Drake
ExpressionMulFactory Class Reference

Detailed Description

Factory class to help build ExpressionMul expressions.

#include <drake/common/symbolic_expression_cell.h>

Public Member Functions

 ExpressionMulFactory ()=default
 Default constructor. More...
 
 ExpressionMulFactory (double constant, std::map< Expression, Expression > base_to_exponent_map)
 Constructs ExpressionMulFactory with constant and base_to_exponent_map. More...
 
 ExpressionMulFactory (const ExpressionMul &mul)
 Constructs ExpressionMulFactory from mul. More...
 
void AddExpression (const Expression &e)
 Adds e to this factory. More...
 
void Add (const ExpressionMul &ptr)
 Adds ExpressionMul pointed by ptr to this factory. More...
 
ExpressionMulFactoryoperator= (const ExpressionMul &ptr)
 Assigns a factory from an ExpressionMul. More...
 
ExpressionMulFactoryNegate ()
 Negates the expressions in factory. More...
 
Expression GetExpression () const
 Returns a symbolic expression. More...
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 ExpressionMulFactory (const ExpressionMulFactory &)=default
 
ExpressionMulFactoryoperator= (const ExpressionMulFactory &)=default
 
 ExpressionMulFactory (ExpressionMulFactory &&)=default
 
ExpressionMulFactoryoperator= (ExpressionMulFactory &&)=default
 

Constructor & Destructor Documentation

◆ ExpressionMulFactory() [1/5]

◆ ExpressionMulFactory() [2/5]

◆ ExpressionMulFactory() [3/5]

ExpressionMulFactory ( )
default

Default constructor.

◆ ExpressionMulFactory() [4/5]

ExpressionMulFactory ( double  constant,
std::map< Expression, Expression base_to_exponent_map 
)

Constructs ExpressionMulFactory with constant and base_to_exponent_map.

◆ ExpressionMulFactory() [5/5]

ExpressionMulFactory ( const ExpressionMul mul)
explicit

Constructs ExpressionMulFactory from mul.

Member Function Documentation

◆ Add()

void Add ( const ExpressionMul ptr)

Adds ExpressionMul pointed by ptr to this factory.

◆ AddExpression()

void AddExpression ( const Expression e)

Adds e to this factory.

◆ GetExpression()

Expression GetExpression ( ) const

Returns a symbolic expression.

◆ Negate()

ExpressionMulFactory& Negate ( )

Negates the expressions in factory.

If it represents c0 * p1 * ... * pn, this method flips it into -c0 * p1 * ... * pn.

Returns
*this.

◆ operator=() [1/3]

ExpressionMulFactory& operator= ( ExpressionMulFactory &&  )
default

◆ operator=() [2/3]

ExpressionMulFactory& operator= ( const ExpressionMulFactory )
default

◆ operator=() [3/3]

ExpressionMulFactory& operator= ( const ExpressionMul ptr)

Assigns a factory from an ExpressionMul.


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