eigen_matrixbase_addons.h File Reference

Go to the source code of this file.

Typedefs
typedef CwiseUnaryOp < ei_scalar_add_op< Scalar > , Derived >	ScalarAddReturnType
typedef Scalar	ScalarType
Functions
EIGEN_DEPRECATED Scalar	Cofactor (unsigned int i, unsigned int j) const
EIGEN_DEPRECATED unsigned int	ColumnsNumber () const
EIGEN_DEPRECATED Scalar	Determinant () const
EIGEN_DEPRECATED void	Dump ()
EIGEN_DEPRECATED Scalar	ElementAt (unsigned int i, unsigned int j) const
Scalar	Ext (const int i) const
EIGEN_DEPRECATED ColXpr	GetColumn (const unsigned int j)
EIGEN_DEPRECATED RowXpr	GetRow (const unsigned int i)
Derived &	HomoNormalize ()
	Homogeneous normalization (division by W)
EIGEN_DEPRECATED Scalar	Max () const
	returns the biggest component
EIGEN_DEPRECATED int	MaxI () const
	returns the index of the biggest component
EIGEN_DEPRECATED Scalar	Min () const
	returns the smallest component
EIGEN_DEPRECATED int	MinI () const
	returns the index of the smallest component
EIGEN_DEPRECATED Scalar	Norm () const
EIGEN_DEPRECATED Derived &	Normalize ()
EIGEN_DEPRECATED Scalar	NormInfinity () const
	norm infinity: largest absolute value of compoenet
EIGEN_DEPRECATED Scalar	NormOne () const
	norm 1: sum of absolute values of components
