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_DataType.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_DATA_TYPE_H_
32#define KIM_DATA_TYPE_H_
33
42{
52};
53#ifndef KIM_DATA_TYPE_DEFINED_
54#define KIM_DATA_TYPE_DEFINED_
61#endif
62
71KIM_DataType KIM_DataType_FromString(char const * const str);
72
80int KIM_DataType_Known(KIM_DataType const dataType);
81
90
99
107char const * KIM_DataType_ToString(KIM_DataType const dataType);
108
109
118
127
136void KIM_DATA_TYPE_GetNumberOfDataTypes(int * const numberOfDataTypes);
137
145int KIM_DATA_TYPE_GetDataType(int const index, KIM_DataType * const dataType);
146
147#endif /* KIM_DATA_TYPE_H_ */
int KIM_DataType_NotEqual(KIM_DataType const lhs, KIM_DataType const rhs)
Compares DataType objects for inequality.
int KIM_DATA_TYPE_GetDataType(int const index, KIM_DataType *const dataType)
Get the identity of each defined standard DataType.
int KIM_DataType_Equal(KIM_DataType const lhs, KIM_DataType const rhs)
Compares DataType objects for equality.
KIM_DataType KIM_DataType_FromString(char const *const str)
Create a DataType object corresponding to the provided string. If the string does not match one of th...
KIM_DataType const KIM_DATA_TYPE_Integer
The standard Integer data type.
char const * KIM_DataType_ToString(KIM_DataType const dataType)
Converts the object to a string.
KIM_DataType const KIM_DATA_TYPE_Double
The standard Double data type.
int KIM_DataType_Known(KIM_DataType const dataType)
Determines if the object is a quantity known to the KIM API.
void KIM_DATA_TYPE_GetNumberOfDataTypes(int *const numberOfDataTypes)
Get the number of standard DataType's defined by the KIM API.
An Extensible Enumeration for the DataType's supported by the KIM API.
Definition: KIM_DataType.h:42
int dataTypeID
Integer identifying the specific DataType represented.
Definition: KIM_DataType.h:51