TensorView.h

#pragma once
 
#include <iolink/DataType.h>
#include <iolink/FlagSet.h>
#include <iolink/IOLinkAPI.h>
#include <iolink/Indexer.h>
#include <iolink/RegionX.h>
#include <iolink/VectorX.h>
#include <iolink/view/View.h>
 
namespace iolink
{
 
enum class TensorCapability
{
  // Flags
  READ = 0x1,          
  WRITE = 0x2,         
  MEMORY_ACCESS = 0x4, 
  RESHAPE = 0x8,       
 
  // Combinations
  READ_WRITE = 0x3,
};
 
// Declare the flagset for tensor capability does not need to be instanciated
// by the library user
extern template class IOLINK_API_IMPORT FlagSet<TensorCapability>;
 
using TensorCapabilitySet = FlagSet<TensorCapability>;
 
// Define bitwise operators for TensorCapability
IOLINK_DEFINE_ENUM_BITWISE_OPERATORS(TensorCapability)
 
 
class IOLINK_API TensorView : public View
{
public:
  virtual ~TensorView() = default;
 
  virtual TensorCapabilitySet capabilities() const = 0;
 
  inline bool support(TensorCapabilitySet capabilities) const { return this->capabilities().has(capabilities); }
 
  virtual const VectorXu64& shape() const = 0;
 
  inline size_t dimensionCount() const { return this->shape().size(); }
 
  virtual DataType dtype() const = 0;
 
  std::string toString() const;
 
  // ==== //
  // READ //
  // ==== //
 
  virtual void read(const RegionXu64& region, void* dst) const;
 
  template <typename T>
  inline T at(const VectorXu64& index) const
  {
    T value;
    const VectorXu64 size = VectorXu64::createUniform(this->dimensionCount(), 1);
    const RegionXu64 region(index, size);
    this->read(region, &value);
    return value;
  }
 
  // ===== //
  // WRITE //
  // ===== //
 
  virtual void write(const RegionXu64& region, const void* src);
 
  template <typename T>
  inline void setAt(const VectorXu64& index, T value)
  {
    const VectorXu64 size = VectorXu64::createUniform(this->dimensionCount(), 1);
    const RegionXu64 region(index, size);
    this->write(region, &value);
  }
 
  // ======= //
  // RESHAPE //
  // ======= //
 
  virtual void reshape(const VectorXu64& shape, DataType dtype);
 
  // ============= //
  // MEMORY_ACCESS //
  // ============= //
 
  virtual const Indexer& indexer() const;
 
  virtual size_t bufferSize() const;
 
  virtual void* buffer();
 
  virtual const void* buffer() const;
};
 
} // end namespace iolink