DebugBilinearGroup (math 3.1.2 API)

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

All Implemented Interfaces:

Representable, StandaloneRepresentable, BilinearGroup
```
public class DebugBilinearGroup
extends java.lang.Object
implements BilinearGroup
```
A BilinearGroup implementing a fast, but insecure pairing over Zn. Allows for counting group operations and (multi-)exponentiations as well as pairings on the bilinear group level.
The counting capability is implemented by wrapping two LazyBilinearGroups which contain DebugBilinearGroupImpls themselves. All operations are executed in both groups, one counts total group operations and one counts each (multi-)exponentiation as one unit. This allows for tracking both kinds of data.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.cryptimeleon.math.structures.groups.elliptic.BilinearGroup
  BilinearGroup.Type

Field Summary

Fields
Modifier and Type	Field and Description
`protected DebugBilinearMap`	`bilMap` The underlying bilinear map used for applying the pairing function and counting it.
`protected LazyBilinearGroup`	`expMultiExpBilGroup` The bilinear group responsible for counting (multi-)exponentiations and group operations outside of those.
`protected DebugGroup`	`g1` The debug group for G1.
`protected DebugGroup`	`g2` The debug group for G2.
`protected DebugGroup`	`gT` The debug group for GT.
`protected BilinearGroup.Type`	`pairingType` The type of pairing this bilinear group should offer.
`protected java.lang.Integer`	`securityParameter` The security level offered by this bilinear group in number of bits.
`protected LazyBilinearGroup`	`totalBilGroup` The bilinear group responsible for counting total group operations.

Constructor Summary

Constructors
Constructor and Description
`DebugBilinearGroup(java.math.BigInteger groupSize, BilinearGroup.Type pairingType)` Initializes this prime order bilinear group with the given size and pairing type.
`DebugBilinearGroup(BilinearGroup.Type pairingType)` Initializes this prime order bilinear group with a random 256 bit size and the given pairing type.
`DebugBilinearGroup(Representation repr)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object other)`
`java.lang.String`	`formatCounterData()` Formats the count data of the default bucket for printing.
`java.lang.String`	`formatCounterData(java.lang.String bucketName)` Formats the count data of the bucket with the given name for printing.
`java.lang.String`	`formatCounterDataAllBuckets()` Formats the count data of all buckets for printing.
`java.lang.String`	`formatCounterDataAllBuckets(boolean summaryOnly)` Formats the counter data of all buckets for printing.
`BilinearMap`	`getBilinearMap()` Returns the `BilinearMap` (contains the pairing operation) belonging to this `BilinearGroup`.
`int`	`getExponentiationWindowSize()` Returns the window size used for the non-cached precomputations computed during the exponentiation algorithm if G1, G2, and GT use the same one; otherwise -1.
`Group`	`getG1()` Returns the source group G1 associated with this bilinear group.
`Group`	`getG2()` Returns the source group G2 associated with this bilinear group.
`Group`	`getGT()` Returns the target group GT associated with this bilinear group.
`HashIntoGroup`	`getHashIntoG1()` Retrieves a hash function that maps byte arrays to G1.
`HashIntoGroup`	`getHashIntoG2()` Retrieves a hash function that maps byte arrays to G2.
`HashIntoGroup`	`getHashIntoGT()` Retrieves a hash function that maps byte arrays to GT.
`GroupHomomorphism`	`getHomomorphismG2toG1()` Retrieves the homomorphism from G2 to G1 if it exists.
`long`	`getNumPairings()` Returns the number of pairings computed in this bilinear group from the default bucket
`long`	`getNumPairings(java.lang.String bucketName)` Returns the number of pairings computed in this bilinear group from the bucket with the given name.
`long`	`getNumPairingsAllBuckets()` Sums up the pairings across all buckets, including the default bucket.
`BilinearGroup.Type`	`getPairingType()`
`int`	`getPrecomputationWindowSize()` Returns the window size used for the precomputations if G1, G2, and GT use the same one; otherwise -1.
`Representation`	`getRepresentation()` The representation of this object.
`java.lang.Integer`	`getSecurityLevel()`
`ExpAlgorithm`	`getSelectedExpAlgorithm()` Returns the selected exponentiation algorithm if G1, G2, and GT use the same one; otherwise null.
`MultiExpAlgorithm`	`getSelectedMultiExpAlgorithm()` Returns the selected multi-exponentiation algorithm if G1, G2, and GT use the same one; otherwise null.
`int`	`hashCode()`
`protected void`	`init()` Initializes the internal debug objects.
`void`	`resetCounters()` Resets the counters of the default bucket, including the ones in groups G1, G2, GT as well as the pairing counter.
`void`	`resetCounters(java.lang.String bucketName)` Resets the counters of the bucket with the given name, including the ones in groups G1, G2, GT as well as the pairing counter.
`void`	`resetCountersAllBuckets()` Resets counters of all buckets.
`void`	`resetNumPairings()` Resets pairing counter of the default bucket.
`void`	`resetNumPairings(java.lang.String bucketName)` Resets pairing counter of the bucket with the given name.
`void`	`resetNumPairingsAllBuckets()` Resets pairing counter of all buckets, including the default bucket.
`void`	`setBucket(java.lang.String name)` Sets the currently used operation count storage bucket to the one with the given name.
`void`	`setExponentiationWindowSize(int exponentiationWindowSize)` Sets the window size used for used for the non-cached precomputations computed during the exponentiation algorithm for G1, G2, and GT at once.
`void`	`setPrecomputationWindowSize(int precomputationWindowSize)` Sets the window size used for the cached precomputations for G1, G2, and GT at once.
`void`	`setSelectedExpAlgorithm(ExpAlgorithm selectedExpAlgorithm)` Sets the exponentiation algorithm used for G1, G2, and GT at once.
`void`	`setSelectedMultiExpAlgorithm(MultiExpAlgorithm selectedMultiExpAlgorithm)` Sets the multi-exponentiation algorithm used for G1, G2, and GT at once.
`java.lang.String`	`toString()`

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

