IntegerModuloP (kona-crypto 1.0.4 API)

All Known Subinterfaces:

ImmutableIntegerModuloP, MutableIntegerModuloP

All Known Implementing Classes:

IntegerPolynomial.MutableElement
```
public interface IntegerModuloP
```
The base interface for integers modulo a prime value. Objects of this type may be either mutable or immutable, and subinterfaces can be used to specify that an object is mutable or immutable. This type should never be used to declare local/member variables, but it may be used for formal parameters of a method. None of the methods in this interface modify the value of arguments or this. The behavior of this interface depends on the particular implementation. For example, some implementations only support a limited number of add operations before each multiply operation. See the documentation of the implementation for details.

See Also:

ImmutableIntegerModuloP, MutableIntegerModuloP

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface IntegerModuloP.MultiplicativeInverser

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IntegerModuloP.MultiplicativeInverser`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ImmutableIntegerModuloP`	`add(IntegerModuloP b)` Add this field element with the supplied element and return the result.
`ImmutableIntegerModuloP`	`additiveInverse()` Compute the additive inverse of the field element
`void`	`addModPowerTwo(IntegerModuloP b, byte[] result)` Perform an addition modulo a power of two and store the little-endian encoding of the result in the supplied array.
`default byte[]`	`addModPowerTwo(IntegerModuloP b, int len)` Perform an addition modulo a power of two and return the little-endian encoding of the result.
`java.math.BigInteger`	`asBigInteger()` Get the canonical value of this element as a BigInteger.
`void`	`asByteArray(byte[] result)` Places the little-endian encoding of this' % 2^(8 * result.length) into the supplied array, where this' is the canonical integer value equivalent to this.
`default byte[]`	`asByteArray(int len)` Returns the little-endian encoding of this' % 2^(8 * len), where this' is the canonical integer value equivalent to this.
`ImmutableIntegerModuloP`	`fixed()` Return this value as a fixed (immutable) element.
`IntegerFieldModuloP`	`getField()` Get the field associated with this element.
`default ImmutableIntegerModuloP`	`multiplicativeInverse()` Compute the multiplicative inverse of this field element.
`ImmutableIntegerModuloP`	`multiply(IntegerModuloP b)` Multiply this field element with the supplied element and return the result.
`MutableIntegerModuloP`	`mutable()` Return this value as a mutable element.
`default ImmutableIntegerModuloP`	`pow(java.math.BigInteger b)` Calculate the power this^b and return the result.
`default ImmutableIntegerModuloP`	`square()` Calculate the square of this element and return the result.
`default ImmutableIntegerModuloP`	`subtract(IntegerModuloP b)` Subtract the supplied element from this one and return the result.

- Method Detail
  - getField
```
IntegerFieldModuloP getField()
```
    Get the field associated with this element.
    
    Returns:
    
    the field
  - asBigInteger
```
java.math.BigInteger asBigInteger()
```
    Get the canonical value of this element as a BigInteger. This value will always be in the range [0, p), where p is the prime that defines the field. This method performs reduction and other computation to produce the result.
    
    Returns:
    
    the value as a BigInteger
  - fixed
```
ImmutableIntegerModuloP fixed()
```
    Return this value as a fixed (immutable) element. This method will copy the underlying representation if the object is mutable.
    
    Returns:
    
    a fixed element with the same value
  - mutable
```
MutableIntegerModuloP mutable()
```
    Return this value as a mutable element. This method will always copy the underlying representation.
    
    Returns:
    
    a mutable element with the same value
  - add
```
ImmutableIntegerModuloP add(IntegerModuloP b)
```
    Add this field element with the supplied element and return the result.
    
    Parameters:
    
    b - the sumand
    
    Returns:
    
    this + b
  - additiveInverse
```
ImmutableIntegerModuloP additiveInverse()
```
    Compute the additive inverse of the field element
    
    Returns:
    
    the addditiveInverse (0 - this)
  - multiply
```
ImmutableIntegerModuloP multiply(IntegerModuloP b)
```
    Multiply this field element with the supplied element and return the result.
    
    Parameters:
    
    b - the multiplicand
    
    Returns:
    
    this * b
  - addModPowerTwo
```
default byte[] addModPowerTwo(IntegerModuloP b,
                              int len)
```
    Perform an addition modulo a power of two and return the little-endian encoding of the result. The value is (this' + b') % 2^(8 * len), where this' and b' are the canonical integer values equivalent to this and b.
    
    Parameters:
    
    b - the sumand
    
    len - the length of the desired array
    
    Returns:
    
    a byte array of length len containing the result
  - addModPowerTwo
```
void addModPowerTwo(IntegerModuloP b,
                    byte[] result)
```
    Perform an addition modulo a power of two and store the little-endian encoding of the result in the supplied array. The value is (this' + b') % 2^(8 * result.length), where this' and b' are the canonical integer values equivalent to this and b.
    
    Parameters:
    
    b - the sumand
    
    result - an array which stores the result upon return
  - asByteArray
```
default byte[] asByteArray(int len)
```
    Returns the little-endian encoding of this' % 2^(8 * len), where this' is the canonical integer value equivalent to this.
    
    Parameters:
    
    len - the length of the desired array
    
    Returns:
    
    a byte array of length len containing the result
  - asByteArray
```
void asByteArray(byte[] result)
```
    Places the little-endian encoding of this' % 2^(8 * result.length) into the supplied array, where this' is the canonical integer value equivalent to this.
    
    Parameters:
    
    result - an array which stores the result upon return
  - multiplicativeInverse
```
default ImmutableIntegerModuloP multiplicativeInverse()
```
    Compute the multiplicative inverse of this field element.
    
    Returns:
    
    the multiplicative inverse (1 / this)
  - subtract
```
default ImmutableIntegerModuloP subtract(IntegerModuloP b)
```
    Subtract the supplied element from this one and return the result.
    
    Parameters:
    
    b - the subtrahend
    
    Returns:
    
    the difference (this - b)
  - square
```
default ImmutableIntegerModuloP square()
```
    Calculate the square of this element and return the result. This method should be used instead of a.multiply(a) because implementations may include optimizations that only apply to squaring.
    
    Returns:
    
    the product (this * this)
  - pow
```
default ImmutableIntegerModuloP pow(java.math.BigInteger b)
```
    Calculate the power this^b and return the result.
    
    Parameters:
    
    b - the exponent
    
    Returns:
    
    the value of this^b

Interface IntegerModuloP

Nested Class Summary

Method Summary

Method Detail

getField

asBigInteger

fixed

mutable

add

additiveInverse

multiply

addModPowerTwo

addModPowerTwo

asByteArray

asByteArray

multiplicativeInverse

subtract

square

pow