kim-api
2.3.0+v2.3.0.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Contains the enumeration constants and the discovery routines for the Numbering Extensible Enumeration. More...
Classes | |
struct | Comparator |
Structure provided for use with std::map. More... | |
Functions | |
void | GetNumberOfNumberings (int *const numberOfNumberings) |
Get the number of standard Numbering's defined by the KIM API. More... | |
int | GetNumbering (int const index, Numbering *const numbering) |
Get the identity of each defined standard Numbering. More... | |
Variables | |
Numbering const | zeroBased |
The standard zeroBased numbering. More... | |
Numbering const | oneBased |
The standard oneBased numbering. More... | |
Contains the enumeration constants and the discovery routines for the Numbering Extensible Enumeration.
int KIM::NUMBERING::GetNumbering | ( | int const | index, |
Numbering *const | numbering | ||
) |
Get the identity of each defined standard Numbering.
[in] | index | Zero-based index uniquely labeling each defined standard Numbering. This index ordering is only guaranteed to be stable during the lifetime of the current process. |
[out] | numbering | The Numbering object associated with index . |
true
if index < 0
or index >= numberOfNumberings
. false
otherwise.void KIM::NUMBERING::GetNumberOfNumberings | ( | int *const | numberOfNumberings | ) |
Numbering const KIM::NUMBERING::oneBased |
The standard oneBased
numbering.
Quantities are numbered starting from one.
Numbering const KIM::NUMBERING::zeroBased |
The standard zeroBased
numbering.
Quantities are numbered starting from zero.