CASM::ConfigIsEquivalent Class Reference

#include <ConfigIsEquivalent.hh>

Detailed Description

Class for comparison of Configurations (with the same Supercell)

• The call operators return the value for equality comparison, and if not equivalent, also store the result for less than comparison

Definition at line 20 of file ConfigIsEquivalent.hh.

Public Types
typedef std::vector < ConfigDoFIsEquivalent >	eq_container

Public Member Functions
	ConfigIsEquivalent (const Configuration &_config, double _tol)
const Configuration &	config () const
eq_container &	global_eq ()
const eq_container &	global_eq () const
eq_container &	site_eq ()
const eq_container &	site_eq () const
bool	is_less () const
	Returns less than comparison. More...
bool	operator() (const Configuration &other) const
	Check if config == other, store config < other. More...
bool	operator() (const PermuteIterator &A) const
	Check if config == A*config, store config < A*config. More...
bool	operator() (const PermuteIterator &A, const PermuteIterator &B) const
	Check if A*config == B*config, store A*config < B*config. More...

Private Attributes
const Configuration *	m_config
eq_container	m_global_eq
eq_container	m_site_eq
bool	m_less

Member Typedef Documentation

typedef std::vector<ConfigDoFIsEquivalent> CASM::ConfigIsEquivalent::eq_container

Definition at line 24 of file ConfigIsEquivalent.hh.

Constructor & Destructor Documentation

CASM::ConfigIsEquivalent::ConfigIsEquivalent ( const Configuration &  _config, double  _tol  )

inline

Definition at line 26 of file ConfigIsEquivalent.hh.

Member Function Documentation

const Configuration& CASM::ConfigIsEquivalent::config ( ) const

inline

Definition at line 42 of file ConfigIsEquivalent.hh.

eq_container& CASM::ConfigIsEquivalent::global_eq ( )

inline

Definition at line 46 of file ConfigIsEquivalent.hh.

const eq_container& CASM::ConfigIsEquivalent::global_eq ( ) const

inline

Definition at line 50 of file ConfigIsEquivalent.hh.

bool CASM::ConfigIsEquivalent::is_less ( ) const

inline

Returns less than comparison.

• Only valid after call operator returns false

Definition at line 65 of file ConfigIsEquivalent.hh.

bool CASM::ConfigIsEquivalent::operator() ( const Configuration &  other ) const

inline

Check if config == other, store config < other.

• Currently assumes that both Configuration have the same DoF types

Definition at line 72 of file ConfigIsEquivalent.hh.

bool CASM::ConfigIsEquivalent::operator() ( const PermuteIterator &  A ) const

inline

Check if config == A*config, store config < A*config.

Definition at line 97 of file ConfigIsEquivalent.hh.

bool CASM::ConfigIsEquivalent::operator() ( const PermuteIterator &  A, const PermuteIterator &  B  ) const

inline

Check if A*config == B*config, store A*config < B*config.

Definition at line 118 of file ConfigIsEquivalent.hh.

eq_container& CASM::ConfigIsEquivalent::site_eq ( )

inline

Definition at line 54 of file ConfigIsEquivalent.hh.

const eq_container& CASM::ConfigIsEquivalent::site_eq ( ) const

inline

Definition at line 58 of file ConfigIsEquivalent.hh.

Member Data Documentation

const Configuration* CASM::ConfigIsEquivalent::m_config

private

Definition at line 143 of file ConfigIsEquivalent.hh.

eq_container CASM::ConfigIsEquivalent::m_global_eq

private

Definition at line 144 of file ConfigIsEquivalent.hh.

bool CASM::ConfigIsEquivalent::m_less

mutableprivate

Definition at line 146 of file ConfigIsEquivalent.hh.

eq_container CASM::ConfigIsEquivalent::m_site_eq

private

Definition at line 145 of file ConfigIsEquivalent.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/ConfigIsEquivalent.hh