concepts::UnitNd< dim > Class Template Reference

A vector of dimension dim and length 1. More...

#include <vectorsMatrices.hh>

Inheritance diagram for concepts::UnitNd< dim >:

Collaboration diagram for concepts::UnitNd< dim >:

List of all members.

Public Member Functions
Real	cross (const Point< Real, dim > &b) const
	Outer product (for 2D)
Real	dot (const Point< Real, dim > &b) const
	Inner product, i.e. for complex arguments: this * conjugate(b)
std::ostream &	info (std::ostream &os) const
Real	l2 () const
	Returns the Euclidian norm of the vector.
Real	l2_2 () const
	Returns the square of the Euclidian norm of the vector.
Real	length () const
	Length of the initially given vector.
void	lincomb (const Point< Real, dim > &a, const Point< Real, dim > &b, const Realca=1.0, const Realcb=1.0)
	Assign the vector the linear combination of a and b.
Real	linfty () const
	Returns the Maximum norm of the vector.
void	max (const Point< Real, dim > &a, const Point< Real, dim > &b)
	Sets the vector to the elementwise maximum of a and b.
void	min (const Point< Real, dim > &a, const Point< Real, dim > &b)
	Sets the vector to the elementwise minimum of a and b.
	operator const Real * () const
	Returns a pointer to the data.
	operator Real * ()
	Returns a pointer to the data.
Point< typename Combtype< Real, G >::type, dim >	operator* (const G n) const
	Scaling operator.
Real	operator* (const Point< Real, dim > &b) const
	Inner product.
Real	operator* (const UnitNd< dim > &b) const
Point< Real, dim > &	operator*= (const G n)
	Scaling operator.
Point< Real, dim >	operator+ (const Point< Real, dim > &p) const
	Addition operator.
Point< Real, dim > &	operator+= (const Point< Real, dim > &p)
	Addition operator.
Point< Real, dim >	operator- (const Point< Real, dim > &p) const
	Subtraction operator.
Point< Real, dim > &	operator-= (const Point< Real, dim > &p)
	Subtraction operator.
Point< Real, dim > &	operator/= (const G n)
const Real &	operator[] (const int i) const
	Index operator.
Real &	operator[] (const int i)
	Index operator.
Point< Real, dim >	operator^ (const Point< Real, dim > &b) const
	Outer product (for 3D)
Point< Real, dim > &	ortho ()
	Rotates the vector by 90 degrees (clockwise) (only 2D)
Point< Real, dim >	ortho () const
	Returns a by 90 degrees (clockwise) rotated vector (only 2D)
Point< Real, dim > &	ortho (const Point< Real, dim > &a)
	Change vector to the by 90 degrees (clockwise) rotated vector a (only 2D)
Point< Real, dim > &	scale (const Point< Real, dim > &n)
	Scaling.
	UnitNd ()
	Constructor. Initializes all elements to 0.
	UnitNd (Real x, Real y, Real z)
	Constructor for at most 3D.
	UnitNd (const Point< Real, dim > &u)
	Constructor for a point.
Private Attributes
Real	len_

---

Detailed Description

template<int dim>
class concepts::UnitNd< dim >

A vector of dimension dim and length 1.

Author:

Gregor Schmidlin, 2002

Definition at line 275 of file vectorsMatrices.hh.

---

Constructor & Destructor Documentation

template<int dim>

concepts::UnitNd< dim >::UnitNd

(

)

[inline]

Constructor. Initializes all elements to 0.

Definition at line 280 of file vectorsMatrices.hh.

template<int dim>

concepts::UnitNd< dim >::UnitNd

(

const Point< Real, dim > &

u

)

[inline]

Constructor for a point.

Definition at line 291 of file vectorsMatrices.hh.

Here is the call graph for this function:

template<int dim>

concepts::UnitNd< dim >::UnitNd	(	Real	x,
		Real	y,
		Real	z
	)		[inline]

Constructor for at most 3D.

Definition at line 297 of file vectorsMatrices.hh.

Here is the call graph for this function:

---

Member Function Documentation

Real concepts::Point< Real , dim >::cross

(

const Point< Real , dim > &

b

)

const [inline, inherited]

Outer product (for 2D)

Definition at line 153 of file vectorsMatrices.hh.

Real concepts::Point< Real , dim >::dot

(

const Point< Real , dim > &

b

)

const [inline, inherited]

Inner product, i.e. for complex arguments: this * conjugate(b)

Definition at line 123 of file vectorsMatrices.hh.

std::ostream& concepts::Point< Real , dim >::info

(

std::ostream &

os

)

const [inherited]

Real concepts::Point< Real , dim >::l2

(

)

const [inline, inherited]

