org.cryptimeleon.math.structures.groups

Class RingAdditiveGroupImpl

java.lang.Object

org.cryptimeleon.math.structures.groups.RingGroupImpl

org.cryptimeleon.math.structures.groups.RingAdditiveGroupImpl

All Implemented Interfaces:

RepresentationRestorer, Representable, StandaloneRepresentable, GroupImpl

public class RingAdditiveGroupImpl
extends RingGroupImpl

Allows interpreting a ring as its additive group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RingAdditiveGroupImpl.RingAdditiveGroupElementImpl A ring element interpreted as an element of the ring's additive group.

Nested classes/interfaces inherited from class org.cryptimeleon.math.structures.groups.RingGroupImpl

RingGroupImpl.RingGroupElementImpl

Field Summary

Fields inherited from class org.cryptimeleon.math.structures.groups.RingGroupImpl

ring

Constructor Summary

Constructors

Constructor and Description
RingAdditiveGroupImpl(Representation repr)
RingAdditiveGroupImpl(Ring ring) Instantiates this ring additive group.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
double	estimateCostInvPerOp() Estimates the number of inversions that can be done per group operation for the same cost.
RingGroupImpl.RingGroupElementImpl	getElement(RingElement ringElement) Creates an element of this group from the given ring element.
RingAdditiveGroupImpl.RingAdditiveGroupElementImpl	getGenerator() Returns any generator of this group if the group is cyclic and it's feasible to compute a generator.
RingAdditiveGroupImpl.RingAdditiveGroupElementImpl	getNeutralElement() Returns the neutral element of this group.
RingAdditiveGroupImpl.RingAdditiveGroupElementImpl	getUniformlyRandomElement() Generates a uniformly random 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	isCommutative() Returns true if this group is known to be commutative.
RingAdditiveGroupImpl.RingAdditiveGroupElementImpl	restoreElement(Representation repr) Restores a group element from its representation.
java.math.BigInteger	size() Retrieves number of elements in the group if possible.

Methods inherited from class org.cryptimeleon.math.structures.groups.RingGroupImpl

getRepresentation, getRing, 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.GroupImpl

exp, getUniformlyRandomNonNeutral, implementsOwnExp, implementsOwnMultiExp, multiexp, restoreFromRepresentation

Constructor Detail

RingAdditiveGroupImpl

public RingAdditiveGroupImpl(Ring ring)

Instantiates this ring additive group.

Parameters:

ring - the base ring to use

RingAdditiveGroupImpl

public RingAdditiveGroupImpl(Representation repr)

Method Detail

size

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

Description copied from interface: GroupImpl

Retrieves number of elements in the group if possible.

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()

Description copied from interface: GroupImpl

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

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.

Returns:

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

getNeutralElement

public RingAdditiveGroupImpl.RingAdditiveGroupElementImpl getNeutralElement()

Description copied from interface: GroupImpl

Returns the neutral element of this group.

getUniformlyRandomElement

public RingAdditiveGroupImpl.RingAdditiveGroupElementImpl getUniformlyRandomElement()
                                                                             throws java.lang.UnsupportedOperationException

Description copied from interface: GroupImpl

Generates a uniformly random element of this group.

Throws:

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

getGenerator

public RingAdditiveGroupImpl.RingAdditiveGroupElementImpl 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)!

Throws:

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class RingGroupImpl

hashCode

public int hashCode()

Overrides:

hashCode in class RingGroupImpl

getElement

public RingGroupImpl.RingGroupElementImpl getElement(RingElement ringElement)

Description copied from class: RingGroupImpl

Creates an element of this group from the given ring element.

Specified by:

getElement in class RingGroupImpl

Parameters:

ringElement - the ring element to convert

Returns:

the given ring element as an element of this group

restoreElement

public RingAdditiveGroupImpl.RingAdditiveGroupElementImpl restoreElement(Representation repr)

Description copied from interface: GroupImpl

Restores a group element from its representation.

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.

Returns:

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

isCommutative

public boolean isCommutative()

Description copied from interface: GroupImpl

Returns true if this group is known to be commutative.