DataStream.hpp

// Copyright (c) 2017 Graphcore Ltd. All rights reserved.
 
#ifndef poplar_DataStream_hpp
#define poplar_DataStream_hpp
#include <memory>
#include <poplar/DataStreamType.hpp>
#include <poplar/ReplicatedStreamMode.hpp>
#include <poplar/Type.hpp>
 
namespace poplar {
namespace core {
class DataStreamRef;
class RemoteBufferRef;
} // namespace core
 
class DataStream {
public:
  DataStream();
  DataStream(const DataStream &);
  DataStream(DataStream &&) noexcept;
  ~DataStream();
 
  DataStream &operator=(const DataStream &);
  DataStream &operator=(DataStream &&) noexcept;
 
  std::string handle() const;
  std::size_t numElements() const;
  unsigned replicationFactor() const;
  ReplicatedStreamMode replicatedMode() const;
  DataStreamType type() const;
  Type elementType() const;
 
  // Implementation
  DataStream(std::unique_ptr<core::DataStreamRef>);
  const core::DataStreamRef &getImpl() const { return *impl; }
 
private:
  std::unique_ptr<core::DataStreamRef> impl;
};
 
class RemoteBuffer {
public:
  RemoteBuffer();
  RemoteBuffer(const RemoteBuffer &);
  RemoteBuffer(RemoteBuffer &&) noexcept;
  ~RemoteBuffer();
 
  RemoteBuffer &operator=(const RemoteBuffer &);
  RemoteBuffer &operator=(RemoteBuffer &&) noexcept;
 
  std::string handle() const;
  DataStream getIpuToHostStream() const;
  DataStream getHostToIpuStream() const;
  size_t numElements() const;
  size_t getRepeats() const;
  Type elementType() const;
  bool isRearrangeOnHost() const;
  bool isOptimisedForMemory() const;
 
  // Implementation
  RemoteBuffer(std::unique_ptr<core::RemoteBufferRef>);
  const core::RemoteBufferRef &getImpl() const { return *impl; }
 
  bool operator==(const RemoteBuffer &b) const;
  bool operator!=(const RemoteBuffer &b) const;
 
private:
  std::unique_ptr<core::RemoteBufferRef> impl;
};
 
} // end namespace poplar
 
#endif // poplar_DataStream_hpp