#include <multicontact-api/geometry/linear-cone.hpp>

Inheritance diagram for multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >:

Collaboration diagram for multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >:

Public Types
enum	{ dim = _dim , Options = _Options }
typedef Eigen::Matrix< Scalar, dim, -1, Options >	MatrixDx
typedef Eigen::Matrix< Scalar, dim, dim, Options >	MatrixD
typedef Eigen::Matrix< Scalar, dim, 1, Options >	VectorD
typedef Eigen::DenseIndex	Index

Public Member Functions
	LinearCone ()
	Default constructor.
template<typename EigenDerived>
	LinearCone (const Eigen::MatrixBase< EigenDerived > &rays)
	Constructor from a set of rays.
	LinearCone (const Index size)
	Contrustor from a given size.
template<typename S2, int O2>
	LinearCone (const LinearCone< S2, dim, O2 > &other)
	Copy constructor.
void	addRay (const VectorD &ray)
template<typename EigenDerived>
void	stack (const Eigen::MatrixBase< EigenDerived > &rays)
template<typename S2, int O2>
void	stack (const LinearCone< S2, dim, O2 > &other)
const MatrixDx &	rays () const
MatrixDx &	rays ()
Index	size () const
template<typename S2, int O2>
bool	operator== (const LinearCone< S2, dim, O2 > &other) const
template<typename S2, int O2>
bool	operator!= (const LinearCone< S2, dim, O2 > &other) const
template<typename S2, int O2>
bool	isApprox (const LinearCone< S2, dim, O2 > &other, const Scalar &prec=Eigen::NumTraits< Scalar >::dummy_precision()) const
void	disp (std::ostream &os) const
Public Member Functions inherited from multicontact_api::serialization::Serializable< LinearCone< _Scalar, _dim, _Options > >
void	loadFromText (const std::string &filename)
	Loads a Derived object from a text file.
void	saveAsText (const std::string &filename) const
	Saved a Derived object as a text file.
void	loadFromXML (const std::string &filename, const std::string &tag_name)
	Loads a Derived object from an XML file.
void	saveAsXML (const std::string &filename, const std::string &tag_name) const
	Saved a Derived object as an XML file.
void	loadFromBinary (const std::string &filename)
	Loads a Derived object from an binary file.
void	saveAsBinary (const std::string &filename) const
	Saved a Derived object as an binary file.

Public Attributes
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar	Scalar

Protected Attributes
MatrixDx	m_rays
	Rays of the linear cone.

Friends
class	boost::serialization::access
std::ostream &	operator<< (std::ostream &os, const LinearCone &C)

Member Typedef Documentation

◆ Index

template<typename _Scalar, int _dim, int _Options>

typedef Eigen::DenseIndex multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::Index

◆ MatrixD

template<typename _Scalar, int _dim, int _Options>

typedef Eigen::Matrix<Scalar, dim, dim, Options> multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::MatrixD

◆ MatrixDx

template<typename _Scalar, int _dim, int _Options>

typedef Eigen::Matrix<Scalar, dim, -1, Options> multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::MatrixDx

◆ VectorD

template<typename _Scalar, int _dim, int _Options>

typedef Eigen::Matrix<Scalar, dim, 1, Options> multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::VectorD

Member Enumeration Documentation

◆ anonymous enum

template<typename _Scalar, int _dim, int _Options>

anonymous enum

Enumerator
dim
Options

Constructor & Destructor Documentation

◆ LinearCone() [1/4]

template<typename _Scalar, int _dim, int _Options>

multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::LinearCone ( )

inline

Default constructor.

◆ LinearCone() [2/4]

template<typename _Scalar, int _dim, int _Options>

template<typename EigenDerived>

multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::LinearCone ( const Eigen::MatrixBase< EigenDerived > & rays )

inlineexplicit

Constructor from a set of rays.

◆ LinearCone() [3/4]

template<typename _Scalar, int _dim, int _Options>

multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::LinearCone ( const Index size )

inlineexplicit

Contrustor from a given size.

◆ LinearCone() [4/4]

template<typename _Scalar, int _dim, int _Options>

template<typename S2, int O2>

multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::LinearCone ( const LinearCone< S2, dim, O2 > & other )

inline

Copy constructor.

Member Function Documentation

◆ addRay()

template<typename _Scalar, int _dim, int _Options>

void multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::addRay ( const VectorD & ray )

inline

◆ disp()

template<typename _Scalar, int _dim, int _Options>

void multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::disp ( std::ostream & os ) const

inline

◆ isApprox()

template<typename _Scalar, int _dim, int _Options>

template<typename S2, int O2>

bool multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::isApprox	(	const LinearCone< S2, dim, O2 > &	other,
		const Scalar &	prec = Eigen::NumTraits<Scalar>::dummy_precision() ) const

inline

◆ operator!=()

template<typename _Scalar, int _dim, int _Options>

template<typename S2, int O2>

bool multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::operator!= ( const LinearCone< S2, dim, O2 > & other ) const

inline

◆ operator==()

template<typename _Scalar, int _dim, int _Options>

template<typename S2, int O2>

bool multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::operator== ( const LinearCone< S2, dim, O2 > & other ) const

inline

◆ rays() [1/2]

template<typename _Scalar, int _dim, int _Options>

MatrixDx & multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::rays ( )

inline

◆ rays() [2/2]

template<typename _Scalar, int _dim, int _Options>

const MatrixDx & multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::rays ( ) const

inline

Returns: the rays of the linear cone.

◆ size()

template<typename _Scalar, int _dim, int _Options>

Index multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::size ( ) const

inline

Returns: the number of rays, i.e. the number of cols of m_rays

◆ stack() [1/2]

template<typename _Scalar, int _dim, int _Options>

template<typename EigenDerived>

void multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::stack ( const Eigen::MatrixBase< EigenDerived > & rays )

inline

◆ stack() [2/2]

template<typename _Scalar, int _dim, int _Options>

template<typename S2, int O2>

void multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::stack ( const LinearCone< S2, dim, O2 > & other )

inline

◆ boost::serialization::access

template<typename _Scalar, int _dim, int _Options>

friend class boost::serialization::access

friend

◆ operator<<

template<typename _Scalar, int _dim, int _Options>

std::ostream & operator<<	(	std::ostream &	os,
		const LinearCone< _Scalar, _dim, _Options > &	C )

friend

Member Data Documentation

◆ m_rays

template<typename _Scalar, int _dim, int _Options>

MatrixDx multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::m_rays

protected

Rays of the linear cone.

◆ Scalar

template<typename _Scalar, int _dim, int _Options>

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef _Scalar multicontact_api::geometry::LinearCone< _Scalar, _dim, _Options >::Scalar

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

include/multicontact-api/geometry/fwd.hpp
include/multicontact-api/geometry/linear-cone.hpp

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Friends

Member Typedef Documentation

◆ Index

◆ MatrixD

◆ MatrixDx

◆ VectorD

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ LinearCone() [1/4]

◆ LinearCone() [2/4]

◆ LinearCone() [3/4]

◆ LinearCone() [4/4]

Member Function Documentation

◆ addRay()

◆ disp()

◆ isApprox()

◆ operator!=()

◆ operator==()

◆ rays() [1/2]

◆ rays() [2/2]

◆ size()

◆ stack() [1/2]

◆ stack() [2/2]

Friends And Related Symbol Documentation

◆ boost::serialization::access

◆ operator<<

Member Data Documentation

◆ m_rays

◆ Scalar