FormulaFalse Class Reference

Detailed Description

Symbolic formula representing false.

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

Public Member Functions
	FormulaFalse ()
	Default Constructor. More...
	~FormulaFalse () 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. 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...
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 FormulaCell
FormulaKind	get_kind () const
	Returns kind of formula. More...
	FormulaCell ()=delete
	Default constructor (deleted). More...
FormulaCell &	operator= (FormulaCell &&f)=delete
	Move-assign (deleted). More...
FormulaCell &	operator= (const FormulaCell &f)=delete
	Copy-assign (deleted). More...

Additional Inherited Members
Protected Member Functions inherited from FormulaCell
	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...
	FormulaCell (FormulaKind k)
	Construct FormulaCell of kind k. More...
virtual	~FormulaCell ()
	Default destructor. More...

Constructor & Destructor Documentation

FormulaFalse()

FormulaFalse

(

)

Default Constructor.

~FormulaFalse()

~FormulaFalse ( )

override

Member Function Documentation

Display()

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

overridevirtual

Outputs string representation of formula into output stream os.

Implements FormulaCell.

EqualTo()

bool EqualTo ( const FormulaCell &  c ) const

overridevirtual

Checks structural equality.

Implements FormulaCell.

Evaluate()

bool Evaluate ( const Environment &  env ) const

overridevirtual

Evaluates under a given environment.

Implements FormulaCell.

GetFreeVariables()

Variables GetFreeVariables ( ) const

overridevirtual

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

overridevirtual

Checks ordering.

Implements FormulaCell.

Substitute()

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.

---

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

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