Returns the Euclidian norm of the vector.

Definition at line 160 of file vectorsMatrices.hh.

Real concepts::Point< Real , dim >::l2_2

(

)

const [inherited]

Returns the square of the Euclidian norm of the vector.

template<int dim>

Real concepts::UnitNd< dim >::length

(

)

const [inline]

Length of the initially given vector.

Definition at line 287 of file vectorsMatrices.hh.

void concepts::Point< Real , dim >::lincomb	(	const Point< Real , dim > &	a,
		const Point< Real , dim > &	b,
		const Real	ca = 1.0,
		const Real	cb = 1.0
	)		[inherited]

Assign the vector the linear combination of a and b.

Real concepts::Point< Real , dim >::linfty

(

)

const [inherited]

Returns the Maximum norm of the vector.

void concepts::Point< Real , dim >::max	(	const Point< Real , dim > &	a,
		const Point< Real , dim > &	b
	)		[inherited]

Sets the vector to the elementwise maximum of a and b.

void concepts::Point< Real , dim >::min	(	const Point< Real , dim > &	a,
		const Point< Real , dim > &	b
	)		[inherited]

Sets the vector to the elementwise minimum of a and b.

concepts::Point< Real , dim >::operator const Real *

(

)

const [inline, inherited]

Returns a pointer to the data.

Definition at line 94 of file vectorsMatrices.hh.

concepts::Point< Real , dim >::operator Real *

(

)

[inline, inherited]

Returns a pointer to the data.

Definition at line 92 of file vectorsMatrices.hh.

Real concepts::Point< Real , dim >::operator*

(

const Point< Real , dim > &

b

)

const [inherited]

Inner product.

Real concepts::Point< Real , dim >::operator*

(

const UnitNd< dim > &

b

)

const [inherited]

Point<typename Combtype<Real ,G>::type, dim> concepts::Point< Real , dim >::operator*

(

const G

n

)

const [inline, inherited]

Scaling operator.

Definition at line 141 of file vectorsMatrices.hh.

Point<Real , dim>& concepts::Point< Real , dim >::operator*=

(

const G

n

)

[inline, inherited]

Scaling operator.

Definition at line 129 of file vectorsMatrices.hh.

Point<Real , dim> concepts::Point< Real , dim >::operator+

(

const Point< Real , dim > &

p

)

const [inline, inherited]

Addition operator.

Definition at line 103 of file vectorsMatrices.hh.

Point<Real , dim>& concepts::Point< Real , dim >::operator+=

(

const Point< Real , dim > &

p

)

[inline, inherited]

Addition operator.

Definition at line 97 of file vectorsMatrices.hh.

Point<Real , dim> concepts::Point< Real , dim >::operator-

(

const Point< Real , dim > &

p

)

const [inline, inherited]

Subtraction operator.

Definition at line 114 of file vectorsMatrices.hh.

Point<Real , dim>& concepts::Point< Real , dim >::operator-=

(

const Point< Real , dim > &

p

)

[inline, inherited]

Subtraction operator.

Definition at line 108 of file vectorsMatrices.hh.

Point<Real , dim>& concepts::Point< Real , dim >::operator/=

(

const G

n

)

[inline, inherited]

Definition at line 135 of file vectorsMatrices.hh.

const Real & concepts::Point< Real , dim >::operator[]

(

const int

i

)

const [inline, inherited]

Index operator.

Definition at line 83 of file vectorsMatrices.hh.

Real & concepts::Point< Real , dim >::operator[]

(

const int

i

)

[inline, inherited]

Index operator.

Definition at line 87 of file vectorsMatrices.hh.

Point<Real , dim> concepts::Point< Real , dim >::operator^

(

const Point< Real , dim > &

b

)

const [inherited]

Outer product (for 3D)

Point<Real , dim>& concepts::Point< Real , dim >::ortho

(

const Point< Real , dim > &

a

)

[inherited]

Change vector to the by 90 degrees (clockwise) rotated vector a (only 2D)

Point<Real , dim> concepts::Point< Real , dim >::ortho

(

)

const [inherited]

Returns a by 90 degrees (clockwise) rotated vector (only 2D)

Point<Real , dim>& concepts::Point< Real , dim >::ortho

(

)

[inherited]

Rotates the vector by 90 degrees (clockwise) (only 2D)

Point<Real , dim>& concepts::Point< Real , dim >::scale

(

const Point< Real , dim > &

n

)

[inline, inherited]

Scaling.

Definition at line 146 of file vectorsMatrices.hh.

---

Member Data Documentation

template<int dim>

Real concepts::UnitNd< dim >::len_ [private]

Definition at line 276 of file vectorsMatrices.hh.

---

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

• basics/vectorsMatrices.hh