CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::OrbitGeneratorCompare< _OrbitType > Struct Template Reference

#include <OrbitGeneration.hh>

Detailed Description

template<typename _OrbitType>
struct CASM::OrbitGeneratorCompare< _OrbitType >

Compare concept functor for canonical generating elements.

  • Uses SymCompareType::compare

Definition at line 90 of file OrbitGeneration.hh.

Public Types

typedef _OrbitType OrbitType
 
typedef OrbitType::Element Element
 
typedef OrbitType::SymCompareType SymCompareType
 

Public Member Functions

 OrbitGeneratorCompare (const SymCompareType &_sym_compare)
 
bool operator() (const Element &A, const Element &B) const
 

Public Attributes

const SymCompareTypesym_compare
 

Member Typedef Documentation

◆ Element

template<typename _OrbitType >
typedef OrbitType::Element CASM::OrbitGeneratorCompare< _OrbitType >::Element

Definition at line 92 of file OrbitGeneration.hh.

◆ OrbitType

template<typename _OrbitType >
typedef _OrbitType CASM::OrbitGeneratorCompare< _OrbitType >::OrbitType

Definition at line 91 of file OrbitGeneration.hh.

◆ SymCompareType

template<typename _OrbitType >
typedef OrbitType::SymCompareType CASM::OrbitGeneratorCompare< _OrbitType >::SymCompareType

Definition at line 93 of file OrbitGeneration.hh.

Constructor & Destructor Documentation

◆ OrbitGeneratorCompare()

template<typename _OrbitType >
CASM::OrbitGeneratorCompare< _OrbitType >::OrbitGeneratorCompare ( const SymCompareType _sym_compare)

Definition at line 73 of file OrbitGeneration_impl.hh.

Member Function Documentation

◆ operator()()

template<typename _OrbitType >
bool CASM::OrbitGeneratorCompare< _OrbitType >::operator() ( const Element A,
const Element B 
) const

Definition at line 78 of file OrbitGeneration_impl.hh.

Member Data Documentation

◆ sym_compare

template<typename _OrbitType >
const SymCompareType& CASM::OrbitGeneratorCompare< _OrbitType >::sym_compare

Definition at line 95 of file OrbitGeneration.hh.


The documentation for this struct was generated from the following files: