gtsam::internal::ExpressionNode< T > Class Template Reference

#include <Expression.h>

Inheritance diagram for gtsam::internal::ExpressionNode< T >:

Public Member Functions
virtual void	dims (std::map< Key, int > &map) const
	Return dimensions for each argument, as a map. More...
virtual std::set< Key >	keys () const
	Return keys that play in this expression as a set. More...
virtual void	print (const std::string &indent="") const =0
	Print. More...
virtual T	traceExecution (const Values &values, ExecutionTrace< T > &trace, char *traceStorage) const =0
	Construct an execution trace for reverse AD. More...
size_t	traceSize () const
virtual T	value (const Values &values) const =0
	Return value. More...
virtual	~ExpressionNode ()
	Destructor. More...

Protected Member Functions
	ExpressionNode (size_t traceSize=0)
	Constructor, traceSize is size of the execution trace of expression rooted here. More...

Protected Attributes
size_t	traceSize_

Friends
GTSAM_EXPORT friend std::ostream &	operator<< (std::ostream &os, const ExpressionNode &node)
	Streaming. More...

Detailed Description

template<class T>
class gtsam::internal::ExpressionNode< T >

Expression node. The superclass for objects that do the heavy lifting An Expression<T> has a pointer to an ExpressionNode<T> underneath allowing Expressions to have polymorphic behaviour even though they are passed by value. This is the same way std::function works. http://loki-lib.sourceforge.net/html/a00652.html

Definition at line 40 of file Expression.h.

Constructor & Destructor Documentation

ExpressionNode()

template<class T >

gtsam::internal::ExpressionNode< T >::ExpressionNode ( size_t  traceSize = 0 )

inlineprotected

Constructor, traceSize is size of the execution trace of expression rooted here.

Definition at line 72 of file ExpressionNode.h.

~ExpressionNode()

template<class T >

virtual gtsam::internal::ExpressionNode< T >::~ExpressionNode ( )

inlinevirtual

Destructor.

Definition at line 79 of file ExpressionNode.h.

Member Function Documentation

dims()

template<class T >

virtual void gtsam::internal::ExpressionNode< T >::dims ( std::map< Key, int > &  map ) const

inlinevirtual

Return dimensions for each argument, as a map.

Reimplemented in gtsam::internal::BinarySumNode< T >, gtsam::internal::ScalarMultiplyNode< T >, gtsam::internal::TernaryExpression< T, A1, A2, A3 >, gtsam::internal::BinaryExpression< T, A1, A2 >, gtsam::internal::UnaryExpression< T, A1 >, and gtsam::internal::LeafExpression< T >.

Definition at line 101 of file ExpressionNode.h.

keys()

template<class T >

virtual std::set<Key> gtsam::internal::ExpressionNode< T >::keys ( ) const

inlinevirtual

Return keys that play in this expression as a set.

Reimplemented in gtsam::internal::BinarySumNode< T >, gtsam::internal::ScalarMultiplyNode< T >, gtsam::internal::TernaryExpression< T, A1, A2, A3 >, gtsam::internal::BinaryExpression< T, A1, A2 >, gtsam::internal::UnaryExpression< T, A1 >, and gtsam::internal::LeafExpression< T >.

Definition at line 95 of file ExpressionNode.h.

print()

template<class T >

virtual void gtsam::internal::ExpressionNode< T >::print ( const std::string &  indent = "" ) const

pure virtual

Print.

Implemented in gtsam::internal::BinarySumNode< T >, gtsam::internal::ScalarMultiplyNode< T >, gtsam::internal::TernaryExpression< T, A1, A2, A3 >, gtsam::internal::BinaryExpression< T, A1, A2 >, gtsam::internal::UnaryExpression< T, A1 >, gtsam::internal::LeafExpression< T >, and gtsam::internal::ConstantExpression< T >.

traceExecution()

template<class T >

virtual T gtsam::internal::ExpressionNode< T >::traceExecution ( const Values &  values, ExecutionTrace< T > &  trace, char *  traceStorage  ) const

pure virtual

Construct an execution trace for reverse AD.

Implemented in gtsam::internal::LeafExpression< T >, gtsam::internal::ConstantExpression< T >, gtsam::internal::BinarySumNode< T >, gtsam::internal::ScalarMultiplyNode< T >, gtsam::internal::TernaryExpression< T, A1, A2, A3 >, gtsam::internal::BinaryExpression< T, A1, A2 >, and gtsam::internal::UnaryExpression< T, A1 >.

traceSize()

template<class T >

size_t gtsam::internal::ExpressionNode< T >::traceSize ( ) const

inline

Definition at line 105 of file ExpressionNode.h.

value()

template<class T >

virtual T gtsam::internal::ExpressionNode< T >::value ( const Values &  values ) const

pure virtual

Return value.

Implemented in gtsam::internal::BinarySumNode< T >, gtsam::internal::ScalarMultiplyNode< T >, gtsam::internal::TernaryExpression< T, A1, A2, A3 >, gtsam::internal::BinaryExpression< T, A1, A2 >, gtsam::internal::UnaryExpression< T, A1 >, gtsam::internal::LeafExpression< T >, and gtsam::internal::ConstantExpression< T >.

Friends And Related Function Documentation

operator<<

template<class T >

GTSAM_EXPORT friend std::ostream& operator<< ( std::ostream &  os, const ExpressionNode< T > &  node  )

friend

Streaming.

Definition at line 87 of file ExpressionNode.h.

Member Data Documentation

traceSize_

template<class T >

size_t gtsam::internal::ExpressionNode< T >::traceSize_

protected

Definition at line 69 of file ExpressionNode.h.

---

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

• Expression.h
• ExpressionNode.h