EIGEN_DEPRECATED const ScalarAddReturnType	operator+ (const Scalar k)
EIGEN_DEPRECATED Derived &	operator+= (const Scalar k)
EIGEN_DEPRECATED const ScalarAddReturnType	operator- (const Scalar k)
EIGEN_DEPRECATED Derived &	operator-= (const Scalar k)
template<typename OtherDerived >
EIGEN_DEPRECATED bool	operator< (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEPRECATED bool	operator<= (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEPRECATED bool	operator> (const MatrixBase< OtherDerived > &other) const
template<typename OtherDerived >
EIGEN_DEPRECATED bool	operator>= (const MatrixBase< OtherDerived > &other) const
EIGEN_DEPRECATED PlainMatrixType	operator^ (const Derived &p) const
template<typename OtherDerived1 , typename OtherDerived2 >
EIGEN_DEPRECATED void	OuterProduct (const MatrixBase< OtherDerived1 > &a, const MatrixBase< OtherDerived2 > &b)
EIGEN_DEPRECATED unsigned int	RowsNumber () const
template<typename OtherDerived >
EIGEN_DEPRECATED Derived &	Scale (const MatrixBase< OtherDerived > &other)
	Per component scaling.
EIGEN_DEPRECATED void	SetColumn (unsigned int j, Scalar *v)
template<typename OtherDerived >
EIGEN_DEPRECATED void	SetColumn (unsigned int j, const MatrixBase< OtherDerived > &other)
EIGEN_DEPRECATED void	SetDiagonal (Scalar *v)
EIGEN_DEPRECATED void	SetIdentity ()
EIGEN_DEPRECATED void	SetRow (unsigned int i, Scalar *v)
template<typename OtherDerived >
EIGEN_DEPRECATED void	SetRow (unsigned int j, const MatrixBase< OtherDerived > &other)
EIGEN_DEPRECATED void	SetZero ()
EIGEN_DEPRECATED Scalar	SquaredNorm () const
EIGEN_DEPRECATED Scalar	Sum () const
	the sum of the components
EIGEN_DEPRECATED void	SwapColumns (const unsigned int i, const unsigned int j)
EIGEN_DEPRECATED void	SwapRows (const unsigned int i, const unsigned int j)
EIGEN_DEPRECATED Scalar	Trace () const
EIGEN_DEPRECATED Derived &	Transpose ()
EIGEN_DEPRECATED Scalar	V (int i) const

---

Typedef Documentation

typedef CwiseUnaryOp<ei_scalar_add_op<Scalar>, Derived> ScalarAddReturnType

Definition at line 134 of file eigen_matrixbase_addons.h.

typedef Scalar ScalarType

Definition at line 28 of file eigen_matrixbase_addons.h.

---

Function Documentation

EIGEN_DEPRECATED Scalar Cofactor	(	unsigned int	i,
		unsigned int	j
	)		const

Return the cofactor A_i,j of the a_i,j element

Returns:

...

Definition at line 60 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED unsigned int ColumnsNumber

(

)

const [inline]

Deprecated:

use cols()

Definition at line 31 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar Determinant

(

)

const

Deprecated:

use *this.determinant() (or *this.lu().determinant() for large matrices) Calculate and return the matrix determinant (Laplace)

Returns:

the matrix determinant

Definition at line 54 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void Dump

(

)

Deprecated:

use ostream << *this or even ostream << *this.withFormat(...)

Definition at line 177 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar & ElementAt	(	unsigned int	i,
		unsigned int	j
	)		const [inline]

Deprecated:

use *this(i,j) (or *this.coeff(i,j)) Return the element stored in the i-th rows at the j-th column

Parameters:

i	the row index
j	the column index

Returns:

the element

Definition at line 44 of file eigen_matrixbase_addons.h.

Scalar Ext

(

const int

i

)

const [inline]

Padding function: give a default 0 value to all the elements that are not in the [0..2] range. Useful for managing in a consistent way object that could have point2 / point3 / point4

Definition at line 252 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED ColXpr GetColumn

(

const unsigned int

j

)

Deprecated:

use *this.col(j)

Definition at line 68 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED RowXpr GetRow

(

const unsigned int

i

)

Deprecated:

use *this.row(i)

Definition at line 71 of file eigen_matrixbase_addons.h.

const PlainMatrixType HomoNormalize

(

)

[inline]

Homogeneous normalization (division by W)

Definition at line 208 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar Max

(

)

const [inline]

returns the biggest component

Definition at line 241 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED int MaxI

(

)

const [inline]

returns the index of the biggest component

Definition at line 245 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar Min

(

)

const [inline]

returns the smallest component

Definition at line 243 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED int MinI

(

)

const [inline]

returns the index of the smallest component

Definition at line 247 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar Norm

(

)

const [inline]

Deprecated:

use norm()

Definition at line 191 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED const PlainMatrixType Normalize

(

)

[inline]

Deprecated:

use normalize() or normalized()

Deprecated:

use normalized()

Definition at line 195 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar NormInfinity

(

)

const [inline]

norm infinity: largest absolute value of compoenet

Definition at line 233 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar NormOne

(

)

const [inline]

norm 1: sum of absolute values of components

Definition at line 235 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED const ScalarAddReturnType operator+

(

const Scalar

k

)

Deprecated:

use *this.cwise() + k

Definition at line 137 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Derived& operator+=

(

const Scalar

k

)

Deprecated:

use *this.cwise() += k (Modifier) Add to each element of this matrix the scalar constant k.

Parameters:

k	the scalar constant

Returns:

the modified matrix

Definition at line 93 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED const ScalarAddReturnType operator-

(

const Scalar

k

)

Deprecated:

use *this.cwise() - k

Definition at line 140 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Derived& operator-=

(

const Scalar

k

)

Deprecated:

use *this.cwise() -= k (Modifier) Subtract from each element of this matrix the scalar constant k.

Parameters:

k	the scalar constant

Returns:

the modified matrix

Definition at line 105 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED bool operator<

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 277 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED bool operator<=

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 291 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED bool operator>

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 284 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED bool operator>=

(

const MatrixBase< OtherDerived > &

other

)

const [inline]

Definition at line 298 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED PlainMatrixType operator^

(

const Derived &

p

)

const [inline]

Deprecated:

use .cross(p)

Definition at line 205 of file eigen_matrixbase_addons.h.

template<typename OtherDerived1 , typename OtherDerived2 >

EIGEN_DEPRECATED void OuterProduct	(	const MatrixBase< OtherDerived1 > &	a,
		const MatrixBase< OtherDerived2 > &	b
	)

Deprecated:

use *this.dot Matrix multiplication: calculates the cross product.

Parameters:

reference

to the matrix to multiply by

Returns:

the matrix product

Deprecated:

use *this = a * b.transpose() (or *this = a * b.adjoint() for complexes)

Definition at line 131 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED unsigned int RowsNumber

(

)

const [inline]

Deprecated:

use rows()

Definition at line 35 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED CwiseBinaryOp< ei_scalar_product_op< Scalar >, Derived, OtherDerived > Scale

(

const MatrixBase< OtherDerived > &

other

)

[inline]

Per component scaling.

Definition at line 266 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SetColumn	(	unsigned int	j,
		Scalar *	v
	)

Deprecated:

use *this.col(j) = expression

Definition at line 149 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED void SetColumn	(	unsigned int	j,
		const MatrixBase< OtherDerived > &	other
	)

Deprecated:

use *this.col(i) = other

Definition at line 154 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SetDiagonal

(

Scalar *

v

)

Deprecated:

use *this.diagonal() = expression

Definition at line 167 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SetIdentity

(

)

Deprecated:

use *this.setIdentity() or *this = MatrixType::Identity(rows,cols), etc.

Definition at line 146 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SetRow	(	unsigned int	i,
		Scalar *	v
	)

Deprecated:

use *this.row(i) = expression

Definition at line 158 of file eigen_matrixbase_addons.h.

template<typename OtherDerived >

EIGEN_DEPRECATED void SetRow	(	unsigned int	j,
		const MatrixBase< OtherDerived > &	other
	)

Deprecated:

use *this.row(i) = other

Definition at line 163 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SetZero

(

)

Deprecated:

use *this.setZero() or *this = MatrixType::Zero(rows,cols), etc.

Definition at line 143 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar SquaredNorm

(

)

const [inline]

Deprecated:

use squaredNorm()

Definition at line 193 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar Sum

(

)

const [inline]

the sum of the components

Definition at line 239 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SwapColumns	(	const unsigned int	i,
		const unsigned int	j
	)

Deprecated:

use m1.col(i).swap(m1.col(j));

Definition at line 74 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED void SwapRows	(	const unsigned int	i,
		const unsigned int	j
	)

Deprecated:

use m1.col(i).swap(m1.col(j))

Definition at line 81 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar Trace

(

)

const

Deprecated:

use trace()

Definition at line 174 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED const Eigen::Transpose< Derived > Transpose

(

)

[inline]

Deprecated:

use transposeInPlace() or transpose()

Deprecated:

use transpose()

Definition at line 200 of file eigen_matrixbase_addons.h.

EIGEN_DEPRECATED Scalar V

(

int

i

)

const [inline]

Definition at line 46 of file eigen_matrixbase_addons.h.