CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase Class Reference

#include <ConfigDoFIsEquivalent.hh>

Inheritance diagram for CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase:

Detailed Description

Base class for functors that compare ConfigDoF.

• Specialized for Integral or Float DoF, and then for type (strain, occupation, displacement etc.)
• The derived call operators return the value for equality comparison, and if not equivalent, also store the result for less than comparison

Definition at line 23 of file ConfigDoFIsEquivalent.hh.

Public Member Functions
	ConfigDoFIsEquivalentBase (const ConfigDoF &_configdof)
const ConfigDoF &	configdof () const
Index	size () const
bool	is_less () const
	Returns less than comparison. More...
bool	operator() (const Configuration &other) const
	Return config == other. More...
virtual bool	operator() (const ConfigDoF &other) const =0
	Return config == other. More...
virtual bool	operator() (const PermuteIterator &A) const =0
	Return config == A*config. More...
virtual bool	operator() (const PermuteIterator &A, const PermuteIterator &B) const =0
	Return A*config == B*config. More...
std::unique_ptr < ConfigDoFIsEquivalentBase >	clone () const

Protected Attributes
bool	m_less

Private Member Functions
virtual ConfigDoFIsEquivalentBase *	_clone () const =0

Private Attributes
const ConfigDoF *	m_configdof

Constructor & Destructor Documentation

CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::ConfigDoFIsEquivalentBase ( const ConfigDoF &  _configdof )

inline

Definition at line 27 of file ConfigDoFIsEquivalent.hh.

Member Function Documentation

virtual ConfigDoFIsEquivalentBase* CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::_clone ( ) const

privatepure virtual

Implemented in CASM::DoFIsEquivalent::Strain, CASM::DoFIsEquivalent::Displacement, and CASM::DoFIsEquivalent::Occupation.

std::unique_ptr<ConfigDoFIsEquivalentBase> CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::clone ( ) const

inline

Definition at line 59 of file ConfigDoFIsEquivalent.hh.

const ConfigDoF& CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::configdof ( ) const

inline

Definition at line 30 of file ConfigDoFIsEquivalent.hh.

bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::is_less ( ) const

inline

Returns less than comparison.

• Only valid after call operator returns false

Definition at line 41 of file ConfigDoFIsEquivalent.hh.

bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const Configuration &  other ) const

inline

Return config == other.

Definition at line 46 of file ConfigDoFIsEquivalent.hh.

virtual bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const ConfigDoF &  other ) const

pure virtual

Return config == other.

Implemented in CASM::DoFIsEquivalent::Strain, CASM::DoFIsEquivalent::Displacement, and CASM::DoFIsEquivalent::Occupation.

virtual bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const PermuteIterator &  A ) const

pure virtual

Return config == A*config.

Implemented in CASM::DoFIsEquivalent::Strain, CASM::DoFIsEquivalent::Displacement, and CASM::DoFIsEquivalent::Occupation.

virtual bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const PermuteIterator &  A, const PermuteIterator &  B  ) const

pure virtual

Return A*config == B*config.

Implemented in CASM::DoFIsEquivalent::Strain, CASM::DoFIsEquivalent::Displacement, and CASM::DoFIsEquivalent::Occupation.

Index CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::size ( ) const

inline

Definition at line 34 of file ConfigDoFIsEquivalent.hh.

Member Data Documentation

const ConfigDoF* CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::m_configdof

private

Definition at line 71 of file ConfigDoFIsEquivalent.hh.

bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::m_less

mutableprotected

Definition at line 65 of file ConfigDoFIsEquivalent.hh.

---

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

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