Apache Commons Math 3.6.1 · org.apache.commons.math3.util.ContinuedFraction

Modifier and Type	Field and Description
private static final double	DEFAULT_EPSILON Maximum allowed numerical error.

Access	Constructor and Description
protected	ContinuedFraction() Default constructor.

Method Summary

Modifier and Type	Method and Description
public double	Returns: the value of the continued fraction evaluated at x. evaluate(double the evaluation point. x) Evaluates the continued fraction at the value x.
public double	Returns: the value of the continued fraction evaluated at x. evaluate(double the evaluation point. x, double maximum error allowed. epsilon) Evaluates the continued fraction at the value x.
public double	Returns: the value of the continued fraction evaluated at x. evaluate(double the evaluation point. x, int maximum number of convergents maxIterations) Evaluates the continued fraction at the value x.
public double	Returns: the value of the continued fraction evaluated at x. evaluate(double the evaluation point. x, double maximum error allowed. epsilon, int maximum number of convergents maxIterations) Evaluates the continued fraction at the value x.
protected abstract double	Returns: the n-th a coefficient. getA(int the coefficient index to retrieve. n, double the evaluation point. x) Access the n-th a coefficient of the continued fraction.
protected abstract double	Returns: the n-th b coefficient. getB(int the coefficient index to retrieve. n, double the evaluation point. x) Access the n-th b coefficient of the continued fraction.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

DEFAULT_EPSILON	back to summary
private static final double DEFAULT_EPSILON Maximum allowed numerical error.

ContinuedFraction	back to summary
protected ContinuedFraction() Default constructor.

Method Detail

evaluate	back to summary
public double evaluate(double x) throws ConvergenceException Evaluates the continued fraction at the value x. Parameters x:double the evaluation point. Returns:double the value of the continued fraction evaluated at x. Exceptions ConvergenceException: if the algorithm fails to converge.

evaluate

back to summary

public double evaluate(double x) throws ConvergenceException

Evaluates the continued fraction at the value x.

Parameters

x:double: the evaluation point.

Returns:double

the value of the continued fraction evaluated at x.

Exceptions

ConvergenceException:: if the algorithm fails to converge.

evaluate	back to summary
public double evaluate(double x, double epsilon) throws ConvergenceException Evaluates the continued fraction at the value x. Parameters x:double the evaluation point. epsilon:double maximum error allowed. Returns:double the value of the continued fraction evaluated at x. Exceptions ConvergenceException: if the algorithm fails to converge.

evaluate

back to summary

public double evaluate(double x, double epsilon) throws ConvergenceException

Evaluates the continued fraction at the value x.

Parameters

x:double: the evaluation point.
epsilon:double: maximum error allowed.

Returns:double

the value of the continued fraction evaluated at x.

Exceptions

ConvergenceException:: if the algorithm fails to converge.

evaluate	back to summary
public double evaluate(double x, int maxIterations) throws ConvergenceException, MaxCountExceededException Evaluates the continued fraction at the value x. Parameters x:double the evaluation point. maxIterations:int maximum number of convergents Returns:double the value of the continued fraction evaluated at x. Exceptions ConvergenceException: if the algorithm fails to converge. MaxCountExceededException: if maximal number of iterations is reached

evaluate

back to summary

public double evaluate(double x, int maxIterations) throws ConvergenceException, MaxCountExceededException

Evaluates the continued fraction at the value x.

Parameters

x:double: the evaluation point.
maxIterations:int: maximum number of convergents

Returns:double

the value of the continued fraction evaluated at x.

Exceptions

ConvergenceException:: if the algorithm fails to converge.
MaxCountExceededException:: if maximal number of iterations is reached

evaluate	back to summary
public double evaluate(double x, double epsilon, int maxIterations) throws ConvergenceException, MaxCountExceededException Evaluates the continued fraction at the value x. The implementation of this method is based on the modified Lentz algorithm as described on page 18 ff. in: I. J. Thompson, A. R. Barnett. "Coulomb and Bessel Functions of Complex Arguments and Order." http://www.fresco.org.uk/papers/Thompson-JCP64p490.pdf Note the implementation uses the terms a_i and b_i as defined in Continued Fraction @ MathWorld. Parameters x:double the evaluation point. epsilon:double maximum error allowed. maxIterations:int maximum number of convergents Returns:double the value of the continued fraction evaluated at x. Exceptions ConvergenceException: if the algorithm fails to converge. MaxCountExceededException: if maximal number of iterations is reached

evaluate

back to summary

public double evaluate(double x, double epsilon, int maxIterations) throws ConvergenceException, MaxCountExceededException

Evaluates the continued fraction at the value x.

The implementation of this method is based on the modified Lentz algorithm as described on page 18 ff. in:

I. J. Thompson, A. R. Barnett. "Coulomb and Bessel Functions of Complex Arguments and Order." http://www.fresco.org.uk/papers/Thompson-JCP64p490.pdf

Note

the implementation uses the terms a_i and b_i as defined in Continued Fraction @ MathWorld.

Parameters

x:double: the evaluation point.
epsilon:double: maximum error allowed.
maxIterations:int: maximum number of convergents

Returns:double

the value of the continued fraction evaluated at x.

Exceptions

ConvergenceException:: if the algorithm fails to converge.
MaxCountExceededException:: if maximal number of iterations is reached

getA	back to summary
protected abstract double getA(int n, double x) Access the n-th a coefficient of the continued fraction. Since a can be a function of the evaluation point, x, that is passed in as well. Parameters n:int the coefficient index to retrieve. x:double the evaluation point. Returns:double the n-th a coefficient.

getA

back to summary

protected abstract double getA(int n, double x)

Access the n-th a coefficient of the continued fraction. Since a can be a function of the evaluation point, x, that is passed in as well.

Parameters

n:int: the coefficient index to retrieve.
x:double: the evaluation point.

Returns:double

the n-th a coefficient.

getB	back to summary
protected abstract double getB(int n, double x) Access the n-th b coefficient of the continued fraction. Since b can be a function of the evaluation point, x, that is passed in as well. Parameters n:int the coefficient index to retrieve. x:double the evaluation point. Returns:double the n-th b coefficient.

getB

back to summary

protected abstract double getB(int n, double x)

Access the n-th b coefficient of the continued fraction. Since b can be a function of the evaluation point, x, that is passed in as well.

Parameters

n:int: the coefficient index to retrieve.
x:double: the evaluation point.

Returns:double

the n-th b coefficient.

public abstract Class ContinuedFraction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail