CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::ConfigDoFIsEquivalent::Occupation Class Reference

#include <ConfigDoFIsEquivalent.hh>

+ Inheritance diagram for CASM::ConfigDoFIsEquivalent::Occupation:

Detailed Description

Compare isotropic occupation values

  • The protected '_check' method provides for both checking equality and if not equivalent, storing the 'less than' result

Definition at line 70 of file ConfigDoFIsEquivalent.hh.

Public Member Functions

 Occupation (ConfigDoF const &_configdof)
 
bool operator() (ConfigDoF const &other) const override
 Return config == other, store config < other. More...
 
bool operator() (PermuteIterator const &A) const override
 Return config == A*config, store config < A*config. More...
 
bool operator() (PermuteIterator const &A, PermuteIterator const &B) const override
 Return A*config == B*config, store A*config < B*config. More...
 
bool operator() (PermuteIterator const &A, ConfigDoF const &other) const override
 Return config == A*other, store config < A*other. More...
 
bool operator() (PermuteIterator const &A, PermuteIterator const &B, ConfigDoF const &other) const override
 Return A*config == B*other, store A*config < B*other. More...
 
bool is_less () const
 Returns less than comparison. More...
 
bool operator() (Configuration const &other) const
 Return config == other. More...
 
std::unique_ptr< Baseclone () const
 

Protected Member Functions

ConfigDoF const & configdof () const
 
template<typename F , typename G >
bool _for_each (F f, G g) const
 

Protected Attributes

bool m_less
 

Private Member Functions

Occupation_clone () const override
 
template<typename T >
bool _check (const T &A, const T &B) const
 

Private Attributes

ConfigDoF const * m_configdof_ptr
 

Constructor & Destructor Documentation

◆ Occupation()

CASM::ConfigDoFIsEquivalent::Occupation::Occupation ( ConfigDoF const &  _configdof)
inline

Definition at line 72 of file ConfigDoFIsEquivalent.hh.

Member Function Documentation

◆ _check()

template<typename T >
bool CASM::ConfigDoFIsEquivalent::Occupation::_check ( const T &  A,
const T &  B 
) const
inlineprivate

Definition at line 129 of file ConfigDoFIsEquivalent.hh.

◆ _clone()

Occupation* CASM::ConfigDoFIsEquivalent::Occupation::_clone ( ) const
inlineoverrideprivatevirtual

Implements CASM::ConfigDoFIsEquivalent::Base.

Definition at line 126 of file ConfigDoFIsEquivalent.hh.

◆ _for_each()

template<typename F , typename G >
bool CASM::ConfigDoFIsEquivalent::Occupation::_for_each ( f,
g 
) const
inlineprotected

Definition at line 114 of file ConfigDoFIsEquivalent.hh.

◆ clone()

std::unique_ptr<Base> CASM::ConfigDoFIsEquivalent::Base::clone ( ) const
inlineinherited

Definition at line 55 of file ConfigDoFIsEquivalent.hh.

◆ configdof()

ConfigDoF const& CASM::ConfigDoFIsEquivalent::Occupation::configdof ( ) const
inlineprotected

Definition at line 111 of file ConfigDoFIsEquivalent.hh.

◆ is_less()

bool CASM::ConfigDoFIsEquivalent::Base::is_less ( ) const
inlineinherited

Returns less than comparison.

  • Only valid after call operator returns false

Definition at line 30 of file ConfigDoFIsEquivalent.hh.

◆ operator()() [1/6]

bool CASM::ConfigDoFIsEquivalent::Occupation::operator() ( ConfigDoF const &  other) const
inlineoverridevirtual

Return config == other, store config < other.

Implements CASM::ConfigDoFIsEquivalent::Base.

Definition at line 75 of file ConfigDoFIsEquivalent.hh.

◆ operator()() [2/6]

bool CASM::ConfigDoFIsEquivalent::Base::operator() ( Configuration const &  other) const
inlineinherited

Return config == other.

Definition at line 33 of file ConfigDoFIsEquivalent.hh.

◆ operator()() [3/6]

bool CASM::ConfigDoFIsEquivalent::Occupation::operator() ( PermuteIterator const &  A) const
inlineoverridevirtual

Return config == A*config, store config < A*config.

Implements CASM::ConfigDoFIsEquivalent::Base.

Definition at line 81 of file ConfigDoFIsEquivalent.hh.

◆ operator()() [4/6]

bool CASM::ConfigDoFIsEquivalent::Occupation::operator() ( PermuteIterator const &  A,
ConfigDoF const &  other 
) const
inlineoverridevirtual

Return config == A*other, store config < A*other.

Implements CASM::ConfigDoFIsEquivalent::Base.

Definition at line 96 of file ConfigDoFIsEquivalent.hh.

◆ operator()() [5/6]

bool CASM::ConfigDoFIsEquivalent::Occupation::operator() ( PermuteIterator const &  A,
PermuteIterator const &  B 
) const
inlineoverridevirtual

Return A*config == B*config, store A*config < B*config.

Implements CASM::ConfigDoFIsEquivalent::Base.

Definition at line 88 of file ConfigDoFIsEquivalent.hh.

◆ operator()() [6/6]

bool CASM::ConfigDoFIsEquivalent::Occupation::operator() ( PermuteIterator const &  A,
PermuteIterator const &  B,
ConfigDoF const &  other 
) const
inlineoverridevirtual

Return A*config == B*other, store A*config < B*other.

Implements CASM::ConfigDoFIsEquivalent::Base.

Definition at line 103 of file ConfigDoFIsEquivalent.hh.

Member Data Documentation

◆ m_configdof_ptr

ConfigDoF const* CASM::ConfigDoFIsEquivalent::Occupation::m_configdof_ptr
private

Definition at line 137 of file ConfigDoFIsEquivalent.hh.

◆ m_less

bool CASM::ConfigDoFIsEquivalent::Base::m_less
mutableprotectedinherited

Definition at line 60 of file ConfigDoFIsEquivalent.hh.


The documentation for this class was generated from the following file: