org.cryptimeleon.math.structures.groups

Interface GroupElementImpl

All Superinterfaces:

Representable, UniqueByteRepresentable

All Known Subinterfaces:

EllipticCurvePoint

All Known Implementing Classes:

AbstractEllipticCurvePoint, AffineEllipticCurvePoint, DebugGroupElementImpl, PairingSourceGroupElement, PairingTargetGroupElementImpl, Sn.SnElementImpl

public interface GroupElementImpl
extends Representable, UniqueByteRepresentable

Immutable objects representing elements of a group usually wrapped by a GroupElement to offer additional evaluation capabilities.

Implementations must properly implement equals() and hashCode().

Method Summary

Modifier and Type	Method and Description
GroupImpl	getStructure() Retrieves the group this element belongs to.
GroupElementImpl	inv() Calculates the inverse of this group element.
default boolean	isNeutralElement() Returns true iff this is the neutral element of the group.
GroupElementImpl	op(GroupElementImpl e) Calculates the result of this op e.
default GroupElementImpl	pow(java.math.BigInteger k) Calculates the result of applying the group operation k times.
default GroupElementImpl	square() Squares this if the group is multiplicative and doubles it if the group is additive.

Methods inherited from interface org.cryptimeleon.math.serialization.Representable

getRepresentation

Methods inherited from interface org.cryptimeleon.math.hash.UniqueByteRepresentable

getUniqueByteRepresentation, updateAccumulator

Method Detail

getStructure

GroupImpl getStructure()

Retrieves the group this element belongs to.

inv

GroupElementImpl inv()

Calculates the inverse of this group element.

Returns:

an element x such that x.op(this).equals(getStructure().getNeutralElement())

op

GroupElementImpl op(GroupElementImpl e)
             throws java.lang.IllegalArgumentException

Calculates the result of this op e.

Parameters:

e - right hand side of the operation

Returns:

the element resulting from the group operation

Throws:

java.lang.IllegalArgumentException - if e is of the wrong type

square

default GroupElementImpl square()

Squares this if the group is multiplicative and doubles it if the group is additive.

If there is a more efficient algorithm for squaring (e.g. for elliptic curve points), this method can be overwritten.

Returns:

this element "squared" (if op is an multiplication), or "doubled" (if op is an addition)

pow

default GroupElementImpl pow(java.math.BigInteger k)

Calculates the result of applying the group operation k times.

isNeutralElement

default boolean isNeutralElement()

Returns true iff this is the neutral element of the group.