reducededge.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_REDUCEDEDGE_H
#define VOTCA_TOOLS_REDUCEDEDGE_H
 
// Local VOTCA includes
#include "edge.h"
 
namespace votca {
namespace tools {
 
class ReducedEdge : public Edge {
 
 public:
  ReducedEdge() = default;
  ReducedEdge(std::vector<Index> vertices);
 
  ReducedEdge(Index vertex1, Index vertex2)
      : ReducedEdge(std::vector<Index>{vertex1, vertex2}) {};
 
  std::vector<Index> getChain() const { return vertices_; }
 
  bool vertexExistInChain(const int& vertex) const;
 
  std::vector<Edge> expand() const;
 
  bool operator==(const ReducedEdge& edge) const;
  bool operator!=(const ReducedEdge& edge) const;
 
  bool operator<(const ReducedEdge& edge) const;
  bool operator>(const ReducedEdge& edge) const;
  bool operator<=(const ReducedEdge& edge) const;
  bool operator>=(const ReducedEdge& edge) const;
 
  using Edge::operator!=;
  using Edge::operator==;
  using Edge::operator<;
  using Edge::operator>;
  using Edge::operator<=;
  using Edge::operator>=;
 
  friend std::ostream& operator<<(std::ostream& os, const ReducedEdge& edge);
};
 
}  // namespace tools
}  // namespace votca
 
namespace std {
template <>
class hash<votca::tools::ReducedEdge> {
 public:
  size_t operator()(const votca::tools::ReducedEdge& ed) const {
    size_t value = 1;
    auto vertices = ed.getChain();
    for (auto vertex : vertices) {
      value += hash<size_t>()(static_cast<size_t>(vertex)) ^ value;
    }
    return value;
  }
};
}  // namespace std
#endif  // VOTCA_TOOLS_REDUCEDEDGE_H