CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
CASM::OccFuncLabeler Class Reference

#include <FunctionVisitor.hh>

+ Inheritance diagram for CASM::OccFuncLabeler:

Detailed Description

Selectively relabel all OccupantFunctions in a Function tree, using their set_formula() method. OccFuncLabeler is constructed using a template string, which should be of the form (substr1 + "%n" + substr2 + "%f" + substr3 + "%b" + substr4), where substr1, etc, are user-defined substrings. "%n" indicates the placement of the neighbor_list index, "%f" indicates the placement of the function index, and "%b" indicates the placement of the basis site index. The relative order of "%n", "%f", and "%b" is determined by the user.

Definition at line 59 of file FunctionVisitor.hh.

Public Member Functions

 OccFuncLabeler (const std::string &_template)
 
std::string type_name () const
 
bool visit (OccupantFunction &host, BasisSet const *bset_ptr) const
 
virtual bool visit (Variable &host, BasisSet const *bset_ptr) const
 
virtual bool visit (PolynomialFunction &host, BasisSet const *bset_ptr) const
 

Private Attributes

Array< std::string > m_sub_strings
 
std::stringstream m_ss
 

Constructor & Destructor Documentation

CASM::OccFuncLabeler::OccFuncLabeler ( const std::string &  _template)

Definition at line 11 of file FunctionVisitor.cc.

Member Function Documentation

std::string CASM::OccFuncLabeler::type_name ( ) const
inlinevirtual

Implements CASM::FunctionVisitor.

Definition at line 65 of file FunctionVisitor.hh.

virtual bool CASM::FunctionVisitor::visit ( Variable host,
BasisSet const *  bset_ptr 
) const
inlinevirtualinherited

Reimplemented in CASM::SubExpressionLabeler, and CASM::VariableLabeler.

Definition at line 31 of file FunctionVisitor.hh.

virtual bool CASM::FunctionVisitor::visit ( PolynomialFunction host,
BasisSet const *  bset_ptr 
) const
inlinevirtualinherited

Reimplemented in CASM::SubExpressionLabeler.

Definition at line 38 of file FunctionVisitor.hh.

bool CASM::OccFuncLabeler::visit ( OccupantFunction host,
BasisSet const *  bset_ptr 
) const
virtual

Reimplemented from CASM::FunctionVisitor.

Definition at line 32 of file FunctionVisitor.cc.

Member Data Documentation

std::stringstream CASM::OccFuncLabeler::m_ss
mutableprivate

Definition at line 61 of file FunctionVisitor.hh.

Array<std::string> CASM::OccFuncLabeler::m_sub_strings
private

Definition at line 60 of file FunctionVisitor.hh.


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