Generic container storing a cartesian point of dimension N. More...
#include <cartesian_point.hpp>
Public Member Functions | |
CartesianPoint (const T &value=T()) | |
Default constructor - sets all elements to the same value. | |
CartesianPoint (const ecl::linear_algebra::Matrix< T, N, 1 > &point_vector) | |
Initialises with the specified eigen style vector. | |
ecl::linear_algebra::CommaInitializer < ecl::linear_algebra::Matrix < T, N, 1 > > | operator<< (const T &value) |
T & | operator[] (const unsigned int &index) ecl_assert_throw_decl(StandardException) |
Array like accessor. | |
const T & | operator[] (const unsigned int &index) const ecl_assert_throw_decl(StandardException) |
Const array like accessor. | |
ecl::linear_algebra::Matrix< T, N, 1 > & | positionVector () |
Representation of the position vector in eigen vector format. | |
const ecl::linear_algebra::Matrix< T, N, 1 > & | positionVector () const |
Representation of the position vector in const eigen vector format. | |
Private Attributes | |
ecl::linear_algebra::Matrix< T, N, 1 > | elements |
Generic container storing a cartesian point of dimension N.
This simply stores a cartesian point as a vector of dimension N.
T | : the underlying element type. |
N | : the dimension. |
Definition at line 46 of file cartesian_point.hpp.
ecl::CartesianPoint< T, N >::CartesianPoint | ( | const T & | value = T() | ) | [inline] |
Default constructor - sets all elements to the same value.
Definition at line 51 of file cartesian_point.hpp.
ecl::CartesianPoint< T, N >::CartesianPoint | ( | const ecl::linear_algebra::Matrix< T, N, 1 > & | point_vector | ) | [inline] |
Initialises with the specified eigen style vector.
point_vector | : input eigen style vector. |
Definition at line 57 of file cartesian_point.hpp.
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; // At this point it is initialised with default values.
point << 1.0,2.0,3.0;
value | : the first of three points to enter. |
Definition at line 75 of file cartesian_point.hpp.
T& ecl::CartesianPoint< T, N >::operator[] | ( | const unsigned int & | index | ) | [inline] |
Array like accessor.
index | : idnex of the element to access. |
StandardException | : throws if the index is outside of the array range [debug mode only]. |
Definition at line 86 of file cartesian_point.hpp.
const T& ecl::CartesianPoint< T, N >::operator[] | ( | const unsigned int & | index | ) | const [inline] |
Const array like accessor.
index | : idnex of the element to access. |
StandardException | : throws if the index is outside of the array range [debug mode only]. |
Definition at line 98 of file cartesian_point.hpp.
ecl::linear_algebra::Matrix<T,N,1>& ecl::CartesianPoint< T, N >::positionVector | ( | ) | [inline] |
Representation of the position vector in eigen vector format.
Converts representation to an eigen vector reference - oft necessary in mathematics calculations.
Definition at line 113 of file cartesian_point.hpp.
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.
Definition at line 121 of file cartesian_point.hpp.
ecl::linear_algebra::Matrix<T,N,1> ecl::CartesianPoint< T, N >::elements [private] |
Definition at line 126 of file cartesian_point.hpp.