ExpressionNaN Class Reference

Detailed Description

Symbolic expression representing NaN (not-a-number).

#include <drake/common/symbolic_expression_cell.h>

Public Member Functions
	ExpressionNaN ()
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...
Expression	Expand () const override
	Expands out products and positive integer powers in expression. 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 ExpressionCell
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 &	operator= (ExpressionCell &&e)=delete
	Move-assigns (DELETED). More...
ExpressionCell &	operator= (const ExpressionCell &e)=delete
	Copy-assigns (DELETED). More...

Additional Inherited Members
Protected Member Functions inherited from ExpressionCell
	ExpressionCell ()=default
	Default constructor. More...
	ExpressionCell (ExpressionCell &&e)=default
	Move-constructs an ExpressionCell from an rvalue. More...
	ExpressionCell (const ExpressionCell &e)=default
	Copy-constructs an ExpressionCell from an lvalue. More...
	ExpressionCell (ExpressionKind k, bool is_poly, bool is_expanded)
	Constructs ExpressionCell of kind k with is_poly and is_expanded. More...
virtual	~ExpressionCell ()=default
	Default destructor. More...

Constructor & Destructor Documentation

ExpressionNaN()

ExpressionNaN

(

)

Member Function Documentation

Differentiate()

Expression Differentiate ( const Variable &  x ) const

overridevirtual

Differentiates this symbolic expression with respect to the variable var.

Exceptions

std::runtime_error

if 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.

EqualTo()

bool EqualTo ( const ExpressionCell &  c ) const

overridevirtual

Checks structural equality.

Implements ExpressionCell.

Evaluate()

double Evaluate ( const Environment &  env ) const

overridevirtual

Evaluates under a given environment (by default, an empty environment).

Exceptions

std::runtime_error

if NaN is detected during evaluation.

Implements ExpressionCell.

Expand()

Expression Expand ( ) const

overridevirtual

Expands out products and positive integer powers in expression.

Exceptions

std::runtime_error

if NaN is detected during expansion.

Implements ExpressionCell.

GetVariables()

Variables GetVariables ( ) const

overridevirtual

Collects variables in expression.

Implements ExpressionCell.

HashAppendDetail()

void HashAppendDetail ( DelegatingHasher *  ) const

overridevirtual

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.

Implements ExpressionCell.

Less()

bool Less ( const ExpressionCell &  c ) const

overridevirtual

Provides lexicographical ordering between expressions.

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::runtime_error

if NaN is detected during substitution.

Implements ExpressionCell.

---

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

• drake/common/symbolic_expression_cell.h