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

#include <vectorsMatrices.hh>

Inheritance diagram for concepts::UnitNd< dim >:

Public Member Functions
Real	dot (const Point< Real, dim > &b) const
	Inner product, i.e. for complex arguments: this * conjugate(b) More...

std::ostream &	info (std::ostream &os) const

Real	l2 () const
	Returns the Euclidian norm of the vector. More...

Real	l2_2 () const
	Returns the square of the Euclidian norm of the vector. More...

Real	length () const
	Length of the initially given vector. More...

void	lincomb (const Point< Real, dim > &a, const Point< Real, dim > &b, const Real ca=1.0, const Real cb=1.0)
	Assign the vector the linear combination of a and b. More...

Real	linfty () const
	Returns the Maximum norm of the vector. More...

void	max (const Point< Real, dim > &a, const Point< Real, dim > &b)
	Sets the vector to the elementwise maximum of a and b. More...

void	min (const Point< Real, dim > &a, const Point< Real, dim > &b)
	Sets the vector to the elementwise minimum of a and b. More...

	operator const Real * () const
	Returns a pointer to the data. More...

	operator Real * ()
	Returns a pointer to the data. More...

Point< Cmplx, dim >	operator* (const Cmplx n) const
	Scaling operator with a complex number. More...

Real	operator* (const Point< Real, dim > &b) const
	Inner product. More...

Point< Real, dim >	operator* (const Real n) const
	Scaling operator with a real number. More...

Real	operator* (const UnitNd< dim > &b) const

Point< Real, dim > &	operator*= (const G n)
	Scaling operator. More...

Point< Real, dim >	operator+ (const Point< Real, dim > &p) const
	Addition operator. More...

Point< Real, dim > &	operator+= (const Point< Real, dim > &p)
	Addition operator. More...

Point< Real, dim >	operator- (const Point< Real, dim > &p) const
	Subtraction operator. More...

Point< Real, dim > &	operator-= (const Point< Real, dim > &p)
	Subtraction operator. More...

Point< Cmplx, dim >	operator/ (const Cmplx n) const
	Unscaling operator with a complex number. More...

Point< Real, dim >	operator/ (const Real n) const
	Unscaling operator with a real number. More...

Point< Real, dim > &	operator/= (const G n)
	Unscaling operator. More...

Real &	operator[] (const uint i)
	Index operator. More...

const Real &	operator[] (const uint i) const
	Index operator. More...

Real	operator^ (const Point< Real, 2 > &b) const
	Outer product (for 2D) More...

Point< Real, 3 >	operator^ (const Point< Real, 3 > &b) const
	Outer product (for 3D) More...

Point< Real, dim > &	ortho ()
	Rotates the vector by 90 degrees (clockwise) (only 2D) More...

Point< Real, dim >	ortho () const
	Returns a by 90 degrees (clockwise) rotated vector (only 2D) More...

Point< Real, dim > &	ortho (const Point< Real, dim > &a)
	Change vector to the by 90 degrees (clockwise) rotated vector `a` (only 2D) More...

Point< Real, dim > &	scale (const Point< Real, dim > &n)
	Scaling. More...

	UnitNd ()
	Constructor. Initializes all elements to 0. More...

	UnitNd (const Point< Real, dim > &u)
	Constructor for a point. More...

	UnitNd (Real x, Real y, Real z)
	Constructor for at most 3D. More...

Private Attributes
Real	data_ [dim]

Real	len_

Detailed Description

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

A vector of dimension dim and length 1.

Author: Gregor Schmidlin, 2002

Definition at line 276 of file vectorsMatrices.hh.

Constructor & Destructor Documentation

◆ UnitNd() [1/3]

template<uint dim>

concepts::UnitNd< dim >::UnitNd ( )

inline

Constructor. Initializes all elements to 0.

Definition at line 281 of file vectorsMatrices.hh.

◆ UnitNd() [2/3]

template<uint dim>

concepts::UnitNd< dim >::UnitNd ( const Point< Real, dim > & u )

inline

Constructor for a point.

Definition at line 292 of file vectorsMatrices.hh.

◆ UnitNd() [3/3]

template<uint dim>

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

inline

Constructor for at most 3D.

Definition at line 298 of file vectorsMatrices.hh.

Member Function Documentation

◆ dot()

Real concepts::Point< Real , dim >::dot ( const Point< Real , dim > & b ) const

inherited

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

◆ info()

std::ostream& concepts::Point< Real , dim >::info ( std::ostream & os ) const

inherited

◆ l2()

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

inlineinherited

Returns the Euclidian norm of the vector.

Definition at line 182 of file vectorsMatrices.hh.

◆ l2_2()

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

inherited

Returns the square of the Euclidian norm of the vector.

◆ length()

template<uint dim>

Real concepts::UnitNd< dim >::length ( ) const

inline

Length of the initially given vector.

Definition at line 288 of file vectorsMatrices.hh.

◆ lincomb()

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.

◆ linfty()

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

inherited

Returns the Maximum norm of the vector.

◆ max()

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.

◆ min()

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.

◆ operator const Real *()

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

