Chemical Data Processing Library C++ API - Version 1.1.1
Public Types | Public Member Functions | List of all members
CDPL::Grid::RegularGrid< T, CVT > Class Template Reference

RegularGrid. More...

#include <RegularGrid.hpp>

Public Types

typedef std::shared_ptr< RegularGridSharedPointer
 
typedef SpatialGrid< T, CVT >::ValueType ValueType
 
typedef SpatialGrid< T, CVT >::CoordinatesValueType CoordinatesValueType
 
typedef SpatialGrid< T, CVT >::CoordinatesType CoordinatesType
 
typedef Math::RegularSpatialGrid< T, CVT >::GridDataType GridDataType
 

Public Member Functions

 RegularGrid (const CoordinatesValueType &xs, const CoordinatesValueType &ys, const CoordinatesValueType &zs)
 
 RegularGrid (const GridDataType &data, const CoordinatesValueType &xs, const CoordinatesValueType &ys, const CoordinatesValueType &zs)
 
 RegularGrid (const CoordinatesValueType &s)
 
 RegularGrid (const GridDataType &data, const CoordinatesValueType &s)
 
ValueTypeoperator() (std::size_t i)
 
const ValueTypeoperator() (std::size_t i) const
 
std::size_t getNumElements () const
 
void getCoordinates (std::size_t i, CoordinatesType &coords) const
 
bool isEmpty () const
 

Detailed Description

template<typename T, typename CVT = T>
class CDPL::Grid::RegularGrid< T, CVT >

RegularGrid.

Member Typedef Documentation

◆ SharedPointer

template<typename T , typename CVT = T>
typedef std::shared_ptr<RegularGrid> CDPL::Grid::RegularGrid< T, CVT >::SharedPointer

◆ ValueType

template<typename T , typename CVT = T>
typedef SpatialGrid<T, CVT>::ValueType CDPL::Grid::RegularGrid< T, CVT >::ValueType

◆ CoordinatesValueType

template<typename T , typename CVT = T>
typedef SpatialGrid<T, CVT>::CoordinatesValueType CDPL::Grid::RegularGrid< T, CVT >::CoordinatesValueType

◆ CoordinatesType

template<typename T , typename CVT = T>
typedef SpatialGrid<T, CVT>::CoordinatesType CDPL::Grid::RegularGrid< T, CVT >::CoordinatesType

◆ GridDataType

template<typename T , typename CVT = T>
typedef Math::RegularSpatialGrid<T, CVT>::GridDataType CDPL::Grid::RegularGrid< T, CVT >::GridDataType

Constructor & Destructor Documentation

◆ RegularGrid() [1/4]

template<typename T , typename CVT = T>
CDPL::Grid::RegularGrid< T, CVT >::RegularGrid ( const CoordinatesValueType xs,
const CoordinatesValueType ys,
const CoordinatesValueType zs 
)
inline

◆ RegularGrid() [2/4]

template<typename T , typename CVT = T>
CDPL::Grid::RegularGrid< T, CVT >::RegularGrid ( const GridDataType data,
const CoordinatesValueType xs,
const CoordinatesValueType ys,
const CoordinatesValueType zs 
)
inline

◆ RegularGrid() [3/4]

template<typename T , typename CVT = T>
CDPL::Grid::RegularGrid< T, CVT >::RegularGrid ( const CoordinatesValueType s)
inlineexplicit

◆ RegularGrid() [4/4]

template<typename T , typename CVT = T>
CDPL::Grid::RegularGrid< T, CVT >::RegularGrid ( const GridDataType data,
const CoordinatesValueType s 
)
inline

Member Function Documentation

◆ operator()() [1/2]

template<typename T , typename CVT = T>
ValueType& CDPL::Grid::RegularGrid< T, CVT >::operator() ( std::size_t  i)
inline

◆ operator()() [2/2]

template<typename T , typename CVT = T>
const ValueType& CDPL::Grid::RegularGrid< T, CVT >::operator() ( std::size_t  i) const
inline

◆ getNumElements()

template<typename T , typename CVT = T>
std::size_t CDPL::Grid::RegularGrid< T, CVT >::getNumElements ( ) const
inline

◆ getCoordinates()

template<typename T , typename CVT = T>
void CDPL::Grid::RegularGrid< T, CVT >::getCoordinates ( std::size_t  i,
CoordinatesType coords 
) const
inline

◆ isEmpty()

template<typename T , typename CVT = T>
bool CDPL::Grid::RegularGrid< T, CVT >::isEmpty ( ) const
inline

The documentation for this class was generated from the following files: