CGAL::Eigen_vector< T, D > Class Template Reference

#include <CGAL/Eigen_vector.h>

Inherits Matrix< T, ::Eigen::Dynamic, 1 >.

Definition

template<class T, int D = ::Eigen::Dynamic>
class CGAL::Eigen_vector< T, D >

The class Eigen_vector is a wrapper around Eigen vector type, which is a simple array of numbers.

Is Model Of:

SvdTraits::Vector

SparseLinearAlgebraTraits_d::Vector.

Template Parameters

T	Number type.

See also

CGAL::Eigen_solver_traits<T>

CGAL::Eigen_sparse_matrix<T>

CGAL::Eigen_sparse_symmetric_matrix<T>

Public Member Functions
Eigen_vector &	operator= (const Eigen_vector &other)
Eigen_vector &	operator= (const EigenType &other)
	Eigen_vector ()
	Constructs a null vector. More...
	Eigen_vector (std::size_t dimension)
	Create a vector initialized with zeros. More...
	Eigen_vector (const Eigen_vector &toCopy)
	Copy constructor. More...
	~Eigen_vector ()
int	dimension () const
	Return the vector's number of coefficients. More...
const EigenType &	eigen_object () const
	Return the internal vector wrapped by this object. More...
EigenType &	eigen_object ()
	Return the internal vector wrapped by this object. More...
void	set (std::size_t i, NT value)
	Write access to a vector coefficient: a_i <- value. More...
NT *	vector ()
	Return a pointer to the data array of this vector. More...

Types
typedef T	NT
typedef ::Eigen::Matrix< T, D, 1 >	EigenType
	The internal vector type from Eigen. More...

Member Typedef Documentation

EigenType

template<class T , int D = ::Eigen::Dynamic>

typedef ::Eigen::Matrix<T, D, 1> CGAL::Eigen_vector< T, D >::EigenType

The internal vector type from Eigen.

NT

template<class T , int D = ::Eigen::Dynamic>

typedef T CGAL::Eigen_vector< T, D >::NT

Constructor & Destructor Documentation

Eigen_vector() [1/3]

template<class T , int D = ::Eigen::Dynamic>

CGAL::Eigen_vector< T, D >::Eigen_vector

(

)

Constructs a null vector.

Eigen_vector() [2/3]

template<class T , int D = ::Eigen::Dynamic>

CGAL::Eigen_vector< T, D >::Eigen_vector

(

std::size_t

dimension

)

Create a vector initialized with zeros.

Eigen_vector() [3/3]

template<class T , int D = ::Eigen::Dynamic>

CGAL::Eigen_vector< T, D >::Eigen_vector

(

const Eigen_vector< T, D > &

toCopy

)

Copy constructor.

~Eigen_vector()

template<class T , int D = ::Eigen::Dynamic>

CGAL::Eigen_vector< T, D >::~Eigen_vector

(

)

Member Function Documentation

dimension()

template<class T , int D = ::Eigen::Dynamic>

int CGAL::Eigen_vector< T, D >::dimension

(

)

const

Return the vector's number of coefficients.

eigen_object() [1/2]

template<class T , int D = ::Eigen::Dynamic>

EigenType& CGAL::Eigen_vector< T, D >::eigen_object

(

)

Return the internal vector wrapped by this object.

eigen_object() [2/2]

template<class T , int D = ::Eigen::Dynamic>

const EigenType& CGAL::Eigen_vector< T, D >::eigen_object

(

)

const

Return the internal vector wrapped by this object.

operator=() [1/2]

template<class T , int D = ::Eigen::Dynamic>

Eigen_vector& CGAL::Eigen_vector< T, D >::operator=

(

const Eigen_vector< T, D > &

other

)

operator=() [2/2]

template<class T , int D = ::Eigen::Dynamic>

Eigen_vector& CGAL::Eigen_vector< T, D >::operator=

(

const EigenType &

other

)

set()

template<class T , int D = ::Eigen::Dynamic>

void CGAL::Eigen_vector< T, D >::set	(	std::size_t	i,
		NT	value
	)

Write access to a vector coefficient: a_i <- value.

vector()

template<class T , int D = ::Eigen::Dynamic>

NT* CGAL::Eigen_vector< T, D >::vector

(

)

Return a pointer to the data array of this vector.