com.github.signaflo.math

Class Rational

java.lang.Object

com.github.signaflo.math.Rational

All Implemented Interfaces:

FieldElement<Rational>, Comparable<Rational>

public final class Rational
extends Object
implements FieldElement<Rational>

A representation of a rational number. This class is immutable and thread-safe.

Method Summary

Modifier and Type	Method and Description
double	abs() Compute and return the absolute value of this element.
Rational	additiveInverse() Return the element of this field that, when added to this element, produces the additive identity.
int	compareTo(Rational other)
Complex	complexSqrt() The square root operation applied to this element, returning a complex number.
Rational	conjugate() Compute and return the conjugate of this element.
Rational	dividedBy(Rational value) Divide this element by the given element and return the result.
boolean	equals(Object o)
static Rational	from(int p)
static Rational	from(int p, int q)
int	hashCode()
Rational	minus(Rational other) Subtract the given element from this element.
Rational	plus(Rational other) Add this element to the given element.
Rational	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.
Rational	times(Rational other) Multiply this element by the given element.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

from

public static Rational from(int p,
                            int q)

from

public static Rational from(int p)

plus

public Rational plus(Rational other)

Description copied from interface: FieldElement

Add this element to the given element.

Specified by:

plus in interface FieldElement<Rational>

Parameters:

other - the element to add to this element.

Returns:

this element added to the given element.

minus

public Rational minus(Rational other)

Description copied from interface: FieldElement

Subtract the given element from this element.

Specified by:

minus in interface FieldElement<Rational>

Parameters:

other - the element to subtract from this element.

Returns:

this element subtracted by the given element.

times

public Rational times(Rational other)

Description copied from interface: FieldElement

Multiply this element by the given element.

Specified by:

times in interface FieldElement<Rational>

Parameters:

other - the element to multiply this element by.

Returns:

this element multiplied by the given element.

sqrt

public Rational sqrt()

Description copied from interface: FieldElement

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 FieldElement.complexSqrt() should be used instead.

Specified by:

sqrt in interface FieldElement<Rational>

Returns:

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

complexSqrt

public Complex complexSqrt()

Description copied from interface: FieldElement

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

Specified by:

complexSqrt in interface FieldElement<Rational>

Returns:

the square root of this element.

conjugate

public Rational conjugate()

Description copied from interface: FieldElement

Compute and return the conjugate of this element.

Specified by:

conjugate in interface FieldElement<Rational>

Returns:

the conjugate of this element.

additiveInverse

public Rational additiveInverse()

Description copied from interface: FieldElement

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

Specified by:

additiveInverse in interface FieldElement<Rational>

Returns:

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

abs

public double abs()

Description copied from interface: FieldElement

Compute and return the absolute value of this element.

Specified by:

abs in interface FieldElement<Rational>

Returns:

the absolute value of this element.

dividedBy

public Rational dividedBy(Rational value)

Description copied from interface: FieldElement

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

Specified by:

dividedBy in interface FieldElement<Rational>

Parameters:

value - the divisor.

Returns:

this element divided by the given element.

compareTo

public int compareTo(@NonNull
                     Rational other)

Specified by:

compareTo in interface Comparable<Rational>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object