org.cryptimeleon.math.expressions.bool

Interface BooleanExpression

All Superinterfaces:

Expression

All Known Subinterfaces:

BoolVariableExpr

All Known Implementing Classes:

BasicNamedBoolVariableExpr, BoolAndExpr, BoolConstantExpr, BoolEmptyExpr, BoolNotExpr, BoolOrExpr, ExponentEqualityExpr, GroupEqualityExpr

public interface BooleanExpression
extends Expression

An Expression that evaluates to a Boolean.

Field Summary

Fields

Modifier and Type	Field and Description
static BoolConstantExpr	FALSE
static BoolConstantExpr	TRUE

Method Summary

Modifier and Type	Method and Description
default BooleanExpression	and(BooleanExpression rhs) Applies a Boolean AND to this and the given Boolean expression.
default java.lang.Boolean	evaluate() Evaluates the expression.
java.lang.Boolean	evaluate(Substitution substitutions) Evaluates the expression after substituting contained variables.
default LazyBoolEvaluationResult	evaluateLazy() Evaluates the result of this expression concurrently in the background.
LazyBoolEvaluationResult	evaluateLazy(Substitution substitutions) Evaluates the result of this expression (with the given substitutions) concurrently in the background.
default BooleanExpression	not() Applies a Boolean NOT to this Boolean expression.
default BooleanExpression	or(BooleanExpression rhs) Applies a Boolean OR to this and the given Boolean expression.
default BooleanExpression	substitute(java.lang.String variable, Expression substitution)
BooleanExpression	substitute(Substitution substitutions) Substitutes variables using the given function.
default BooleanExpression	substitute(VariableExpression variable, Expression substitution) Substitutes a specific variable with the given expression.
static BooleanExpression	valueOf(boolean bool)

Methods inherited from interface org.cryptimeleon.math.expressions.Expression

accumulate, containsExprMatchingPredicate, containsVariables, forEachChild, getVariables, treeWalk

Field Detail

TRUE

static final BoolConstantExpr TRUE

FALSE

static final BoolConstantExpr FALSE

Method Detail

substitute

BooleanExpression substitute(Substitution substitutions)

Description copied from interface: Expression

Substitutes variables using the given function.

Specified by:

substitute in interface Expression

Parameters:

substitutions - a function mapping variable expressions to their replacement expressions

Returns:

the expression after substitution

substitute

default BooleanExpression substitute(java.lang.String variable,
                                     Expression substitution)

Specified by:

substitute in interface Expression

substitute

default BooleanExpression substitute(VariableExpression variable,
                                     Expression substitution)

Description copied from interface: Expression

Substitutes a specific variable with the given expression.

Specified by:

substitute in interface Expression

Parameters:

variable - the variable to replace

substitution - the expression to substitute

Returns:

the expression after substitution

evaluate

default java.lang.Boolean evaluate()

Description copied from interface: Expression

Evaluates the expression.

Specified by:

evaluate in interface Expression

Returns:

the result of evaluation

evaluate

java.lang.Boolean evaluate(Substitution substitutions)

Description copied from interface: Expression

Evaluates the expression after substituting contained variables.

Specified by:

evaluate in interface Expression

Parameters:

substitutions - a function mapping variables to expressions that can be evaluated

Returns:

the result of evaluation

evaluateLazy

LazyBoolEvaluationResult evaluateLazy(Substitution substitutions)

Evaluates the result of this expression (with the given substitutions) concurrently in the background.
The result can be retrieved by calling getResult() on the return value.

evaluateLazy

default LazyBoolEvaluationResult evaluateLazy()

Evaluates the result of this expression concurrently in the background. Result can be retrieved by calling getResult() on the return value.
Use this for (potentially) more computationally expensive expressions.

and

default BooleanExpression and(BooleanExpression rhs)

Applies a Boolean AND to this and the given Boolean expression.

Returns:

a new Boolean expression representing the Boolean AND of this and the given Boolean expression

or

default BooleanExpression or(BooleanExpression rhs)

Applies a Boolean OR to this and the given Boolean expression.

Returns:

a new Boolean expression representing the Boolean OR of this and the given Boolean expression

not

default BooleanExpression not()

Applies a Boolean NOT to this Boolean expression.

Returns:

a new Boolean expression representing the Boolean NOT of this Boolean expression.

valueOf

static BooleanExpression valueOf(boolean bool)