A parametrized line. More...

#include <ForwardDeclarations.h>

Public Types
enum	{ AmbientDimAtCompileTime = _AmbientDim, Options = _Options }

typedef Eigen::Index	Index

typedef NumTraits< Scalar >::Real	RealScalar

typedef _Scalar	Scalar

typedef Matrix< Scalar, AmbientDimAtCompileTime, 1, Options >	VectorType

Public Member Functions
template<typename NewScalarType >
EIGEN_DEVICE_FUNC internal::cast_return_type< ParametrizedLine, ParametrizedLine< NewScalarType, AmbientDimAtCompileTime, Options > >::type	cast () const

EIGEN_DEVICE_FUNC Index	dim () const

EIGEN_DEVICE_FUNC const VectorType &	direction () const

EIGEN_DEVICE_FUNC VectorType &	direction ()

EIGEN_DEVICE_FUNC RealScalar	distance (const VectorType &p) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC Scalar	intersection (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC _Scalar	intersection (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC Scalar	intersectionParameter (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC _Scalar	intersectionParameter (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

template<int OtherOptions>
EIGEN_DEVICE_FUNC VectorType	intersectionPoint (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane) const

EIGEN_DEVICE_FUNC bool	isApprox (const ParametrizedLine &other, const typename NumTraits< Scalar >::Real &prec=NumTraits< Scalar >::dummy_precision()) const

EIGEN_DEVICE_FUNC const VectorType &	origin () const

EIGEN_DEVICE_FUNC VectorType &	origin ()

EIGEN_DEVICE_FUNC	ParametrizedLine ()

template<int OtherOptions>
EIGEN_DEVICE_FUNC	ParametrizedLine (const ParametrizedLine< Scalar, AmbientDimAtCompileTime, OtherOptions > &other)

EIGEN_DEVICE_FUNC	ParametrizedLine (Index _dim)

EIGEN_DEVICE_FUNC	ParametrizedLine (const VectorType &origin, const VectorType &direction)

template<int OtherOptions>
EIGEN_DEVICE_FUNC	ParametrizedLine (const Hyperplane< _Scalar, _AmbientDim, OtherOptions > &hyperplane)

template<typename OtherScalarType , int OtherOptions>
EIGEN_DEVICE_FUNC	ParametrizedLine (const ParametrizedLine< OtherScalarType, AmbientDimAtCompileTime, OtherOptions > &other)

EIGEN_DEVICE_FUNC VectorType	pointAt (const Scalar &t) const

EIGEN_DEVICE_FUNC VectorType	projection (const VectorType &p) const

EIGEN_DEVICE_FUNC RealScalar	squaredDistance (const VectorType &p) const

EIGEN_DEVICE_FUNC	~ParametrizedLine ()

Static Public Member Functions
static EIGEN_DEVICE_FUNC ParametrizedLine	Through (const VectorType &p0, const VectorType &p1)

Protected Attributes
VectorType	m_direction

VectorType	m_origin

Detailed Description

template<typename _Scalar, int _AmbientDim, int _Options>
class Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >

A parametrized line.

A parametrized line is defined by an origin point $\mathbf{o}$ and a unit direction vector $\mathbf{d}$ such that the line corresponds to the set $l(t) = \mathbf{o} + t \mathbf{d}$ , $t \in \mathbf{R}$ .

Template Parameters

_Scalar	the scalar type, i.e., the type of the coefficients
_AmbientDim	the dimension of the ambient space, can be a compile time value or Dynamic.

Definition at line 275 of file ForwardDeclarations.h.

Member Typedef Documentation

template<typename _Scalar, int _AmbientDim, int _Options>

typedef Eigen::Index Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::Index

Deprecated:: since Eigen 3.3

Definition at line 40 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

typedef NumTraits<Scalar>::Real Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::RealScalar

Definition at line 39 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

typedef _Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::Scalar

Definition at line 38 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

typedef Matrix<Scalar,AmbientDimAtCompileTime,1,Options> Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::VectorType

Definition at line 41 of file ParametrizedLine.h.

Member Enumeration Documentation

template<typename _Scalar, int _AmbientDim, int _Options>

anonymous enum

Enumerator
AmbientDimAtCompileTime
Options

Definition at line 34 of file ParametrizedLine.h.

Constructor & Destructor Documentation

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( )

inline

Default constructor without initialization

Definition at line 44 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( const ParametrizedLine< Scalar, AmbientDimAtCompileTime, OtherOptions > & other )

inline

Definition at line 47 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( Index _dim )

inlineexplicit

Constructs a dynamic-size line with _dim the dimension of the ambient space

Definition at line 53 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine	(	const VectorType &	origin,
		const VectorType &	direction
	)

inline

Initializes a parametrized line of direction direction and origin origin.

Warning: the vector direction is assumed to be normalized.

Definition at line 58 of file ParametrizedLine.h.

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane )

inlineexplicit

Constructs a parametrized line from a 2D hyperplane

Warning: the ambient space must have dimension 2 such that the hyperplane actually describes a line

Definition at line 146 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::~ParametrizedLine ( )

inline

Definition at line 68 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

template<typename OtherScalarType , int OtherOptions>

EIGEN_DEVICE_FUNC Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::ParametrizedLine ( const ParametrizedLine< OtherScalarType, AmbientDimAtCompileTime, OtherOptions > & other )

inlineexplicit

Copy constructor with scalar type conversion

Definition at line 122 of file ParametrizedLine.h.

Member Function Documentation

template<typename _Scalar, int _AmbientDim, int _Options>

template<typename NewScalarType >

EIGEN_DEVICE_FUNC internal::cast_return_type<ParametrizedLine, ParametrizedLine<NewScalarType,AmbientDimAtCompileTime,Options> >::type Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::cast ( ) const

inline

Returns: *this with scalar type casted to NewScalarType

Note that if NewScalarType is equal to the current scalar type of *this then this function smartly returns a const reference to *this.

Definition at line 114 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC Index Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::dim ( ) const

inline

Returns: the dimension in which the line holds

Definition at line 71 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC const VectorType& Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::direction ( void ) const

inline

Definition at line 76 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC VectorType& Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::direction ( void )

inline

Definition at line 77 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC RealScalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::distance ( const VectorType & p ) const

inline

Returns: the distance of a point p to its projection onto the line *this.

See also: squaredDistance()

Definition at line 90 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersection ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

template<typename _Scalar, int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC _Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersection ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

inline

Deprecated:: use intersectionParameter()

Returns: the parameter value of the intersection between *this and the given hyperplane

Definition at line 178 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersectionParameter ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

template<typename _Scalar, int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC _Scalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersectionParameter ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

inline

Returns: the parameter value of the intersection between *this and the given hyperplane

Definition at line 166 of file ParametrizedLine.h.

template<typename _Scalar , int _AmbientDim, int _Options>

template<int OtherOptions>

EIGEN_DEVICE_FUNC ParametrizedLine< _Scalar, _AmbientDim, _Options >::VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::intersectionPoint ( const Hyperplane< _Scalar, _AmbientDim, OtherOptions > & hyperplane ) const

inline

Returns: the point of the intersection between *this and the given hyperplane

Definition at line 188 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC bool Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::isApprox	(	const ParametrizedLine< _Scalar, _AmbientDim, _Options > &	other,
		const typename NumTraits< Scalar >::Real &	prec = `NumTraits<Scalar>::dummy_precision()`
	)		const

inline

Returns: true if *this is approximately equal to other, within the precision determined by prec.

See also: MatrixBase::isApprox()

Definition at line 132 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC const VectorType& Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::origin ( ) const

inline

Definition at line 73 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC VectorType& Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::origin ( )

inline

Definition at line 74 of file ParametrizedLine.h.

template<typename _Scalar , int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC ParametrizedLine< _Scalar, _AmbientDim, _Options >::VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::pointAt ( const Scalar & t ) const

inline

Returns: the point at t along this line

Definition at line 157 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::projection ( const VectorType & p ) const

inline

Returns: the projection of a point p onto the line *this.

Definition at line 93 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

EIGEN_DEVICE_FUNC RealScalar Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::squaredDistance ( const VectorType & p ) const

inline

Returns: the squared distance of a point p to its projection onto the line *this.

See also: distance()

Definition at line 82 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

static EIGEN_DEVICE_FUNC ParametrizedLine Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::Through	(	const VectorType &	p0,
		const VectorType &	p1
	)

inlinestatic

Constructs a parametrized line going from p0 to p1.

Definition at line 65 of file ParametrizedLine.h.

Member Data Documentation

template<typename _Scalar, int _AmbientDim, int _Options>

VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::m_direction

protected

Definition at line 137 of file ParametrizedLine.h.

template<typename _Scalar, int _AmbientDim, int _Options>

VectorType Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >::m_origin

protected

Definition at line 137 of file ParametrizedLine.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

template<typename _Scalar, int _AmbientDim, int _Options> class Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename _Scalar, int _AmbientDim, int _Options>
class Eigen::ParametrizedLine< _Scalar, _AmbientDim, _Options >