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

RegularGrid. More...

#include <RegularGrid.hpp>

+ Inheritance diagram for CDPL::Grid::RegularGrid< T, CVT >:

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 Types inherited from CDPL::Grid::SpatialGrid< T, T >
typedef std::shared_ptr< SpatialGridSharedPointer
 
typedef T ValueType
 
typedef T CoordinatesValueType
 
typedef Math::CVector< T, 3 > CoordinatesType
 
- Public Types inherited from CDPL::Grid::AttributedGrid
typedef std::shared_ptr< AttributedGridSharedPointer
 
- Public Types inherited from CDPL::Base::PropertyContainer
typedef PropertyMap::value_type PropertyEntry
 A Base::LookupKey / Base::Any pair that stores the property value for a given property key. More...
 
typedef PropertyMap::const_iterator ConstPropertyIterator
 A constant iterator used to iterate over the property entries. More...
 
- Public Types inherited from CDPL::Math::RegularSpatialGrid< T, T >
enum  DataMode
 
typedef T ValueType
 
typedef T CoordinatesValueType
 
typedef Grid< T > GridDataType
 
typedef CMatrix< T, 4, 4 > CoordinatesTransformType
 
typedef CoordinatesTransformType::MatrixTemporaryType InvCoordinatesTransformType
 
typedef std::conditional< std::is_const< Grid< T > >::value, typename GD::ConstReference, typename GD::Reference >::type Reference
 
typedef GD::ConstReference ConstReference
 
typedef GD::SizeType SizeType
 
typedef std::ptrdiff_t SSizeType
 
typedef GD::DifferenceType DifferenceType
 
typedef SelfType ClosureType
 
typedef const SelfType ConstClosureType
 
typedef std::shared_ptr< SelfTypeSharedPointer
 
- Public Types inherited from CDPL::Math::GridExpression< E >
typedef E ExpressionType
 
- Public Types inherited from CDPL::Math::Expression< E >
typedef E ExpressionType
 

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
 
- Public Member Functions inherited from CDPL::Grid::SpatialGrid< T, T >
virtual void getCoordinates (std::size_t i, CoordinatesType &coords) const=0
 
- Public Member Functions inherited from CDPL::Grid::AttributedGrid
virtual ~AttributedGrid ()
 
- Public Member Functions inherited from CDPL::Base::PropertyContainer
std::size_t getNumProperties () const
 Returns the number of property entries. More...
 
template<typename T >
void setProperty (const LookupKey &key, T &&val)
 Sets the value of the property specified by key to val. More...
 
template<typename T >
const T & getProperty (const LookupKey &key) const
 Returns the value of the property specified by key as a const reference to an object of type T. More...
 
template<typename T >
const T & getPropertyOrDefault (const LookupKey &key, const T &def_val) const
 Returns the value of the property specified by key as a const reference to an object of type T, or the default value def_val if a stored value does not exist. More...
 
const AnygetProperty (const LookupKey &key, bool throw_=false) const
 Returns the value of the property specified by key. More...
 
bool isPropertySet (const LookupKey &key) const
 Tells whether or not a value has been assigned to the property specified by key. More...
 
ConstPropertyIterator getPropertiesBegin () const
 Returns a constant iterator pointing to the beginning of the property entries. More...
 
ConstPropertyIterator getPropertiesEnd () const
 Returns a constant iterator pointing to the end of the property entries. More...
 
ConstPropertyIterator begin () const
 Returns a constant iterator pointing to the beginning of the property entries. More...
 
ConstPropertyIterator end () const
 Returns a constant iterator pointing to the end of the property entries. More...
 
bool removeProperty (const LookupKey &key)
 Clears the value of the property specified by key. More...
 
void clearProperties ()
 Clears all property values. More...
 
void addProperties (const PropertyContainer &cntnr)
 Adds the property value entries in the PropertyContainer instance cntnr. More...
 
void copyProperties (const PropertyContainer &cntnr)
 Replaces the current set of properties by a copy of the entries in cntnr. More...
 
void swap (PropertyContainer &cntnr)
 Exchanges the properties of this container with the properties of the container cntnr. More...
 
const PropertyContainergetProperties () const
 Returns a const reference to itself. More...
 
- Public Member Functions inherited from CDPL::Math::RegularSpatialGrid< T, T >
 RegularSpatialGrid (const CoordinatesValueType &xs, const CoordinatesValueType &ys, const CoordinatesValueType &zs)
 
 RegularSpatialGrid (const GridDataType &data, const CoordinatesValueType &xs, const CoordinatesValueType &ys, const CoordinatesValueType &zs)
 
 RegularSpatialGrid (const CoordinatesValueType &s)
 
 RegularSpatialGrid (const GridDataType &data, const CoordinatesValueType &s)
 
 RegularSpatialGrid (const RegularSpatialGrid &usg)
 
 RegularSpatialGrid (RegularSpatialGrid &&usg)
 
