KIM_Numbering.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	KIM_Numbering
	An Extensible Enumeration for the Numbering's supported by the KIM API. More...

Typedefs
typedef struct KIM_Numbering	KIM_Numbering
	Forward declaration. More...

Functions
KIM_Numbering	KIM_Numbering_FromString (char const *const str)
	Create a Numbering object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More...
int	KIM_Numbering_Known (KIM_Numbering const numbering)
	Determines if the object is a quantity known to the KIM API. More...
int	KIM_Numbering_Equal (KIM_Numbering const lhs, KIM_Numbering const rhs)
	Compares Numbering objects for equality. More...
int	KIM_Numbering_NotEqual (KIM_Numbering const lhs, KIM_Numbering const rhs)
	Compares Numbering objects for inequality. More...
char const *	KIM_Numbering_ToString (KIM_Numbering const numbering)
	Converts the object to a string. More...
void	KIM_NUMBERING_GetNumberOfNumberings (int *const numberOfNumberings)
	Get the number of standard Numbering's defined by the KIM API. More...
int	KIM_NUMBERING_GetNumbering (int const index, KIM_Numbering *const numbering)
	Get the identity of each defined standard Numbering. More...

Variables
KIM_Numbering const	KIM_NUMBERING_zeroBased
	The standard zeroBased numbering. More...
KIM_Numbering const	KIM_NUMBERING_oneBased
	The standard oneBased numbering. More...

Typedef Documentation

KIM_Numbering

typedef struct KIM_Numbering KIM_Numbering

Forward declaration.

Since

2.0

Definition at line 60 of file KIM_Numbering.h.

Function Documentation

KIM_Numbering_Equal()

int KIM_Numbering_Equal	(	KIM_Numbering const	lhs,
		KIM_Numbering const	rhs
	)

Compares Numbering objects for equality.

See also

KIM::Numbering::operator==(), kim_numbering_module::operator(.eq.)

Since

2.0

KIM_Numbering_FromString()

KIM_Numbering KIM_Numbering_FromString

(

char const *const

str

)

Create a Numbering object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.

See also

KIM::Numbering::Numbering(std::string const &), kim_numbering_module::kim_from_string

Since

2.0

KIM_NUMBERING_GetNumbering()

int KIM_NUMBERING_GetNumbering	(	int const	index,
		KIM_Numbering *const	numbering
	)

Get the identity of each defined standard Numbering.

See also

KIM::NUMBERING::GetNumbering, kim_numbering_module::kim_get_numbering

Since

2.0

KIM_NUMBERING_GetNumberOfNumberings()

void KIM_NUMBERING_GetNumberOfNumberings

(

int *const

numberOfNumberings

)

Get the 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

KIM_Numbering_Known()

int KIM_Numbering_Known

(

KIM_Numbering const

numbering

)

Determines if the object is a quantity known to the KIM API.

See also

KIM::Numbering::Known, kim_numbering_module::kim_known

Since

2.0

KIM_Numbering_NotEqual()

int KIM_Numbering_NotEqual	(	KIM_Numbering const	lhs,
		KIM_Numbering const	rhs
	)

Compares Numbering objects for inequality.

See also

KIM::Numbering::operator!=(), kim_numbering_module::operator(.ne.)

Since

2.0

KIM_Numbering_ToString()

char const* KIM_Numbering_ToString

(

KIM_Numbering const

numbering

)

Converts the object to a string.

See also

KIM::Numbering::ToString, kim_numbering_module::kim_to_string

Since

2.0

Variable Documentation

KIM_NUMBERING_oneBased

KIM_Numbering const KIM_NUMBERING_oneBased

The standard oneBased numbering.

See also

KIM::NUMBERING::oneBased, kim_numbering_module::kim_numbering_one_based

Since

2.0

KIM_NUMBERING_zeroBased

KIM_Numbering const KIM_NUMBERING_zeroBased

The standard zeroBased numbering.

See also

KIM::NUMBERING::zeroBased, kim_numbering_module::kim_numbering_zero_based

Since

2.0