com.entrust.toolkit.security.arithmetic.fields

Interface FieldElement

All Known Implementing Classes:

GFpElement, Polynomial

Deprecated.

since 8.0; use Entrust's new EC architecture com.entrust.toolkit.security.crypto.ec instead

public interface FieldElement

Defines typical methods related to the mathematical structure of a field element.

Method Summary

Modifier and Type	Method and Description
FieldElement	add(FieldElement operand) Deprecated. Adds operand to the calling element and returns the result.
boolean	equals(java.lang.Object obj) Deprecated. Compares two field elements for equality.
FieldElement	exponentiate(java.math.BigInteger exponent) Deprecated. Multiplies the calling element exponent by itself and returns the result.
java.math.BigInteger	getBigInteger() Deprecated. Returns an integer representation of the calling field element.
Field	getField() Deprecated. Returns the mathematical field to which this element belongs.
FieldElement	multiplicativeInverse() Deprecated. Returns the multiplicative inverse of this element in its field.
FieldElement	multiply(FieldElement operand) Deprecated. Multiplies operand by the calling element and returns the result.
FieldElement	subtract(FieldElement operand) Deprecated. Subtracts operand from the calling element and returns the result.
ASN1Object	toASN1Object() Deprecated. Returns an ASN.1 structure representing this field element.
java.lang.String	toString() Deprecated. Returns the string representation.

Method Detail

getField

Field getField()

Deprecated.

Returns the mathematical field to which this element belongs.

Returns:

the Field object to which this element belongs.

add

FieldElement add(FieldElement operand)
          throws java.lang.IllegalArgumentException

Deprecated.

Adds operand to the calling element and returns the result.

Note

The calling element remains unchanged.

Parameters:

operand - the value to add to the calling element

Returns:

a FieldElement — this+operand

Throws:

java.lang.IllegalArgumentException - if operand does not belong to the same field as the calling element

subtract

FieldElement subtract(FieldElement operand)
               throws java.lang.IllegalArgumentException

Deprecated.

Subtracts operand from the calling element and returns the result.

Note

The calling element remains unchanged.

Parameters:

operand - the value to substract from the calling element

Returns:

a FieldElement — this-operand

Throws:

java.lang.IllegalArgumentException - if operand does not belong to the same field as the calling element

multiply

FieldElement multiply(FieldElement operand)
               throws java.lang.IllegalArgumentException

Deprecated.

Multiplies operand by the calling element and returns the result.

Note

The calling element remains unchanged.

Parameters:

operand - the value with which to multiply the calling element

Returns:

a FieldElement — this*operand

Throws:

java.lang.IllegalArgumentException - if operand does not belong to the same field as the calling element

multiplicativeInverse

FieldElement multiplicativeInverse()
                            throws java.lang.ArithmeticException

Deprecated.

Returns the multiplicative inverse of this element in its field.

The zero element does not have a multiplicative inverse. For each field element e other than the zero element, e.multiply(e.multiplicativeInverse()) is always the one element (or identity element) of its field.

Returns:

a FieldElement — the multiplicative inverse element of the calling element

Throws:

java.lang.ArithmeticException - if the calling element is the zero element of its field

exponentiate

FieldElement exponentiate(java.math.BigInteger exponent)

Deprecated.

Multiplies the calling element exponent by itself and returns the result.

Note

The calling element remains unchanged.

Parameters:

exponent - the exponent

Returns:

a FieldElement — this^exponent

equals

boolean equals(java.lang.Object obj)

Deprecated.

Compares two field elements for equality.

Two field elements are equal if their fields and their integer representations are equal.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference field element with which to compare

Returns:

true if the calling field element is equal to obj, false otherwise

getBigInteger

java.math.BigInteger getBigInteger()

Deprecated.

Returns an integer representation of the calling field element.

The integer representation must be reversible — given the field and the integer representation, the calling field element must be uniquely identified.

Returns:

the integer representation of the calling element

toASN1Object

ASN1Object toASN1Object()

Deprecated.

Returns an ASN.1 structure representing this field element.

Although the ASN.1 encoding is not inherent in the field, this method is quite useful when used with elliptic curve cryptography (ECC) operations.

Returns:

the calling element as an ASN.1 structure

toString

java.lang.String toString()

Deprecated.

Returns the string representation.

Overrides:

toString in class java.lang.Object

Returns:

the string