GenericFieldElement (ECCelerate 6.2 API)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

ExtensionFieldElement, FieldElement, PrimeCharacteristicFieldElement

All Known Implementing Classes:

BinaryFieldElement, PrimeFieldElement, QuadraticExtensionFieldElement, SexticExtensionFieldElement
```
public interface GenericFieldElement
extends Cloneable
```
This interface describes the methods every field element has to provide.

Author:

Christian Hanser, Sebastian Ramacher

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GenericFieldElement`	`add(GenericFieldElement b)` Adds `b` to `this`.
`GenericFieldElement`	`addBase(GenericFieldElement b)` Adds `b` to `this` where `b` is an element of the underlying base field.
`GenericFieldElement`	`addOutOfPlace(GenericFieldElement b)` Adds `this` with `b` which is an element of the base field, where a new object holding the result is created.
`GenericFieldElement`	`clone()` Clones the value of this field element.
`GenericFieldElement`	`divide(GenericFieldElement b)` Divides `this` and another field elements.
`boolean`	`equals(Object obj)`
`GenericFieldElement`	`exponentiate(BigInteger n)` Raises `this` to the power `n`.
`GenericFieldElement`	`exponentiate(int n)` Raises `this` to the power `n`.
`GenericFieldElement`	`exponentiateByPowerOf2(int n)` Raise `this` to the power of 2^`n`.
`GenericFieldElement`	`exponentiateOutOfPlace(BigInteger n)` Raises `this` to the power `n`.
`GenericFieldElement`	`exponentiateOutOfPlace(int n)` Raises `this` to the power `n`.
`GenericField`	`getField()` Returns the associated finite field.
`int`	`hashCode()`
`GenericFieldElement`	`invert()` Sets `this` to its inverse.
`boolean`	`isOne()` Determines whether `this` is one.
`boolean`	`isZero()` Determines whether `this` is zero.
`GenericFieldElement`	`multiply(BigInteger n)` Multiples `this` by `n`.
`GenericFieldElement`	`multiply(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the same field.
`GenericFieldElement`	`multiplyByBase(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the base field.
`GenericFieldElement`	`multiplyByBaseOutOfPlace(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the base field, where a new object holding the result is created.
`GenericFieldElement`	`multiplyOutOfPlace(BigInteger n)` Multiples `this` by `n`, where a new object holding the result is created.
`GenericFieldElement`	`multiplyOutOfPlace(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the same field, where a new object holding the result is created.
`GenericFieldElement`	`negate()` Returns the negative of `this`.
`GenericFieldElement`	`negateOutOfPlace()` Returns the negative of `this`, where a new object holding the result is created.
`GenericFieldElement`	`square()` Computes the square of `this` in-place.
`GenericFieldElement`	`squareOutOfPlace()` Computes the square of `this`, where a new object holding the result is created.
`GenericFieldElement`	`squareRoot()` Computes the square root of `this` in-place.
`GenericFieldElement`	`subtract(GenericFieldElement b)` Subtracts `b` from `this`.
`GenericFieldElement`	`subtractOutOfPlace(GenericFieldElement b)` Subtracts `b` from `this` which is an element of the base field, where a new object holding the result is created.
`byte[]`	`toByteArray()` Returns the `byte[]` representation of this instance.
`String`	`toString()`

- Method Detail
  - negate
```
GenericFieldElement negate()
```
    Returns the negative of this. This functions works in-place.
    
    Returns:
    
    the negative of this
  - negateOutOfPlace
```
GenericFieldElement negateOutOfPlace()
```
    Returns the negative of this, where a new object holding the result is created.
    
    Returns:
    
    the negative of this
  - add
```
GenericFieldElement add(GenericFieldElement b)
```
    Adds b to this. This functions works in-place.
    
    Parameters:
    
    b - the second addend
    
    Returns:
    
    the sum of this and b
  - addOutOfPlace
```
GenericFieldElement addOutOfPlace(GenericFieldElement b)
```
    Adds this with b which is an element of the base field, where a new object holding the result is created.
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the sum of this and b
  - addBase
```
GenericFieldElement addBase(GenericFieldElement b)
```
    Adds b to this where b is an element of the underlying base field.
    
    Parameters:
    
    b - the second addend
    
    Returns:
    
    the sum of this and b
  - subtract
```
GenericFieldElement subtract(GenericFieldElement b)
```
    Subtracts b from this. This functions works in-place.
    
    Parameters:
    
    b - the subtrahend
    
    Returns:
    
    the difference of this and b
  - subtractOutOfPlace
```
GenericFieldElement subtractOutOfPlace(GenericFieldElement b)
```
    Subtracts b from this which is an element of the base field, where a new object holding the result is created.
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the difference of this and b
  - invert
```
GenericFieldElement invert()
```
    Sets this to its inverse.
    
    Returns:
    
    the inverse of this
  - multiply
```
GenericFieldElement multiply(GenericFieldElement b)
```
    Multiplies this with b which is an element of the same field.
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiplyOutOfPlace
```
GenericFieldElement multiplyOutOfPlace(GenericFieldElement b)
```
    Multiplies this with b which is an element of the same field, where a new object holding the result is created.
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiplyByBase
```
GenericFieldElement multiplyByBase(GenericFieldElement b)
```
    Multiplies this with b which is an element of the base field.
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiplyByBaseOutOfPlace
```
GenericFieldElement multiplyByBaseOutOfPlace(GenericFieldElement b)
```
    Multiplies this with b which is an element of the base field, where a new object holding the result is created.
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiply
```
GenericFieldElement multiply(BigInteger n)
```
    Multiples this by n.
    
    Parameters:
    
    n - the factor
    
    Returns:
    
    the product of this and n
  - multiplyOutOfPlace
```
GenericFieldElement multiplyOutOfPlace(BigInteger n)
```
    Multiples this by n, where a new object holding the result is created.
    
    Parameters:
    
    n - the factor
    
    Returns:
    
    the product of this and n
  - divide
```
GenericFieldElement divide(GenericFieldElement b)
```
    Divides this and another field elements.
    
    Parameters:
    
    b - the divisor
    
    Returns:
    
    the quotient of this and b
  - square
```
GenericFieldElement square()
```
    Computes the square of this in-place.
    
    Returns:
    
    the square of this
  - squareOutOfPlace
```
GenericFieldElement squareOutOfPlace()
```
    Computes the square of this, where a new object holding the result is created.
    
    Returns:
    
    the square of this
  - squareRoot
```
GenericFieldElement squareRoot()
```
    Computes the square root of this in-place.
    
    Returns:
    
    the square root of this or null if the square root does not exist.
  - exponentiate
```
GenericFieldElement exponentiate(BigInteger n)
```
    Raises this to the power n. Works in-place.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the nth power of this
  - exponentiate
```
GenericFieldElement exponentiate(int n)
```
    Raises this to the power n. Works in-place.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the nth power of this
  - exponentiateOutOfPlace
```
GenericFieldElement exponentiateOutOfPlace(BigInteger n)
```
    Raises this to the power n.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the nth power of this
  - exponentiateOutOfPlace
```
GenericFieldElement exponentiateOutOfPlace(int n)
```
    Raises this to the power n.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the nth power of this
  - exponentiateByPowerOf2
```
GenericFieldElement exponentiateByPowerOf2(int n)
```
    Raise this to the power of 2^n.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the 2^n-th power of this.
  - isOne
```
boolean isOne()
```
    Determines whether this is one.
    
    Returns:
    
    true iff this is the one element
  - isZero
```
boolean isZero()
```
    Determines whether this is zero.
    
    Returns:
    
    true iff this is the zero element
  - getField
```
GenericField getField()
```
    Returns the associated finite field.
    
    Returns:
    
    the associated finite field
  - clone
```
GenericFieldElement clone()
```
    Clones the value of this field element.
    
    Returns:
    
    the clone
  - equals
```
boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
String toString()
```
    Overrides:
    
    toString in class Object
  - toByteArray
```
byte[] toByteArray()
```
    Returns the byte[] representation of this instance.
    
    Returns:
    
    the byte[] representation

Interface GenericFieldElement

Method Summary

Method Detail

negate

negateOutOfPlace

add

addOutOfPlace

addBase

subtract

subtractOutOfPlace

invert

multiply

multiplyOutOfPlace

multiplyByBase

multiplyByBaseOutOfPlace

multiply

multiplyOutOfPlace

divide

square

squareOutOfPlace

squareRoot

exponentiate

exponentiate

exponentiateOutOfPlace

exponentiateOutOfPlace

exponentiateByPowerOf2

isOne

isZero

getField

clone

equals

hashCode

toString

toByteArray