FormulaOr Class Reference

Detailed Description

Symbolic formula representing disjunctions (f1 ∨ ... ∨ fn).

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

Public Member Functions
	FormulaOr (const std::set< Formula > &formulas)
	Constructs from formulas.
	FormulaOr (const Formula &f1, const Formula &f2)
	Constructs f1 ∨ f2.
	~FormulaOr () 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 NaryFormulaCell
	NaryFormulaCell ()=delete
	Default constructor (deleted).
	NaryFormulaCell (NaryFormulaCell &&f)=default
	Move-construct a formula from an rvalue.
	NaryFormulaCell (const NaryFormulaCell &f)=default
	Copy-construct a formula from an lvalue.
NaryFormulaCell &	operator= (NaryFormulaCell &&f)=delete
	Move-assign (DELETED).
NaryFormulaCell &	operator= (const NaryFormulaCell &f)=delete
	Copy-assign (DELETED).
	NaryFormulaCell (FormulaKind k, std::set< Formula > formulas)
	Construct NaryFormulaCell of kind k with formulas.
	~NaryFormulaCell () 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 std::set< Formula > &	get_operands () const
	Returns the formulas.
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 NaryFormulaCell
std::ostream &	DisplayWithOp (std::ostream &os, const std::string &op) const
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

FormulaOr() [1/2]

FormulaOr ( const std::set< Formula > & formulas )

explicit

Constructs from formulas.

FormulaOr() [2/2]

FormulaOr	(	const Formula &	f1,
		const Formula &	f2 )

Constructs f1 ∨ f2.

~FormulaOr()

~FormulaOr ( )

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