inlineinherited

Returns a pointer to the data.

Definition at line 101 of file vectorsMatrices.hh.

◆ operator Real *()

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

inlineinherited

Returns a pointer to the data.

Definition at line 99 of file vectorsMatrices.hh.

◆ operator*() [1/4]

Point<Cmplx, dim> concepts::Point< Real , dim >::operator* ( const Cmplx n ) const

inlineinherited

Scaling operator with a complex number.

Definition at line 148 of file vectorsMatrices.hh.

◆ operator*() [2/4]

Real concepts::Point< Real , dim >::operator* ( const Point< Real , dim > & b ) const

inherited

Inner product.

◆ operator*() [3/4]

Point<Real , dim> concepts::Point< Real , dim >::operator* ( const Real n ) const

inlineinherited

Scaling operator with a real number.

Definition at line 153 of file vectorsMatrices.hh.

◆ operator*() [4/4]

Real concepts::Point< Real , dim >::operator* ( const UnitNd< dim > & b ) const

inherited

◆ operator*=()

Point<Real , dim>& concepts::Point< Real , dim >::operator*= ( const G n )

inlineinherited

Scaling operator.

Definition at line 134 of file vectorsMatrices.hh.

◆ operator+()

Point<Real , dim> concepts::Point< Real , dim >::operator+ ( const Point< Real , dim > & p ) const

inlineinherited

Addition operator.

Definition at line 110 of file vectorsMatrices.hh.

◆ operator+=()

Point<Real , dim>& concepts::Point< Real , dim >::operator+= ( const Point< Real , dim > & p )

inlineinherited

Addition operator.

Definition at line 104 of file vectorsMatrices.hh.

◆ operator-()

Point<Real , dim> concepts::Point< Real , dim >::operator- ( const Point< Real , dim > & p ) const

inlineinherited

Subtraction operator.

Definition at line 121 of file vectorsMatrices.hh.

◆ operator-=()

Point<Real , dim>& concepts::Point< Real , dim >::operator-= ( const Point< Real , dim > & p )

inlineinherited

Subtraction operator.

Definition at line 115 of file vectorsMatrices.hh.

◆ operator/() [1/2]

Point<Cmplx, dim> concepts::Point< Real , dim >::operator/ ( const Cmplx n ) const

inlineinherited

Unscaling operator with a complex number.

Definition at line 159 of file vectorsMatrices.hh.

◆ operator/() [2/2]

Point<Real , dim> concepts::Point< Real , dim >::operator/ ( const Real n ) const

inlineinherited

Unscaling operator with a real number.

Definition at line 164 of file vectorsMatrices.hh.

◆ operator/=()

Point<Real , dim>& concepts::Point< Real , dim >::operator/= ( const G n )

inlineinherited

Unscaling operator.

Definition at line 142 of file vectorsMatrices.hh.

◆ operator[]() [1/2]

Real & concepts::Point< Real , dim >::operator[] ( const uint i )

inlineinherited

Index operator.

Definition at line 94 of file vectorsMatrices.hh.

◆ operator[]() [2/2]

const Real & concepts::Point< Real , dim >::operator[] ( const uint i ) const

inlineinherited

Index operator.

Definition at line 90 of file vectorsMatrices.hh.

◆ operator^() [1/2]

Real concepts::Point< Real , dim >::operator^ ( const Point< Real , 2 > & b ) const

inherited

Outer product (for 2D)

◆ operator^() [2/2]

Point<Real , 3> concepts::Point< Real , dim >::operator^ ( const Point< Real , 3 > & b ) const

inherited

Outer product (for 3D)

◆ ortho() [1/3]

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

inherited

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

◆ ortho() [2/3]

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

inherited

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

◆ ortho() [3/3]

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)

◆ scale()

Point<Real , dim>& concepts::Point< Real , dim >::scale ( const Point< Real , dim > & n )

inlineinherited

Scaling.

Definition at line 170 of file vectorsMatrices.hh.

Member Data Documentation

◆ data_

Real concepts::Point< Real , dim >::data_[dim]

privateinherited

Definition at line 209 of file vectorsMatrices.hh.

◆ len_

template<uint dim>

Real concepts::UnitNd< dim >::len_

private

Definition at line 277 of file vectorsMatrices.hh.

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

basics/vectorsMatrices.hh

concepts::UnitNd< dim > Class Template Reference

Public Member Functions

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ UnitNd() [1/3]

◆ UnitNd() [2/3]

◆ UnitNd() [3/3]

Member Function Documentation

◆ dot()

◆ info()

◆ l2()

◆ l2_2()

◆ length()

◆ lincomb()

◆ linfty()

◆ max()

◆ min()

◆ operator const Real *()

◆ operator Real *()

◆ operator*() [1/4]

◆ operator*() [2/4]

◆ operator*() [3/4]

◆ operator*() [4/4]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator^() [1/2]

◆ operator^() [2/2]

◆ ortho() [1/3]

◆ ortho() [2/3]

◆ ortho() [3/3]

◆ scale()

Member Data Documentation

◆ data_

◆ len_

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