Logo Search packages:      
Sourcecode: eigen3 version File versions  Download package

Hyperplane< _Scalar, _AmbientDim > Class Template Reference

A hyperplane. More...

#include <Hyperplane.h>

Collaboration diagram for Hyperplane< _Scalar, _AmbientDim >:

List of all members.

Public Types

enum  { AmbientDimAtCompileTime = _AmbientDim }
enum  { AmbientDimAtCompileTime = _AmbientDim, Options = _Options }
typedef Matrix< Scalar, int(AmbientDimAtCompileTime)==Dynamic?Dynamic:int(AmbientDimAtCompileTime)+1, 1 > Coefficients
typedef Matrix< Scalar, Index(AmbientDimAtCompileTime)==Dynamic?Dynamic:Index(AmbientDimAtCompileTime)+1,
1, Options > 
Coefficients
typedef const Block< const
Coefficients,
AmbientDimAtCompileTime, 1 > 
ConstNormalReturnType
typedef DenseIndex Index
typedef Block< Coefficients,
AmbientDimAtCompileTime, 1 > 
NormalReturnType
typedef Block< Coefficients,
AmbientDimAtCompileTime, 1 > 
NormalReturnType
typedef NumTraits< Scalar >::Real RealScalar
typedef NumTraits< Scalar >::Real RealScalar
typedef _Scalar Scalar
typedef _Scalar Scalar
typedef Matrix< Scalar,
AmbientDimAtCompileTime, 1 > 
VectorType
typedef Matrix< Scalar,
AmbientDimAtCompileTime, 1 > 
VectorType

Public Member Functions

Scalar absDistance (const VectorType &p) const
Scalar absDistance (const VectorType &p) const
template<typename NewScalarType >
internal::cast_return_type
< Hyperplane, Hyperplane
< NewScalarType,
AmbientDimAtCompileTime >
>::type 
cast () const
template<typename NewScalarType >
internal::cast_return_type
< Hyperplane, Hyperplane
< NewScalarType,
AmbientDimAtCompileTime,
Options > >::type 
cast () const
const Coefficientscoeffs () const
Coefficientscoeffs ()
const Coefficientscoeffs () const
Coefficientscoeffs ()
int dim () const
Index dim () const
 Hyperplane ()
 Hyperplane (int _dim)
 Hyperplane ()
template<int OtherOptions>
 Hyperplane (const Hyperplane< Scalar, AmbientDimAtCompileTime, OtherOptions > &other)
 Hyperplane (const VectorType &n, const VectorType &e)
 Hyperplane (Index _dim)
 Hyperplane (const VectorType &n, Scalar d)
 Hyperplane (const VectorType &n, const VectorType &e)
 Hyperplane (const VectorType &n, Scalar d)
 Hyperplane (const ParametrizedLine< Scalar, AmbientDimAtCompileTime > &parametrized)
 Hyperplane (const ParametrizedLine< Scalar, AmbientDimAtCompileTime > &parametrized)
template<typename OtherScalarType >
 Hyperplane (const Hyperplane< OtherScalarType, AmbientDimAtCompileTime > &other)
template<typename OtherScalarType , int OtherOptions>
 Hyperplane (const Hyperplane< OtherScalarType, AmbientDimAtCompileTime, OtherOptions > &other)
VectorType intersection (const Hyperplane &other)
VectorType intersection (const Hyperplane &other) const
bool isApprox (const Hyperplane &other, typename NumTraits< Scalar >::Real prec=precision< Scalar >()) const
template<int OtherOptions>
bool isApprox (const Hyperplane< Scalar, AmbientDimAtCompileTime, OtherOptions > &other, typename NumTraits< Scalar >::Real prec=NumTraits< Scalar >::dummy_precision()) const
const NormalReturnType normal () const
NormalReturnType normal ()
ConstNormalReturnType normal () const
NormalReturnType normal ()
void normalize (void)
void normalize (void)
const Scalar & offset () const
Scalar & offset ()
const Scalar & offset () const
Scalar & offset ()
VectorType projection (const VectorType &p) const
VectorType projection (const VectorType &p) const
Scalar signedDistance (const VectorType &p) const
Scalar signedDistance (const VectorType &p) const
template<typename XprType >
Hyperplanetransform (const MatrixBase< XprType > &mat, TransformTraits traits=Affine)
template<typename XprType >
Hyperplanetransform (const MatrixBase< XprType > &mat, TransformTraits traits=Affine)
Hyperplanetransform (const Transform< Scalar, AmbientDimAtCompileTime > &t, TransformTraits traits=Affine)
template<int TrOptions>
Hyperplanetransform (const Transform< Scalar, AmbientDimAtCompileTime, Affine, TrOptions > &t, TransformTraits traits=Affine)

Static Public Member Functions

static Hyperplane Through (const VectorType &p0, const VectorType &p1)
static Hyperplane Through (const VectorType &p0, const VectorType &p1, const VectorType &p2)
static Hyperplane Through (const VectorType &p0, const VectorType &p1)
static Hyperplane Through (const VectorType &p0, const VectorType &p1, const VectorType &p2)

Protected Attributes

Coefficients m_coeffs

Detailed Description

template<typename _Scalar, int _AmbientDim>
class Hyperplane< _Scalar, _AmbientDim >

A hyperplane.

A hyperplane is an affine subspace of dimension n-1 in a space of dimension n. For example, a hyperplane in a plane is a line; a hyperplane in 3-space is a plane.

Parameters:
_Scalarthe scalar type, i.e., the type of the coefficients
_AmbientDimthe dimension of the ambient space, can be a compile time value or Dynamic. Notice that the dimension of the hyperplane is _AmbientDim-1.

This class represents an hyperplane as the zero set of the implicit equation $ n \cdot x + d = 0 $ where $ n $ is a unit normal vector of the plane (linear part) and $ d $ is the distance (offset) to the origin.

Definition at line 46 of file Hyperplane.h.


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

Generated by  Doxygen 1.6.0   Back to index