gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic > Class Template Reference

#include <OptionalJacobian.h>

Public Types
typedef Eigen::MatrixXd	Jacobian
	Jacobian size type. More...

Public Member Functions
	operator bool () const
	Return true if allocated, false if default constructor was used. More...
Jacobian &	operator* ()
	De-reference, like boost optional. More...
Jacobian *	operator-> ()
	TODO: operator->() More...
	OptionalJacobian ()
	View on constructor argument, if given. More...
	OptionalJacobian (Jacobian *pointer)
	Construct from pointer to dynamic matrix. More...
	OptionalJacobian (Jacobian &dynamic)
	Construct from refrence to dynamic matrix. More...
	OptionalJacobian (boost::none_t)
	Constructor with boost::none just makes empty. More...
	OptionalJacobian (const boost::optional< Eigen::MatrixXd & > optional)
	Constructor compatible with old-style derivatives. More...

Private Attributes
Jacobian *	pointer_

Detailed Description

template<>
class gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >

Definition at line 161 of file OptionalJacobian.h.

Member Typedef Documentation

typedef Eigen::MatrixXd gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::Jacobian

Jacobian size type.

Definition at line 166 of file OptionalJacobian.h.

Constructor & Destructor Documentation

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::OptionalJacobian ( )

inline

View on constructor argument, if given.

Default constructor acts like boost::none

Definition at line 175 of file OptionalJacobian.h.

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::OptionalJacobian ( Jacobian *  pointer )

inline

Construct from pointer to dynamic matrix.

Definition at line 180 of file OptionalJacobian.h.

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::OptionalJacobian ( Jacobian &  dynamic )

inline

Construct from refrence to dynamic matrix.

Definition at line 183 of file OptionalJacobian.h.

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::OptionalJacobian ( boost::none_t  )

inline

Constructor with boost::none just makes empty.

Definition at line 188 of file OptionalJacobian.h.

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::OptionalJacobian ( const boost::optional< Eigen::MatrixXd & >  optional )

inline

Constructor compatible with old-style derivatives.

Definition at line 193 of file OptionalJacobian.h.

Member Function Documentation

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::operator bool ( ) const

inline

Return true if allocated, false if default constructor was used.

Definition at line 201 of file OptionalJacobian.h.

Jacobian& gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::operator* ( )

inline

De-reference, like boost optional.

Definition at line 206 of file OptionalJacobian.h.

Jacobian* gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::operator-> ( )

inline

TODO: operator->()

Definition at line 211 of file OptionalJacobian.h.

Member Data Documentation

Jacobian* gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::pointer_

private

Definition at line 170 of file OptionalJacobian.h.

---

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

• OptionalJacobian.h