org.cryptimeleon.math.expressions

Class ValueBundle

java.lang.Object

org.cryptimeleon.math.expressions.ValueBundle

All Implemented Interfaces:

Substitution

public class ValueBundle
extends java.lang.Object
implements Substitution

A key-value mapping used for passing around named algebraic values.

These values can be used to substitute variables with the same name in some Expression.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<VariableExpression,java.lang.Boolean>	bools Maps variable expressions to substitute Booleans.
protected java.util.HashMap<VariableExpression,GroupElement>	groupElems Maps variable expressions to substitute GroupElements.
protected java.util.HashMap<VariableExpression,java.math.BigInteger>	ints Maps variable expressions to substitute BigIntegers.
protected java.util.HashMap<VariableExpression,RingElement>	ringElems Maps variable expressions to substitute RingElements.

Constructor Summary

Constructors

Constructor and Description
ValueBundle() Initializes an empty ValueBundle.
ValueBundle(ValueBundle other) Creates a copy of the given ValueBundle.

Method Summary

Modifier and Type	Method and Description
ValueBundle	copy() Creates a copy of this ValueBundle.
java.lang.Boolean	getBoolean(VariableExpression key) Returns the Boolean corresponding to the given variable expression.
GroupElement	getGroupElement(VariableExpression key) Returns the GroupElement corresponding to the given variable expression.
java.math.BigInteger	getInteger(VariableExpression key) Retrieves the BigInteger corresponding to the given variable expression.
RingElement	getRingElement(VariableExpression key) Returns the RingElement corresponding to the given variable expression.
Expression	getSubstitution(VariableExpression variable) Constructs a new Expression by substituting variables in the given VariableExpression.
Zn.ZnElement	getZnElement(VariableExpression key) Returns the ZnElement corresponding to the given variable expression.
Zp.ZpElement	getZpElement(VariableExpression key) Returns the ZpElement corresponding to the given variable expression.
void	put(VariableExpression key, java.math.BigInteger value) Adds a BigInteger with the given key to this value bundle.
void	put(VariableExpression key, boolean value)
void	put(VariableExpression key, GroupElement value) Adds a GroupElement with the given key to this value bundle.
void	put(VariableExpression key, RingElement value) Adds a RingElement with the given key to this value bundle.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

join, join, joinAndIgnoreNullpointers, joinDisjoint, joinDisjoint

Field Detail

groupElems

protected java.util.HashMap<VariableExpression,GroupElement> groupElems

Maps variable expressions to substitute GroupElements.

ints

protected java.util.HashMap<VariableExpression,java.math.BigInteger> ints

Maps variable expressions to substitute BigIntegers.

ringElems

protected java.util.HashMap<VariableExpression,RingElement> ringElems

Maps variable expressions to substitute RingElements.

bools

protected java.util.HashMap<VariableExpression,java.lang.Boolean> bools

Maps variable expressions to substitute Booleans.

Constructor Detail

ValueBundle

public ValueBundle()

Initializes an empty ValueBundle.

ValueBundle

public ValueBundle(ValueBundle other)

Creates a copy of the given ValueBundle.

The maps used to store the algebraic elements are recreated, the elements themselves are not cloned.

Method Detail

copy

public ValueBundle copy()

Creates a copy of this ValueBundle.

The maps used to store the algebraic elements are recreated, the elements themselves are not cloned.

getGroupElement

public GroupElement getGroupElement(VariableExpression key)

Returns the GroupElement corresponding to the given variable expression.

Parameters:

key - the variable expression to retrieve the element for

Returns:

the corresponding group element

getRingElement

public RingElement getRingElement(VariableExpression key)

Returns the RingElement corresponding to the given variable expression.

Parameters:

key - the variable expression to retrieve the element for

Returns:

the corresponding ring element

getZnElement

public Zn.ZnElement getZnElement(VariableExpression key)

Returns the ZnElement corresponding to the given variable expression.

Parameters:

key - the variable expression to retrieve the element for

Returns:

the corresponding Zn element

getZpElement

public Zp.ZpElement getZpElement(VariableExpression key)

Returns the ZpElement corresponding to the given variable expression.

Parameters:

key - the variable expression to retrieve the element for

Returns:

the corresponding Zp element

getBoolean

public java.lang.Boolean getBoolean(VariableExpression key)

Returns the Boolean corresponding to the given variable expression.

Parameters:

key - the variable expression to retrieve the Boolean for

Returns:

the corresponding Boolean

getInteger

public java.math.BigInteger getInteger(VariableExpression key)

Retrieves the BigInteger corresponding to the given variable expression.

If the desired integer cannot be found, the method looks for an integer-like ring element with the given key instead.

Parameters:

key - the variable expression to retrieve the integer for

Returns:

the corresponding integer

put

public void put(VariableExpression key,
                GroupElement value)

Adds a GroupElement with the given key to this value bundle.

If the key is used already by another element (no matter the type), that element gets removed.

Parameters:

key - the key to identify the group element with

value - the group element to add

put

public void put(VariableExpression key,
                RingElement value)

Adds a RingElement with the given key to this value bundle.

If the key is used already by another element (no matter the type), that element gets removed.

Parameters:

key - the key to identify the ring element with

value - the ring element to add

put

public void put(VariableExpression key,
                java.math.BigInteger value)

Adds a BigInteger with the given key to this value bundle.

If the key is used already by another element (no matter the type), that element gets removed.

Parameters:

key - the key to identify the BigInteger with

value - the BigInteger to add

put

public void put(VariableExpression key,
                boolean value)

getSubstitution

public Expression getSubstitution(VariableExpression variable)

Constructs a new Expression by substituting variables in the given VariableExpression.

Works by, depending on the type of the VariableExpression, searching the corresponding key-value map for the substitution with the key given by the variable's name and applying the substitution if possible. If no such element exists, or the VariableExpression is of an unsupported subtype, null is returned.

Specified by:

getSubstitution in interface Substitution

Parameters:

variable - the VariableExpression to substitute

Returns:

the substituted Expression if substitution was successful, else null