PrimeCharacteristicFieldElement (ECCelerate 6.2 API)

All Superinterfaces:

Cloneable, GenericFieldElement

All Known Subinterfaces:

ExtensionFieldElement

All Known Implementing Classes:

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

Author:

Christian Hanser

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PrimeCharacteristicFieldElement`	`add(GenericFieldElement b)` Adds `b` to `this`.
`PrimeCharacteristicFieldElement`	`addBase(GenericFieldElement b)` Adds `b` to `this` where `b` is an element of the underlying base field.
`PrimeCharacteristicFieldElement`	`addOutOfPlace(GenericFieldElement b)` Adds two elements and returns a new object holding the result.
`PrimeCharacteristicFieldElement`	`addOutOfPlace(PrimeCharacteristicFieldElement b)` Adds two elements and returns a new object holding the result.
`PrimeCharacteristicFieldElement`	`clone()` Clones the value of this field element.
`PrimeCharacteristicFieldElement`	`divide(GenericFieldElement b)` Divides `this` and another field elements.
`PrimeCharacteristicFieldElement`	`divideBy2()` Divides `this` by 2.
`PrimeCharacteristicFieldElement`	`exponentiate(BigInteger n)` Raises `this` to the power `n`.
`PrimeCharacteristicFieldElement`	`exponentiate(int n)` Raises `this` to the power `n`.
`PrimeCharacteristicFieldElement`	`exponentiateByPowerOf2(int n)` Raise `this` to the power of 2^`n`.
`int`	`getQuadraticCharacter()` Implements a quadratic character, which returns -1,0,1 depending on whether `this` is a quadratic non-residue, a multiple of the modulus, or a quadratic residue.
`PrimeCharacteristicFieldElement`	`invert()` Sets `this` to its inverse.
`PrimeCharacteristicFieldElement`	`multiply(BigInteger b)` Multiples `this` by `n`.
`PrimeCharacteristicFieldElement`	`multiply(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the same field.
`PrimeCharacteristicFieldElement`	`multiplyBy2()` Multiplies `this` with 2.
`PrimeCharacteristicFieldElement`	`multiplyBy2OutOfPlace()` Multiplies `this` with 2 and returns a new object holding the result.
`PrimeCharacteristicFieldElement`	`multiplyBy3()` Multiplies `this` with 3.
`PrimeCharacteristicFieldElement`	`multiplyBy3OutOfPlace()` Multiplies `this` with 3 and returns a new object holding the result.
`PrimeCharacteristicFieldElement`	`multiplyByBase(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the base field.
`PrimeCharacteristicFieldElement`	`multiplyByBaseOutOfPlace(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the base field, where a new object holding the result is created.
`PrimeCharacteristicFieldElement`	`multiplyByPowerOf2(int n)` Multiplies `this` by 2^`n`.
`PrimeCharacteristicFieldElement`	`multiplyByPowerOf2OutOfPlace(int n)` Multiplies `this` by 2^`n` and returns a new object holding the result.
`PrimeCharacteristicFieldElement`	`multiplyOutOfPlace(BigInteger b)` Multiples `this` by `n`, where a new object holding the result is created.
`PrimeCharacteristicFieldElement`	`multiplyOutOfPlace(GenericFieldElement b)` Multiplies `this` with `b` which is an element of the same field, where a new object holding the result is created.
`PrimeCharacteristicFieldElement`	`negate()` Returns the negative of `this`.
`PrimeCharacteristicFieldElement`	`negateOutOfPlace()` Returns the negative of `this`, where a new object holding the result is created.
`PrimeCharacteristicFieldElement`	`square()` Computes the square of `this` in-place.
`PrimeCharacteristicFieldElement`	`squareOutOfPlace()` Computes the square of `this`, where a new object holding the result is created.
`PrimeCharacteristicFieldElement`	`squareRoot()` Computes the square root of `this` in-place.
`PrimeCharacteristicFieldElement`	`squareRoot(boolean checkSquare)` Computes the square root of `this`.
`PrimeCharacteristicFieldElement`	`subtract(GenericFieldElement b)` Subtracts `b` from `this`.
`PrimeCharacteristicFieldElement`	`subtractOutOfPlace(GenericFieldElement b)` Subtracts `b` from `this` which is an element of the base field, where a new object holding the result is created.
`PrimeCharacteristicFieldElement`	`subtractOutOfPlace(PrimeCharacteristicFieldElement b)` Subtracts `b` from `this` and returns a new object holding the result.

Methods inherited from interface iaik.security.ec.math.field.GenericFieldElement
equals, exponentiateOutOfPlace, exponentiateOutOfPlace, getField, hashCode, isOne, isZero, toByteArray, toString

- Method Detail
  - multiplyBy2
```
PrimeCharacteristicFieldElement multiplyBy2()
```
    Multiplies this with 2.
    
    Returns:
    
    the product of this and 2
  - multiplyBy2OutOfPlace
```
PrimeCharacteristicFieldElement multiplyBy2OutOfPlace()
```
    Multiplies this with 2 and returns a new object holding the result.
    
    Returns:
    
    the product of this and 2
  - multiplyBy3
```
PrimeCharacteristicFieldElement multiplyBy3()
```
    Multiplies this with 3.
    
    Returns:
    
    the product of this and 3
  - multiplyBy3OutOfPlace
```
PrimeCharacteristicFieldElement multiplyBy3OutOfPlace()
```
    Multiplies this with 3 and returns a new object holding the result.
    
    Returns:
    
    the product of this and 3
  - multiplyByPowerOf2
```
PrimeCharacteristicFieldElement multiplyByPowerOf2(int n)
```
    Multiplies this by 2^n.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the product of this and 2^n
  - multiplyByPowerOf2OutOfPlace
```
PrimeCharacteristicFieldElement multiplyByPowerOf2OutOfPlace(int n)
```
    Multiplies this by 2^n and returns a new object holding the result.
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the product of this and 2^n
  - divideBy2
```
PrimeCharacteristicFieldElement divideBy2()
```
    Divides this by 2.
    
    Returns:
    
    this divided by 2.
  - add
```
PrimeCharacteristicFieldElement add(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Adds b to this. This functions works in-place.
    
    Specified by:
    
    add in interface GenericFieldElement
    
    Parameters:
    
    b - the second addend
    
    Returns:
    
    the sum of this and b
  - addOutOfPlace
```
PrimeCharacteristicFieldElement addOutOfPlace(GenericFieldElement b)
```
    Adds two elements and returns a new object holding the result.
    
    Specified by:
    
    addOutOfPlace in interface GenericFieldElement
    
    Parameters:
    
    b - the other value
    
    Returns:
    
    the sum
  - addOutOfPlace
```
PrimeCharacteristicFieldElement addOutOfPlace(PrimeCharacteristicFieldElement b)
```
    Adds two elements and returns a new object holding the result.
    
    Parameters:
    
    b - the other value
    
    Returns:
    
    the sum
  - multiply
```
PrimeCharacteristicFieldElement multiply(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Multiplies this with b which is an element of the same field.
    
    Specified by:
    
    multiply in interface GenericFieldElement
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiply
```
PrimeCharacteristicFieldElement multiply(BigInteger b)
```
    Description copied from interface: GenericFieldElement
    
    Multiples this by n.
    
    Specified by:
    
    multiply in interface GenericFieldElement
    
    Parameters:
    
    b - the factor
    
    Returns:
    
    the product of this and n
  - multiplyOutOfPlace
```
PrimeCharacteristicFieldElement multiplyOutOfPlace(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Multiplies this with b which is an element of the same field, where a new object holding the result is created.
    
    Specified by:
    
    multiplyOutOfPlace in interface GenericFieldElement
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiplyOutOfPlace
```
PrimeCharacteristicFieldElement multiplyOutOfPlace(BigInteger b)
```
    Description copied from interface: GenericFieldElement
    
    Multiples this by n, where a new object holding the result is created.
    
    Specified by:
    
    multiplyOutOfPlace in interface GenericFieldElement
    
    Parameters:
    
    b - the factor
    
    Returns:
    
    the product of this and n
  - multiplyByBase
```
PrimeCharacteristicFieldElement multiplyByBase(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Multiplies this with b which is an element of the base field.
    
    Specified by:
    
    multiplyByBase in interface GenericFieldElement
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - multiplyByBaseOutOfPlace
```
PrimeCharacteristicFieldElement multiplyByBaseOutOfPlace(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Multiplies this with b which is an element of the base field, where a new object holding the result is created.
    
    Specified by:
    
    multiplyByBaseOutOfPlace in interface GenericFieldElement
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the product of this and b
  - square
```
PrimeCharacteristicFieldElement square()
```
    Description copied from interface: GenericFieldElement
    
    Computes the square of this in-place.
    
    Specified by:
    
    square in interface GenericFieldElement
    
    Returns:
    
    the square of this
  - squareOutOfPlace
```
PrimeCharacteristicFieldElement squareOutOfPlace()
```
    Description copied from interface: GenericFieldElement
    
    Computes the square of this, where a new object holding the result is created.
    
    Specified by:
    
    squareOutOfPlace in interface GenericFieldElement
    
    Returns:
    
    the square of this
  - addBase
```
PrimeCharacteristicFieldElement addBase(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Adds b to this where b is an element of the underlying base field.
    
    Specified by:
    
    addBase in interface GenericFieldElement
    
    Parameters:
    
    b - the second addend
    
    Returns:
    
    the sum of this and b
  - exponentiate
```
PrimeCharacteristicFieldElement exponentiate(BigInteger n)
```
    Description copied from interface: GenericFieldElement
    
    Raises this to the power n. Works in-place.
    
    Specified by:
    
    exponentiate in interface GenericFieldElement
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the nth power of this
  - exponentiate
```
PrimeCharacteristicFieldElement exponentiate(int n)
```
    Description copied from interface: GenericFieldElement
    
    Raises this to the power n. Works in-place.
    
    Specified by:
    
    exponentiate in interface GenericFieldElement
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the nth power of this
  - exponentiateByPowerOf2
```
PrimeCharacteristicFieldElement exponentiateByPowerOf2(int n)
```
    Description copied from interface: GenericFieldElement
    
    Raise this to the power of 2^n.
    
    Specified by:
    
    exponentiateByPowerOf2 in interface GenericFieldElement
    
    Parameters:
    
    n - the exponent
    
    Returns:
    
    the 2^n-th power of this.
  - subtract
```
PrimeCharacteristicFieldElement subtract(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Subtracts b from this. This functions works in-place.
    
    Specified by:
    
    subtract in interface GenericFieldElement
    
    Parameters:
    
    b - the subtrahend
    
    Returns:
    
    the difference of this and b
  - subtractOutOfPlace
```
PrimeCharacteristicFieldElement subtractOutOfPlace(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Subtracts b from this which is an element of the base field, where a new object holding the result is created.
    
    Specified by:
    
    subtractOutOfPlace in interface GenericFieldElement
    
    Parameters:
    
    b - the second factor
    
    Returns:
    
    the difference of this and b
  - subtractOutOfPlace
```
PrimeCharacteristicFieldElement subtractOutOfPlace(PrimeCharacteristicFieldElement b)
```
    Subtracts b from this and returns a new object holding the result.
    
    Parameters:
    
    b - the subtrahend
    
    Returns:
    
    the difference of this and b
  - negate
```
PrimeCharacteristicFieldElement negate()
```
    Description copied from interface: GenericFieldElement
    
    Returns the negative of this. This functions works in-place.
    
    Specified by:
    
    negate in interface GenericFieldElement
    
    Returns:
    
    the negative of this
  - negateOutOfPlace
```
PrimeCharacteristicFieldElement negateOutOfPlace()
```
    Description copied from interface: GenericFieldElement
    
    Returns the negative of this, where a new object holding the result is created.
    
    Specified by:
    
    negateOutOfPlace in interface GenericFieldElement
    
    Returns:
    
    the negative of this
  - divide
```
PrimeCharacteristicFieldElement divide(GenericFieldElement b)
```
    Description copied from interface: GenericFieldElement
    
    Divides this and another field elements.
    
    Specified by:
    
    divide in interface GenericFieldElement
    
    Parameters:
    
    b - the divisor
    
    Returns:
    
    the quotient of this and b
  - invert
```
PrimeCharacteristicFieldElement invert()
```
    Description copied from interface: GenericFieldElement
    
    Sets this to its inverse.
    
    Specified by:
    
    invert in interface GenericFieldElement
    
    Returns:
    
    the inverse of this
  - squareRoot
```
PrimeCharacteristicFieldElement squareRoot()
```
    Description copied from interface: GenericFieldElement
    
    Computes the square root of this in-place.
    
    Specified by:
    
    squareRoot in interface GenericFieldElement
    
    Returns:
    
    the square root of this or null if the square root does not exist.
  - squareRoot
```
PrimeCharacteristicFieldElement squareRoot(boolean checkSquare)
```
    Computes the square root of this.
    
    Parameters:
    
    checkSquare - check if a is a square. If true, the return value is undefined for non-squares.
    
    Returns:
    
    square root of this
  - getQuadraticCharacter
```
int getQuadraticCharacter()
```
    Implements a quadratic character, which returns -1,0,1 depending on whether this is a quadratic non-residue, a multiple of the modulus, or a quadratic residue.
    
    Returns:
    
    the quadratic character (this/p)
  - clone
```
PrimeCharacteristicFieldElement clone()
```
    Description copied from interface: GenericFieldElement
    
    Clones the value of this field element.
    
    Specified by:
    
    clone in interface GenericFieldElement
    
    Returns:
    
    the clone

Interface PrimeCharacteristicFieldElement

Method Summary

Methods inherited from interface iaik.security.ec.math.field.GenericFieldElement

Method Detail

multiplyBy2

multiplyBy2OutOfPlace

multiplyBy3

multiplyBy3OutOfPlace

multiplyByPowerOf2

multiplyByPowerOf2OutOfPlace

divideBy2

add

addOutOfPlace

addOutOfPlace

multiply

multiply

multiplyOutOfPlace

multiplyOutOfPlace

multiplyByBase

multiplyByBaseOutOfPlace

square

squareOutOfPlace

addBase

exponentiate

exponentiate

exponentiateByPowerOf2

subtract

subtractOutOfPlace

subtractOutOfPlace

negate

negateOutOfPlace

divide

invert

squareRoot

squareRoot

getQuadraticCharacter

clone