CASM::ConfigDoFIsEquivalent::Float Class Reference

#include <ConfigDoFIsEquivalent.hh>

Inheritance diagram for CASM::ConfigDoFIsEquivalent::Float:

Detailed Description

Abstract base class specialization of Base for floating point DoF types.

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

Definition at line 290 of file ConfigDoFIsEquivalent.hh.

Public Member Functions
	Float (double _tol, DoFKey const &_key)
DoFKey const &	key () const
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 Member Functions
template<typename T >
bool	_check (const T &A, const T &B) const

Protected Attributes
bool	m_less

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

Private Attributes
const double	m_tol
const DoFKey	m_key

Constructor & Destructor Documentation

Float()

CASM::ConfigDoFIsEquivalent::Float::Float ( double  _tol, DoFKey const &  _key  )

inline

Definition at line 292 of file ConfigDoFIsEquivalent.hh.

Member Function Documentation

_check()

template<typename T >

bool CASM::ConfigDoFIsEquivalent::Float::_check ( const T &  A, const T &  B  ) const

inlineprotected

Definition at line 298 of file ConfigDoFIsEquivalent.hh.

_clone()

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

privatepure virtualinherited

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

inlineinherited

Definition at line 55 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.

key()

DoFKey const& CASM::ConfigDoFIsEquivalent::Float::key ( ) const

inline

Definition at line 294 of file ConfigDoFIsEquivalent.hh.

operator()() [1/6]

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

pure virtualinherited

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

inlineinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

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 virtualinherited

Return A*config == B*other.

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

tol()

double CASM::ConfigDoFIsEquivalent::Float::tol ( ) const

inlineprivate

Definition at line 315 of file ConfigDoFIsEquivalent.hh.

Member Data Documentation

m_key

const DoFKey CASM::ConfigDoFIsEquivalent::Float::m_key

private

Definition at line 319 of file ConfigDoFIsEquivalent.hh.

m_less

bool CASM::ConfigDoFIsEquivalent::Base::m_less

mutableprotectedinherited

Definition at line 60 of file ConfigDoFIsEquivalent.hh.

m_tol

const double CASM::ConfigDoFIsEquivalent::Float::m_tol

private

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