Specialisation for a cartesian point of dimension 3. More...

#include <cartesian_point.hpp>

Public Member Functions
	CartesianPoint (const T &value=T())
	Default constructor - sets all elements to the same value. More...

	CartesianPoint (const ecl::linear_algebra::Matrix< T, 3, 1 > &vec)
	Initialises with the specified eigen style vector. More...

	CartesianPoint (const T &x_i, const T &y_i, const T &z_i)
	Initialises the point with the specified values. More...

ecl::linear_algebra::CommaInitializer< ecl::linear_algebra::Matrix< T, 3, 1 > >	operator<< (const T &value)

ecl::linear_algebra::Matrix< T, 3, 1 > &	positionVector ()
	Representation of the position vector in eigen vector format. More...

const ecl::linear_algebra::Matrix< T, 3, 1 > &	positionVector () const
	Representation of the position vector in const eigen vector format. More...

unsigned int	size ()
	Size/dimension of the cartesian point. More...

const T &	x () const
	Returns a constant reference to the x co-ordinate. More...

T	x ()
	Returns a copy of the x co-ordinate. More...

void	x (const T &value)
	Sets the x-coordinate. More...

const T &	y () const
	Returns a constant reference to the y co-ordinate. More...

T	y ()
	Returns a copy of the y co-ordinate. More...

void	y (const T &value)
	Sets the y-coordinate. More...

const T &	z () const
	Returns a constant reference to the z co-ordinate. More...

T	z ()
	Returns a copy of the z co-ordinate. More...

void	z (const T &value)
	Sets the z-coordinate. More...

virtual	~CartesianPoint ()

Private Attributes
ecl::linear_algebra::Matrix< T, 3, 1 >	elements

Friends
template<typename OutputStream , typename Type >
OutputStream &	operator<< (OutputStream &ostream, const CartesianPoint< Type, 3 > &point)

Detailed Description

template<typename T>
class ecl::CartesianPoint< T, 3 >

Specialisation for a cartesian point of dimension 3.

It introduces handles to x(), y(), z() for convenience, whilst still permitting a vector representation of the underlying storage container via the positionVector() method.

Template Parameters

T	: the underlying element type.

See also: CartesianPoint3d, CartesianPoint3f, CartesianPoint3i.

Definition at line 144 of file cartesian_point.hpp.

Constructor & Destructor Documentation

◆ CartesianPoint() [1/3]

template<typename T >

ecl::CartesianPoint< T, 3 >::CartesianPoint ( const T & value = T() )

inline

Default constructor - sets all elements to the same value.

Definition at line 149 of file cartesian_point.hpp.

◆ CartesianPoint() [2/3]

template<typename T >

ecl::CartesianPoint< T, 3 >::CartesianPoint ( const ecl::linear_algebra::Matrix< T, 3, 1 > & vec )

inline

Initialises with the specified eigen style vector.

Parameters

vec	: input three dimensional eigen style vector.

Definition at line 155 of file cartesian_point.hpp.

◆ CartesianPoint() [3/3]

template<typename T >

ecl::CartesianPoint< T, 3 >::CartesianPoint	(	const T &	x_i,
		const T &	y_i,
		const T &	z_i
	)

inline

Initialises the point with the specified values.

Parameters

x_i	: x co-ordinate.
y_i	: y co-ordinate.
z_i	: z co-ordinate.

Definition at line 163 of file cartesian_point.hpp.

◆ ~CartesianPoint()

template<typename T >

virtual ecl::CartesianPoint< T, 3 >::~CartesianPoint ( )

inlinevirtual

Definition at line 167 of file cartesian_point.hpp.

Member Function Documentation

◆ operator<<()

template<typename T >

ecl::linear_algebra::CommaInitializer< ecl::linear_algebra::Matrix<T,3,1> > ecl::CartesianPoint< T, 3 >::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;

Parameters

value : the first of three points to enter.

Returns: CommaInitialiser : eigen's comma initialiser mechanism.

Definition at line 185 of file cartesian_point.hpp.

◆ positionVector() [1/2]

template<typename T >

ecl::linear_algebra::Matrix<T,3,1>& ecl::CartesianPoint< T, 3 >::positionVector ( )

inline

Representation of the position vector in eigen vector format.

Converts representation to an eigen vector reference - oft necessary in mathematics calculations.

