Saf::Math::Algebra::Hyperplane< N, T > Class Template Reference

Class implementing general N-dimensional plane from linear algebra. More...

#include <Hyperplane.h>

List of all members.

Public Member Functions
	Hyperplane ()
	Constructor.
	Hyperplane (const Vector< N, T > &normal, const Vector< N, T > &point)
	Constructor.
	Hyperplane (const Hyperplane< N, T > &p)
	Copy constructor.
T	Distance () const
	Get distance from the origin.
bool	IsAbove (const Vector< N, T > &point) const
	Decide whether given point is above or below the hyperplane.
const Vector< N, T > &	Normal () const
	Get normal vector of the hyperplane.
Hyperplane< N, T > &	operator= (const Hyperplane< N, T > &p)
	Assignment operator.
void	Set (const Vector< N, T > &normal, const Vector< N, T > &point)
	Specify hyperplane by specyfing its normal vector and point lying on it.

---

Detailed Description

template<Size N, class T>
class Saf::Math::Algebra::Hyperplane< N, T >

Class implementing general N-dimensional plane from linear algebra.

Template Parameters:

N	Dimensionality. For N=2 this class represents a line. For N=3 it represents a plane and so on. It holds that the represented object divides the space into two halves.
T	Data type used to store the coefficients.

---

Constructor & Destructor Documentation

template<Size N, class T>

Saf::Math::Algebra::Hyperplane< N, T >::Hyperplane

(

)

[inline]

Constructor.

template<Size N, class T>

Saf::Math::Algebra::Hyperplane< N, T >::Hyperplane	(	const Vector< N, T > &	normal,
		const Vector< N, T > &	point
	)		[inline]

Constructor.

template<Size N, class T>

Saf::Math::Algebra::Hyperplane< N, T >::Hyperplane

(

const Hyperplane< N, T > &

p

)

[inline]

Copy constructor.

---

Member Function Documentation

template<Size N, class T>

T Saf::Math::Algebra::Hyperplane< N, T >::Distance

(

)

const [inline]

Get distance from the origin.

template<Size N, class T>

bool Saf::Math::Algebra::Hyperplane< N, T >::IsAbove

(

const Vector< N, T > &

point

)

const [inline]

Decide whether given point is above or below the hyperplane.

template<Size N, class T>

const Vector<N,T>& Saf::Math::Algebra::Hyperplane< N, T >::Normal

(

)

const [inline]

Get normal vector of the hyperplane.

template<Size N, class T>

Hyperplane<N,T>& Saf::Math::Algebra::Hyperplane< N, T >::operator=

(

const Hyperplane< N, T > &

p

)

[inline]

Assignment operator.

template<Size N, class T>

void Saf::Math::Algebra::Hyperplane< N, T >::Set	(	const Vector< N, T > &	normal,
		const Vector< N, T > &	point
	)		[inline]

Specify hyperplane by specyfing its normal vector and point lying on it.

---

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

• Saf/Math/Algebra/Hyperplane.h