ExpressionMulFactory Class Reference

Detailed Description

Factory class to help build ExpressionMul expressions.

#include <drake/common/symbolic/expression/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 Expression-valued base_to_exponent_map. More...
	ExpressionMulFactory (const std::map< Variable, int > &base_to_exponent_map)
	Constructs ExpressionMulFactory with a Monomial-like (Variable to integer power) 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...
ExpressionMulFactory &	operator= (const ExpressionMul &ptr)
	Assigns a factory from an ExpressionMul. More...
ExpressionMulFactory &&	Negate () &&
	Negates the expressions in factory. More...
Expression	GetExpression () &&
	Returns a symbolic expression. More...
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
	ExpressionMulFactory (const ExpressionMulFactory &)=default
ExpressionMulFactory &	operator= (const ExpressionMulFactory &)=default
	ExpressionMulFactory (ExpressionMulFactory &&)=default
ExpressionMulFactory &	operator= (ExpressionMulFactory &&)=default

Constructor & Destructor Documentation

ExpressionMulFactory() [1/6]

ExpressionMulFactory ( const ExpressionMulFactory &  )

default

ExpressionMulFactory() [2/6]

ExpressionMulFactory ( ExpressionMulFactory &&  )

default

ExpressionMulFactory() [3/6]

ExpressionMulFactory ( )

default

Default constructor.

ExpressionMulFactory() [4/6]

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

Constructs ExpressionMulFactory with constant and Expression-valued base_to_exponent_map.

Note that this constructor runs in constant-time because it moves the map into storage; it does not loop over the map.

ExpressionMulFactory() [5/6]

ExpressionMulFactory ( const std::map< Variable, int > &  base_to_exponent_map )

explicit

Constructs ExpressionMulFactory with a Monomial-like (Variable to integer power) base_to_exponent_map.

ExpressionMulFactory() [6/6]

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

(

)

&&

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:

• drake/common/symbolic/expression/expression_cell.h