Drake
FormulaEq Class Reference

Symbolic formula representing equality (e1 = e2). More...

#include <drake/common/symbolic_formula_cell.h>

Inheritance diagram for FormulaEq:
[legend]
Collaboration diagram for FormulaEq:
[legend]

Public Member Functions

 FormulaEq (const Expression &e1, const Expression &e2)
 Constructs from e1 and e2. More...
 
bool Evaluate (const Environment &env) const override
 Evaluates under a given environment. More...
 
Formula Substitute (const Substitution &s) const override
 Returns a Formula obtained by replacing all occurrences of the variables in s in the current formula cell with the corresponding expressions in s. More...
 
std::ostream & Display (std::ostream &os) const override
 Outputs string representation of formula into output stream os. More...
 
- Public Member Functions inherited from RelationalFormulaCell
 RelationalFormulaCell ()=delete
 Default constructor (deleted). More...
 
 RelationalFormulaCell (RelationalFormulaCell &&f)=default
 Move-construct a formula from an rvalue. More...
 
 RelationalFormulaCell (const RelationalFormulaCell &f)=default
 Copy-construct a formula from an lvalue. More...
 
RelationalFormulaCelloperator= (RelationalFormulaCell &&f)=delete
 Move-assign (DELETED). More...
 
RelationalFormulaCelloperator= (const RelationalFormulaCell &f)=delete
 Copy-assign (DELETED). More...
 
 RelationalFormulaCell (FormulaKind k, const Expression &lhs, const Expression &rhs)
 Construct RelationalFormulaCell of kind k with lhs and rhs. More...
 
Variables GetFreeVariables () const override
 Returns set of free variables in formula. More...
 
bool EqualTo (const FormulaCell &f) const override
 Checks structural equality. More...
 
bool Less (const FormulaCell &f) const override
 Checks ordering. More...
 
const Expressionget_lhs_expression () const
 Returns the expression on left-hand-side. More...
 
const Expressionget_rhs_expression () const
 Returns the expression on right-hand-side. More...
 
- Public Member Functions inherited from FormulaCell
FormulaKind get_kind () const
 Returns kind of formula. More...
 
size_t get_hash () const
 Returns hash of formula. More...
 

Additional Inherited Members

- Protected Member Functions inherited from FormulaCell
 FormulaCell ()=delete
 Default constructor (deleted). More...
 
 FormulaCell (FormulaCell &&f)=default
 Move-construct a formula from an rvalue. More...
 
 FormulaCell (const FormulaCell &f)=default
 Copy-construct a formula from an lvalue. More...
 
FormulaCelloperator= (FormulaCell &&f)=delete
 Move-assign (DELETED). More...
 
FormulaCelloperator= (const FormulaCell &f)=delete
 Copy-assign (DELETED). More...
 
 FormulaCell (FormulaKind k, size_t hash)
 Construct FormulaCell of kind k with hash. More...
 
virtual ~FormulaCell ()=default
 Default destructor. More...
 

Detailed Description

Symbolic formula representing equality (e1 = e2).

Constructor & Destructor Documentation

FormulaEq ( const Expression e1,
const Expression e2 
)

Constructs from e1 and e2.

Here is the call graph for this function:

Member Function Documentation

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

Outputs string representation of formula into output stream os.

Implements FormulaCell.

Here is the call graph for this function:

bool Evaluate ( const Environment env) const
overridevirtual

Evaluates under a given environment.

Implements FormulaCell.

Here is the call graph for this function:

Formula Substitute ( const Substitution s) const
overridevirtual

Returns a Formula obtained by replacing all occurrences of the variables in s in the current formula cell with the corresponding expressions in s.

Implements FormulaCell.

Here is the call graph for this function:


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