Methods inherited from interface org.cryptimeleon.math.structures.groups.elliptic.BilinearGroup
getHashIntoZGroupExponent, getZn, size

- Field Detail
  - securityParameter
```
protected java.lang.Integer securityParameter
```
    The security level offered by this bilinear group in number of bits.
  - pairingType
```
protected BilinearGroup.Type pairingType
```
    The type of pairing this bilinear group should offer.
  - totalBilGroup
```
protected LazyBilinearGroup totalBilGroup
```
    The bilinear group responsible for counting total group operations.
  - expMultiExpBilGroup
```
protected LazyBilinearGroup expMultiExpBilGroup
```
    The bilinear group responsible for counting (multi-)exponentiations and group operations outside of those.
  - bilMap
```
protected DebugBilinearMap bilMap
```
    The underlying bilinear map used for applying the pairing function and counting it.
  - g1
```
protected DebugGroup g1
```
    The debug group for G1.
  - g2
```
protected DebugGroup g2
```
    The debug group for G2.
  - gT
```
protected DebugGroup gT
```
    The debug group for GT.
- Constructor Detail
  - DebugBilinearGroup
```
public DebugBilinearGroup(java.math.BigInteger groupSize,
                          BilinearGroup.Type pairingType)
```
    Initializes this prime order bilinear group with the given size and pairing type.
    
    Parameters:
    
    groupSize - the size of the group
    
    pairingType - the type of pairing that should be offered by this bilinear group
  - DebugBilinearGroup
```
public DebugBilinearGroup(BilinearGroup.Type pairingType)
```
    Initializes this prime order bilinear group with a random 256 bit size and the given pairing type.
    
    Parameters:
    
    pairingType - the type of pairing that should be offered by this bilinear group
  - DebugBilinearGroup
```
public DebugBilinearGroup(Representation repr)
```
- Method Detail
  - init
```
protected void init()
```
    Initializes the internal debug objects.
  - getG1
```
public Group getG1()
```
    Description copied from interface: BilinearGroup
    
    Returns the source group G1 associated with this bilinear group.
    
    Specified by:
    
    getG1 in interface BilinearGroup
  - getG2
```
public Group getG2()
```
    Description copied from interface: BilinearGroup
    
    Returns the source group G2 associated with this bilinear group.
    
    Specified by:
    
    getG2 in interface BilinearGroup
  - getGT
