Polynomial ("Entrust Authority Security Toolkit for the Java Platform")

java.lang.Object
- com.entrust.toolkit.security.arithmetic.fields.Polynomial

All Implemented Interfaces:

FieldElement

Deprecated.
since 8.0; use Entrust's new EC architecture com.entrust.toolkit.security.crypto.ec instead
```
public class Polynomial
extends java.lang.Object
implements FieldElement
```
This interface defines an element in a mathematical field.

Constructor Summary

Constructors
Constructor and Description
`Polynomial(java.math.BigInteger value, PolynomialField field)` Deprecated. Creates an element in the `GF2mTrinomial field`.
`Polynomial(Polynomial template)` Deprecated. Creates an element that is the exact copy of the `template` argument.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`FieldElement`	`add(FieldElement b)` Deprecated. Adds th e argument, `b`, to the calling element and returns the result.
`void`	`copy(Polynomial template)` Deprecated. Copies the value of the `template` argument into the calling element.
`boolean`	`equals(java.lang.Object obj)` Deprecated. Compares two polynomials for equality.
`FieldElement`	`exponentiate(java.math.BigInteger b)` Deprecated. Multiplies the calling by itself `b` times and returns the result.
`java.math.BigInteger`	`getBigInteger()` Deprecated. Returns the calling element as an integer.
`int`	`getDegree()` Deprecated. Returns the degree of the calling polynomial.
`Field`	`getField()` Deprecated. Returns the mathematical field to which the calling element belongs.
`static boolean`	`isIrreducible(java.math.BigInteger polynome)` Deprecated. Returns `true` if and only if `polynome` is irreducible.
`FieldElement`	`multiplicativeInverse()` Deprecated. Returns the multiplicative inverse of the calling element.
`FieldElement`	`multiply(FieldElement b)` Deprecated. Multiplies the argument, `b`, by the calling element and returns the result.
`void`	`setAdd(Polynomial b)` Deprecated. Adds the argument, `b`, to the calling element.
`void`	`setMultiplicativeInverse()` Deprecated. Inverts the calling element.
`void`	`setMultiply(Polynomial b)` Deprecated. Multiplies the argument, `b`, by the calling element.
`FieldElement`	`subtract(FieldElement b)` Deprecated. Subtracts the argument, `b`, from the calling element and returns the result.
`ASN1Object`	`toASN1Object()` Deprecated. Returns an ASN.1 structure representing the calling element.
`java.lang.String`	`toString()` Deprecated. Returns a `String` representation of the calling polynomial.

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Polynomial
```
public Polynomial(java.math.BigInteger value,
                  PolynomialField field)
```
    Deprecated.
    
    Creates an element in the GF2mTrinomial field.
    
    Parameters:
    
    value - the value of the element encoded as an integer
    
    field - the field to which this element belongs
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is negative
    
    java.lang.NullPointerException - if field is null
  - Polynomial
```
public Polynomial(Polynomial template)
```
    Deprecated.
    
    Creates an element that is the exact copy of the template argument.
    
    Parameters:
    
    template - the element to be copied
    
    Throws:
    
    java.lang.NullPointerException - if template is null
- Method Detail
  - copy
```
public void copy(Polynomial template)
```
    Deprecated.
    
    Copies the value of the template argument into the calling element.
    template must belong to the same field as the calling element.
    
    Parameters:
    
    template - the element to copy
    
    Throws:
    
    java.lang.NullPointerException - if template is null
  - getField
```
public Field getField()
```
    Deprecated.
    
    Returns the mathematical field to which the calling element belongs.
    
    Specified by:
    
    getField in interface FieldElement
    
    Returns:
    
    the Field to which this element belongs
  - add
```
public FieldElement add(FieldElement b)
                 throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Adds th e argument, b, to the calling element and returns the result.
    The calling element remains unchanged.
    
    Specified by:
    
    add in interface FieldElement
    
    Parameters:
    
    b - the value to add to this element
    
    Returns:
    
    the element this+b
    
    Throws:
    
    java.lang.IllegalArgumentException - if b does not belong to the same field as the calling element
  - setAdd
```
public void setAdd(Polynomial b)
```
    Deprecated.
    
    Adds the argument, b, to the calling element.
    
    Parameters:
    
    b - the value to add to the calling element
  - subtract
```
public FieldElement subtract(FieldElement b)
                      throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Subtracts the argument, b, from the calling element and returns the result.
    The calling element remains unchanged.
    
    Specified by:
    
    subtract in interface FieldElement
    
    Parameters:
    
    b - the value to substract from this element
    
    Returns:
    
    the element this-b
    
    Throws:
    
    java.lang.IllegalArgumentException - if b does not belong to the same field as the calling element
  - multiply
