CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
CASM::DoFIsEquivalent::IntegralIsEquivalent Class Referenceabstract

#include <ConfigDoFIsEquivalent.hh>

+ Inheritance diagram for CASM::DoFIsEquivalent::IntegralIsEquivalent:

Detailed Description

Abstract base class specialization of ConfigDoFIsEquivalentBase for integral DoF types.

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

Definition at line 80 of file ConfigDoFIsEquivalent.hh.

Public Member Functions

 IntegralIsEquivalent (const ConfigDoF &_configdof)
 
const ConfigDoFconfigdof () 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 Member Functions

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

Protected Attributes

bool m_less
 

Constructor & Destructor Documentation

CASM::DoFIsEquivalent::IntegralIsEquivalent::IntegralIsEquivalent ( const ConfigDoF _configdof)
inline

Definition at line 83 of file ConfigDoFIsEquivalent.hh.

Member Function Documentation

template<typename T >
bool CASM::DoFIsEquivalent::IntegralIsEquivalent::_check ( const T &  A,
const T &  B 
) const
inlineprotected

Definition at line 88 of file ConfigDoFIsEquivalent.hh.

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

Definition at line 59 of file ConfigDoFIsEquivalent.hh.

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

Definition at line 30 of file ConfigDoFIsEquivalent.hh.

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

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
inlineinherited

Return config == other.

Definition at line 46 of file ConfigDoFIsEquivalent.hh.

virtual bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const ConfigDoF other) const
pure virtualinherited
virtual bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const PermuteIterator A) const
pure virtualinherited
virtual bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::operator() ( const PermuteIterator A,
const PermuteIterator B 
) const
pure virtualinherited
Index CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::size ( ) const
inlineinherited

Definition at line 34 of file ConfigDoFIsEquivalent.hh.

Member Data Documentation

bool CASM::DoFIsEquivalent::ConfigDoFIsEquivalentBase::m_less
mutableprotectedinherited

Definition at line 65 of file ConfigDoFIsEquivalent.hh.


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