FormulaGeq Class Reference

Detailed Description

Symbolic formula representing 'greater-than-or-equal-to' (e1 ≥ e2).

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

Public Member Functions
	FormulaGeq (const Expression &e1, const Expression &e2)
	Constructs from e1 and e2.
	~FormulaGeq () override
bool	Evaluate (const Environment &env) const override
	Evaluates under a given environment.
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.
std::ostream &	Display (std::ostream &os) const override
	Outputs string representation of formula into output stream os.
Public Member Functions inherited from RelationalFormulaCell
	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.
	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

FormulaGeq()

FormulaGeq	(	const Expression &	e1,
		const Expression &	e2 )

Constructs from e1 and e2.

~FormulaGeq()

~FormulaGeq ( )

override

Member Function Documentation

Display()

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

overridevirtual

Outputs string representation of formula into output stream os.

Implements FormulaCell.

Evaluate()

bool Evaluate ( const Environment & env ) const

nodiscardoverridevirtual

Evaluates under a given environment.

Implements FormulaCell.

Substitute()

Formula Substitute ( const Substitution & s ) const

nodiscardoverridevirtual

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.

---

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

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