kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
KIM_Numbering.h
Go to the documentation of this file.
1/* */
2/* KIM-API: An API for interatomic models */
3/* Copyright (c) 2013--2022, Regents of the University of Minnesota. */
4/* All rights reserved. */
5/* */
6/* Contributors: */
7/* Ryan S. Elliott */
8/* */
9/* SPDX-License-Identifier: LGPL-2.1-or-later */
10/* */
11/* This library is free software; you can redistribute it and/or */
12/* modify it under the terms of the GNU Lesser General Public */
13/* License as published by the Free Software Foundation; either */
14/* version 2.1 of the License, or (at your option) any later version. */
15/* */
16/* This library is distributed in the hope that it will be useful, */
17/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU */
19/* Lesser General Public License for more details. */
20/* */
21/* You should have received a copy of the GNU Lesser General Public License */
22/* along with this library; if not, write to the Free Software Foundation, */
23/* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */
24/* */
25
26/* */
27/* Release: This file is part of the kim-api-2.3.0 package. */
28/* */
29
30
31#ifndef KIM_NUMBERING_H_
32#define KIM_NUMBERING_H_
33
42{
52};
53#ifndef KIM_NUMBERING_DEFINED_
54#define KIM_NUMBERING_DEFINED_
61#endif
62
72
81
90
99
107char const * KIM_Numbering_ToString(KIM_Numbering const numbering);
108
118
127
136void KIM_NUMBERING_GetNumberOfNumberings(int * const numberOfNumberings);
137
145int KIM_NUMBERING_GetNumbering(int const index,
146 KIM_Numbering * const numbering);
147
148#endif /* KIM_NUMBERING_H_ */
int KIM_Numbering_NotEqual(KIM_Numbering const lhs, KIM_Numbering const rhs)
Compares Numbering objects for inequality.
void KIM_NUMBERING_GetNumberOfNumberings(int *const numberOfNumberings)
Get the number of standard Numbering's defined by the KIM API.
char const * KIM_Numbering_ToString(KIM_Numbering const numbering)
Converts the object to a string.
int KIM_NUMBERING_GetNumbering(int const index, KIM_Numbering *const numbering)
Get the identity of each defined standard Numbering.
KIM_Numbering const KIM_NUMBERING_oneBased
The standard oneBased numbering.
int KIM_Numbering_Known(KIM_Numbering const numbering)
Determines if the object is a quantity known to the KIM API.
KIM_Numbering const KIM_NUMBERING_zeroBased
The standard zeroBased numbering.
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 t...
int KIM_Numbering_Equal(KIM_Numbering const lhs, KIM_Numbering const rhs)
Compares Numbering objects for equality.
An Extensible Enumeration for the Numbering's supported by the KIM API.
Definition: KIM_Numbering.h:42
int numberingID
Integer identifying the specific Numbering represented.
Definition: KIM_Numbering.h:51