#include <ClusterInvariants.hh>

Inheritance diagram for CASM::ClusterInvariants:

Detailed Description

Stores cluster invariants: number of sites and site distances.

Default expects (as for CoordCluster):

ClusterType::size()
ClusterType::coordinate(size_type index)

CASM::Monte::size_type
Index size_type
Definition: MonteDefinitions.hh:11

Definition at line 29 of file ClusterInvariants.hh.

Public Member Functions
	ClusterInvariants (IntegralCluster const &cluster)
	Construct and calculate cluster invariants. More...

int	size () const
	Number of elements in the cluster. More...

std::vector< double > const &	displacement () const
	const Access displacements between coordinates in the cluster, sorted in ascending order More...

std::unique_ptr< Cloneable >	clone () const

std::unique_ptr< Cloneable >	move ()

Private Member Functions
virtual Cloneable *	_clone () const =0

virtual Cloneable *	_move ()=0

Private Attributes
int	m_size
	Number of UnitCellCoords in cluster. More...

std::vector< double >	m_disp
	Displacement between each pair of UnitCellCoords, sorted in ascending order. More...

Constructor & Destructor Documentation

◆ ClusterInvariants()

CASM::ClusterInvariants::ClusterInvariants ( IntegralCluster const & cluster )

explicit

Construct and calculate cluster invariants.

Definition at line 11 of file ClusterInvariants.cc.

Member Function Documentation

◆ _clone()

virtual Cloneable* notstd::Cloneable::_clone ( ) const

privatepure virtualinherited

◆ _move()

virtual Cloneable* notstd::Cloneable::_move ( )

privatepure virtualinherited

◆ clone()

std::unique_ptr<Cloneable> notstd::Cloneable::clone ( ) const

inlineinherited

Definition at line 92 of file cloneable_ptr.hh.

◆ displacement()

const std::vector< double > & CASM::ClusterInvariants::displacement ( ) const

const Access displacements between coordinates in the cluster, sorted in ascending order

Definition at line 31 of file ClusterInvariants.cc.

◆ move()

std::unique_ptr<Cloneable> notstd::Cloneable::move ( )

inlineinherited

Definition at line 95 of file cloneable_ptr.hh.

◆ size()

int CASM::ClusterInvariants::size ( ) const

Number of elements in the cluster.

Definition at line 27 of file ClusterInvariants.cc.

Member Data Documentation

◆ m_disp

std::vector<double> CASM::ClusterInvariants::m_disp

private

Displacement between each pair of UnitCellCoords, sorted in ascending order.

Definition at line 48 of file ClusterInvariants.hh.

◆ m_size

int CASM::ClusterInvariants::m_size