org.rvpf.base.value

Class Rational

Object

Number

Rational

All Implemented Interfaces:

Serializable, Comparable<Rational>

@Immutable
public final class Rational
extends Number
implements Comparable<Rational>

Rational.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Rational	abs() Returns the absolute value of this number.
Rational	add(long integer) Adds an integer.
Rational	add(Rational other) Adds an other rational.
int	compareTo(Rational other)
Rational	divide(long integer) Divides by an integer.
Rational	divide(Rational other) Divides by an other rational.
double	doubleValue()
boolean	equals(Object object)
float	floatValue()
long	getDenominator() Gets the denominator.
long	getNumerator() Gets the numerator.
int	hashCode()
int	intValue()
long	longValue()
Rational	multiply(long integer) Multiplies by an integer.
Rational	multiply(Rational other) Multiplies by an other rational.
Rational	negate() Negates this number.
Rational	reciprocal() Returns the reciprocal value of this number.
int	signum() Returns the signum function of this number.
Rational	subtract(long integer) Subtracts an integer.
Rational	subtract(Rational other) Subtracts an other rational.
String	toString()
static Rational	valueOf(long numerator, long denominator) Returns a rational number having the values specified.
static Rational	valueOf(String string) Returns a rational number from the value of a string.

Methods inherited from class Number

byteValue, shortValue

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

valueOf

@Nonnull
 @CheckReturnValue
public static Rational valueOf(@Nonnull
                                                             String string)

Returns a rational number from the value of a string.

Parameters:

string - The string.

Returns:

The rational number.

valueOf

@Nonnull
 @CheckReturnValue
public static Rational valueOf(long numerator,
                                                             long denominator)

Returns a rational number having the values specified.

Parameters:

numerator - The numerator.

denominator - The denominator.

Returns:

The rational number.

abs

@Nonnull
 @CheckReturnValue
public Rational abs()

Returns the absolute value of this number.

Returns:

The absolute value.

add

@Nonnull
 @CheckReturnValue
public Rational add(long integer)

Adds an integer.

Parameters:

integer - The (long) integer.

Returns:

The result.

add

@Nonnull
 @CheckReturnValue
public Rational add(@Nonnull
                                                  Rational other)

Adds an other rational.

Parameters:

other - The other rational.

Returns:

The result.

compareTo

public int compareTo(Rational other)

Specified by:

compareTo in interface Comparable<Rational>

divide

@Nonnull
 @CheckReturnValue
public Rational divide(long integer)

Divides by an integer.

Parameters:

integer - The (long) integer.

Returns:

The result.

divide

@Nonnull
 @CheckReturnValue
public Rational divide(@Nonnull
                                                     Rational other)

Divides by an other rational.

Parameters:

other - The other rational.

Returns:

The result.

doubleValue

public double doubleValue()

Specified by:

doubleValue in class Number

equals

public boolean equals(Object object)

Overrides:

equals in class Object

floatValue

public float floatValue()

Specified by:

floatValue in class Number

getDenominator

@CheckReturnValue
public long getDenominator()

Gets the denominator.

Returns:

The denominator.

getNumerator

@CheckReturnValue
public long getNumerator()

Gets the numerator.

Returns:

The numerator.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

multiply

@Nonnull
 @CheckReturnValue
public Rational multiply(long integer)

Multiplies by an integer.

Parameters:

integer - The (long) integer.

Returns:

The result.

multiply

@Nonnull
 @CheckReturnValue
public Rational multiply(@Nonnull
                                                       Rational other)

Multiplies by an other rational.

Parameters:

other - The other rational.

Returns:

The result.

negate

@Nonnull
 @CheckReturnValue
public Rational negate()

Negates this number.

Returns:

The result.

reciprocal

@Nonnull
 @CheckReturnValue
public Rational reciprocal()

Returns the reciprocal value of this number.

Returns:

The reciprocal value.

signum

@CheckReturnValue
public int signum()

Returns the signum function of this number.

Returns:

The signum function.

subtract

@Nonnull
 @CheckReturnValue
public Rational subtract(long integer)

Subtracts an integer.

Parameters:

integer - The (long) integer.

Returns:

The result.

subtract

@Nonnull
 @CheckReturnValue
public Rational subtract(@Nonnull
                                                       Rational other)

Subtracts an other rational.

Parameters:

other - The other rational.

Returns:

The result.

toString

public String toString()

Overrides:

toString in class Object