org.cryptimeleon.math.structures.groups.debug

Class DebugGroupImpl

java.lang.Object

org.cryptimeleon.math.structures.groups.debug.DebugGroupImpl

All Implemented Interfaces:

RepresentationRestorer, Representable, StandaloneRepresentable, GroupImpl

public class DebugGroupImpl
extends java.lang.Object
implements GroupImpl

Zn-based group that supports counting group operations, inversions, squarings and exponentiations as well as number of terms in each multi-exponentiation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	enableExpCounting Whether to count exponentiations as a single unit.
protected java.lang.Boolean	enableMultiExpCounting Whether to count multi-exponentiations as a single unit.
protected java.util.List<java.lang.Integer>	multiExpTermNumbers Contains number of terms for each multi-exponentiation performed.
protected java.lang.String	name Name of this group.
protected long	numExps The counted number of exponentiations.
protected long	numInversions The counted number of inversions.
protected long	numOps The counted number of operations.
protected long	numRetrievedRepresentations Number of retrieved representations for elements of this group.
protected long	numSquarings The counted number of squarings.
protected Zn	zn The Zn underlying this group.

Constructor Summary

Constructors

Constructor and Description
DebugGroupImpl(Representation repr)
DebugGroupImpl(java.lang.String name, java.math.BigInteger n) Instantiates this group with the given name and group size and to not count (multi-)exponentiations explicitly (instead only total group operations are counted).
DebugGroupImpl(java.lang.String name, java.math.BigInteger n, boolean enableExpCounting, boolean enableMultiExpCounting) Instantiates this group with the given name, group size, and counting configuration.

Method Summary

Modifier and Type	Method and Description
protected void	addMultiExpBaseNumber(int numTerms) Tracks the fact that a multi-exponentiation with the given number of terms was done.
boolean	equals(java.lang.Object other)
double	estimateCostInvPerOp() Estimates the number of inversions that can be done per group operation for the same cost.
GroupElementImpl	exp(GroupElementImpl base, java.math.BigInteger exponent, SmallExponentPrecomputation precomputation) Can be overwritten to implement a custom exponentiation algorithm for the group.
GroupElementImpl	getGenerator() Returns any generator of this group if the group is cyclic and it's feasible to compute a generator.
java.util.List<java.lang.Integer>	getMultiExpTermNumbers()
GroupElementImpl	getNeutralElement() Returns the neutral element of this group.
long	getNumExps()
long	getNumInversions()
long	getNumOps()
long	getNumRetrievedRepresentations()
long	getNumSquarings()
Representation	getRepresentation() The representation of this object.
GroupElementImpl	getUniformlyRandomElement() Generates a uniformly random element of this group.
GroupElementImpl	getUniformlyRandomNonNeutral() Generates a uniformly random non-neutral element of this group.
java.util.Optional<java.lang.Integer>	getUniqueByteLength() Returns the number of bytes returned by this structure's UniqueByteRepresentable.getUniqueByteRepresentation(), or an empty Optional if this structure's elements do not guarantee a fixed length.
int	hashCode()
boolean	hasPrimeSize() Returns true if the size of this structure is known and prime.
boolean	implementsOwnExp() Indicates whether this group implements its own custom exponentiation algorithm by overwriting GroupImpl.exp(org.cryptimeleon.math.structures.groups.GroupElementImpl, java.math.BigInteger, org.cryptimeleon.math.structures.groups.exp.SmallExponentPrecomputation).
boolean	implementsOwnMultiExp() Indicates whether this group implements its own multi-exponentiation algorithm by overwriting GroupImpl.multiexp(Multiexponentiation).
protected void	incrementNumExps()
protected void	incrementNumInversions()
protected void	incrementNumOps()
protected void	incrementNumRetrievedRepresentations()
protected void	incrementNumSquarings()
boolean	isCommutative() Returns true if this group is known to be commutative.
GroupElementImpl	multiexp(Multiexponentiation mexp) Can be overwritten to implement a custom multi-exponentiation algorithm for the group.
void	resetCounters()
void	resetExpsCounter()
void	resetInvsCounter()
void	resetMultiExpTermNumbers()
void	resetOpsCounter()
void	resetRetrievedRepresentationsCounter()
void	resetSquaringsCounter()
GroupElementImpl	restoreElement(Representation repr) Restores a group element from its representation.
java.math.BigInteger	size() Retrieves number of elements in the group if possible.
java.lang.String	toString()
DebugGroupElementImpl	wrap(Zn.ZnElement elem) Wraps a ZnElement in a CountingGroupElementImpl belonging to this group.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cryptimeleon.math.structures.groups.GroupImpl

restoreFromRepresentation

Field Detail

name

protected java.lang.String name

