kim-api 2.4.1+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
 
Loading...
Searching...
No Matches
KIM_DataType.hpp
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.4.1 package.
28//
29
30
31#ifndef KIM_DATA_TYPE_HPP_
32#define KIM_DATA_TYPE_HPP_
33
34#include <string>
35
36namespace KIM
37{
47{
48 public:
59
64
70 DataType(int const id);
71
79 DataType(std::string const & str);
80
88 bool Known() const;
89
97 bool operator==(DataType const & rhs) const;
98
106 bool operator!=(DataType const & rhs) const;
107
118 std::string const & ToString() const;
119}; // class DataType
120
123namespace DATA_TYPE
124{
132extern DataType const Integer;
133
141extern DataType const Double;
142
143
154void GetNumberOfDataTypes(int * const numberOfDataTypes);
155
169int GetDataType(int const index, DataType * const dataType);
170
175{
180 bool operator()(DataType const & a, DataType const & b) const
181 {
182 return a.dataTypeID < b.dataTypeID;
183 }
184}; // struct Comparator
185} // namespace DATA_TYPE
186} // namespace KIM
187
188#endif // KIM_DATA_TYPE_HPP_
An Extensible Enumeration for the DataType's supported by the KIM API.
DataType()
Create an uninitialized DataType object.
bool Known() const
Determines if the object is a quantity known to the KIM API.
DataType(int const id)
Create a DataType object with the specified id.
bool operator!=(DataType const &rhs) const
Compares DataType objects for inequality.
std::string const & ToString() const
Converts the object to a string.
int dataTypeID
Integer identifying the specific DataType represented.
bool operator==(DataType const &rhs) const
Compares DataType objects for equality.
DataType(std::string const &str)
Create a DataType object corresponding to the provided string. If the string does not match one of th...
Contains the enumeration constants and the discovery routines for the DataType Extensible Enumeration...
DataType const Integer
The standard Integer data type.
int GetDataType(int const index, DataType *const dataType)
Get the identity of each defined standard DataType.
void GetNumberOfDataTypes(int *const numberOfDataTypes)
Get the number of standard DataType's defined by the KIM API.
DataType const Double
The standard Double data type.
Structure provided for use with std::map.
bool operator()(DataType const &a, DataType const &b) const
Provides an (logically unmeaningful) ordering for DataType objects so that they can be stored in a st...