ExponentExpr (math 1.0.0 API)

All Superinterfaces:

Expression

All Known Subinterfaces:

ExponentVariableExpr

All Known Implementing Classes:

BasicNamedExponentVariableExpr, ExponentConstantExpr, ExponentEmptyExpr, ExponentInvExpr, ExponentMulExpr, ExponentNegExpr, ExponentPowExpr, ExponentSumExpr
```
public interface ExponentExpr
extends Expression
```
An Expression that evaluates to an integer.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default ExponentExpr`	`add(ExponentExpr other)` Adds the given expression to this expression.
`default ExponentExpr`	`add(java.lang.String other)` Adds an `ExponentVariableExpr` with the given variable name to this expression.
`default ExponentExpr`	`add(Zn.ZnElement other)`
`java.math.BigInteger`	`evaluate()` Evaluates the expression.
`default java.math.BigInteger`	`evaluate(Substitution substitutions)` Evaluates the expression after substituting contained variables.
`Zn.ZnElement`	`evaluate(Zn zn)` Evaluates the expression in the given ring `Zn`.
`default Zn.ZnElement`	`evaluate(Zn zn, Substitution substitutions)` Evaluates this expression in the given `Zn` after substituting variables using the given substitutions.
`default ExponentExpr`	`invert()` Multiplicatively inverts this expression.
`default ExponentEqualityExpr`	`isEqualTo(java.math.BigInteger other)` Creates an `ExponentEqualityExpr` of this expression and the argument.
`default ExponentEqualityExpr`	`isEqualTo(ExponentExpr other)` Creates an `ExponentEqualityExpr` of this expression and the argument.
`default ExponentEqualityExpr`	`isEqualTo(Zn.ZnElement other)` Creates an `ExponentEqualityExpr` of this expression and the argument.
`ExponentSumExpr`	`linearize()` Returns an equivalent expression of the form `y + f(variables)`, where `y` is constant (no variables), and the expression `f` is linear.
`default ExponentExpr`	`mul(java.math.BigInteger other)` Multiplies this expression with the given constant.
`default ExponentExpr`	`mul(ExponentExpr other)` Multiplies this expression with the given expression.
`default ExponentExpr`	`mul(long other)` Multiplies this expression with the given constant.
`default ExponentExpr`	`mul(RingElement other)`
`default ExponentExpr`	`mul(java.lang.String other)` Multiplies a `ExponentVariableExpr` with the given variable name with this expression.
`default ExponentExpr`	`negate()` Negates this expression.
`default ExponentExpr`	`pow(java.math.BigInteger exponent)` Raises this expression to the given power.
`default ExponentExpr`	`pow(ExponentExpr exponent)` Raises this expression to the given power.
`default ExponentExpr`	`pow(long exponent)` Raises this expression to the given power.
`default ExponentExpr`	`pow(RingElement exponent)`
`default ExponentExpr`	`pow(java.lang.String exponent)` Raises this expression to the power variable with the given name.
`default ExponentExpr`	`sub(ExponentExpr other)` Subtracts the given expression from this expression.
`default ExponentExpr`	`sub(java.lang.String other)` Subtracts a `ExponentVariableExpr` with the given variable name from this expression.
`default ExponentExpr`	`sub(Zn.ZnElement other)`
`default ExponentExpr`	`substitute(java.lang.String variable, Expression substitution)`
`ExponentExpr`	`substitute(Substitution substitutions)` Substitutes variables using the given function.
`default ExponentExpr`	`substitute(VariableExpression variable, Expression substitution)` Substitutes a specific variable with the given expression.

Methods inherited from interface org.cryptimeleon.math.expressions.Expression
accumulate, containsExprMatchingPredicate, containsVariables, forEachChild, getVariables, treeWalk

- Method Detail
  - evaluate
```
java.math.BigInteger evaluate()
```
    Description copied from interface: Expression
    
    Evaluates the expression.
    
    Specified by:
    
    evaluate in interface Expression
    
    Returns:
    
    the result of evaluation
  - evaluate
```
Zn.ZnElement evaluate(Zn zn)
```
    Evaluates the expression in the given ring Zn.
    
    Parameters:
    
    zn - the Zn to evaluate in
    
    Returns:
    
    the result of evaluation as a Zn.ZnElement
  - evaluate
```
default java.math.BigInteger 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
  - evaluate
```
default Zn.ZnElement evaluate(Zn zn,
                              Substitution substitutions)
```
    Evaluates this expression in the given Zn after substituting variables using the given substitutions.
    
    Parameters:
    
    zn - the ring Zn to evaluate the expression in
    
    substitutions - a function mapping variables to expressions that can be evaluated
    
    Returns:
    
    the result of evaluating this expression as a Zn.ZnElement
  - substitute
```
default ExponentExpr substitute(java.lang.String variable,
                                Expression substitution)
```
    Specified by:
    
    substitute in interface Expression
  - substitute
