Generic container storing a cartesian point of dimension N.
More...
#include <cartesian_point.hpp>
|
ecl::linear_algebra::Matrix< T, N, 1 > | elements |
|
template<typename T, unsigned int N>
class ecl::CartesianPoint< T, N >
Generic container storing a cartesian point of dimension N.
This simply stores a cartesian point as a vector of dimension N.
- Template Parameters
-
T | : the underlying element type. |
N | : the dimension. |
- See also
- CartesianPoint<T,3>, CartesianPoint<T,2>.
Definition at line 46 of file cartesian_point.hpp.
template<typename T , unsigned int N>
Default constructor - sets all elements to the same value.
Definition at line 51 of file cartesian_point.hpp.
template<typename T , unsigned int N>
Initialises with the specified eigen style vector.
- Parameters
-
point_vector | : input eigen style vector. |
Definition at line 57 of file cartesian_point.hpp.
template<typename T , unsigned int N>
ecl::linear_algebra::CommaInitializer< ecl::linear_algebra::Matrix<T,N,1> > ecl::CartesianPoint< T, N >::operator<< |
( |
const T & |
value | ) |
|
|
inline |
Provides a comma initialisation facility. This initiates the comma initialiser with an iterator to the underlying elements and then leaves the initialiser to do the rest.
CartesianPoint<double,3> point;
point << 1.0,2.0,3.0;
- Parameters
-
value | : the first of three points to enter. |
- Returns
- CommaInitialiser : eigen's comma initialiser mechanism.
Definition at line 75 of file cartesian_point.hpp.
template<typename T , unsigned int N>
Array like accessor.
- Parameters
-
index | : idnex of the element to access. |
- Returns
- T& : handle to the underlying element.
- Exceptions
-
StandardException | : throws if the index is outside of the array range [debug mode only]. |
Definition at line 86 of file cartesian_point.hpp.
template<typename T , unsigned int N>
Const array like accessor.
- Parameters
-
index | : idnex of the element to access. |
- Returns
- const T& : handle to the underlying element.
- Exceptions
-
StandardException | : throws if the index is outside of the array range [debug mode only]. |
Definition at line 98 of file cartesian_point.hpp.
template<typename T , unsigned int N>
Representation of the position vector in eigen vector format.
Converts representation to an eigen vector reference - oft necessary in mathematics calculations.
- Returns
- Matrix<T,N,1> : a reference to the underlying storage container.
Definition at line 113 of file cartesian_point.hpp.
template<typename T , unsigned int N>
const ecl::linear_algebra::Matrix<T,N,1>& ecl::CartesianPoint< T, N >::positionVector |
( |
| ) |
const |
|
inline |
Representation of the position vector in const eigen vector format.
Converts representation to a const eigen vector reference - oft necessary in mathematics calculations.
- Returns
- Matrix<T,N,1> : a reference to the underlying storage container.
Definition at line 121 of file cartesian_point.hpp.
template<typename T , unsigned int N>
The documentation for this class was generated from the following file: