#include <ArraySampledFunctional.h>
Public Member Functions | |
| ArraySampledFunctional () | |
| These constructors copy the array that is passed to them. More... | |
| ArraySampledFunctional (const T &data) | |
| ArraySampledFunctional (ArraySampledFunctional< T > &other) | |
| The standard copy constructor and assignment operator. More... | |
| ArraySampledFunctional< T > & | operator= (ArraySampledFunctional< T > &other) |
| virtual T | operator() (const uInt &index) const |
| Define the functions for the SampledFunction interface. More... | |
| virtual uInt | nelements () const |
| Return the total size of the data set. More... | |
| virtual | ~ArraySampledFunctional () |
| const T | operator() (const uInt &index) |
| An alternate version of the sampling function which is more effecient because it does not need to create as many temporary objects or copy the Array data. More... | |
 Public Member Functions inherited from casacore::SampledFunctional< T > | |
| virtual | ~SampledFunctional () |
| The virtual destructor does nothing. More... | |
| Public Member Functions inherited from casacore::Functional< Domain, Range > | |
| virtual | ~Functional () |
| Destructor. More... | |
| virtual Range | operator() (const Domain &x) const =0 |
Map a Domain x into a Range y value. More... | |
Private Attributes | |
| T | theRefData |
| IPosition | theEnd |
| uInt | theLastAxis |
| uInt | theNelements |
Detailed Description
template<class T>
class casacore::ArraySampledFunctional< T >
Index into an array using the longest axis
Intended use:
Public interface
Review Status
- Reviewed By:
- wyoung
- Date Reviewed:
- 1996/10/19
- Test programs:
- tSampledFunctional
Prerequisite
Etymology
A SampledFunctional is an interface that allows random access to a fixed size data set. An ArraySampledFunctional allows you to access slices of an an Array<T> object.
Synopsis
An ArraySampledFunctional allows an Array<T> object to be sliced up with each sample being one slice of the original Array. The slices are always the same size and the indexing is always done along the last non-degenerate dimension. For example a(4,3,20,1) is interpreted as a SampledFunctional with 20 elements, each one being a 4 by 3 matrix.
The Array that is passed to the constructor is copied by this class but because Arrays themselves use reference symantics, the actual data is not copied but referenced. This means that modifying the data in the original array will correspondingly modify the data accessed by this class.
Similarly the Array that is returned for each Slice is a reference to the actual data so that modifying this array really modifies the original data. This is not recommended as the operator() function is not supposed to be used to get a modifiable portion of the data.
Example
Constructing and using ArraySampledFunctionals
Motivation
I needed a SampledFunctional which could return Arrays of arbitrary (but fixed) size for each index. This could be done using a ScalarSampledFunctional<Array<T> > but is ineffecient as each element is stored as a separate Array. This class is a more efficient way to solve this problem.
Template Type Argument Requirements (T)
- The template type MUST be an Array of some arbitrary type. This is because this class will return a slice of this Array. The Array template type cannot be subsumed into the class definition because the definition of the inherited operator() function means that the return type must be the template type
Thrown Exceptions
- Exceptions are not thrown directly by this class.
To Do
- Nothing I can think of.
Definition at line 112 of file ArraySampledFunctional.h.
Constructor & Destructor Documentation
◆ ArraySampledFunctional() [1/3]
| casacore::ArraySampledFunctional< T >::ArraySampledFunctional | ( | ) |
These constructors copy the array that is passed to them.
But because arrays use reference symantics the data is not copied. The default constructor is basically useless, as there is no way to add the data once the class has been constructed.
◆ ArraySampledFunctional() [2/3]
| casacore::ArraySampledFunctional< T >::ArraySampledFunctional | ( | const T & | data | ) |
◆ ArraySampledFunctional() [3/3]
| casacore::ArraySampledFunctional< T >::ArraySampledFunctional | ( | ArraySampledFunctional< T > & | other | ) |
The standard copy constructor and assignment operator.
◆ ~ArraySampledFunctional()
|
virtual |
Member Function Documentation
◆ nelements()
|
virtual |
Return the total size of the data set.
Implements casacore::SampledFunctional< T >.
◆ operator()() [1/2]
| const T casacore::ArraySampledFunctional< T >::operator() | ( | const uInt & | index | ) |
An alternate version of the sampling function which is more effecient because it does not need to create as many temporary objects or copy the Array data.
◆ operator()() [2/2]
|
virtual |
Define the functions for the SampledFunction interface.
Implements casacore::SampledFunctional< T >.
◆ operator=()
| ArraySampledFunctional<T>& casacore::ArraySampledFunctional< T >::operator= | ( | ArraySampledFunctional< T > & | other | ) |
Member Data Documentation
◆ theEnd
|
private |
Definition at line 147 of file ArraySampledFunctional.h.
◆ theLastAxis
|
private |
Definition at line 148 of file ArraySampledFunctional.h.
◆ theNelements
|
private |
Definition at line 149 of file ArraySampledFunctional.h.
◆ theRefData
|
private |
Definition at line 146 of file ArraySampledFunctional.h.
The documentation for this class was generated from the following file:
- scimath/Functionals/ArraySampledFunctional.h
