org.bouncycastle.pqc.legacy.math.linearalgebra
Interface GFElement

All Known Implementing Classes:

GF2nElement

public interface GFElement

This interface defines a finite field element. It is implemented by the class GF2nElement.

See Also:

GF2nElement

Method Summary

GFElement	add(GFElement addend) Compute the sum of this element and the addend.
void	addToThis(GFElement addend) Compute the sum of this element and the addend, overwriting this element.
java.lang.Object	clone()
boolean	equals(java.lang.Object other) Compare this curve with another object.
int	hashCode()
GFElement	invert() Compute the multiplicative inverse of this element.
boolean	isOne() Checks whether this element is one.
boolean	isZero() Checks whether this element is zero.
GFElement	multiply(GFElement factor) Compute the product of this element and factor.
void	multiplyThisBy(GFElement factor) Compute this * factor (overwrite this).
GFElement	subtract(GFElement minuend) Compute the difference of this element and minuend.
void	subtractFromThis(GFElement minuend) Compute the difference of this element and minuend, overwriting this element.
byte[]	toByteArray() Returns this element as byte array.
java.math.BigInteger	toFlexiBigInt() Returns this element as FlexiBigInt.
java.lang.String	toString() Return a String representation of this element.
java.lang.String	toString(int radix) Return a String representation of this element.

Method Detail

clone

public java.lang.Object clone()

Returns:

a copy of this GFElement

equals

public boolean equals(java.lang.Object other)

Compare this curve with another object.

Parameters:

other - the other object

Returns:

the result of the comparison

hashCode

public int hashCode()

Returns:

the hash code of this element

isZero

public boolean isZero()

Checks whether this element is zero.

Returns:

true if this is the zero element

isOne

public boolean isOne()

Checks whether this element is one.

Returns:

true if this is the one element

add

public GFElement add(GFElement addend)
              throws java.lang.RuntimeException

Compute the sum of this element and the addend.

Parameters:

addend - the addend

Returns:

this + other (newly created)

Throws:

java.lang.RuntimeException

addToThis

public void addToThis(GFElement addend)
               throws java.lang.RuntimeException

Compute the sum of this element and the addend, overwriting this element.

Parameters:

addend - the addend

Throws:

java.lang.RuntimeException

subtract

public GFElement subtract(GFElement minuend)
                   throws java.lang.RuntimeException

Compute the difference of this element and minuend.

Parameters:

minuend - the minuend

Returns:

this - minuend (newly created)

Throws:

java.lang.RuntimeException

subtractFromThis

public void subtractFromThis(GFElement minuend)

Compute the difference of this element and minuend, overwriting this element.

Parameters:

minuend - the minuend

multiply

public GFElement multiply(GFElement factor)
                   throws java.lang.RuntimeException

Compute the product of this element and factor.

Parameters:

factor - the factor

Returns:

this * factor (newly created)

Throws:

java.lang.RuntimeException

multiplyThisBy

public void multiplyThisBy(GFElement factor)
                    throws java.lang.RuntimeException

Compute this * factor (overwrite this).

Parameters:

factor - the factor

Throws:

java.lang.RuntimeException

invert

public GFElement invert()
                 throws java.lang.ArithmeticException

Compute the multiplicative inverse of this element.

Returns:

this -1 (newly created)

Throws:

java.lang.ArithmeticException - if this is the zero element.

toFlexiBigInt

public java.math.BigInteger toFlexiBigInt()

Returns this element as FlexiBigInt. The conversion is P1363-conform.

Returns:

this element as BigInt

toByteArray

public byte[] toByteArray()

Returns this element as byte array. The conversion is P1363-conform.

Returns:

this element as byte array

toString

public java.lang.String toString()

Return a String representation of this element.

Returns:

String representation of this element

toString

public java.lang.String toString(int radix)

Return a String representation of this element. radix specifies the radix of the String representation.

Parameters:

radix - specifies the radix of the String representation

Returns:

String representation of this element with the specified radix