CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Types | Public Member Functions | Private Attributes | List of all members
CASM::xtal::SpeciesAttribute Class Reference

#include <SpeciesAttribute.hh>

Detailed Description

Definition at line 29 of file SpeciesAttribute.hh.

Public Types

using BasicTraits = AnisoValTraits
 
using KeyType = std::string
 

Public Member Functions

BasicTraits const & traits (KeyType const &key)
 
 SpeciesAttribute (AnisoValTraits const &_traits, Eigen::Ref< const Eigen::VectorXd > const &_value)
 
 SpeciesAttribute (AnisoValTraits const &_traits)
 
std::string const & name () const
 
Eigen::VectorXd const & value () const
 
void set_value (Eigen::Ref< const Eigen::VectorXd > const &_value)
 
bool identical (SpeciesAttribute const &other, double _tol) const
 
BasicTraits const & traits () const
 

Private Attributes

BasicTraits m_traits
 
Eigen::VectorXd m_value
 

Member Typedef Documentation

◆ BasicTraits

using CASM::xtal::SpeciesAttribute::BasicTraits = AnisoValTraits

Definition at line 31 of file SpeciesAttribute.hh.

◆ KeyType

using CASM::xtal::SpeciesAttribute::KeyType = std::string

Definition at line 32 of file SpeciesAttribute.hh.

Constructor & Destructor Documentation

◆ SpeciesAttribute() [1/2]

CASM::xtal::SpeciesAttribute::SpeciesAttribute ( AnisoValTraits const &  _traits,
Eigen::Ref< const Eigen::VectorXd > const &  _value 
)
inline

Definition at line 36 of file SpeciesAttribute.hh.

◆ SpeciesAttribute() [2/2]

CASM::xtal::SpeciesAttribute::SpeciesAttribute ( AnisoValTraits const &  _traits)
inline

Definition at line 40 of file SpeciesAttribute.hh.

Member Function Documentation

◆ identical()

bool CASM::xtal::SpeciesAttribute::identical ( SpeciesAttribute const &  other,
double  _tol 
) const

Definition at line 10 of file SpeciesAttribute.cc.

◆ name()

std::string const& CASM::xtal::SpeciesAttribute::name ( ) const
inline

Definition at line 43 of file SpeciesAttribute.hh.

◆ set_value()

void CASM::xtal::SpeciesAttribute::set_value ( Eigen::Ref< const Eigen::VectorXd > const &  _value)
inline

Definition at line 47 of file SpeciesAttribute.hh.

◆ traits() [1/2]

BasicTraits const& CASM::xtal::SpeciesAttribute::traits ( ) const
inline

Definition at line 53 of file SpeciesAttribute.hh.

◆ traits() [2/2]

BasicTraits const& CASM::xtal::SpeciesAttribute::traits ( KeyType const &  key)

◆ value()

Eigen::VectorXd const& CASM::xtal::SpeciesAttribute::value ( ) const
inline

Definition at line 45 of file SpeciesAttribute.hh.

Member Data Documentation

◆ m_traits

BasicTraits CASM::xtal::SpeciesAttribute::m_traits
private

Definition at line 56 of file SpeciesAttribute.hh.

◆ m_value

Eigen::VectorXd CASM::xtal::SpeciesAttribute::m_value
private

Definition at line 57 of file SpeciesAttribute.hh.

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