Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
gtsam::internal::BinaryExpression< T, A1, A2 > Class Template Reference

Binary Expression. More...

#include <ExpressionNode.h>

Inheritance diagram for gtsam::internal::BinaryExpression< T, A1, A2 >:
Inheritance graph
[legend]

Classes

struct  Record
 

Public Member Functions

void dims (std::map< Key, int > &map) const override
 Return dimensions for each argument. More...
 
std::set< Keykeys () const override
 Return keys that play in this expression. More...
 
void print (const std::string &indent="") const override
 Print. More...
 
T traceExecution (const Values &values, ExecutionTrace< T > &trace, char *ptr) const override
 Construct an execution trace for reverse AD, see UnaryExpression for explanation. More...
 
T value (const Values &values) const override
 Return value. More...
 
 ~BinaryExpression () override
 Destructor. More...
 
- Public Member Functions inherited from gtsam::internal::ExpressionNode< T >
size_t traceSize () const
 
virtual ~ExpressionNode ()
 Destructor. More...
 

Private Types

typedef Expression< T >::template BinaryFunction< A1, A2 >::type Function
 

Private Member Functions

 BinaryExpression (Function f, const Expression< A1 > &e1, const Expression< A2 > &e2)
 Constructor with a binary function f, and two input arguments. More...
 

Private Attributes

std::shared_ptr< ExpressionNode< A1 > > expression1_
 
std::shared_ptr< ExpressionNode< A2 > > expression2_
 
Function function_
 

Friends

class ::ExpressionFactorBinaryTest
 
class Expression< T >
 

Additional Inherited Members

- Protected Member Functions inherited from gtsam::internal::ExpressionNode< T >
 ExpressionNode (size_t traceSize=0)
 Constructor, traceSize is size of the execution trace of expression rooted here. More...
 
- Protected Attributes inherited from gtsam::internal::ExpressionNode< T >
size_t traceSize_
 

Detailed Description

template<class T, class A1, class A2>
class gtsam::internal::BinaryExpression< T, A1, A2 >

Binary Expression.

Definition at line 336 of file ExpressionNode.h.

Member Typedef Documentation

◆ Function

template<class T , class A1 , class A2 >
typedef Expression<T>::template BinaryFunction<A1, A2>::type gtsam::internal::BinaryExpression< T, A1, A2 >::Function
private

Definition at line 338 of file ExpressionNode.h.

Constructor & Destructor Documentation

◆ BinaryExpression()

template<class T , class A1 , class A2 >
gtsam::internal::BinaryExpression< T, A1, A2 >::BinaryExpression ( Function  f,
const Expression< A1 > &  e1,
const Expression< A2 > &  e2 
)
inlineprivate

Constructor with a binary function f, and two input arguments.

Definition at line 344 of file ExpressionNode.h.

◆ ~BinaryExpression()

template<class T , class A1 , class A2 >
gtsam::internal::BinaryExpression< T, A1, A2 >::~BinaryExpression ( )
inlineoverride

Destructor.

Definition at line 357 of file ExpressionNode.h.

Member Function Documentation

◆ dims()

template<class T , class A1 , class A2 >
void gtsam::internal::BinaryExpression< T, A1, A2 >::dims ( std::map< Key, int > &  map) const
inlineoverridevirtual

Return dimensions for each argument.

Reimplemented from gtsam::internal::ExpressionNode< T >.

Definition at line 383 of file ExpressionNode.h.

◆ keys()

template<class T , class A1 , class A2 >
std::set<Key> gtsam::internal::BinaryExpression< T, A1, A2 >::keys ( ) const
inlineoverridevirtual

Return keys that play in this expression.

Reimplemented from gtsam::internal::ExpressionNode< T >.

Definition at line 375 of file ExpressionNode.h.

◆ print()

template<class T , class A1 , class A2 >
void gtsam::internal::BinaryExpression< T, A1, A2 >::print ( const std::string &  indent = "") const
inlineoverridevirtual

Print.

Implements gtsam::internal::ExpressionNode< T >.

Definition at line 361 of file ExpressionNode.h.

◆ traceExecution()

template<class T , class A1 , class A2 >
T gtsam::internal::BinaryExpression< T, A1, A2 >::traceExecution ( const Values values,
ExecutionTrace< T > &  trace,
char *  ptr 
) const
inlineoverridevirtual

Construct an execution trace for reverse AD, see UnaryExpression for explanation.

Implements gtsam::internal::ExpressionNode< T >.

Definition at line 430 of file ExpressionNode.h.

◆ value()

template<class T , class A1 , class A2 >
T gtsam::internal::BinaryExpression< T, A1, A2 >::value ( const Values values) const
inlineoverridevirtual

Return value.

Implements gtsam::internal::ExpressionNode< T >.

Definition at line 368 of file ExpressionNode.h.

Friends And Related Function Documentation

◆ ::ExpressionFactorBinaryTest

template<class T , class A1 , class A2 >
friend class ::ExpressionFactorBinaryTest
friend

Definition at line 352 of file ExpressionNode.h.

◆ Expression< T >

template<class T , class A1 , class A2 >
friend class Expression< T >
friend

Definition at line 351 of file ExpressionNode.h.

Member Data Documentation

◆ expression1_

template<class T , class A1 , class A2 >
std::shared_ptr<ExpressionNode<A1> > gtsam::internal::BinaryExpression< T, A1, A2 >::expression1_
private

Definition at line 339 of file ExpressionNode.h.

◆ expression2_

template<class T , class A1 , class A2 >
std::shared_ptr<ExpressionNode<A2> > gtsam::internal::BinaryExpression< T, A1, A2 >::expression2_
private

Definition at line 340 of file ExpressionNode.h.

◆ function_

template<class T , class A1 , class A2 >
Function gtsam::internal::BinaryExpression< T, A1, A2 >::function_
private

Definition at line 341 of file ExpressionNode.h.


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


gtsam
Author(s):
autogenerated on Sun Dec 22 2024 04:24:51