Returns: Matrix<T,3,1> : a reference to the underlying storage container.

Definition at line 196 of file cartesian_point.hpp.

◆ positionVector() [2/2]

template<typename T >

const ecl::linear_algebra::Matrix<T,3,1>& ecl::CartesianPoint< T, 3 >::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,3,1> : a reference to the underlying storage container.

Definition at line 205 of file cartesian_point.hpp.

◆ size()

template<typename T >

unsigned int ecl::CartesianPoint< T, 3 >::size ( )

inline

Size/dimension of the cartesian point.

Returns: unsigned int : size/dimension.

Definition at line 214 of file cartesian_point.hpp.

◆ x() [1/3]

template<typename T >

const T& ecl::CartesianPoint< T, 3 >::x ( ) const

inline

Returns a constant reference to the x co-ordinate.

Returns: const T& : x value.

Definition at line 221 of file cartesian_point.hpp.

◆ x() [2/3]

template<typename T >

T ecl::CartesianPoint< T, 3 >::x ( )

inline

Returns a copy of the x co-ordinate.

Returns: T : x value.

Definition at line 239 of file cartesian_point.hpp.

◆ x() [3/3]

template<typename T >

void ecl::CartesianPoint< T, 3 >::x ( const T & value )

inline

Sets the x-coordinate.

Definition at line 253 of file cartesian_point.hpp.

◆ y() [1/3]

template<typename T >

const T& ecl::CartesianPoint< T, 3 >::y ( ) const

inline

Returns a constant reference to the y co-ordinate.

Returns: const T& : y value.

Definition at line 227 of file cartesian_point.hpp.

◆ y() [2/3]

template<typename T >

T ecl::CartesianPoint< T, 3 >::y ( )

inline

Returns a copy of the y co-ordinate.

Returns: T : y value.

Definition at line 245 of file cartesian_point.hpp.

◆ y() [3/3]

template<typename T >

void ecl::CartesianPoint< T, 3 >::y ( const T & value )

inline

Sets the y-coordinate.

Definition at line 254 of file cartesian_point.hpp.

◆ z() [1/3]

template<typename T >

const T& ecl::CartesianPoint< T, 3 >::z ( ) const

inline

Returns a constant reference to the z co-ordinate.

Returns: const T& : z value.

Definition at line 233 of file cartesian_point.hpp.

◆ z() [2/3]

template<typename T >

T ecl::CartesianPoint< T, 3 >::z ( )

inline

Returns a copy of the z co-ordinate.

Returns: T : z value.

Definition at line 251 of file cartesian_point.hpp.

◆ z() [3/3]

template<typename T >

void ecl::CartesianPoint< T, 3 >::z ( const T & value )

inline

Sets the z-coordinate.

Definition at line 255 of file cartesian_point.hpp.

Friends And Related Function Documentation

◆ operator<<

template<typename T >

template<typename OutputStream , typename Type >

OutputStream& operator<<	(	OutputStream &	ostream,
		const CartesianPoint< Type, 3 > &	point
	)

friend

Insertion operator for sending the point to an output stream. This is raw, and has no formatting.

Parameters

ostream	: the output stream.
point	: the point to be inserted.

Returns: OutputStream : continue streaming with the updated output stream.

Definition at line 279 of file cartesian_point.hpp.

Member Data Documentation

◆ elements

template<typename T >

ecl::linear_algebra::Matrix<T,3,1> ecl::CartesianPoint< T, 3 >::elements

private

Definition at line 261 of file cartesian_point.hpp.

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

cartesian_point.hpp

Public Member Functions

Private Attributes

Friends

Detailed Description

template<typename T> class ecl::CartesianPoint< T, 3 >

Constructor & Destructor Documentation

◆ CartesianPoint() [1/3]

◆ CartesianPoint() [2/3]

◆ CartesianPoint() [3/3]

◆ ~CartesianPoint()

Member Function Documentation

◆ operator<<()

◆ positionVector() [1/2]

◆ positionVector() [2/2]

◆ size()

◆ x() [1/3]

◆ x() [2/3]

◆ x() [3/3]

◆ y() [1/3]

◆ y() [2/3]

◆ y() [3/3]

◆ z() [1/3]

◆ z() [2/3]

◆ z() [3/3]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ elements

template<typename T>
class ecl::CartesianPoint< T, 3 >