Property.hpp

Go to the documentation of this file.

#ifndef GL_PROPERTY_HPP
#define GL_PROPERTY_HPP

namespace gl {

//    Property Class declaration

class Property
{
public:
  using idx_t = gl::index_type;

  Property(const idx_t &numNodes = 0, const std::string &label = "Graph") : numNodes_(numNodes), label_(label), numEdges_(0) {}

  Property(const Property&) = default;                
  Property(Property&&) noexcept = default;            
  Property &operator=(const Property&) = default;     
  Property &operator=(Property&&) noexcept = default; 
  ~Property() = default;                            

  bool operator== (const Property& rhs) const;
  bool operator!= (const Property& rhs) const;
  inline idx_t numNodes() const;
  inline void numNodes(const idx_t &numNodes);
  inline void numNodesIncrement(const idx_t &increment = 1);
  inline void numNodesDecrement(const idx_t &decrement = 1);

  inline idx_t numEdges() const;
  inline void numEdges(const idx_t &numEdges);
  inline void numEdgesIncrement(const idx_t &increment = 1);
  inline void numEdgesDecrement(const idx_t &decrement = 1);

  inline std::string label() const;
  inline void label(const std::string &label);

private:
  idx_t numNodes_;    
  idx_t numEdges_;    
  std::string label_; 
};

//    Property function implementations

#ifndef DOXYGEN_SHOULD_SKIP_THIS

// equality operator
bool Property::operator== (const Property& rhs) const
{
  return numNodes_ == rhs.numNodes_ 
      && numEdges_ == rhs.numEdges_
      && label_ == rhs.label_;
}
// inequality operator
bool Property::operator!= (const Property& rhs) const
{
  return !operator==(rhs);
}

// getter for numNodes
inline typename Property::idx_t Property::numNodes() const {
  return numNodes_;
}
// setter for numNodes
inline void Property::numNodes(const typename Property::idx_t& numNodes) {
  numNodes_ = numNodes;
}

// increment for numNodes
inline void Property::numNodesIncrement (const typename Property::idx_t& increment) {
  numNodes_ += increment;
}
// decrement for numNodes
inline void Property::numNodesDecrement (const typename Property::idx_t& decrement) {
  GL_ASSERT(decrement <= numNodes_,"Property::numNodesDecrement | Decrement results in negative number of nodes")
  numNodes_ -= decrement;
}

// getter for numEdges
inline typename Property::idx_t Property::numEdges() const {
  return numEdges_;
}
// setter for numEdges
inline void Property::numEdges(const typename Property::idx_t& numEdges) {
  numEdges_ = numEdges;
}

// increment for numEdges
inline void Property::numEdgesIncrement (const typename Property::idx_t& increment) {
  numEdges_ += increment;
}
// decrement for numEdges
inline void Property::numEdgesDecrement (const typename Property::idx_t& decrement) {GL_ASSERT(decrement <= numNodes_,"Property::numEdgesDecrement | Decrement results in negative number of edges")
  numEdges_ -= decrement;
}

// getter for label
inline std::string Property::label() const {
  return label_;
}
// setter for label
inline void Property::label(const std::string& label) {
  label_ = label;
}
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

} // namespace gl

#endif // GL_PROPERTY_HPP