```
public Group getGT()
```
    Description copied from interface: BilinearGroup
    
    Returns the target group GT associated with this bilinear group.
    
    Specified by:
    
    getGT in interface BilinearGroup
  - getBilinearMap
```
public BilinearMap getBilinearMap()
```
    Description copied from interface: BilinearGroup
    
    Returns the BilinearMap (contains the pairing operation) belonging to this BilinearGroup.
    
    Specified by:
    
    getBilinearMap in interface BilinearGroup
  - getHomomorphismG2toG1
```
public GroupHomomorphism getHomomorphismG2toG1()
                                        throws java.lang.UnsupportedOperationException
```
    Description copied from interface: BilinearGroup
    
    Retrieves the homomorphism from G2 to G1 if it exists.
    
    Specified by:
    
    getHomomorphismG2toG1 in interface BilinearGroup
    
    Throws:
    
    java.lang.UnsupportedOperationException - if no such homomorphism exists or the bilinear group is not configured to support such functionality
  - getHashIntoG1
```
public HashIntoGroup getHashIntoG1()
                            throws java.lang.UnsupportedOperationException
```
    Description copied from interface: BilinearGroup
    
    Retrieves a hash function that maps byte arrays to G1.
    
    Specified by:
    
    getHashIntoG1 in interface BilinearGroup
    
    Throws:
    
    java.lang.UnsupportedOperationException - if no such hash function exists or the bilinear group is not configured to support such functionality
  - getHashIntoG2
```
public HashIntoGroup getHashIntoG2()
                            throws java.lang.UnsupportedOperationException
```
    Description copied from interface: BilinearGroup
    
    Retrieves a hash function that maps byte arrays to G2.
    
    Specified by:
    
    getHashIntoG2 in interface BilinearGroup
    
    Throws:
    
    java.lang.UnsupportedOperationException - if no such hash function exists or the bilinear group is not configured to support such functionality
  - getHashIntoGT
```
public HashIntoGroup getHashIntoGT()
                            throws java.lang.UnsupportedOperationException
```
    Description copied from interface: BilinearGroup
    
    Retrieves a hash function that maps byte arrays to GT.
    
    Specified by:
    
    getHashIntoGT in interface BilinearGroup
    
    Throws:
    
    java.lang.UnsupportedOperationException - if no such hash function exists or the bilinear group is not configured to support such functionality
  - getSecurityLevel
```
public java.lang.Integer getSecurityLevel()
```
    Specified by:
    
    getSecurityLevel in interface BilinearGroup
  - getPairingType
```
public BilinearGroup.Type getPairingType()
```
    Specified by:
    
    getPairingType in interface BilinearGroup
  - 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
  - equals
```
public boolean equals(java.lang.Object other)
```
    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
  - setBucket
```
public void setBucket(java.lang.String name)
```
    Sets the currently used operation count storage bucket to the one with the given name. If a bucket with the given name does not exist, a new one is created.
    The bucket is activated across G1, G2, and GT, as well as the pairing counter.
    All operations executed after setting a bucket will be counted within that bucket only.
    
    Parameters:
    
    name - the name of the bucket to enable
  - getNumPairings
```
public long getNumPairings(java.lang.String bucketName)
```
    Returns the number of pairings computed in this bilinear group from the bucket with the given name.
  - getNumPairings
```
public long getNumPairings()
```
    Returns the number of pairings computed in this bilinear group from the default bucket
  - getNumPairingsAllBuckets
```
public long getNumPairingsAllBuckets()
```
    Sums up the pairings across all buckets, including the default bucket.
  - resetNumPairings
```
public void resetNumPairings(java.lang.String bucketName)
```
    Resets pairing counter of the bucket with the given name.
  - resetNumPairings
```
public void resetNumPairings()
```
    Resets pairing counter of the default bucket.
  - resetNumPairingsAllBuckets
```
public void resetNumPairingsAllBuckets()
```
    Resets pairing counter of all buckets, including the default bucket.
  - resetCounters
```
public void resetCounters(java.lang.String bucketName)
```
    Resets the counters of the bucket with the given name, including the ones in groups G1, G2, GT as well as the pairing counter.
  - resetCounters
