org.cryptimeleon.math.structures.groups.basic

Class BasicGroup

java.lang.Object

org.cryptimeleon.math.structures.groups.basic.BasicGroup

All Implemented Interfaces:

RepresentationRestorer, Representable, StandaloneRepresentable, Group, Structure

Direct Known Subclasses:

RingGroup, Secp256k1Basic

public class BasicGroup
extends java.lang.Object
implements Group

A basic GroupImpl wrapper where operations are evaluated naively, i.e. operation by operation.

Useful for groups with very efficient operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected GroupImpl	impl
protected boolean	isPrimeOrder
protected java.math.BigInteger	size
protected Zn	zn

Constructor Summary

Constructors

Constructor and Description
BasicGroup(GroupImpl impl)
BasicGroup(Representation repr)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
GroupElement	getGenerator() Returns any generator of this group if the group is cyclic and it's feasible to compute a generator.
GroupElement	getNeutralElement() Returns the neutral element for this group
Representation	getRepresentation() The representation of this object.
GroupElement	getUniformlyRandomElement() Returns an element of this structure that is drawn uniformly at random using a cryptographically strong RNG.
GroupElement	getUniformlyRandomNonNeutral() Generates a uniformly random non-neutral element of this group 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	hasPrimeSize() Checks if the structure has prime size.
boolean	isCommutative() Returns true if this group is known to be commutative.
GroupElement	restoreElement(Representation repr) Creates an element of this structure from its representation.
java.math.BigInteger	size() Returns the number of elements in this structure (the size).
protected BasicGroupElement	wrap(GroupElementImpl impl)

Methods inherited from class java.lang.Object

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

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

expr, getUniformlyRandomElements, getUniformlyRandomExponent, getUniformlyRandomExponents, getUniformlyRandomNonNeutrals, getUniformlyRandomNonzeroExponent, getUniformlyRandomNonzeroExponents, getUniformlyRandomUnitExponent, getUniformlyRandomUnitExponents, restoreFromRepresentation, restoreVector

Field Detail

impl

protected GroupImpl impl

size

protected java.math.BigInteger size

isPrimeOrder

protected boolean isPrimeOrder

zn

protected Zn zn

Constructor Detail

BasicGroup

public BasicGroup(GroupImpl impl)

BasicGroup

public BasicGroup(Representation repr)

Method Detail

wrap

protected BasicGroupElement wrap(GroupElementImpl impl)

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

hasPrimeSize

public boolean hasPrimeSize()

Description copied from interface: Structure

Checks if the structure has prime size.

Specified by:

hasPrimeSize in interface Structure

Returns:

true if the structure has prime size, else false.

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

getUniformlyRandomNonNeutral

public GroupElement getUniformlyRandomNonNeutral()

Description copied from interface: Group

Generates a uniformly random non-neutral element of this group using a cryptographically strong RNG.

Specified by:

getUniformlyRandomNonNeutral in interface Group

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

getGenerator

public GroupElement getGenerator()
                          throws java.lang.UnsupportedOperationException

Description copied from interface: Group

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 Group

Throws:

java.lang.UnsupportedOperationException - if the group doesn't know or have a generator

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

getZn

public Zn getZn()

Description copied from interface: Group

Returns Zn, where n == size().

Specified by:

getZn 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

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