Package org.xlsx4j.org.apache.poi.ss.format

Class SimpleFraction

java.lang.Object

org.xlsx4j.org.apache.poi.ss.format.SimpleFraction

public class SimpleFraction
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private final int	denominator	The denominator.
private final int	numerator	The numerator.

Constructor Summary

Constructors

Constructor	Description
SimpleFraction(int numerator, int denominator)	Create a fraction given a numerator and denominator.

Method Summary

Modifier and Type	Method	Description
static SimpleFraction	buildFractionExactDenominator(double val, int exactDenom)	Create a fraction given a double value and a denominator.
private static SimpleFraction	buildFractionMaxDenominator(double value, double epsilon, int maxDenominator, int maxIterations)	Create a fraction given the double value and either the maximum error allowed or the maximum number of denominator digits.
static SimpleFraction	buildFractionMaxDenominator(double value, int maxDenominator)	Create a fraction given the double value and either the maximum error allowed or the maximum number of denominator digits.
int	getDenominator()	Access the denominator.
int	getNumerator()	Access the numerator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

denominator

private final int denominator

The denominator.

numerator

private final int numerator

The numerator.

Constructor Details

SimpleFraction

public SimpleFraction(int numerator,
 int denominator)

Create a fraction given a numerator and denominator.

Parameters:

numerator -

denominator - maxDenominator The maximum allowed value for denominator

Method Details

buildFractionExactDenominator

public static SimpleFraction buildFractionExactDenominator(double val,
 int exactDenom)

Create a fraction given a double value and a denominator.

Parameters:

val - double value of fraction

exactDenom - the exact denominator

Returns:

a SimpleFraction with the given values set.

buildFractionMaxDenominator

public static SimpleFraction buildFractionMaxDenominator(double value,
 int maxDenominator)

Create a fraction given the double value and either the maximum error allowed or the maximum number of denominator digits.

Parameters:

value - the double value to convert to a fraction.

maxDenominator - maximum denominator value allowed.

Throws:

RuntimeException - if the continued fraction failed to converge.

IllegalArgumentException - if value > Integer.MAX_VALUE

buildFractionMaxDenominator

private static SimpleFraction buildFractionMaxDenominator(double value,
 double epsilon,
 int maxDenominator,
 int maxIterations)

Create a fraction given the double value and either the maximum error allowed or the maximum number of denominator digits.

References:

• Continued Fraction equations (11) and (22)-(26)

Based on org.apache.commons.math.fraction.Fraction from Apache Commons-Math. YK: The only reason of having this class is to avoid dependency on the Commons-Math jar.

Parameters:

value - the double value to convert to a fraction.

epsilon - maximum error allowed. The resulting fraction is within epsilon of value, in absolute terms.

maxDenominator - maximum denominator value allowed.

maxIterations - maximum number of convergents

Throws:

RuntimeException - if the continued fraction failed to converge.

IllegalArgumentException - if value > Integer.MAX_VALUE

getDenominator

public int getDenominator()

Access the denominator.

Returns:

the denominator.

getNumerator

public int getNumerator()

Access the numerator.

Returns:

the numerator.