Inheritance diagram for gtsam::DummyFactor:

Public Member Functions
	DummyFactor ()
	Default constructor: don't use directly.

	DummyFactor (const Key &key1, size_t dim1, const Key &key2, size_t dim2)
	standard binary constructor

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

bool	equals (const NonlinearFactor &f, double tol=1e-9) const override
	Check if two factors are equal. More...

const std::vector< size_t > &	dims () const

double	error (const Values &c) const override
	Calculate the error of the factor - zero for dummy factors. More...

size_t	dim () const override
	get the dimension of the factor (number of rows on linearization) More...

boost::shared_ptr< GaussianFactor >	linearize (const Values &c) const override
	linearize to a GaussianFactor More...

NonlinearFactor::shared_ptr	clone () const override
	Creates a shared_ptr clone of the factor - needs to be specialized to allow for subclasses. More...

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 &) const
	Checks whether a factor should be used based on a set of values. More...

virtual 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. More...

virtual shared_ptr	rekey (const KeyVector &new_keys) const
	Clones a factor and fully replaces its keys. More...

virtual bool	sendable () const
	Should the factor be evaluated in the same thread as the caller This is to enable factors that has shared states (like the Python GIL lock) More...

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

KeyVector &	keys ()

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

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

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

Key	front () const
	First key.

Key	back () const
	Last key.

const_iterator	find (Key key) const
	find

const KeyVector &	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

Protected Attributes
std::vector< size_t >	dims_

size_t	rowDim_
	choose dimension for the rows

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

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

Public Types inherited from gtsam::Factor
typedef KeyVector::iterator	iterator
	Iterator over keys.

typedef KeyVector::const_iterator	const_iterator
	Const iterator over keys.

Protected Types inherited from gtsam::NonlinearFactor
typedef Factor	Base

typedef NonlinearFactor	This

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...

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

Creates a shared_ptr clone of the factor - needs to be specialized to allow for subclasses.

By default, throws exception if subclass does not implement the function.

Reimplemented from gtsam::NonlinearFactor.

◆ dim()

size_t gtsam::DummyFactor::dim ( ) const

inlineoverridevirtual

get the dimension of the factor (number of rows on linearization)

Implements gtsam::NonlinearFactor.

◆ equals()

bool gtsam::DummyFactor::equals	(	const NonlinearFactor &	f,
		double	tol = `1e-9`
	)		const

overridevirtual

Check if two factors are equal.

Reimplemented from gtsam::NonlinearFactor.

◆ error()

double gtsam::DummyFactor::error ( const Values & c ) const

inlineoverridevirtual

Calculate the error of the factor - zero for dummy factors.

Implements gtsam::NonlinearFactor.

◆ linearize()

boost::shared_ptr< GaussianFactor > gtsam::DummyFactor::linearize ( const Values & c ) const

overridevirtual

linearize to a GaussianFactor

Implements gtsam::NonlinearFactor.

◆ print()

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

overridevirtual

print

Reimplemented from gtsam::NonlinearFactor.

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

/Users/dellaert/git/github/gtsam_unstable/slam/DummyFactor.h
/Users/dellaert/git/github/gtsam_unstable/slam/DummyFactor.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ clone()

◆ dim()

◆ equals()

◆ error()

◆ linearize()

◆ print()