CASM::ECIContainer Class Reference

#include <ECIContainer.hh>

Detailed Description

A sparse container of ECI values and their corresponding orbit indices.

Definition at line 12 of file ECIContainer.hh.

Public Types
typedef Clexulator::size_type	size_type

Public Member Functions
	ECIContainer ()
	Default constructor. More...
template<typename SparseECIIterator , typename OrbitIndexIterator >
	ECIContainer (SparseECIIterator eci_begin, SparseECIIterator eci_end, OrbitIndexIterator index_begin)
	Construct from range of ECI values and corresponding orbit indices. More...
size_type	size () const
	Number of eci specified (no guarentee they are all non-zero) More...
const std::vector< double > &	value () const
	const Access ECI values More...
const std::vector< size_type > &	index () const
	const Access orbit indices of ECI values More...

Private Attributes
std::vector< double >	m_value
	Efective cluster interaction values. More...
std::vector< size_type >	m_index
	Orbit index for each coefficient in m_value. More...

Member Typedef Documentation

size_type

typedef Clexulator::size_type CASM::ECIContainer::size_type

Definition at line 14 of file ECIContainer.hh.

Constructor & Destructor Documentation

ECIContainer() [1/2]

CASM::ECIContainer::ECIContainer ( )

inline

Default constructor.

Definition at line 17 of file ECIContainer.hh.

ECIContainer() [2/2]

template<typename SparseECIIterator , typename OrbitIndexIterator >

CASM::ECIContainer::ECIContainer ( SparseECIIterator  eci_begin, SparseECIIterator  eci_end, OrbitIndexIterator  index_begin  )

inline

Construct from range of ECI values and corresponding orbit indices.

Parameters

eci_begin,eci_end	Iterators of range of ECI values
index_begin	Iterator to beginning of range (of size equal to [eci_begin, eci_end)) containing the orbit indices of the corresponding ECI values.

Definition at line 27 of file ECIContainer.hh.

Member Function Documentation

index()

const std::vector<size_type>& CASM::ECIContainer::index ( ) const

inline

const Access orbit indices of ECI values

Definition at line 44 of file ECIContainer.hh.

size()

size_type CASM::ECIContainer::size ( ) const

inline

Number of eci specified (no guarentee they are all non-zero)

Definition at line 38 of file ECIContainer.hh.

value()

const std::vector<double>& CASM::ECIContainer::value ( ) const

inline

const Access ECI values

Definition at line 41 of file ECIContainer.hh.

Member Data Documentation

m_index

std::vector<size_type> CASM::ECIContainer::m_index

private

Orbit index for each coefficient in m_value.

Definition at line 51 of file ECIContainer.hh.

m_value

std::vector<double> CASM::ECIContainer::m_value

private

Efective cluster interaction values.

Definition at line 48 of file ECIContainer.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/ECIContainer.hh