Drake
Drake C++ Documentation
FormulaAnd Class Reference

Detailed Description

Symbolic formula representing conjunctions (f1 ∧ ...

∧ fn).

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

Public Member Functions

 FormulaAnd (const std::set< Formula > &formulas)
 Constructs from formulas. More...
 
 FormulaAnd (const Formula &f1, const Formula &f2)
 Constructs f1f2. More...
 
 ~FormulaAnd () override
 
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 NaryFormulaCell
 NaryFormulaCell ()=delete
 Default constructor (deleted). More...
 
 NaryFormulaCell (NaryFormulaCell &&f)=default
 Move-construct a formula from an rvalue. More...
 
 NaryFormulaCell (const NaryFormulaCell &f)=default
 Copy-construct a formula from an lvalue. More...
 
NaryFormulaCelloperator= (NaryFormulaCell &&f)=delete
 Move-assign (DELETED). More...
 
NaryFormulaCelloperator= (const NaryFormulaCell &f)=delete
 Copy-assign (DELETED). More...
 
 NaryFormulaCell (FormulaKind k, std::set< Formula > formulas)
 Construct NaryFormulaCell of kind k with formulas. More...
 
 ~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. 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 std::set< Formula > & get_operands () const
 Returns the formulas. More...
 
- Public Member Functions inherited from FormulaCell
FormulaKind get_kind () const
 Returns kind of formula. More...
 
 FormulaCell ()=delete
 Default constructor (deleted). More...
 
FormulaCelloperator= (FormulaCell &&f)=delete
 Move-assign (deleted). More...
 
FormulaCelloperator= (const FormulaCell &f)=delete
 Copy-assign (deleted). More...
 

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. 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

◆ FormulaAnd() [1/2]

FormulaAnd ( const std::set< Formula > &  formulas)
explicit

Constructs from formulas.

◆ FormulaAnd() [2/2]

FormulaAnd ( const Formula f1,
const Formula f2 
)

Constructs f1f2.

◆ ~FormulaAnd()

~FormulaAnd ( )
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
overridevirtual

Evaluates under a given environment.

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: