RelationalFormulaCell Class Reference

Detailed Description

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

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

Public Member Functions
	RelationalFormulaCell ()=delete
	Default constructor (deleted).
	RelationalFormulaCell (RelationalFormulaCell &&f)=default
	Move-construct a formula from an rvalue.
	RelationalFormulaCell (const RelationalFormulaCell &f)=default
	Copy-construct a formula from an lvalue.
RelationalFormulaCell &	operator= (RelationalFormulaCell &&f)=delete
	Move-assign (DELETED).
RelationalFormulaCell &	operator= (const RelationalFormulaCell &f)=delete
	Copy-assign (DELETED).
	RelationalFormulaCell (FormulaKind k, Expression lhs, Expression rhs)
	Construct RelationalFormulaCell of kind k with lhs and rhs.
	~RelationalFormulaCell () override
void	HashAppendDetail (DelegatingHasher *) const override
	Sends all hash-relevant bytes for this FormulaCell type into the given hasher, per the hash_append generic hashing concept – except for get_kind(), because Formula already sends that.
Variables	GetFreeVariables () const override
	Returns set of free variables in formula.
bool	EqualTo (const FormulaCell &f) const override
	Checks structural equality.
bool	Less (const FormulaCell &f) const override
	Checks ordering.
const Expression &	get_lhs_expression () const
	Returns the expression on left-hand-side.
const Expression &	get_rhs_expression () const
	Returns the expression on right-hand-side.
Public Member Functions inherited from FormulaCell
FormulaKind	get_kind () const
	Returns kind of formula.
virtual bool	Evaluate (const Environment &env) const =0
	Evaluates under a given environment.
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.
virtual std::ostream &	Display (std::ostream &os) const =0
	Outputs string representation of formula into output stream os.
	FormulaCell ()=delete
	Default constructor (deleted).
FormulaCell &	operator= (FormulaCell &&f)=delete
	Move-assign (deleted).
FormulaCell &	operator= (const FormulaCell &f)=delete
	Copy-assign (deleted).

Additional Inherited Members
Protected Member Functions inherited from FormulaCell
	FormulaCell (FormulaCell &&f)=default
	Move-construct a formula from an rvalue.
	FormulaCell (const FormulaCell &f)=default
	Copy-construct a formula from an lvalue.
	FormulaCell (FormulaKind k)
	Construct FormulaCell of kind k.
virtual	~FormulaCell ()
	Default destructor.

Constructor & Destructor Documentation

RelationalFormulaCell() [1/4]

RelationalFormulaCell ( )

delete

Default constructor (deleted).

RelationalFormulaCell() [2/4]

RelationalFormulaCell ( RelationalFormulaCell && f )

default

Move-construct a formula from an rvalue.

RelationalFormulaCell() [3/4]

RelationalFormulaCell ( const RelationalFormulaCell & f )

default

Copy-construct a formula from an lvalue.

RelationalFormulaCell() [4/4]

RelationalFormulaCell	(	FormulaKind	k,
		Expression	lhs,
		Expression	rhs )

Construct RelationalFormulaCell of kind k with lhs and rhs.

~RelationalFormulaCell()

~RelationalFormulaCell ( )

override

Member Function Documentation

EqualTo()

bool EqualTo ( const FormulaCell & c ) const

nodiscardoverridevirtual

Checks structural equality.

Implements FormulaCell.

get_lhs_expression()

const Expression & get_lhs_expression ( ) const

nodiscard

Returns the expression on left-hand-side.

get_rhs_expression()

const Expression & get_rhs_expression ( ) const

nodiscard

Returns the expression on right-hand-side.

GetFreeVariables()

Variables GetFreeVariables ( ) const

nodiscardoverridevirtual

Returns set of free variables in formula.

Implements FormulaCell.

HashAppendDetail()

void HashAppendDetail ( DelegatingHasher * ) const

overridevirtual

Sends all hash-relevant bytes for this FormulaCell type into the given hasher, per the hash_append generic hashing concept – except for get_kind(), because Formula already sends that.

Implements FormulaCell.

Less()

bool Less ( const FormulaCell & c ) const

nodiscardoverridevirtual

Checks ordering.

Implements FormulaCell.

operator=() [1/2]

RelationalFormulaCell & operator= ( const RelationalFormulaCell & f )

delete

Copy-assign (DELETED).

operator=() [2/2]

RelationalFormulaCell & operator= ( RelationalFormulaCell && f )

delete

Move-assign (DELETED).

---

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

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