ewalena::Point< dim, ValueType > Class Template Reference

#include <include/ewalena/base/point.h>

Inheritance diagram for ewalena::Point< dim, ValueType >:

Collaboration diagram for ewalena::Point< dim, ValueType >:

List of all members.

Public Member Functions
void	clone (const Point< dim, ValueType > &p)
ValueType	l2_norm (const Point< dim, ValueType > &p=Point< dim, ValueType >()) const
void	operator*= (const ValueType &scalar)
void	operator+= (const Point< dim, ValueType > &p)
void	operator-= (const Point< dim, ValueType > &p)
void	operator/= (const ValueType &scalar)
ValueType	operator= (const unsigned int i)
const ValueType	operator= (const unsigned int i) const
	Point ()
	Point (const ValueType x)
	Point (const ValueType x, const ValueType y)
	Point (const ValueType x, const ValueType y, const ValueType z)
	~Point ()
Protected Member Functions
ewalena::Tensor< dim, 1, ValueType >	operator* ()
const ewalena::Tensor< dim, 1, ValueType >	operator* () const

---

Detailed Description

template<int dim, typename ValueType = double>
class ewalena::Point< dim, ValueType >

A class that describes a Euclidean point .

Author:

Toby D. Young 2012.

---

Constructor & Destructor Documentation

template<int dim, typename ValueType = double>

ewalena::Point< dim, ValueType >::Point

(

)

[inline]

Constructor.

template<int dim, typename ValueType >

ewalena::Point< dim, ValueType >::Point

(

const ValueType

x

)

[inline, explicit]

Explicit constructor for 1d.

template<int dim, typename ValueType >

ewalena::Point< dim, ValueType >::Point	(	const ValueType	x,
		const ValueType	y
	)		[inline, explicit]

Explicit constructor for 2d.

template<int dim, typename ValueType >

ewalena::Point< dim, ValueType >::Point	(	const ValueType	x,
		const ValueType	y,
		const ValueType	z
	)		[inline, explicit]

Explicit constructor for 3d.

template<int dim, typename ValueType = double>

ewalena::Point< dim, ValueType >::~Point

(

)

Destructor.

---

Member Function Documentation

template<int dim, typename ValueType >

void ewalena::Point< dim, ValueType >::clone

(

const Point< dim, ValueType > &

p

)

[inline]

Clone this point.

template<int dim, typename ValueType = double>

ValueType ewalena::Point< dim, ValueType >::l2_norm

(

const Point< dim, ValueType > &

p = Point< dim, ValueType >()

)

const

Return the -norm of this vector with respect to the point p (also called the Eucleadian distnace between this point and point p). The default arguemnt is a null point, , and thus returns the Eucleadian distance of this point to the origin.

template<int dim, typename ValueType = double>

ewalena::Tensor<dim, 1, ValueType> ewalena::Point< dim, ValueType >::operator*

(

)

[inline, protected]

Read-write access operator to the underlying rank one tensor field base.

Reimplemented from ewalena::Tensor< dim, 1, ValueType >.

template<int dim, typename ValueType = double>

const ewalena::Tensor<dim, 1, ValueType> ewalena::Point< dim, ValueType >::operator*

(

)

const [inline, protected]

Read only access operator to the underlying rank one tensor field base.

Reimplemented from ewalena::Tensor< dim, 1, ValueType >.

template<int dim, typename ValueType >

void ewalena::Point< dim, ValueType >::operator*=

(

const ValueType &

scalar

)

[inline]

Inline multiplication operator. Multiply (scale) this point by a scalar value.

Reimplemented from ewalena::Tensor< dim, 1, ValueType >.

template<int dim, typename ValueType >

void ewalena::Point< dim, ValueType >::operator+=

(

const Point< dim, ValueType > &

p

)

[inline]

Inline addition operator. Add p to this point.

template<int dim, typename ValueType >

void ewalena::Point< dim, ValueType >::operator-=

(

const Point< dim, ValueType > &

p

)

[inline]

Inline subtraction operator. Subtract p from this point.

template<int dim, typename ValueType >

void ewalena::Point< dim, ValueType >::operator/=

(

const ValueType &

scalar

)

[inline]

Inline division operator. Divide this point by a scalar value.

Reimplemented from ewalena::Tensor< dim, 1, ValueType >.

template<int dim, typename ValueType >

ValueType ewalena::Point< dim, ValueType >::operator=

(

const unsigned int

i

)

[inline]

Read-write access operator to the ith index of this point.

template<int dim, typename ValueType >

const ValueType ewalena::Point< dim, ValueType >::operator=

(

const unsigned int

i

)

const [inline]

Read only access operator to the ith index of this point.

---

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

• include/ewalena/base/point.h