PermuteIterator.hh

Go to the documentation of this file.

#ifndef PermuteIterator_HH
#define PermuteIterator_HH

#include "casm/container/Array.hh"
#include "casm/symmetry/SymGroupRep.hh"
#include "casm/container/Permutation.hh"
#include "casm/misc/Comparisons.hh"

namespace CASM {
  class PrimGrid;

  class PermuteIterator :
    public std::iterator <std::bidirectional_iterator_tag, PermuteIterator>,
    public Comparisons<PermuteIterator> {

    SymGroupRep::RemoteHandle m_fg_permute_rep;

    PrimGrid const *m_prim_grid;

    Array<Permutation> const *m_trans_permute;

    Index m_factor_group_index;
    Index m_translation_index;

  public:

    PermuteIterator();

    PermuteIterator(const PermuteIterator &iter);

    PermuteIterator(SymGroupRep::RemoteHandle _fg_permute_rep,
                    const PrimGrid &_prim_grid,
                    Index _factor_group_index,
                    Index _translation_index);

    PermuteIterator &operator=(PermuteIterator iter);

    const PermuteIterator &operator*() const;

    Permutation combined_permute() const;

    template<typename T>
    ReturnArray<T> permute(const Array<T> &before_array) const;

    Index factor_group_index() const;

    Index translation_index() const;

    const Permutation &factor_group_permute() const;

    const Permutation &translation_permute() const;

    SymOp sym_op()const;

    Index permute_ind(Index i) const;

    template<typename T>
    const T &permute_by_bit(Index i, const Array<T> &before_array) const;

    bool operator<(const PermuteIterator &iter) const;

    // prefix ++PermuteIterator
    PermuteIterator &operator++();

    // postfix PermuteIterator++
    PermuteIterator operator++(int);

    // prefix --PermuteIterator
    PermuteIterator &operator--();

    // postfix PermuteIterator--
    PermuteIterator operator--(int);

    PermuteIterator begin_next_fg_op() const;

    PermuteIterator inverse() const;

    PermuteIterator operator*(const PermuteIterator &RHS) const;

    jsonParser &to_json(jsonParser &json) const;
    void from_json(const jsonParser &json);

    friend void swap(PermuteIterator &a, PermuteIterator &b);

  private:

    friend Comparisons<PermuteIterator>;

    bool _eq(const PermuteIterator &iter) const;

  };

  jsonParser &to_json(const PermuteIterator &clust, jsonParser &json);
  void from_json(PermuteIterator &clust, const jsonParser &json);

}
#endif