com.github.signaflo.math

Interface FieldElement<T>

Type Parameters:

T - The type of field element.

All Superinterfaces:

Comparable<T>

All Known Implementing Classes:

Complex, Rational, Real

public interface FieldElement<T>
extends Comparable<T>

Represents an element of a mathematical field.

Method Summary

Modifier and Type	Method and Description
double	abs() Compute and return the absolute value of this element.
T	additiveInverse() Return the element of this field that, when added to this element, produces the additive identity.
Complex	complexSqrt() The square root operation applied to this element, returning a complex number.
T	conjugate() Compute and return the conjugate of this element.
T	dividedBy(T other) Divide this element by the given element and return the result.
T	minus(T other) Subtract the given element from this element.
T	plus(T other) Add this element to the given element.
T	sqrt() Computes and returns the square root of this number as long as the square root is of the same type (i.e., belongs to the same field) as this number.
T	times(T other) Multiply this element by the given element.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

plus

T plus(T other)

Add this element to the given element.

Parameters:

other - the element to add to this element.

Returns:

this element added to the given element.

minus

T minus(T other)

Subtract the given element from this element.

Parameters:

other - the element to subtract from this element.

Returns:

this element subtracted by the given element.

times

T times(T other)

Multiply this element by the given element.

Parameters:

other - the element to multiply this element by.

Returns:

this element multiplied by the given element.

complexSqrt

Complex complexSqrt()

The square root operation applied to this element, returning a complex number. If the field this element belongs to is not part of the complex number hierarchy, then implementations may throw an IllegalStateException

Returns:

the square root of this element.

Throws:

IllegalStateException - if the field this element belongs to is not part of the complex hierarchy.

sqrt

T sqrt()

Computes and returns the square root of this number as long as the square root is of the same type (i.e., belongs to the same field) as this number. If the return type is not guaranteed to be of the same type as this number, then complexSqrt() should be used instead.

Returns:

the square root of this number if the square root is of the same type.

Throws:

IllegalStateException - if the square root is not of the same type as this number.

conjugate

T conjugate()

Compute and return the conjugate of this element.

Returns:

the conjugate of this element.

additiveInverse

T additiveInverse()

Return the element of this field that, when added to this element, produces the additive identity.

Returns:

the element of this field that, when added to this element, produces the additive identity.

abs

double abs()

Compute and return the absolute value of this element.

Returns:

the absolute value of this element.

dividedBy

T dividedBy(T other)

Divide this element by the given element and return the result.

Parameters:

other - the divisor.

Returns:

this element divided by the given element.