jhelp.util.math.rational

Class Rational

java.lang.Object

jhelp.util.math.rational.Rational

All Implemented Interfaces:

java.lang.Comparable<Rational>

public class Rational
extends java.lang.Object
implements java.lang.Comparable<Rational>

Represents a rational number

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private int	denominator Denominator
private static float	EPSILON Epsilon precision
static Rational	INVALID Invalid rational.
static Rational	MINUS_ONE -1 rational
private int	numerator Numerator
static Rational	ONE 1 rational
static Rational	ZERO 0 rational

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Rational(int numerator, int denominator) Create a new instance of Rational

Method Summary

Methods

Modifier and Type	Method and Description
Rational	addition(Rational rational) Add an other rational
static Rational	addition(Rational rational1, Rational rational2) Add 2 rational
int	compareTo(Rational rational) Compare with an other rational.
static Rational	createRational(float f) Create rational from real.
static Rational	createRational(int integer) Create rational from integer
static Rational	createRational(int numerator, int denominator) Create a rational
Rational	divide(Rational rational) Divide an other rational
static Rational	divide(Rational rational1, Rational rational2) Divide 2 rational
private static boolean	equals(float f1, float f2) Indicates if 2 reals are equals in epsilon precision
boolean	equals(java.lang.Object obj) Indicates if an object is equals to this rational Parent documentation:
int	getDenominator() Denominator
int	getNumerator() Numerator
int	hashCode() Compute hash code for rational Parent documentation:
Rational	inverse() Inverse the rational
boolean	isInteger() Indicates if rational can be see as integer.
boolean	isNegative() Indicates if rational is strictly negative
boolean	isPositive() Indicates if rational is strictly positive
static Rational	middle(Rational rational1, Rational rational2) Compute the rational just in the middle of 2 other rational
Rational	multiply(Rational rational) Multiply an other rational
static Rational	multiply(Rational rational1, Rational rational2) Multiply 2 rational
Rational	opposite() Rational opposite
static java.lang.String	proportion(int numberPositive, char positiveSymbol, int numberNegative, char negativeSymbol) Compute a string representation of a proportion
Rational	subtract(Rational rational) Subtract an other rational
static Rational	subtract(Rational rational1, Rational rational2) Subtract 2 rational
java.lang.String	toString() String representation Parent documentation:
float	value() Real value

Methods inherited from class java.lang.Object

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

Field Detail

EPSILON

private static final float EPSILON

Epsilon precision

See Also:

Constant Field Values

INVALID

public static final Rational INVALID

Invalid rational. The rational have non meaning (like divide by 0)

MINUS_ONE

public static final Rational MINUS_ONE

-1 rational

ONE

public static final Rational ONE

1 rational

ZERO

public static final Rational ZERO

0 rational

denominator

private final int denominator

Denominator

numerator

private final int numerator

Numerator

Constructor Detail

Rational

private Rational(int numerator,
        int denominator)

Create a new instance of Rational

Parameters:

numerator - Numerator

denominator - Denominator

Method Detail

equals

private static boolean equals(float f1,
             float f2)

Indicates if 2 reals are equals in epsilon precision

Parameters:

f1 - First real

f2 - Second real

Returns:

true if they are equals at epsilon precision

addition

public static Rational addition(Rational rational1,
                Rational rational2)

Add 2 rational

Parameters:

rational1 - First rational

rational2 - Second rational

Returns:

Rational result

createRational

public static Rational createRational(float f)

Create rational from real.
It founds the nearest rational at epsilon precision

Parameters:

f - Real to found nearest rational

Returns:

Rational created

createRational

public static Rational createRational(int integer)

Create rational from integer

Parameters:

integer - Integer source

Returns:

Result rational

createRational

public static Rational createRational(int numerator,
                      int denominator)

Create a rational

Parameters:

numerator - Numerator

denominator - Denominator

Returns:

Created rational

divide

public static Rational divide(Rational rational1,
              Rational rational2)

Divide 2 rational

Parameters:

rational1 - First rational

rational2 - Second rational

Returns:

Rational result

middle

public static Rational middle(Rational rational1,
              Rational rational2)

Compute the rational just in the middle of 2 other rational

Parameters:

rational1 - First rational

rational2 - Second rational

Returns:

Middle computed

multiply

public static Rational multiply(Rational rational1,
                Rational rational2)

Multiply 2 rational

Parameters:

rational1 - First rational

rational2 - Second rational

Returns:

Rational result

proportion

public static java.lang.String proportion(int numberPositive,
                          char positiveSymbol,
                          int numberNegative,
                          char negativeSymbol)

Compute a string representation of a proportion

Parameters:

numberPositive - Number of "positive" value

positiveSymbol - Character used to represents "positive" values

numberNegative - Number of "negative" value

negativeSymbol - Character used to represents "negative" values

Returns:

Computed proportion

subtract

public static Rational subtract(Rational rational1,
                Rational rational2)

Subtract 2 rational

Parameters:

rational1 - First rational

rational2 - Second rational

Returns:

Rational result

addition

public Rational addition(Rational rational)

Add an other rational

Parameters:

rational - Rational to add

Returns:

Addition result

compareTo

public int compareTo(Rational rational)

Compare with an other rational.
It returns :

< 0	If this rational is < the given rational
= 0	If this rational is equals the given rational
> 0	If this rational is > the given rational

Parent documentation:

Specified by:

compareTo in interface java.lang.Comparable<Rational>

Parameters:

rational - Rational to compare with

Returns:

Comparison result

See Also:

Comparable.compareTo(java.lang.Object)

divide

public Rational divide(Rational rational)

Divide an other rational

Parameters:

rational - Rational to divide

Returns:

Division result

equals

public boolean equals(java.lang.Object obj)

Indicates if an object is equals to this rational

Parent documentation:

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to test

Returns:

true in equality

See Also:

Object.equals(java.lang.Object)

getDenominator

public int getDenominator()

Denominator

Returns:

Denominator

getNumerator

public int getNumerator()

Numerator

Returns:

Numerator

hashCode

public int hashCode()

Compute hash code for rational

Parent documentation:

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code

See Also:

Object.hashCode()

inverse

public Rational inverse()

Inverse the rational

Returns:

Inverted

isInteger

public boolean isInteger()

Indicates if rational can be see as integer.
Can get the value with the numerator

Returns:

true if the rational is an integer

isNegative

public boolean isNegative()

Indicates if rational is strictly negative

Returns:

true if rational is strictly negative

isPositive

public boolean isPositive()

Indicates if rational is strictly positive

Returns:

true if ration is strictly positive

multiply

public Rational multiply(Rational rational)

Multiply an other rational

Parameters:

rational - Rational to multiply

Returns:

Multiplication result

opposite

public Rational opposite()

Rational opposite

Returns:

Opposite

subtract

public Rational subtract(Rational rational)

Subtract an other rational

Parameters:

rational - Rational to subtract

Returns:

Subtraction result

toString

public java.lang.String toString()

String representation

Parent documentation:

Overrides:

toString in class java.lang.Object

Returns:

String representation

See Also:

Object.toString()

value

public float value()

Real value

Returns:

Real value