Name of this group. Group elements between CountingGroupElementImpl instances only allow for group operations if the groups' names match.

zn

protected Zn zn

The Zn underlying this group. Realizes the actual group operations.

enableExpCounting

protected java.lang.Boolean enableExpCounting

Whether to count exponentiations as a single unit. If set to true, group operations in those exponentiations will not be counted.

enableMultiExpCounting

protected java.lang.Boolean enableMultiExpCounting

Whether to count multi-exponentiations as a single unit. If set to true, group operations in those multi-exponentiations will not be counted.

numInversions

protected long numInversions

The counted number of inversions.

numOps

protected long numOps

The counted number of operations. Squarings are not considered in the group operation counter.

numSquarings

protected long numSquarings

The counted number of squarings.

numExps

protected long numExps

The counted number of exponentiations.

numRetrievedRepresentations

protected long numRetrievedRepresentations

Number of retrieved representations for elements of this group.

multiExpTermNumbers

protected java.util.List<java.lang.Integer> multiExpTermNumbers

Contains number of terms for each multi-exponentiation performed.

Constructor Detail

DebugGroupImpl

public DebugGroupImpl(java.lang.String name,
                      java.math.BigInteger n)

Instantiates this group with the given name and group size and to not count (multi-)exponentiations explicitly (instead only total group operations are counted).

Parameters:

name - a unique name for this group. group operations are only compatible between groups of the same name and n

n - the size of this group

DebugGroupImpl

public DebugGroupImpl(java.lang.String name,
                      java.math.BigInteger n,
                      boolean enableExpCounting,
                      boolean enableMultiExpCounting)

Instantiates this group with the given name, group size, and counting configuration.

Parameters:

name - a unique name for this group. group operations are only compatible between groups of the same name and n

n - the size of this group

enableExpCounting - if true, exponentiations in G1, G2 and GT are counted as a single unit and group operations within exponentiations are not counted; otherwise the former is not done and group operations within exponentiations are added to the total count

enableMultiExpCounting - if true, number of terms in each multi-exponentiation is tracked and group operations within multi-exponentiations are not counted; otherwise the former is not done and group operations within multi-exponentiations are added to the total count

DebugGroupImpl

public DebugGroupImpl(Representation repr)

Method Detail

getRepresentation

public Representation getRepresentation()

Description copied from interface: Representable

The representation of this object. Used for serialization. A convenient way to implement this is using @link ReprUtil

Specified by:

getRepresentation in interface Representable

Returns:

a Representation or null if an equal object can be recreated without any information.

See Also:

Representation

getNeutralElement

public GroupElementImpl getNeutralElement()

Description copied from interface: GroupImpl

Returns the neutral element of this group.

Specified by:

getNeutralElement in interface GroupImpl

getUniformlyRandomElement

public GroupElementImpl getUniformlyRandomElement()
                                           throws java.lang.UnsupportedOperationException

Description copied from interface: GroupImpl

Generates a uniformly random element of this group.

Specified by:

getUniformlyRandomElement in interface GroupImpl

Throws:

java.lang.UnsupportedOperationException - if the random generation cannot be done

getUniformlyRandomNonNeutral

public GroupElementImpl getUniformlyRandomNonNeutral()
                                              throws java.lang.UnsupportedOperationException

Description copied from interface: GroupImpl

Generates a uniformly random non-neutral element of this group.

Specified by:

getUniformlyRandomNonNeutral in interface GroupImpl

Throws:

java.lang.UnsupportedOperationException - if the random generation cannot be done

restoreElement

public GroupElementImpl restoreElement(Representation repr)

Description copied from interface: GroupImpl

Restores a group element from its representation.

Specified by:

restoreElement in interface GroupImpl

getGenerator

public GroupElementImpl getGenerator()
                              throws java.lang.UnsupportedOperationException

Description copied from interface: GroupImpl

Returns any generator of this group if the group is cyclic and it's feasible to compute a generator.

Repeated calls may or may not always supply the same generator again (i.e. the output is not guaranteed to be random)!

Specified by:

getGenerator in interface GroupImpl

Throws:

java.lang.UnsupportedOperationException - if group is not cyclic or it's too hard to compute a generator

getUniqueByteLength

public java.util.Optional<java.lang.Integer> getUniqueByteLength()

Description copied from interface: GroupImpl

Returns the number of bytes returned by this structure's UniqueByteRepresentable.getUniqueByteRepresentation(), or an empty Optional if this structure's elements do not guarantee a fixed length.

For example, elements of Zp will always be represented by ceil(ceil(log(p))/8) bytes, hence getUniqueByteLength() would return ceil(ceil(log(p))/8).

A polynomial ring would return an empty Optional since a polynomial's unique byte representation length depends on its degree.

Specified by:

getUniqueByteLength in interface GroupImpl

Returns:

the guaranteed fixed length of getUniqueByteRepresentation(), or an empty Optional, if no guarantee

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isCommutative

public boolean isCommutative()

Description copied from interface: GroupImpl

Returns true if this group is known to be commutative.

Specified by:

isCommutative in interface GroupImpl

size

public java.math.BigInteger size()
                          throws java.lang.UnsupportedOperationException

Description copied from interface: GroupImpl

Retrieves number of elements in the group if possible.

Specified by:

size in interface GroupImpl

Returns:

size of this group (number of group elements in it) or null if infinite

Throws:

java.lang.UnsupportedOperationException - if the number of elements is unknown or is too expensive to compute

hasPrimeSize

public boolean hasPrimeSize()
                     throws java.lang.UnsupportedOperationException

Description copied from interface: GroupImpl

Returns true if the size of this structure is known and prime.

Specified by:

hasPrimeSize in interface GroupImpl

Throws:

java.lang.UnsupportedOperationException

implementsOwnExp

public boolean implementsOwnExp()

Description copied from interface: GroupImpl

Indicates whether this group implements its own custom exponentiation algorithm by overwriting GroupImpl.exp(org.cryptimeleon.math.structures.groups.GroupElementImpl, java.math.BigInteger, org.cryptimeleon.math.structures.groups.exp.SmallExponentPrecomputation).

Specified by:

implementsOwnExp in interface GroupImpl

Returns:

true if the group overwrites GroupImpl.exp(org.cryptimeleon.math.structures.groups.GroupElementImpl, java.math.BigInteger, org.cryptimeleon.math.structures.groups.exp.SmallExponentPrecomputation), else false

exp

public GroupElementImpl exp(GroupElementImpl base,
                            java.math.BigInteger exponent,
                            SmallExponentPrecomputation precomputation)

Description copied from interface: GroupImpl

Can be overwritten to implement a custom exponentiation algorithm for the group.

Specified by:

exp in interface GroupImpl

Parameters:

base - the base of the exponentiation

exponent - the exponent of the exponentiation

precomputation - a set of precomputations that can be used to speed up the exponentiation

Returns:

the result of base base to the power of exponent

implementsOwnMultiExp

public boolean implementsOwnMultiExp()

Description copied from interface: GroupImpl

Indicates whether this group implements its own multi-exponentiation algorithm by overwriting GroupImpl.multiexp(Multiexponentiation).

Specified by:

implementsOwnMultiExp in interface GroupImpl

Returns:

true if the group implements its own multi-exponentiation algorithm, else false

multiexp

public GroupElementImpl multiexp(Multiexponentiation mexp)

Description copied from interface: GroupImpl

Can be overwritten to implement a custom multi-exponentiation algorithm for the group.

Specified by:

multiexp in interface GroupImpl

Parameters:

mexp - contains the multi-exponentiation terms

Returns:

result of computing the multi-exponentiation

wrap

public DebugGroupElementImpl wrap(Zn.ZnElement elem)

Wraps a ZnElement in a CountingGroupElementImpl belonging to this group.

estimateCostInvPerOp

public double estimateCostInvPerOp()

Description copied from interface: GroupImpl

Estimates the number of inversions that can be done per group operation for the same cost. For example, 2 would mean that an inversion costs half as much as a group operation, on average.

Specified by:

estimateCostInvPerOp in interface GroupImpl

Returns:

Estimated number of inversions that can be done per group operation for the same cost

incrementNumOps

protected void incrementNumOps()

incrementNumInversions

protected void incrementNumInversions()

incrementNumSquarings

protected void incrementNumSquarings()

incrementNumExps

protected void incrementNumExps()

addMultiExpBaseNumber

protected void addMultiExpBaseNumber(int numTerms)

Tracks the fact that a multi-exponentiation with the given number of terms was done.

Parameters:

numTerms - the number of terms (bases) in the multi-exponentiation

incrementNumRetrievedRepresentations

protected void incrementNumRetrievedRepresentations()

getNumInversions

public long getNumInversions()

getNumOps

public long getNumOps()

getNumSquarings

public long getNumSquarings()

getNumExps

public long getNumExps()

getMultiExpTermNumbers

public java.util.List<java.lang.Integer> getMultiExpTermNumbers()

getNumRetrievedRepresentations

public long getNumRetrievedRepresentations()

resetOpsCounter

public void resetOpsCounter()

resetInvsCounter

public void resetInvsCounter()

resetSquaringsCounter

public void resetSquaringsCounter()

resetExpsCounter

public void resetExpsCounter()

resetMultiExpTermNumbers

public void resetMultiExpTermNumbers()

resetRetrievedRepresentationsCounter

public void resetRetrievedRepresentationsCounter()

resetCounters

public void resetCounters()