Drake
Drake C++ Documentation
ExpressionAbs Class Reference

Detailed Description

Symbolic expression representing absolute value function.

#include <drake/common/symbolic/expression/expression_cell.h>

Public Member Functions

 ExpressionAbs (const Expression &e)
 
Expression Expand () const override
 Expands out products and positive integer powers in expression. More...
 
Expression EvaluatePartial (const Environment &env) const override
 Returns an Expression obtained by replacing all occurrences of the variables in env in the current expression cell with the corresponding values in env. More...
 
Expression Substitute (const Substitution &s) const override
 Returns an Expression obtained by replacing all occurrences of the variables in s in the current expression cell with the corresponding expressions in s. More...
 
Expression Differentiate (const Variable &x) const override
 Differentiates this symbolic expression with respect to the variable var. More...
 
std::ostream & Display (std::ostream &os) const override
 Outputs string representation of expression into output stream os. More...
 
- Public Member Functions inherited from UnaryExpressionCell
void HashAppendDetail (DelegatingHasher *) const override
 Sends all hash-relevant bytes for this ExpressionCell type into the given hasher, per the hash_append generic hashing concept – except for get_kind(), because Expression already sends that. More...
 
Variables GetVariables () const override
 Collects variables in expression. More...
 
bool EqualTo (const ExpressionCell &e) const override
 Checks structural equality. More...
 
bool Less (const ExpressionCell &e) const override
 Provides lexicographical ordering between expressions. More...
 
double Evaluate (const Environment &env) const override
 Evaluates under a given environment (by default, an empty environment). More...
 
const Expressionget_argument () const
 Returns the argument. More...
 
- Public Member Functions inherited from ExpressionCell
virtual ~ExpressionCell ()
 
std::atomic< int > & use_count () const
 Returns the intrusive use count (ala boost::intrusive_ptr). More...
 
ExpressionKind get_kind () const
 Returns expression kind. More...
 
bool is_polynomial () const
 Checks if this symbolic expression is convertible to Polynomial. More...
 
bool is_expanded () const
 Checks if this symbolic expression is already expanded. More...
 
void set_expanded ()
 Sets this symbolic expression as already expanded. More...
 
 ExpressionCell (const ExpressionCell &)=delete
 
ExpressionCelloperator= (const ExpressionCell &)=delete
 
 ExpressionCell (ExpressionCell &&)=delete
 
ExpressionCelloperator= (ExpressionCell &&)=delete
 

Friends

Expression abs (const Expression &e)
 

Additional Inherited Members

- Protected Member Functions inherited from UnaryExpressionCell
 UnaryExpressionCell (ExpressionKind k, Expression e, bool is_poly, bool is_expanded)
 Constructs UnaryExpressionCell of kind k with e, is_poly, and is_expanded. More...
 
- Protected Member Functions inherited from ExpressionCell
 ExpressionCell (ExpressionKind k, bool is_poly, bool is_expanded)
 Constructs ExpressionCell of kind k with is_poly and is_expanded, with a use_count of zero. More...
 

Constructor & Destructor Documentation

◆ ExpressionAbs()

ExpressionAbs ( const Expression e)
explicit

Member Function Documentation

◆ Differentiate()

Expression Differentiate ( const Variable x) const
overridevirtual

Differentiates this symbolic expression with respect to the variable var.

Exceptions
std::exceptionif it is not differentiable.

Implements ExpressionCell.

◆ Display()

std::ostream& Display ( std::ostream &  os) const
overridevirtual

Outputs string representation of expression into output stream os.

Implements ExpressionCell.

◆ EvaluatePartial()

Expression EvaluatePartial ( const Environment env) const
overridevirtual

Returns an Expression obtained by replacing all occurrences of the variables in env in the current expression cell with the corresponding values in env.

Exceptions
std::exceptionif NaN is detected during substitution.

Implements ExpressionCell.

◆ Expand()

Expression Expand ( ) const
overridevirtual

Expands out products and positive integer powers in expression.

Exceptions
std::exceptionif NaN is detected during expansion.

Implements ExpressionCell.

◆ Substitute()

Expression Substitute ( const Substitution s) const
overridevirtual

Returns an Expression obtained by replacing all occurrences of the variables in s in the current expression cell with the corresponding expressions in s.

Exceptions
std::exceptionif NaN is detected during substitution.

Implements ExpressionCell.

Friends And Related Function Documentation

◆ abs

Expression abs ( const Expression e)
friend

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