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 (std::nullopt_t)
	Constructor with std::nullopt just makes empty. More...
	OptionalJacobian (const std::optional< std::reference_wrapper< Eigen::MatrixXd >> optional)
	Constructor for optional matrix reference. More...

Private Attributes
Jacobian *	pointer_

Detailed Description

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

Definition at line 189 of file OptionalJacobian.h.

Member Typedef Documentation

Jacobian

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

Jacobian size type.

Definition at line 194 of file OptionalJacobian.h.

Constructor & Destructor Documentation

OptionalJacobian() [1/5]

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

inline

View on constructor argument, if given.

Default constructor

Definition at line 203 of file OptionalJacobian.h.

OptionalJacobian() [2/5]

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

inline

Construct from pointer to dynamic matrix.

Definition at line 208 of file OptionalJacobian.h.

OptionalJacobian() [3/5]

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

inline

Construct from refrence to dynamic matrix.

Definition at line 211 of file OptionalJacobian.h.

OptionalJacobian() [4/5]

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

inline

Constructor with std::nullopt just makes empty.

Definition at line 214 of file OptionalJacobian.h.

OptionalJacobian() [5/5]

gtsam::OptionalJacobian< Eigen::Dynamic, Eigen::Dynamic >::OptionalJacobian ( const std::optional< std::reference_wrapper< Eigen::MatrixXd >>  optional )

inline

Constructor for optional matrix reference.

Definition at line 219 of file OptionalJacobian.h.

Member Function Documentation

operator bool()

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

inline

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

Definition at line 225 of file OptionalJacobian.h.

operator*()

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

inline

De-reference, like boost optional.

Definition at line 230 of file OptionalJacobian.h.

operator->()

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

inline

TODO: operator->()

Definition at line 235 of file OptionalJacobian.h.

Member Data Documentation

pointer_

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

private

Definition at line 198 of file OptionalJacobian.h.

---

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

• OptionalJacobian.h