SubClusterGenerator.hh

Go to the documentation of this file.

#ifndef CASM_SubClusterGenerator
#define CASM_SubClusterGenerator
 
#include <boost/iterator/iterator_facade.hpp>
 
#include "casm/container/Counter.hh"
#include "casm/misc/cloneable_ptr.hh"
 
namespace CASM {
 
template <typename ClusterType>
class SubClusterGenerator
    : public boost::iterator_facade<SubClusterGenerator<ClusterType>,
                                    ClusterType, boost::forward_traversal_tag> {
 public:
  SubClusterGenerator() {}
 
  explicit SubClusterGenerator(const ClusterType &clust)
      : m_cluster(notstd::make_unique<ClusterType>(clust)),
        m_current_valid(false),
        m_current(notstd::make_unique<ClusterType>(clust)),
        m_site_counter(std::vector<int>(m_cluster->size(), 0),
                       std::vector<int>(m_cluster->size(), 1),
                       std::vector<int>(m_cluster->size(), 1)) {}
 
 private:
  friend class boost::iterator_core_access;
 
  void increment() {
    ++m_site_counter;
    m_current_valid = false;
  }
 
  bool equal(const SubClusterGenerator &other) const {
    if (valid() && other.valid()) {
      return std::equal(m_site_counter.value_begin(),
                        m_site_counter.value_end(),
                        other.m_site_counter.value_begin());
    }
    if (!valid() && !other.valid()) {
      return true;
    }
    return false;
  }
 
  ClusterType &dereference() const {
    // lazy construction of 'm_current'
    if (!m_current_valid) {
      m_current->elements().clear();
      for (Index i = 0; i < m_site_counter.size(); ++i) {
        if (m_site_counter()[i]) {
          m_current->elements().push_back(m_cluster->element(i));
        }
      }
    }
    return *m_current;
  }
 
  bool valid() const {
    if (!m_cluster || !m_site_counter.valid()) {
      return false;
    }
    return m_site_counter.valid();
  }
 
 private:
  notstd::cloneable_ptr<ClusterType> m_cluster;
 
  bool m_current_valid;
 
  notstd::cloneable_ptr<ClusterType> m_current;
 
  Counter<std::vector<int> > m_site_counter;
};
}  // namespace CASM
 
#endif