virtual ~RegularSpatialGrid ()
 
void setDataMode (DataMode mode)
 
DataMode getDataMode () const
 
Reference operator() (SizeType i)
 
ConstReference operator() (SizeType i) const
 
Reference operator() (SizeType i, SizeType j, SizeType k)
 
ConstReference operator() (SizeType i, SizeType j, SizeType k) const
 
SizeType getSize () const
 
SizeType getSize1 () const
 
SizeType getSize2 () const
 
SizeType getSize3 () const
 
SizeType getMaxSize () const
 
SizeType getMaxSize1 () const
 
SizeType getMaxSize2 () const
 
SizeType getMaxSize3 () const
 
CoordinatesValueType getXStepSize () const
 
CoordinatesValueType getYStepSize () const
 
CoordinatesValueType getZStepSize () const
 
void setXStepSize (const CoordinatesValueType &xs)
 
void setYStepSize (const CoordinatesValueType &ys)
 
void setZStepSize (const CoordinatesValueType &zs)
 
CoordinatesValueType getXExtent () const
 
CoordinatesValueType getYExtent () const
 
CoordinatesValueType getZExtent () const
 
void getCoordinates (SizeType i, V &coords) const
 
void getCoordinates (SSizeType i, SSizeType j, SSizeType k, V &coords) const
 
void getLocalCoordinates (SSizeType i, SSizeType j, SSizeType k, V &coords) const
 
void getLocalCoordinates (const V1 &world_coords, V2 &local_coords) const
 
bool containsPoint (const V &pos) const
 
bool containsLocalPoint (const V &pos) const
 
void getContainingCell (const V1 &pos, V2 &indices) const
 
void getLocalContainingCell (const V1 &pos, V2 &indices) const
 
bool isEmpty () const
 
const GridDataTypegetData () const
 
GridDataTypegetData ()
 
const CoordinatesTransformTypegetCoordinatesTransform () const
 
void setCoordinatesTransform (const T1 &xform)
 
RegularSpatialGridoperator= (const RegularSpatialGrid &usg)
 
RegularSpatialGridoperator= (RegularSpatialGrid &&usg)
 
RegularSpatialGridoperator= (const GridExpression< E > &e)
 
RegularSpatialGridoperator+= (const GridExpression< E > &e)
 
RegularSpatialGridoperator-= (const GridExpression< E > &e)
 
std::enable_if< IsScalar< T >::value, RegularSpatialGrid >::type & operator*= (const T1 &t)
 
std::enable_if< IsScalar< T >::value, RegularSpatialGrid >::type & operator/= (const T1 &t)
 
RegularSpatialGridassign (const GridExpression< E > &e)
 
RegularSpatialGridplusAssign (const GridExpression< E > &e)
 
RegularSpatialGridminusAssign (const GridExpression< E > &e)
 
void swap (RegularSpatialGrid &usg)
 
void clear (const ValueType &v=ValueType())
 
void resize (SizeType m, SizeType n, SizeType o, bool preserve=true, const ValueType &v=ValueType())
 
- Public Member Functions inherited from CDPL::Math::GridExpression< E >
const ExpressionTypeoperator() () const
 
ExpressionTypeoperator() ()
 

Additional Inherited Members

- Protected Member Functions inherited from CDPL::Grid::SpatialGrid< T, T >
SpatialGridoperator= (const SpatialGrid &grid)
 
- Protected Member Functions inherited from CDPL::Grid::AttributedGrid
AttributedGridoperator= (const AttributedGrid &grid)
 
- Protected Member Functions inherited from CDPL::Base::PropertyContainer
 PropertyContainer ()
 Constructs an empty PropertyContainer instance. More...
 
 PropertyContainer (const PropertyContainer &cntnr)
 Constructs a copy of the PropertyContainer instance cntnr. More...
 
virtual ~PropertyContainer ()
 Virtual destructor. More...
 
PropertyContaineroperator= (const PropertyContainer &cntnr)
 Assignment operator. More...
 
- Protected Member Functions inherited from CDPL::Math::GridExpression< E >
 GridExpression ()
 
 ~GridExpression ()
 
- Protected Member Functions inherited from CDPL::Math::Expression< E >
 Expression ()
 
 ~Expression ()
 

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)
inlinevirtual

◆ operator()() [2/2]

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

◆ getNumElements()

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

◆ 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
inlinevirtual

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