ProvSQL C/C++ API
Adding support for provenance and uncertainty management to PostgreSQL databases
Loading...
Searching...
No Matches
semiring::BoolExpr Class Reference

Provenance-as-Boolean-circuit semiring. More...

#include "BoolExpr.h"

Inheritance diagram for semiring::BoolExpr:
Collaboration diagram for semiring::BoolExpr:

Public Member Functions

 BoolExpr (BooleanCircuit &bc)
 Construct a BoolExpr semiring over the given circuit.
 
value_type zero () const override
 Return the additive identity \(\mathbb{0}\).
 
value_type one () const override
 Return the multiplicative identity \(\mathbb{1}\).
 
value_type plus (const std::vector< value_type > &vec) const override
 Apply the additive operation to a list of values.
 
value_type times (const std::vector< value_type > &vec) const override
 Apply the multiplicative operation to a list of values.
 
virtual value_type monus (value_type x, value_type y) const override
 Apply the monus (m-semiring difference) operation.
 
value_type delta (value_type x) const override
 Apply the \(\delta\) operator.
 
virtual bool absorptive () const override
 Return true if this semiring is absorptive ( \(a \oplus a = a\)).
 
- Public Member Functions inherited from semiring::Semiring< gate_t >
virtual value_type cmp (value_type s1, ComparisonOperator op, value_type s2) const
 Evaluate a comparison gate.
 
virtual value_type semimod (value_type x, value_type s) const
 Apply a semimodule scalar multiplication.
 
virtual value_type agg (AggregationOperator op, const std::vector< value_type > &s)
 Evaluate an aggregation gate.
 
virtual value_type value (const std::string &s) const
 Interpret a literal string as a semiring value.
 
virtual ~Semiring ()=default
 

Private Types

using value_t = gate_t
 Carrier type: a gate ID in the target BooleanCircuit.
 

Private Attributes

BooleanCircuitc
 The Boolean circuit being constructed.
 
const gate_t ZERO
 Pre-allocated zero gate (OR with no children)
 
const gate_t ONE
 Pre-allocated one gate (AND with no children)
 

Additional Inherited Members

- Public Types inherited from semiring::Semiring< gate_t >
typedef gate_t value_type
 The carrier type of this semiring.
 

Detailed Description

Provenance-as-Boolean-circuit semiring.

The carrier type is gate_t (a gate identifier in BooleanCircuit). Evaluating the provenance circuit over this semiring constructs a new Boolean circuit expressing the provenance formula.

Definition at line 42 of file BoolExpr.h.

Member Typedef Documentation

◆ value_t

Carrier type: a gate ID in the target BooleanCircuit.

Definition at line 43 of file BoolExpr.h.

Constructor & Destructor Documentation

◆ BoolExpr()

semiring::BoolExpr::BoolExpr ( BooleanCircuit bc)
inline

Construct a BoolExpr semiring over the given circuit.

Parameters
bcThe Boolean circuit in which semiring operations create new gates.

Definition at line 54 of file BoolExpr.h.

Member Function Documentation

◆ absorptive()

virtual bool semiring::BoolExpr::absorptive ( ) const
inlineoverridevirtual

Return true if this semiring is absorptive ( \(a \oplus a = a\)).

When true, the circuit evaluator may deduplicate the children of plus gates, which can improve performance significantly for semirings such as Boolean and Why-provenance.

Returns
false by default; override to return true.

Reimplemented from semiring::Semiring< gate_t >.

Definition at line 115 of file BoolExpr.h.

◆ delta()

value_type semiring::BoolExpr::delta ( value_type  x) const
inlineoverridevirtual

Apply the \(\delta\) operator.

Parameters
xInput value.
Returns
\(\delta(x)\).

Implements semiring::Semiring< gate_t >.

Definition at line 111 of file BoolExpr.h.

◆ monus()

virtual value_type semiring::BoolExpr::monus ( value_type  x,
value_type  y 
) const
inlineoverridevirtual

Apply the monus (m-semiring difference) operation.

Parameters
xMinuend.
ySubtrahend.
Returns
\(x \ominus y\).

Implements semiring::Semiring< gate_t >.

Definition at line 97 of file BoolExpr.h.

Here is the call graph for this function:

◆ one()

value_type semiring::BoolExpr::one ( ) const
inlineoverridevirtual

Return the multiplicative identity \(\mathbb{1}\).

Returns
The one element of the semiring.

Implements semiring::Semiring< gate_t >.

Definition at line 61 of file BoolExpr.h.

◆ plus()

value_type semiring::BoolExpr::plus ( const std::vector< value_type > &  v) const
inlineoverridevirtual

Apply the additive operation to a list of values.

Parameters
vOrdered list of operands (empty list should return zero()).
Returns
\(v_0 \oplus v_1 \oplus \cdots\).

Implements semiring::Semiring< gate_t >.

Definition at line 65 of file BoolExpr.h.

Here is the call graph for this function:

◆ times()

value_type semiring::BoolExpr::times ( const std::vector< value_type > &  v) const
inlineoverridevirtual

Apply the multiplicative operation to a list of values.

Parameters
vOrdered list of operands (empty list should return one()).
Returns
\(v_0 \otimes v_1 \otimes \cdots\).

Implements semiring::Semiring< gate_t >.

Definition at line 81 of file BoolExpr.h.

Here is the call graph for this function:

◆ zero()

value_type semiring::BoolExpr::zero ( ) const
inlineoverridevirtual

Return the additive identity \(\mathbb{0}\).

Returns
The zero element of the semiring.

Implements semiring::Semiring< gate_t >.

Definition at line 57 of file BoolExpr.h.

Member Data Documentation

◆ c

BooleanCircuit& semiring::BoolExpr::c
private

The Boolean circuit being constructed.

Definition at line 45 of file BoolExpr.h.

◆ ONE

const gate_t semiring::BoolExpr::ONE
private

Pre-allocated one gate (AND with no children)

Definition at line 47 of file BoolExpr.h.

◆ ZERO

const gate_t semiring::BoolExpr::ZERO
private

Pre-allocated zero gate (OR with no children)

Definition at line 46 of file BoolExpr.h.


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