```
default ExponentExpr 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
  - substitute
```
ExponentExpr 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
  - negate
```
default ExponentExpr negate()
```
    Negates this expression.
    
    Returns:
    
    the negated expression
  - invert
```
default ExponentExpr invert()
```
    Multiplicatively inverts this expression.
    
    Returns:
    
    the multiplicatively inverted expression
  - add
```
default ExponentExpr add(ExponentExpr other)
```
    Adds the given expression to this expression.
    
    Parameters:
    
    other - the addend
    
    Returns:
    
    the result of adding the two expressions
  - add
```
default ExponentExpr add(Zn.ZnElement other)
```
  - add
```
default ExponentExpr add(java.lang.String other)
```
    Adds an ExponentVariableExpr with the given variable name to this expression.
    
    Parameters:
    
    other - the name of the variable to add
    
    Returns:
    
    the result of adding the two expressions.
  - sub
```
default ExponentExpr sub(ExponentExpr other)
```
    Subtracts the given expression from this expression. Realized by adding the negation.
    
    Parameters:
    
    other - the subtrahend
    
    Returns:
    
    the result of subtraction
  - sub
```
default ExponentExpr sub(Zn.ZnElement other)
```
  - sub
```
default ExponentExpr sub(java.lang.String other)
```
    Subtracts a ExponentVariableExpr with the given variable name from this expression. Realized by adding the negation.
    
    Parameters:
    
    other - the name of the variable to subtract
    
    Returns:
    
    the result of subtraction
  - mul
```
default ExponentExpr mul(ExponentExpr other)
```
    Multiplies this expression with the given expression.
    
    Parameters:
    
    other - the factor
    
    Returns:
    
    the result of multiplication
  - mul
```
default ExponentExpr mul(java.math.BigInteger other)
```
    Multiplies this expression with the given constant.
    
    Parameters:
    
    other - the factor
    
    Returns:
    
    the result of multiplication
  - mul
```
default ExponentExpr mul(RingElement other)
```
  - mul
```
default ExponentExpr mul(long other)
```
    Multiplies this expression with the given constant.
    
    Parameters:
    
    other - the factor
    
    Returns:
    
    the result of multiplication
  - mul
```
default ExponentExpr mul(java.lang.String other)
```
    Multiplies a ExponentVariableExpr with the given variable name with this expression.
    
    Parameters:
    
    other - the name of the variable to multiply with
    
    Returns:
    
    the result of multiplication
  - pow
```
default ExponentExpr pow(ExponentExpr exponent)
```
    Raises this expression to the given power.
    
    Parameters:
    
    exponent - the power
    
    Returns:
    
    the result of the exponentiation
  - pow
```
default ExponentExpr pow(long exponent)
```
    Raises this expression to the given power.
    
    Parameters:
    
    exponent - the power
    
    Returns:
    
    the result of the exponentiation
  - pow
```
default ExponentExpr pow(java.math.BigInteger exponent)
```
    Raises this expression to the given power.
    
    Parameters:
    
    exponent - the power
    
    Returns:
    
    the result of the exponentiation
  - pow
```
default ExponentExpr pow(RingElement exponent)
```
  - pow
```
default ExponentExpr pow(java.lang.String exponent)
```
    Raises this expression to the power variable with the given name.
    
    Parameters:
    
    exponent - the name of the power variable
    
    Returns:
    
    the result of the exponentiation
  - isEqualTo
```
default ExponentEqualityExpr isEqualTo(ExponentExpr other)
```
    Creates an ExponentEqualityExpr of this expression and the argument.
  - isEqualTo
```
default ExponentEqualityExpr isEqualTo(Zn.ZnElement other)
```
    Creates an ExponentEqualityExpr of this expression and the argument.
  - isEqualTo
```
default ExponentEqualityExpr isEqualTo(java.math.BigInteger other)
```
    Creates an ExponentEqualityExpr of this expression and the argument.
  - linearize
```
ExponentSumExpr linearize()
                   throws java.lang.IllegalArgumentException
```
    Returns an equivalent expression of the form y + f(variables), where y is constant (no variables), and the expression f is linear. Linearity means that
```
 f(variables) + f(variables2) = f(variables + variables2)
 
```
    The exact result is a ExponentSumExpr where the left-hand-side y fulfills y.containsVariables() == false and the right-hand side is linear.
    Throws:
    
    java.lang.IllegalArgumentException - if it's not possible to form the desired output (e.g., the input is something like \(g^{x_1 \cdot x_2}\) for variables \(x_1, x_2\)).

Interface ExponentExpr

Method Summary

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

Method Detail

evaluate

evaluate

evaluate

evaluate

substitute

substitute

substitute

negate

invert

add

add

add

sub

sub

sub

mul

mul

mul

mul

mul

pow

pow

pow

pow

pow

isEqualTo

isEqualTo

isEqualTo

linearize