Abstract base class to all WValueSets.
More...
#include <WValueSetBase.h>
List of all members.
Protected Attributes |
const size_t | m_order |
| The order of the tensors for this ValueSet.
|
const size_t | m_dimension |
| The dimension of the tensors for this ValueSet.
|
const dataType | m_dataType |
| The data type of the values' elements.
|
Private Member Functions |
virtual WValueSetVariant const | getVariant () const |
| Creates a boost::variant reference.
|
Detailed Description
Abstract base class to all WValueSets.
This class doesn't provide any genericness.
Definition at line 57 of file WValueSetBase.h.
Constructor & Destructor Documentation
WValueSetBase::WValueSetBase |
( |
size_t |
order, |
|
|
size_t |
dimension, |
|
|
dataType |
inDataType |
|
) |
| |
Despite this is an abstract class all subclasses should have an order and dimension.
- Parameters:
-
order | the tensor order of the values stored in this WValueSet |
dimension | the tensor dimension of the values stored in this WValueSet |
inDataType | indication of the primitive data type used to store the values |
Definition at line 31 of file WValueSetBase.cpp.
WValueSetBase::~WValueSetBase |
( |
| ) |
|
|
pure virtual |
Member Function Documentation
template<typename Func_T >
Func_T::result_type WValueSetBase::applyFunction |
( |
Func_T const & |
func | ) |
|
|
inline |
Apply a function object to this valueset.
- Template Parameters:
-
Func_T | The type of the function object, should be derived from the boost::static_visitor template. |
- Parameters:
-
func | The function object to apply. |
- Returns:
- The result of the operation.
Definition at line 162 of file WValueSetBase.h.
virtual size_t WValueSetBase::dimension |
( |
| ) |
const |
|
inlinevirtual |
virtual size_t WValueSetBase::elementsPerValue |
( |
| ) |
const |
|
inlinevirtual |
Returns the number of elements of type T per value.
- Notes:
- this is dimension to the power of order.
- Returns:
- number of elements per value
Definition at line 123 of file WValueSetBase.h.
virtual dataType WValueSetBase::getDataType |
( |
| ) |
const |
|
inlinevirtual |
virtual double WValueSetBase::getMaximumValue |
( |
| ) |
const |
|
pure virtual |
This method returns the largest value in the valueset.
It does not handle vectors, matrices and so on well. It simply returns the largest value in the data array. This is especially useful for texture scaling or other statistic tools (histograms).
- Returns:
- the largest value in the data.
Implemented in WValueSet< T >, and Dummy.
virtual double WValueSetBase::getMinimumValue |
( |
| ) |
const |
|
pure virtual |
This method returns the smallest value in the valueset.
It does not handle vectors, matrices and so on well. It simply returns the smallest value in the data array. This is especially useful for texture scaling or other statistic tools (histograms).
- Returns:
- the smallest value in the data.
Implemented in WValueSet< T >, and Dummy.
virtual double WValueSetBase::getScalarDouble |
( |
size_t |
i | ) |
const |
|
pure virtual |
virtual WValueSetVariant const WValueSetBase::getVariant |
( |
| ) |
const |
|
inlineprivatevirtual |
Creates a boost::variant reference.
- Returns:
- var A pointer to a variant reference to the valueset.
Reimplemented in WValueSet< T >.
Definition at line 189 of file WValueSetBase.h.
virtual WValue< double > WValueSetBase::getWValueDouble |
( |
size_t |
i | ) |
const |
|
pure virtual |
virtual WVector_2 WValueSetBase::getWVector |
( |
size_t |
i | ) |
const |
|
pure virtual |
- Parameters:
-
i | id of the WVector to retrieve |
- Returns:
- The i-th WValue (stored in this value set) as WVector. There are size() such scalars.
Implemented in WValueSet< T >, and Dummy.
virtual size_t WValueSetBase::order |
( |
| ) |
const |
|
inlinevirtual |
- Returns:
- Order of the values in this ValueSet
Definition at line 113 of file WValueSetBase.h.
virtual size_t WValueSetBase::rawSize |
( |
| ) |
const |
|
pure virtual |
- Returns:
- The number of integrals (POD like int, double) in this ValueSet.
Implemented in WValueSet< T >, and Dummy.
virtual size_t WValueSetBase::size |
( |
| ) |
const |
|
pure virtual |
Member Data Documentation
const dataType WValueSetBase::m_dataType |
|
protected |
const size_t WValueSetBase::m_dimension |
|
protected |
const size_t WValueSetBase::m_order |
|
protected |
The documentation for this class was generated from the following files: