#include <ConfigEnumRandomOccupations.hh>
Enumerate n random occupations in a particular Supercell.
Definition at line 26 of file ConfigEnumRandomOccupations.hh.
CASM::ConfigEnumRandomOccupations::ConfigEnumRandomOccupations |
( |
Supercell & |
_scel, |
|
|
Index |
_n_config, |
|
|
MTRand & |
_mtrand |
|
) |
| |
Construct with a Supercell, using all permutations.
Constructor.
- Parameters
-
_initial,_final | Initial and final configurations to interpolate between |
_size | The total number of configurations to enumerate, including the initial and final configurations |
- The
final
configuration is not pointed at by the end iterator, which points past-the-final element, as is typical
_size
will be equal tostd::distance(this->
begin(), this->
end())
Definition at line 103 of file ConfigEnumRandomOccupations.cc.
Access the current ObjectType by reference.
Definition at line 244 of file Enumerator.hh.
void CASM::EnumeratorBase::_decrement_step |
( |
| ) |
|
|
inlineprotectedinherited |
void CASM::EnumeratorBase::_increment_step |
( |
| ) |
|
|
inlineprotectedinherited |
void CASM::EnumeratorBase::_initialize |
( |
| ) |
|
|
inlineprotectedinherited |
Initialize
- Sets step to 0
- Sets valid to true
Definition at line 148 of file Enumerator.hh.
Initialize
- Sets current to point at _initial
- Sets step to 0
- Sets valid to true
Definition at line 216 of file Enumerator.hh.
void CASM::EnumeratorBase::_invalidate |
( |
| ) |
|
|
inlineprotectedinherited |
void CASM::EnumeratorBase::_set_step |
( |
step_type |
val | ) |
|
|
inlineprotectedinherited |
void CASM::EnumeratorBase::_validate |
( |
| ) |
|
|
inlineprotectedinherited |
Used if random access enumerator step is moved into valid range.
Definition at line 174 of file Enumerator.hh.
Access the current ObjectType by reference.
Definition at line 232 of file Enumerator.hh.
void CASM::ConfigEnumRandomOccupations::increment |
( |
| ) |
|
|
overrideprivatevirtual |
std::string CASM::ConfigEnumRandomOccupations::name |
( |
| ) |
const |
|
inlineoverridevirtual |
void CASM::ConfigEnumRandomOccupations::randomize |
( |
| ) |
|
|
private |
Default Object source just uses step#
Returns:
{
"enumerated_by": "<enumerator_type>",
}
Definition at line 131 of file Enumerator.hh.
step_type CASM::EnumeratorBase::step |
( |
| ) |
const |
|
inlineinherited |
Increments with each enumerated object.
Definition at line 113 of file Enumerator.hh.
bool CASM::EnumeratorBase::valid |
( |
| ) |
const |
|
inlineinherited |
Returns false if enumeration is complete.
Definition at line 118 of file Enumerator.hh.
const std::string CASM::ConfigEnumRandomOccupations::enumerator_name = "ConfigEnumRandomOccupations" |
|
static |
const std::string CASM::ConfigEnumRandomOccupations::interface_help |
|
static |
Array<int> CASM::ConfigEnumRandomOccupations::m_max_allowed |
|
private |
MTRand* CASM::ConfigEnumRandomOccupations::m_mtrand |
|
private |
Index CASM::ConfigEnumRandomOccupations::m_n_config |
|
private |
The documentation for this class was generated from the following files: