DebugGroup (math 2.1.0 API)

java.lang.Object
- org.cryptimeleon.math.structures.groups.debug.DebugGroup

All Implemented Interfaces:

RepresentationRestorer, Representable, StandaloneRepresentable, Group, Structure
```
public class DebugGroup
extends java.lang.Object
implements Group
```
Zn-based group that supports counting group operations, inversions, squarings and exponentiations as well as number of terms in each multi-exponentiation.
This counting capability is realized by using two LazyGroups that each wrap a DebugGroupImpl. One counts total group operations and squarings, and the other counts (multi-)exponentiations as a single unit (not including group operations and squarings done inside (multi-)exponentiations).

Constructor Summary

Constructors
Constructor and Description
`DebugGroup(LazyGroup groupTotal, LazyGroup groupExpMultiExp)` This constructor allows instantiating the `DebugGroup` with specific `LazyGroup` instances.
`DebugGroup(Representation repr)`
`DebugGroup(java.lang.String name, java.math.BigInteger n)` Initializes the counting group with a given name and size.
`DebugGroup(java.lang.String name, long n)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`formatCounterData()` Formats the count data for printing.
`int`	`getExponentiationWindowSize()` Returns the window size used for the non-cached precomputations computed during the exponentiation algorithm.
`java.util.List<java.lang.Integer>`	`getMultiExpTermNumbers()` Retrieves number of terms of each multi-exponentiation done.
`GroupElement`	`getNeutralElement()` Returns the neutral element for this group
`long`	`getNumExps()` Retrieves number of group exponentiations done.
`long`	`getNumInversionsNoExpMultiExp()` Retrieves number of group inversions not including ones done in (multi-)exponentiation algorithms.
`long`	`getNumInversionsTotal()` Retrieves number of group inversions including ones done in (multi-)exponentiation algorithms.
`long`	`getNumOpsNoExpMultiExp()` Retrieves number of group ops not including ones done in (multi-)exponentiation algorithms.
`long`	`getNumOpsTotal()` Retrieves number of group ops including ones done in (multi-)exponentiation algorithms.
`long`	`getNumRetrievedRepresentations()` Retrieves number of retrieved representations of group elements for this group (via getRepresentation()).
`long`	`getNumSquaringsNoExpMultiExp()` Retrieves number of group squarings not including ones done in (multi-)exponentiation algorithms.
`long`	`getNumSquaringsTotal()` Retrieves number of group squarings including ones done in (multi-)exponentiation algorithms.
`int`	`getPrecomputationWindowSize()` Returns the window size used for the precomputations.
`Representation`	`getRepresentation()` The representation of this object.
`ExpAlgorithm`	`getSelectedExpAlgorithm()`
`MultiExpAlgorithm`	`getSelectedMultiExpAlgorithm()`
`GroupElement`	`getUniformlyRandomElement()` Returns an element of this structure that is drawn uniformly at random using a cryptographically strong RNG.
`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.
`Zn`	`getZn()` Returns `Zn`, where `n == size()`.
`int`	`hashCode()`
`boolean`	`isCommutative()` Returns true if this group is known to be commutative.
`void`	`resetCounters()` Resets all counters.
`GroupElement`	`restoreElement(Representation repr)` Creates an element of this structure from its representation.
`void`	`setExponentiationWindowSize(int exponentiationWindowSize)` Sets the window size used for used for the non-cached precomputations computed during the exponentiation algorithm.
`void`	`setPrecomputationWindowSize(int precomputationWindowSize)` Sets the window size used for the cached precomputations.
`void`	`setSelectedExpAlgorithm(ExpAlgorithm selectedExpAlgorithm)`
`void`	`setSelectedMultiExpAlgorithm(MultiExpAlgorithm selectedMultiExpAlgorithm)`
`java.math.BigInteger`	`size()` Returns the number of elements in this structure (the size).
`java.lang.String`	`toString()`
`DebugGroupElement`	`wrap(Zn.ZnElement elem)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cryptimeleon.math.structures.groups.Group
expr, getGenerator, getUniformlyRandomElements, getUniformlyRandomExponent, getUniformlyRandomExponents, getUniformlyRandomNonNeutral, getUniformlyRandomNonNeutrals, getUniformlyRandomNonzeroExponent, getUniformlyRandomNonzeroExponents, getUniformlyRandomUnitExponent, getUniformlyRandomUnitExponents, restoreFromRepresentation, restoreVector

Methods inherited from interface org.cryptimeleon.math.structures.Structure
hasPrimeSize

- Constructor Detail
  - DebugGroup
```
public DebugGroup(java.lang.String name,
                  java.math.BigInteger n)
```
    Initializes the counting group with a given name and size. Group operations only work between groups of the same name and size.
    
    Parameters:
    
    name - the name of the group
    
    n - the desired size of the group
  - DebugGroup
```
public DebugGroup(java.lang.String name,
                  long n)
```
  - DebugGroup
```
public DebugGroup(LazyGroup groupTotal,
                  LazyGroup groupExpMultiExp)
```
    This constructor allows instantiating the DebugGroup with specific LazyGroup instances. This can, for example, be used to change the choice of (multi-)exponentiation algorithm by configuring the LazyGroup instances to use a different (multi-)exponentiation algorithm.
  - DebugGroup
```
public DebugGroup(Representation repr)
```
- Method Detail
  - getNeutralElement
```
public GroupElement getNeutralElement()
```
    Description copied from interface: Group
    
    Returns the neutral element for this group
    
    Specified by:
    
    getNeutralElement in interface Group
  - size
```
public java.math.BigInteger size()
                          throws java.lang.UnsupportedOperationException
```
    Description copied from interface: Structure
    
    Returns the number of elements in this structure (the size).
    
    Specified by:
    
    size in interface Structure
    
    Returns:
    
    the number of elements contained in this structure or null if infinite
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the number of elements is unknown or too expensive to compute
  - getZn
```
public Zn getZn()
```
    Description copied from interface: Group
    
    Returns Zn, where n == size().
    
    Specified by:
    
    getZn in interface Group
  - getUniformlyRandomElement
```
public GroupElement getUniformlyRandomElement()
                                       throws java.lang.UnsupportedOperationException
```
    Description copied from interface: Structure
    
    Returns an element of this structure that is drawn uniformly at random using a cryptographically strong RNG.
    
    Specified by:
    
    getUniformlyRandomElement in interface Group
    
    Specified by:
    
    getUniformlyRandomElement in interface Structure
    
    Throws:
    
    java.lang.UnsupportedOperationException - if the operation is not supported
  - restoreElement
```
public GroupElement restoreElement(Representation repr)
```
    Description copied from interface: Structure
    
    Creates an element of this structure from its representation.
    
    Specified by:
    
    restoreElement in interface Group
    
    Specified by:
    
    restoreElement in interface Structure
    
    Parameters:
    
    repr - the Representation returned by Representable.getRepresentation()
    
    Returns:
    
    the decoded element corresponding to the representation
  - wrap
```
public DebugGroupElement wrap(Zn.ZnElement elem)
```
  - getUniqueByteLength
```
public java.util.Optional<java.lang.Integer> getUniqueByteLength()
```
    Description copied from interface: Structure
    
    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 Structure
    
    Returns:
    
    the guaranteed fixed length of getUniqueByteRepresentation(), or an empty Optional, if no guarantee
  - isCommutative
```
public boolean isCommutative()
```
    Description copied from interface: Group
    
    Returns true if this group is known to be commutative.
    
    Specified by:
    
    isCommutative in interface Group
  - 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
  - getNumSquaringsTotal
```
public long getNumSquaringsTotal()
```
    Retrieves number of group squarings including ones done in (multi-)exponentiation algorithms.
  - getNumInversionsTotal
```
public long getNumInversionsTotal()
```
    Retrieves number of group inversions including ones done in (multi-)exponentiation algorithms.
  - getNumOpsTotal
```
public long getNumOpsTotal()
```
    Retrieves number of group ops including ones done in (multi-)exponentiation algorithms. Does not include squarings.
  - getNumSquaringsNoExpMultiExp
```
public long getNumSquaringsNoExpMultiExp()
```
    Retrieves number of group squarings not including ones done in (multi-)exponentiation algorithms.
  - getNumInversionsNoExpMultiExp
```
public long getNumInversionsNoExpMultiExp()
```
    Retrieves number of group inversions not including ones done in (multi-)exponentiation algorithms.
  - getNumOpsNoExpMultiExp
```
public long getNumOpsNoExpMultiExp()
```
    Retrieves number of group ops not including ones done in (multi-)exponentiation algorithms. Does not include squarings.
  - getNumExps
```
public long getNumExps()
```
    Retrieves number of group exponentiations done.
  - getMultiExpTermNumbers
```
public java.util.List<java.lang.Integer> getMultiExpTermNumbers()
```
    Retrieves number of terms of each multi-exponentiation done.
  - getNumRetrievedRepresentations
```
public long getNumRetrievedRepresentations()
```
    Retrieves number of retrieved representations of group elements for this group (via getRepresentation()).
  - resetCounters
```
public void resetCounters()
```
    Resets all counters.
  - formatCounterData
```
public java.lang.String formatCounterData()
```
    Formats the count data for printing.
    
    Returns:
    
    a string detailing the results of counting
  - getExponentiationWindowSize
```
public int getExponentiationWindowSize()
```
    Returns the window size used for the non-cached precomputations computed during the exponentiation algorithm.
  - setExponentiationWindowSize
```
public void setExponentiationWindowSize(int exponentiationWindowSize)
```
    Sets the window size used for used for the non-cached precomputations computed during the exponentiation algorithm.
    A larger window size leads to an exponential increase in the number of precomputations done during exponentiation. As the precomputations affected by this variable are only temporarily stored during execution of the exponentiation algorithm, we do not recommend setting this too high as the cost of computing the whole window quickly exceeds its performance benefits during the actual exponentiation.
    If you want to change the number of cached precomputations, use this#setPrecomputationWindowSize(int).
  - getPrecomputationWindowSize
```
public int getPrecomputationWindowSize()
```
    Returns the window size used for the precomputations.
  - setPrecomputationWindowSize
```
public void setPrecomputationWindowSize(int precomputationWindowSize)
```
    Sets the window size used for the cached precomputations.
    A larger window size leads to an exponential increase in the number of cached precomputations done but can also improve the performance of later exponentiations.
  - getSelectedMultiExpAlgorithm
```
public MultiExpAlgorithm getSelectedMultiExpAlgorithm()
```
  - setSelectedMultiExpAlgorithm
```
public void setSelectedMultiExpAlgorithm(MultiExpAlgorithm selectedMultiExpAlgorithm)
```
  - getSelectedExpAlgorithm
```
public ExpAlgorithm getSelectedExpAlgorithm()
```
  - setSelectedExpAlgorithm
```
public void setSelectedExpAlgorithm(ExpAlgorithm selectedExpAlgorithm)
```
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DebugGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cryptimeleon.math.structures.Structure

Constructor Detail

DebugGroup

DebugGroup

DebugGroup

DebugGroup

Method Detail

getNeutralElement

size

getZn

getUniformlyRandomElement

restoreElement

wrap

getUniqueByteLength

isCommutative

getRepresentation

getNumSquaringsTotal

getNumInversionsTotal

getNumOpsTotal

getNumSquaringsNoExpMultiExp

getNumInversionsNoExpMultiExp

getNumOpsNoExpMultiExp

getNumExps

getMultiExpTermNumbers

getNumRetrievedRepresentations

resetCounters

formatCounterData

getExponentiationWindowSize

setExponentiationWindowSize

getPrecomputationWindowSize

setPrecomputationWindowSize

getSelectedMultiExpAlgorithm

setSelectedMultiExpAlgorithm

getSelectedExpAlgorithm

setSelectedExpAlgorithm

equals

hashCode

toString