axom::sidre Namespace Reference

Namespaces
	detail
	internal

Classes
class	Array
	Provides a generic multi-component array, contained in Sidre. More...
class	Attribute
	An Attribute holds scalar metadata describing a View. More...
class	AttrValues
class	Buffer
	Buffer is a container that describes and holds data in memory. More...
struct	ConduitMemory
	Object to do Conduit memory operations through Axom. More...
class	DataStore
	DataStore is the main interface for creating and accessing Buffer objects. More...
class	Group
	Group holds a collection of Views and (child) Groups. More...
class	View
	A View object describes data, which may be owned by the view object (e.g., via an attached Buffer) or owned externally. More...
class	IOBaton
	IOBaton ensures that during I/O operations, only one rank will interact with a particular file at one time. More...
class	IOManager
	IOManager manages and organizes the I/O operations. More...

Typedefs
template<typename T >
using	MCArray = Array< T, 2 >
	Helper alias for multi-component arrays. More...
using	Node = conduit::Node
	The Node class is the primary object in Conduit. More...
using	DataType = conduit::DataType
	DataType is a general Conduit descriptor. More...
using	Schema = conduit::Schema
	A Conduit Schema describes the data in a Node. More...
using	IndexType = axom::IndexType
	IndexType is used for any labeling of a sidre object by an integer identifier. More...
using	TypeID = DataTypeId
	TypeID is used to identify the type of a buffer (SIDRE_INT8_ID, etc). More...

Enumerations
enum	DataTypeId {   NO_TYPE_ID = CONDUIT_EMPTY_ID , INT8_ID = CONDUIT_INT8_ID , INT16_ID = CONDUIT_INT16_ID , INT32_ID = CONDUIT_INT32_ID ,   INT64_ID = CONDUIT_INT64_ID , UINT8_ID = CONDUIT_UINT8_ID , UINT16_ID = CONDUIT_UINT16_ID , UINT32_ID = CONDUIT_UINT32_ID ,   UINT64_ID = CONDUIT_UINT64_ID , FLOAT32_ID = CONDUIT_FLOAT32_ID , FLOAT64_ID = CONDUIT_FLOAT64_ID , CHAR8_STR_ID = CONDUIT_CHAR8_STR_ID ,   INT_ID = CONDUIT_NATIVE_INT_ID , UINT_ID = CONDUIT_NATIVE_UNSIGNED_INT_ID , LONG_ID = CONDUIT_NATIVE_LONG_ID , ULONG_ID = CONDUIT_NATIVE_UNSIGNED_LONG_ID ,   FLOAT_ID = CONDUIT_NATIVE_FLOAT_ID , DOUBLE_ID = CONDUIT_NATIVE_DOUBLE_ID }
	Enum that holds the numeric data type id options for sidre types. More...

Functions
bool	indexIsValid (IndexType idx)
	Returns true if idx is valid, else false. More...
bool	nameIsValid (const std::string &name)
	Returns true if name is valid, else false. More...
constexpr int	getInvalidAllocatorID () noexcept
	Return Axom's identifier for an invalid allocator. More...
constexpr int	getMallocAllocatorID () noexcept
	Return Axom's identifier for the malloc allocator. More...
TypeID	getTypeID (const int typeID)
	Convenience function to convert int to TypeID type. More...

Variables
constexpr IndexType	InvalidIndex = axom::InvalidIndex
	Common invalid index identifier used in sidre. More...
const std::string	InvalidName = axom::utilities::string::InvalidName
	Common invalid name string usde in sidre. More...

Typedef Documentation

MCArray

template<typename T >

using axom::sidre::MCArray = typedef Array<T, 2>

Helper alias for multi-component arrays.

Node

using axom::sidre::Node = typedef conduit::Node

The Node class is the primary object in Conduit.

DataType

using axom::sidre::DataType = typedef conduit::DataType

DataType is a general Conduit descriptor.

Schema

using axom::sidre::Schema = typedef conduit::Schema

A Conduit Schema describes the data in a Node.

IndexType

using axom::sidre::IndexType = typedef axom::IndexType

IndexType is used for any labeling of a sidre object by an integer identifier.

TypeID

using axom::sidre::TypeID = typedef DataTypeId

TypeID is used to identify the type of a buffer (SIDRE_INT8_ID, etc).

Enumeration Type Documentation

DataTypeId

enum axom::sidre::DataTypeId

Enum that holds the numeric data type id options for sidre types.

Enumerator
NO_TYPE_ID
INT8_ID
INT16_ID
INT32_ID
INT64_ID
UINT8_ID
UINT16_ID
UINT32_ID
UINT64_ID
FLOAT32_ID
FLOAT64_ID
CHAR8_STR_ID
INT_ID
UINT_ID
LONG_ID
ULONG_ID
FLOAT_ID
DOUBLE_ID

Function Documentation

indexIsValid()

bool axom::sidre::indexIsValid ( IndexType  idx )

inline

Returns true if idx is valid, else false.

Used for the loop test when iterating over the Buffers or Attributes in a DataStore or the Views or Groups in a Group.

References InvalidIndex.

nameIsValid()

bool axom::sidre::nameIsValid ( const std::string &  name )

inline

Returns true if name is valid, else false.

References axom::utilities::string::InvalidName.

getInvalidAllocatorID()

constexpr int axom::sidre::getInvalidAllocatorID ( )

inlineconstexprnoexcept

Return Axom's identifier for an invalid allocator.

This returns the value of axom::INVALID_ALLOCATOR_ID.

References axom::INVALID_ALLOCATOR_ID.

getMallocAllocatorID()

constexpr int axom::sidre::getMallocAllocatorID ( )

inlineconstexprnoexcept

Return Axom's identifier for the malloc allocator.

This returns the value of axom::MALLOC_ALLOCATOR_ID.

References axom::MALLOC_ALLOCATOR_ID.

getTypeID()

TypeID axom::sidre::getTypeID ( const int  typeID )

inline

Convenience function to convert int to TypeID type.

Used to convert C defines to C++ enumerations.

Variable Documentation

InvalidIndex

constexpr IndexType axom::sidre::InvalidIndex = axom::InvalidIndex

constexpr

Common invalid index identifier used in sidre.

InvalidName

const std::string axom::sidre::InvalidName = axom::utilities::string::InvalidName

Common invalid name string usde in sidre.