CASM::ConfigDoFIsEquivalent::Base Class Reference

#include <ConfigDoFIsEquivalent.hh>

Inheritance diagram for CASM::ConfigDoFIsEquivalent::Base:

Detailed Description

Base class for functors that compare ConfigDoF.

• Specialized for Occupation 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
virtual	~Base ()
bool	is_less () const
	Returns less than comparison. More...
bool	operator() (Configuration const &other) const
	Return config == other. More...
virtual bool	operator() (ConfigDoF const &other) const =0
	Return config == other. More...
virtual bool	operator() (PermuteIterator const &A) const =0
	Return config == A*config. More...
virtual bool	operator() (PermuteIterator const &A, PermuteIterator const &B) const =0
	Return A*config == B*config. More...
virtual bool	operator() (PermuteIterator const &A, ConfigDoF const &other) const =0
	Return config == A*other. More...
virtual bool	operator() (PermuteIterator const &A, PermuteIterator const &B, ConfigDoF const &other) const =0
	Return A*config == B*other. More...
std::unique_ptr< Base >	clone () const

Protected Attributes
bool	m_less

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

Constructor & Destructor Documentation

~Base()

virtual CASM::ConfigDoFIsEquivalent::Base::~Base ( )

inlinevirtual

Definition at line 25 of file ConfigDoFIsEquivalent.hh.

Member Function Documentation

_clone()

virtual Base* CASM::ConfigDoFIsEquivalent::Base::_clone ( ) const

privatepure virtual

Implemented in CASM::ConfigDoFIsEquivalent::Global, CASM::ConfigDoFIsEquivalent::Local, CASM::ConfigDoFIsEquivalent::AnisoOccupation, and CASM::ConfigDoFIsEquivalent::Occupation.

clone()

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

inline

Definition at line 55 of file ConfigDoFIsEquivalent.hh.

is_less()

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

inline

Returns less than comparison.

• Only valid after call operator returns false

Definition at line 30 of file ConfigDoFIsEquivalent.hh.

operator()() [1/6]

virtual bool CASM::ConfigDoFIsEquivalent::Base::operator() ( ConfigDoF const &  other ) const

pure virtual

Return config == other.

Implemented in CASM::ConfigDoFIsEquivalent::Global, CASM::ConfigDoFIsEquivalent::Local, CASM::ConfigDoFIsEquivalent::AnisoOccupation, and CASM::ConfigDoFIsEquivalent::Occupation.

operator()() [2/6]

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

inline

Return config == other.

Definition at line 33 of file ConfigDoFIsEquivalent.hh.

operator()() [3/6]

virtual bool CASM::ConfigDoFIsEquivalent::Base::operator() ( PermuteIterator const &  A ) const

pure virtual

Return config == A*config.

Implemented in CASM::ConfigDoFIsEquivalent::Global, CASM::ConfigDoFIsEquivalent::Local, CASM::ConfigDoFIsEquivalent::AnisoOccupation, and CASM::ConfigDoFIsEquivalent::Occupation.

operator()() [4/6]

virtual bool CASM::ConfigDoFIsEquivalent::Base::operator() ( PermuteIterator const &  A, ConfigDoF const &  other  ) const

pure virtual

Return config == A*other.

Implemented in CASM::ConfigDoFIsEquivalent::Global, CASM::ConfigDoFIsEquivalent::Local, CASM::ConfigDoFIsEquivalent::AnisoOccupation, and CASM::ConfigDoFIsEquivalent::Occupation.

operator()() [5/6]

virtual bool CASM::ConfigDoFIsEquivalent::Base::operator() ( PermuteIterator const &  A, PermuteIterator const &  B  ) const

pure virtual

Return A*config == B*config.

Implemented in CASM::ConfigDoFIsEquivalent::Global, CASM::ConfigDoFIsEquivalent::Local, CASM::ConfigDoFIsEquivalent::AnisoOccupation, and CASM::ConfigDoFIsEquivalent::Occupation.

operator()() [6/6]

virtual bool CASM::ConfigDoFIsEquivalent::Base::operator() ( PermuteIterator const &  A, PermuteIterator const &  B, ConfigDoF const &  other  ) const

pure virtual

Return A*config == B*other.

Implemented in CASM::ConfigDoFIsEquivalent::Global, CASM::ConfigDoFIsEquivalent::Local, CASM::ConfigDoFIsEquivalent::AnisoOccupation, and CASM::ConfigDoFIsEquivalent::Occupation.

Member Data Documentation

m_less

bool CASM::ConfigDoFIsEquivalent::Base::m_less

mutableprotected

Definition at line 60 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