edge.h

Go to the documentation of this file.

/*
 *            Copyright 2009-2020 The VOTCA Development Team
 *                       (http://www.votca.org)
 *
 *      Licensed under the Apache License, Version 2.0 (the "License")
 *
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *              http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef VOTCA_TOOLS_EDGE_H
#define VOTCA_TOOLS_EDGE_H
 
// Standard includes
#include <iostream>
#include <limits>
#include <utility>
#include <vector>
 
// Local VOTCA includes
#include "types.h"
 
namespace votca {
namespace tools {
 
class Edge {
 protected:
  std::vector<Index> vertices_;
 
 public:
  Edge() = default;
  virtual ~Edge() = default;
  Edge(Index ID1, Index ID2);
  Index getOtherEndPoint(Index ver) const;
  Index getEndPoint1() const { return vertices_.front(); }
  Index getEndPoint2() const { return vertices_.back(); }
 
  bool loop() const { return vertices_.front() == vertices_.back(); }
 
  bool contains(Index ID) const;
  virtual bool operator==(const Edge& ed) const;
  virtual bool operator!=(const Edge& ed) const;
 
  virtual bool operator<(const Edge& ed) const;
  virtual bool operator>(const Edge& ed) const;
  virtual bool operator<=(const Edge& ed) const;
  virtual bool operator>=(const Edge& ed) const;
 
  friend std::ostream& operator<<(std::ostream& os, const Edge& ed);
};
 
// Value used as a dummy object
const Edge DUMMY_EDGE(std::numeric_limits<Index>::max(),
                      std::numeric_limits<Index>::max());
}  // namespace tools
}  // namespace votca
 
namespace std {
template <>
class hash<votca::tools::Edge> {
 public:
  size_t operator()(const votca::tools::Edge& ed) const {
    return hash<votca::Index>()(ed.getEndPoint1()) ^
           hash<votca::Index>()(ed.getEndPoint2());
  }
};
}  // namespace std
#endif  // VOTCA_TOOLS_EDGE_H