```
public void resetCounters()
```
    Resets the counters of the default bucket, including the ones in groups G1, G2, GT as well as the pairing counter.
  - resetCountersAllBuckets
```
public void resetCountersAllBuckets()
```
    Resets counters of all buckets.
  - formatCounterData
```
public java.lang.String formatCounterData(java.lang.String bucketName)
```
    Formats the count data of the bucket with the given name for printing.
    
    Parameters:
    
    bucketName - the name of the bucket whose data to format for printing
    
    Returns:
    
    a string detailing the results of counting
  - formatCounterData
```
public java.lang.String formatCounterData()
```
    Formats the count data of the default bucket for printing.
    
    Returns:
    
    a string detailing the results of counting
  - formatCounterDataAllBuckets
```
public java.lang.String formatCounterDataAllBuckets()
```
    Formats the count data of all buckets for printing.
    
    Returns:
    
    a string detailing results of counting
  - formatCounterDataAllBuckets
```
public java.lang.String formatCounterDataAllBuckets(boolean summaryOnly)
```
    Formats the counter data of all buckets for printing.
    
    Parameters:
    
    summaryOnly - if true, only formats the summed up results across all buckets; otherwise, outputs results of every bucket plus the summary
    
    Returns:
    
    a string detailing results of counting
  - getExponentiationWindowSize
```
public int getExponentiationWindowSize()
```
    Returns the window size used for the non-cached precomputations computed during the exponentiation algorithm if G1, G2, and GT use the same one; otherwise -1.
  - setExponentiationWindowSize
```
public void setExponentiationWindowSize(int exponentiationWindowSize)
```
    Sets the window size used for used for the non-cached precomputations computed during the exponentiation algorithm for G1, G2, and GT at once.
    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 setPrecomputationWindowSize(int).
  - getPrecomputationWindowSize
```
public int getPrecomputationWindowSize()
```
    Returns the window size used for the precomputations if G1, G2, and GT use the same one; otherwise -1.
  - setPrecomputationWindowSize
```
public void setPrecomputationWindowSize(int precomputationWindowSize)
```
    Sets the window size used for the cached precomputations for G1, G2, and GT at once.
    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()
```
    Returns the selected multi-exponentiation algorithm if G1, G2, and GT use the same one; otherwise null.
  - setSelectedMultiExpAlgorithm
```
public void setSelectedMultiExpAlgorithm(MultiExpAlgorithm selectedMultiExpAlgorithm)
```
    Sets the multi-exponentiation algorithm used for G1, G2, and GT at once.
  - getSelectedExpAlgorithm
```
public ExpAlgorithm getSelectedExpAlgorithm()
```
    Returns the selected exponentiation algorithm if G1, G2, and GT use the same one; otherwise null.
  - setSelectedExpAlgorithm
```
public void setSelectedExpAlgorithm(ExpAlgorithm selectedExpAlgorithm)
```
    Sets the exponentiation algorithm used for G1, G2, and GT at once.

Class DebugBilinearGroup

Nested Class Summary

Nested classes/interfaces inherited from interface org.cryptimeleon.math.structures.groups.elliptic.BilinearGroup

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.cryptimeleon.math.structures.groups.elliptic.BilinearGroup

Field Detail

securityParameter

pairingType

totalBilGroup

expMultiExpBilGroup

bilMap

g1

g2

gT

Constructor Detail

DebugBilinearGroup

DebugBilinearGroup

DebugBilinearGroup

Method Detail

init

getG1

getG2

getGT

getBilinearMap

getHomomorphismG2toG1

getHashIntoG1

getHashIntoG2

getHashIntoGT

getSecurityLevel

getPairingType

getRepresentation

equals

hashCode

toString

setBucket

getNumPairings

getNumPairings

getNumPairingsAllBuckets

resetNumPairings

resetNumPairings

resetNumPairingsAllBuckets

resetCounters

resetCounters

resetCountersAllBuckets

formatCounterData

formatCounterData

formatCounterDataAllBuckets

formatCounterDataAllBuckets

getExponentiationWindowSize

setExponentiationWindowSize

getPrecomputationWindowSize

setPrecomputationWindowSize

getSelectedMultiExpAlgorithm

setSelectedMultiExpAlgorithm

getSelectedExpAlgorithm

setSelectedExpAlgorithm