Clusterography

Detailed Description

Functions and classes related to clusters.

Modules
	ClusterOrbits
	Functions and classes for IntegralCluster orbits of any type.
	ClusterSpecs
	ClusterSpecs Generate IntegralCluster orbits of specific types.
	ClusterSymCompare
	Functions and classes for creating cluster SymCompare functors for orbit generation .
	IntegralCluster
	Functions and classes related to IntegralCluster.
	IntegralClusterOrbits
	Traits and functions for specific types of IntegralCluster orbits.

Classes
class	CASM::ClusterInvariants
	Stores cluster invariants: number of sites and site distances. More...
class	CASM::WithinScelClusterInvariants
	Stores cluster invariants: number of sites and site distances (using robust_min_dist) More...
class	CASM::ClusterSymCompare< Base >
	CRTP Base class for common cluster symmetry and comparison implementations. More...
class	CASM::AperiodicSymCompare< Element >
	Comparisons of clusters using aperiodic symmetry. More...
class	CASM::PrimPeriodicSymCompare< Element >
	Comparisons of clusters using prim periodic symmetry. More...
class	CASM::ScelPeriodicSymCompare< Element >
	Comparisons of clusters using supercell periodic symmetry, but without periodic images. More...
class	CASM::GenericCluster< Base >
	A CRTP base class for a cluster of anything. More...
class	CASM::Orbit< _SymCompareType >
	An Orbit of Element. More...

Functions
template<typename OrbitIterator >
std::pair< OrbitIterator, OrbitIterator >	CASM::orbit_branch (OrbitIterator begin, OrbitIterator end, Index size)
	Returns the first range containing orbits of the requested orbit branch in the given range of Orbit. More...

Function Documentation

orbit_branch()

template<typename OrbitIterator >

std::pair< OrbitIterator, OrbitIterator > CASM::orbit_branch	(	OrbitIterator	begin,
		OrbitIterator	end,
		Index	size
	)

Returns the first range containing orbits of the requested orbit branch in the given range of Orbit.

Definition at line 282 of file ClusterOrbits_impl.hh.