Inheritance diagram for gtsam::BetweenFactor< VALUE >:

Public Member Functions
	BetweenFactor ()
	default constructor - only use for serialization

	BetweenFactor (Key key1, Key key2, const VALUE &measured, const SharedNoiseModel &model)
	Constructor.

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

virtual void	print (const std::string &s, const KeyFormatter &keyFormatter=DefaultKeyFormatter) const
	implement functions needed for Testable More...

virtual bool	equals (const NonlinearFactor &expected, double tol=1e-9) const
	equals

Vector	evaluateError (const T &p1, const T &p2, boost::optional< Matrix & > H1=boost::none, boost::optional< Matrix & > H2=boost::none) const
	implement functions needed to derive from Factor More...

const VALUE &	measured () const
	return the measured

std::size_t	size () const
	number of variables attached to this factor

Public Member Functions inherited from gtsam::NoiseModelFactor2< VALUE, VALUE >
	NoiseModelFactor2 ()
	Default Constructor for I/O.

	NoiseModelFactor2 (const SharedNoiseModel &noiseModel, Key j1, Key j2)
	Constructor. More...

Key	key1 () const
	methods to retrieve both keys

Key	key2 () const

virtual Vector	unwhitenedError (const Values &x, boost::optional< std::vector< Matrix > & > H=boost::none) const
	Calls the 2-key specific version of evaluateError, which is pure virtual so must be implemented in the derived class. More...

Public Member Functions inherited from gtsam::NoiseModelFactor
	NoiseModelFactor ()
	Default constructor for I/O only.

virtual	~NoiseModelFactor ()
	Destructor.

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

virtual size_t	dim () const
	get the dimension of the factor (number of rows on linearization)

SharedNoiseModel	get_noiseModel () const
	access to the noise model

Vector	whitenedError (const Values &c) const
	Vector of errors, whitened This is the raw error, i.e., i.e. More...

virtual double	error (const Values &c) const
	Calculate the error of the factor. More...

boost::shared_ptr< GaussianFactor >	linearize (const Values &x) const
	Linearize a non-linearFactorN to get a GaussianFactor, \( Ax-b \approx h(x+\delta x)-z = h(x) + A \delta x - z \) Hence \( b = z - h(x) = - \mathtt{error\_vector}(x) \).

Public Member Functions inherited from gtsam::NonlinearFactor
	NonlinearFactor ()
	Default constructor for I/O only.

template<typename CONTAINER >
	NonlinearFactor (const CONTAINER &keys)
	Constructor from a collection of the keys involved in this factor.

virtual	~NonlinearFactor ()
	Destructor.

virtual bool	active (const Values &c) const
	Checks whether a factor should be used based on a set of values. More...

shared_ptr	rekey (const std::map< Key, Key > &rekey_mapping) const
	Creates a shared_ptr clone of the factor with different keys using a map from old->new keys.

shared_ptr	rekey (const std::vector< Key > &new_keys) const
	Clones a factor and fully replaces its keys. More...

Public Member Functions inherited from gtsam::Factor
Key	front () const
	First key.

Key	back () const
	Last key.

const_iterator	find (Key key) const
	find

const FastVector< Key > &	keys () const
	Access the factor's involved variable keys.

const_iterator	begin () const
	Iterator at beginning of involved variable keys.

const_iterator	end () const
	Iterator at end of involved variable keys.

size_t	size () const

void	print (const std::string &s="Factor", const KeyFormatter &formatter=DefaultKeyFormatter) const
	print

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

FastVector< Key > &	keys ()

iterator	begin ()
	Iterator at beginning of involved variable keys.

iterator	end ()
	Iterator at end of involved variable keys.

Public Types
typedef VALUE	T

typedef boost::shared_ptr < BetweenFactor >	shared_ptr
	The measurement. More...

Public Types inherited from gtsam::NoiseModelFactor2< VALUE, VALUE >
typedef VALUE	X1

typedef VALUE	X2

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

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

Public Types inherited from gtsam::Factor
typedef FastVector< Key >::iterator	iterator
	Iterator over keys.

typedef FastVector< Key > ::const_iterator	const_iterator
	Const iterator over keys.

Friends
class	boost::serialization::access
	Serialization function.

Additional Inherited Members
Protected Types inherited from gtsam::NoiseModelFactor2< VALUE, VALUE >
typedef NoiseModelFactor	Base

typedef NoiseModelFactor2 < VALUE, VALUE >	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 inherited from gtsam::NoiseModelFactor
	NoiseModelFactor (const SharedNoiseModel &noiseModel)
	Constructor - only for subclasses, as this does not set keys.

Protected Member Functions inherited from gtsam::Factor
	Factor ()
	Default constructor for I/O.

template<typename CONTAINER >
	Factor (const CONTAINER &keys)
	Construct factor from container of keys. More...

template<typename ITERATOR >
	Factor (ITERATOR first, ITERATOR last)
	Construct factor from iterator keys. More...

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

Static Protected Member Functions inherited from gtsam::Factor
template<typename CONTAINER >
static Factor	FromKeys (const CONTAINER &keys)
	Construct factor from container of keys. More...

template<typename ITERATOR >
static Factor	FromIterators (ITERATOR first, ITERATOR last)
	Construct factor from iterator keys. More...

Protected Attributes inherited from gtsam::NoiseModelFactor
SharedNoiseModel	noiseModel_

Protected Attributes inherited from gtsam::Factor
FastVector< Key >	keys_
	The keys involved in this factor.

Member Typedef Documentation

template<class VALUE >

typedef boost::shared_ptr<BetweenFactor> gtsam::BetweenFactor< VALUE >::shared_ptr

The measurement.

concept check by type

Member Function Documentation

template<class VALUE >

virtual gtsam::NonlinearFactor::shared_ptr gtsam::BetweenFactor< VALUE >::clone ( ) const

inlinevirtual

Returns: a deep copy of this factor

Reimplemented from gtsam::NonlinearFactor.

template<class VALUE >

Vector gtsam::BetweenFactor< VALUE >::evaluateError	(	const T &	p1,
		const T &	p2,
		boost::optional< Matrix & >	H1 = `boost::none`,
		boost::optional< Matrix & >	H2 = `boost::none`
	)		const

inlinevirtual

implement functions needed to derive from Factor

vector of errors

Implements gtsam::NoiseModelFactor2< VALUE, VALUE >.

template<class VALUE >

virtual void gtsam::BetweenFactor< VALUE >::print	(	const std::string &	s,
		const KeyFormatter &	keyFormatter = `DefaultKeyFormatter`
	)		const

inlinevirtual

implement functions needed for Testable

print

Reimplemented from gtsam::NoiseModelFactor.

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

/home/cbeall3/git/gtsamB/gtsam/slam/BetweenFactor.h

Public Member Functions

Public Types

Friends

Additional Inherited Members

Member Typedef Documentation

Member Function Documentation