```
public FieldElement multiply(FieldElement b)
                      throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Multiplies the argument, b, by the calling element and returns the result.
    This element remains unchanged.
    
    Specified by:
    
    multiply in interface FieldElement
    
    Parameters:
    
    b - the value to multiply to this element
    
    Returns:
    
    the element this*b
    
    Throws:
    
    java.lang.IllegalArgumentException - if b does not belong to the same field as teh calling element
  - setMultiply
```
public void setMultiply(Polynomial b)
```
    Deprecated.
    
    Multiplies the argument, b, by the calling element.
    
    Parameters:
    
    b - the value to multiply by the calling element
  - multiplicativeInverse
```
public FieldElement multiplicativeInverse()
```
    Deprecated.
    
    Returns the multiplicative inverse of the calling element.
    For every element e, there is one multiplicative inverse i, such that e*i = o, where o is the one element of the field to which e and i belong.
    
    Specified by:
    
    multiplicativeInverse in interface FieldElement
    
    Returns:
    
    the multiplicative inverse of the calling element
  - setMultiplicativeInverse
```
public void setMultiplicativeInverse()
```
    Deprecated.
    
    Inverts the calling element.
  - exponentiate
```
public FieldElement exponentiate(java.math.BigInteger b)
                          throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Multiplies the calling by itself b times and returns the result.
    The calling element remains unchanged.
    
    Specified by:
    
    exponentiate in interface FieldElement
    
    Parameters:
    
    b - the exponent
    
    Returns:
    
    the element this^b
    
    Throws:
    
    java.lang.IllegalArgumentException - if b is negative
  - getDegree
```
public int getDegree()
```
    Deprecated.
    
    Returns the degree of the calling polynomial.
    The number of bits used to represent a polynomial is degree+1.
    
    Returns:
    
    the degree of the calling polynomial
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Deprecated.
    Compares two polynomials for equality.
    The equals method implements an equivalence relation:
    - It is reflexive: for any reference value x, x.equals(x) should return true.
    - It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false.
    - For any reference value x, x.equals(null) should return false.
    Two polynomials are equal if their fields and their integer representations are equal.
    Specified by:
    
    equals in interface FieldElement
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    obj - the reference polynomial with which to compare
    
    Returns:
    
    true if the calling polynomial is the same as the obj argument — false otherwise
  - getBigInteger
```
public java.math.BigInteger getBigInteger()
```
    Deprecated.
    
    Returns the calling element as an integer.
    The element is converted according to X9.62.
    
    Specified by:
    
    getBigInteger in interface FieldElement
    
    Returns:
    
    the integer representing the calling element
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    Returns a String representation of the calling polynomial.
    
    Specified by:
    
    toString in interface FieldElement
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the hexadecimal value of the integer representation of this polynomial as a String
  - toASN1Object
```
public ASN1Object toASN1Object()
```
    Deprecated.
    
    Returns an ASN.1 structure representing the calling element.
    The ASN.1 structure is built according to the definition in X9.62.
    
    Specified by:
    
    toASN1Object in interface FieldElement
    
    Returns:
    
    the calling element as an ASN.1 structure
  - isIrreducible
```
public static boolean isIrreducible(java.math.BigInteger polynome)
```
    Deprecated.
    
    Returns true if and only if polynome is irreducible.
    
    Parameters:
    
    polynome - the integer representation of the polynomial to be tested for irreducibility
    
    Returns:
    
    true if the polynome is irreducible — false otherwise

Class Polynomial

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Polynomial

Polynomial

Method Detail

copy

getField

add

setAdd

subtract

multiply

setMultiply

multiplicativeInverse

setMultiplicativeInverse

exponentiate

getDegree

equals

getBigInteger

toString

toASN1Object

isIrreducible