Drake
RelationalFormulaCell Class Reference

Represents the base class for relational operators (==, !=, <, <=, >, >=). More...

#include <drake/common/symbolic_formula_cell.h>

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

Public Member Functions

 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...
 
virtual bool Evaluate (const Environment &env) const =0
 Evaluates under a given environment. More...
 
virtual Formula Substitute (const Substitution &s) const =0
 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...
 
virtual std::ostream & Display (std::ostream &os) const =0
 Outputs string representation of formula into output stream os. 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

Represents the base class for relational operators (==, !=, <, <=, >, >=).

Constructor & Destructor Documentation

Default constructor (deleted).

Move-construct a formula from an rvalue.

Copy-construct a formula from an lvalue.

RelationalFormulaCell ( FormulaKind  k,
const Expression lhs,
const Expression rhs 
)

Construct RelationalFormulaCell of kind k with lhs and rhs.

Here is the call graph for this function:

Member Function Documentation

bool EqualTo ( const FormulaCell c) const
overridevirtual

Checks structural equality.

Implements FormulaCell.

Here is the call graph for this function:

const Expression& get_lhs_expression ( ) const
inline

Returns the expression on left-hand-side.

Here is the caller graph for this function:

const Expression& get_rhs_expression ( ) const
inline

Returns the expression on right-hand-side.

Here is the caller graph for this function:

Variables GetFreeVariables ( ) const
overridevirtual

Returns set of free variables in formula.

Implements FormulaCell.

Here is the call graph for this function:

bool Less ( const FormulaCell c) const
overridevirtual

Checks ordering.

Implements FormulaCell.

Here is the call graph for this function:

RelationalFormulaCell& operator= ( RelationalFormulaCell &&  f)
delete

Move-assign (DELETED).

RelationalFormulaCell& operator= ( const RelationalFormulaCell f)
delete

Copy-assign (DELETED).


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