GraphElements.hpp

// Copyright (c) 2015 Graphcore Ltd. All rights reserved.
 
#ifndef poplar_GraphElements_hpp
#define poplar_GraphElements_hpp
 
#include <memory>
#include <poplar/StringRef.hpp>
 
namespace poplar {
namespace core {
class GraphBuilder;
}
class Graph;
 
typedef unsigned vertex_id;
 
class FieldRef;
 
class VertexRef {
  const core::GraphBuilder *graph;
  vertex_id id;
 
public:
  VertexRef() {}
 
  FieldRef operator[](StringRef fieldName) const;
 
  vertex_id getId() const { return id; }
 
private:
  VertexRef(const core::GraphBuilder *graph, unsigned id)
      : graph(graph), id(id) {}
 
  friend class core::GraphBuilder;
  friend class Graph;
  friend class FieldRef;
};
 
class FieldRef {
public:
  // The vertex instance this field ref is for.
  VertexRef vertex;
  // The ID of the field within the vertex.
  unsigned fieldId;
  // If `indexed` is true this gives the value of the index, otherwise
  // it is ignored.
  std::size_t index;
  // True if this is a references to a sub-element of the field.
  bool indexed;
 
  FieldRef() {}
 
  FieldRef operator[](std::size_t index) const {
    return FieldRef(vertex, fieldId, index);
  }
 
  bool isIndexed() const { return indexed; }
  std::size_t getIndex() const { return index; }
 
private:
  FieldRef(VertexRef vertex, StringRef fieldName);
 
  FieldRef(VertexRef vertex, unsigned fieldId);
 
  FieldRef(VertexRef vertex, StringRef fieldName, std::size_t index);
 
  FieldRef(VertexRef vertex, unsigned fieldId, std::size_t index);
 
  friend class VertexRef;
};
 
inline FieldRef VertexRef::operator[](StringRef fieldName) const {
  return FieldRef(*this, fieldName);
}
 
class ComputeSet {
  unsigned computeset_id;
 
public:
  ComputeSet() {}
 
  ComputeSet(unsigned id) : computeset_id(id) {}
  unsigned getId() const { return computeset_id; }
};
 
inline bool operator==(const ComputeSet &lhs, const ComputeSet &rhs) {
  return lhs.getId() == rhs.getId();
}
 
class Function {
  unsigned function_id;
 
public:
  Function() {}
 
  Function(unsigned id) : function_id(id) {}
  unsigned getId() const { return function_id; }
};
 
inline bool operator==(const Function &lhs, const Function &rhs) {
  return lhs.getId() == rhs.getId();
}
 
class FunctionBuffer {
  unsigned function_buffer_id;
 
public:
  FunctionBuffer() {}
  explicit FunctionBuffer(unsigned id) : function_buffer_id(id) {}
  unsigned getId() const { return function_buffer_id; }
};
 
inline bool operator==(const FunctionBuffer &lhs, const FunctionBuffer &rhs) {
  return lhs.getId() == rhs.getId();
}
 
class HostFunction {
  unsigned function_id;
 
public:
  HostFunction(unsigned id) : function_id(id) {}
  unsigned getId() const { return function_id; }
};
 
} // End namespace poplar.
 
#endif // poplar_GraphElements_hpp