kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Functions | Variables
KIM::NUMBERING Namespace Reference

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...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the Numbering Extensible Enumeration.

Function Documentation

◆ GetNumbering()

int KIM::NUMBERING::GetNumbering ( int const  index,
Numbering *const  numbering 
)

Get the identity of each defined standard Numbering.

Parameters
[in]indexZero-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]numberingThe Numbering object associated with index.
Returns
true if index < 0 or index >= numberOfNumberings.
false otherwise.
See also
KIM_NUMBERING_GetNumbering, kim_numbering_module::kim_get_numbering
Since
2.0

◆ GetNumberOfNumberings()

void KIM::NUMBERING::GetNumberOfNumberings ( int *const  numberOfNumberings)

Get the number of standard Numbering's defined by the KIM API.

Parameters
[out]numberOfNumberingsThe number of standard Numbering's defined by the KIM API.
See also
KIM_NUMBERING_GetNumberOfNumberings, kim_numbering_module::kim_get_number_of_numberings
Since
2.0

Variable Documentation

◆ oneBased

Numbering const KIM::NUMBERING::oneBased

The standard oneBased numbering.

Quantities are numbered starting from one.

See also
KIM_NUMBERING_oneBased, kim_numbering_module::kim_numbering_one_based
Since
2.0

◆ zeroBased

Numbering const KIM::NUMBERING::zeroBased

The standard zeroBased numbering.

Quantities are numbered starting from zero.

See also
KIM_NUMBERING_zeroBased, kim_numbering_module::kim_numbering_zero_based
Since
2.0