#include <Pendulum.h>

Inheritance diagram for gtsam::PendulumFactor1:

[legend]

Public Types
typedef boost::shared_ptr< PendulumFactor1 >	shared_ptr

Public Types inherited from gtsam::NoiseModelFactor3< double, double, double >
typedef double	X1

typedef double	X2

typedef double	X3

Public Types inherited from gtsam::NoiseModelFactor
typedef boost::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::NonlinearFactor
typedef boost::shared_ptr< This >	shared_ptr

Public Types inherited from gtsam::Factor
typedef KeyVector::const_iterator	const_iterator
	Const iterator over keys. More...

typedef KeyVector::iterator	iterator
	Iterator over keys. More...

Public Member Functions
gtsam::NonlinearFactor::shared_ptr	clone () const override

Vector	evaluateError (const double &qk1, const double &qk, const double &v, boost::optional< Matrix & > H1=boost::none, boost::optional< Matrix & > H2=boost::none, boost::optional< Matrix & > H3=boost::none) const override

	PendulumFactor1 (Key k1, Key k, Key velKey, double h, double mu=1000.0)
	Constructor. k1: q_{k+1}, k: q_k, velKey: velocity variable depending on the chosen method, h: time step. More...

Public Member Functions inherited from gtsam::NoiseModelFactor3< double, double, double >
Key	key1 () const

Key	key2 () const

Key	key3 () const

	NoiseModelFactor3 ()

	NoiseModelFactor3 (const SharedNoiseModel &noiseModel, Key j1, Key j2, Key j3)

Vector	unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const override

	~NoiseModelFactor3 () override

Public Member Functions inherited from gtsam::NoiseModelFactor
shared_ptr	cloneWithNewNoiseModel (const SharedNoiseModel newNoise) const

size_t	dim () const override

bool	equals (const NonlinearFactor &f, double tol=1e-9) const override

double	error (const Values &c) const override

boost::shared_ptr< GaussianFactor >	linearize (const Values &x) const override

const SharedNoiseModel &	noiseModel () const
	access to the noise model More...

	NoiseModelFactor ()

template<typename CONTAINER >
	NoiseModelFactor (const SharedNoiseModel &noiseModel, const CONTAINER &keys)

void	print (const std::string &s="", const KeyFormatter &keyFormatter=DefaultKeyFormatter) const override

Vector	unweightedWhitenedError (const Values &c) const

double	weight (const Values &c) const

Vector	whitenedError (const Values &c) const

	~NoiseModelFactor () override

Public Member Functions inherited from gtsam::NonlinearFactor
	NonlinearFactor ()

template<typename CONTAINER >
	NonlinearFactor (const CONTAINER &keys)

virtual	~NonlinearFactor ()

virtual bool	active (const Values &) const

shared_ptr	rekey (const std::map< Key, Key > &rekey_mapping) const

shared_ptr	rekey (const KeyVector &new_keys) const

Public Member Functions inherited from gtsam::Factor
virtual	~Factor ()=default
	Default destructor. More...

Key	front () const
	First key. More...

Key	back () const
	Last key. More...

const_iterator	find (Key key) const
	find More...

const KeyVector &	keys () const
	Access the factor's involved variable keys. More...

const_iterator	begin () const

const_iterator	end () const

size_t	size () const

virtual void	printKeys (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print only keys More...

KeyVector &	keys ()

iterator	begin ()

iterator	end ()

Protected Types
typedef NoiseModelFactor3< double, double, double >	Base

Protected Types inherited from gtsam::NoiseModelFactor3< double, double, double >
typedef NoiseModelFactor	Base

typedef NoiseModelFactor3< double, double, double >	This

Protected Types inherited from gtsam::NoiseModelFactor
typedef NonlinearFactor	Base

typedef NoiseModelFactor	This

Protected Types inherited from gtsam::NonlinearFactor
typedef Factor	Base

typedef NonlinearFactor	This

Protected Member Functions
	PendulumFactor1 ()

Protected Member Functions inherited from gtsam::NoiseModelFactor
	NoiseModelFactor (const SharedNoiseModel &noiseModel)

Protected Member Functions inherited from gtsam::Factor
	Factor ()

template<typename CONTAINER >
	Factor (const CONTAINER &keys)

template<typename ITERATOR >
	Factor (ITERATOR first, ITERATOR last)

bool	equals (const This &other, double tol=1e-9) const
	check equality More...

Protected Attributes
double	h_

Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_

Protected Attributes inherited from gtsam::Factor
KeyVector	keys_
	The keys involved in this factor. More...

Additional Inherited Members
Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor	FromKeys (const CONTAINER &keys)

template<typename ITERATOR >
static Factor	FromIterators (ITERATOR first, ITERATOR last)

Detailed Description

This class implements the first constraint.

For explicit Euler method: q_{k+1} = q_k + h*v_k
For implicit Euler method: q_{k+1} = q_k + h*v_{k+1}
For sympletic Euler method: q_{k+1} = q_k + h*v_{k+1}

Definition at line 23 of file Pendulum.h.

Member Typedef Documentation

typedef NoiseModelFactor3<double, double, double> gtsam::PendulumFactor1::Base

protected

Definition at line 27 of file Pendulum.h.

typedef boost::shared_ptr<PendulumFactor1> gtsam::PendulumFactor1::shared_ptr

Definition at line 36 of file Pendulum.h.

Constructor & Destructor Documentation

gtsam::PendulumFactor1::PendulumFactor1 ( )

inlineprotected

default constructor to allow for serialization

Definition at line 30 of file Pendulum.h.

gtsam::PendulumFactor1::PendulumFactor1	(	Key	k1,
		Key	k,
		Key	velKey,
		double	h,
		double	mu = `1000.0`
	)

inline

Constructor. k1: q_{k+1}, k: q_k, velKey: velocity variable depending on the chosen method, h: time step.

Definition at line 39 of file Pendulum.h.

Member Function Documentation

gtsam::NonlinearFactor::shared_ptr gtsam::PendulumFactor1::clone ( ) const

inlineoverridevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

Definition at line 43 of file Pendulum.h.

Vector gtsam::PendulumFactor1::evaluateError	(	const double &	qk1,
		const double &	qk,
		const double &	v,
		boost::optional< Matrix & >	H1 = `boost::none`,
		boost::optional< Matrix & >	H2 = `boost::none`,
		boost::optional< Matrix & >	H3 = `boost::none`
	)		const

inlineoverridevirtual

q_k + h*v - q_k1 = 0, with optional derivatives

Implements gtsam::NoiseModelFactor3< double, double, double >.

Definition at line 48 of file Pendulum.h.

Member Data Documentation

double gtsam::PendulumFactor1::h_

protected

Definition at line 32 of file Pendulum.h.

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

Pendulum.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation