You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ra...@apache.org on 2017/04/20 10:37:57 UTC
[1/3] commons-numbers git commit: Establish baseline of files copied
from commons-math. (Will not build.)
Repository: commons-numbers
Updated Branches:
refs/heads/feature-NUMBERS-12 [created] e3399d1ba
Establish baseline of files copied from commons-math. (Will not build.)
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/4e1339ee
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/4e1339ee
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/4e1339ee
Branch: refs/heads/feature-NUMBERS-12
Commit: 4e1339eec8f100236f7aac310f797f87c986b47e
Parents: b37c9f1
Author: Ray DeCampo <ra...@decampo.org>
Authored: Thu Apr 20 06:30:11 2017 -0400
Committer: Ray DeCampo <ra...@decampo.org>
Committed: Thu Apr 20 06:30:11 2017 -0400
----------------------------------------------------------------------
.../numbers/fraction/ContinuedFraction.java | 181 +++++++++++++++++++
.../numbers/fraction/ContinuedFractionTest.java | 46 +++++
2 files changed, 227 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/4e1339ee/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
new file mode 100644
index 0000000..56b7267
--- /dev/null
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
@@ -0,0 +1,181 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.math4.util;
+
+import org.apache.commons.math4.exception.ConvergenceException;
+import org.apache.commons.math4.exception.MaxCountExceededException;
+import org.apache.commons.math4.exception.util.LocalizedFormats;
+
+/**
+ * Provides a generic means to evaluate continued fractions. Subclasses simply
+ * provided the a and b coefficients to evaluate the continued fraction.
+ *
+ * <p>
+ * References:
+ * <ul>
+ * <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
+ * Continued Fraction</a></li>
+ * </ul>
+ * </p>
+ *
+ */
+public abstract class ContinuedFraction {
+ /** Maximum allowed numerical error. */
+ private static final double DEFAULT_EPSILON = 10e-9;
+
+ /**
+ * Default constructor.
+ */
+ protected ContinuedFraction() {
+ super();
+ }
+
+ /**
+ * 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.
+ * @param n the coefficient index to retrieve.
+ * @param x the evaluation point.
+ * @return the n-th a coefficient.
+ */
+ protected abstract double getA(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.
+ * @param n the coefficient index to retrieve.
+ * @param x the evaluation point.
+ * @return the n-th b coefficient.
+ */
+ protected abstract double getB(int n, double x);
+
+ /**
+ * Evaluates the continued fraction at the value x.
+ * @param x the evaluation point.
+ * @return the value of the continued fraction evaluated at x.
+ * @throws ConvergenceException if the algorithm fails to converge.
+ */
+ public double evaluate(double x) throws ConvergenceException {
+ return evaluate(x, DEFAULT_EPSILON, Integer.MAX_VALUE);
+ }
+
+ /**
+ * Evaluates the continued fraction at the value x.
+ * @param x the evaluation point.
+ * @param epsilon maximum error allowed.
+ * @return the value of the continued fraction evaluated at x.
+ * @throws ConvergenceException if the algorithm fails to converge.
+ */
+ public double evaluate(double x, double epsilon) throws ConvergenceException {
+ return evaluate(x, epsilon, Integer.MAX_VALUE);
+ }
+
+ /**
+ * Evaluates the continued fraction at the value x.
+ * @param x the evaluation point.
+ * @param maxIterations maximum number of convergents
+ * @return the value of the continued fraction evaluated at x.
+ * @throws ConvergenceException if the algorithm fails to converge.
+ * @throws MaxCountExceededException if maximal number of iterations is reached
+ */
+ public double evaluate(double x, int maxIterations)
+ throws ConvergenceException, MaxCountExceededException {
+ return evaluate(x, DEFAULT_EPSILON, maxIterations);
+ }
+
+ /**
+ * Evaluates the continued fraction at the value x.
+ * <p>
+ * The implementation of this method is based on the modified Lentz algorithm as described
+ * on page 18 ff. in:
+ * <ul>
+ * <li>
+ * I. J. Thompson, A. R. Barnett. "Coulomb and Bessel Functions of Complex Arguments and Order."
+ * <a target="_blank" href="http://www.fresco.org.uk/papers/Thompson-JCP64p490.pdf">
+ * http://www.fresco.org.uk/papers/Thompson-JCP64p490.pdf</a>
+ * </li>
+ * </ul>
+ * <b>Note:</b> the implementation uses the terms a<sub>i</sub> and b<sub>i</sub> as defined in
+ * <a href="http://mathworld.wolfram.com/ContinuedFraction.html">Continued Fraction @ MathWorld</a>.
+ * </p>
+ *
+ * @param x the evaluation point.
+ * @param epsilon maximum error allowed.
+ * @param maxIterations maximum number of convergents
+ * @return the value of the continued fraction evaluated at x.
+ * @throws ConvergenceException if the algorithm fails to converge.
+ * @throws MaxCountExceededException if maximal number of iterations is reached
+ */
+ public double evaluate(double x, double epsilon, int maxIterations)
+ throws ConvergenceException, MaxCountExceededException {
+ final double small = 1e-50;
+ double hPrev = getA(0, x);
+
+ // use the value of small as epsilon criteria for zero checks
+ if (Precision.equals(hPrev, 0.0, small)) {
+ hPrev = small;
+ }
+
+ int n = 1;
+ double dPrev = 0.0;
+ double cPrev = hPrev;
+ double hN = hPrev;
+
+ while (n < maxIterations) {
+ final double a = getA(n, x);
+ final double b = getB(n, x);
+
+ double dN = a + b * dPrev;
+ if (Precision.equals(dN, 0.0, small)) {
+ dN = small;
+ }
+ double cN = a + b / cPrev;
+ if (Precision.equals(cN, 0.0, small)) {
+ cN = small;
+ }
+
+ dN = 1 / dN;
+ final double deltaN = cN * dN;
+ hN = hPrev * deltaN;
+
+ if (Double.isInfinite(hN)) {
+ throw new ConvergenceException(LocalizedFormats.CONTINUED_FRACTION_INFINITY_DIVERGENCE,
+ x);
+ }
+ if (Double.isNaN(hN)) {
+ throw new ConvergenceException(LocalizedFormats.CONTINUED_FRACTION_NAN_DIVERGENCE,
+ x);
+ }
+
+ if (FastMath.abs(deltaN - 1.0) < epsilon) {
+ break;
+ }
+
+ dPrev = dN;
+ cPrev = cN;
+ hPrev = hN;
+ n++;
+ }
+
+ if (n >= maxIterations) {
+ throw new MaxCountExceededException(LocalizedFormats.NON_CONVERGENT_CONTINUED_FRACTION,
+ maxIterations, x);
+ }
+
+ return hN;
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/4e1339ee/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java b/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
new file mode 100644
index 0000000..686fb51
--- /dev/null
+++ b/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.math4.util;
+
+import org.apache.commons.math4.util.ContinuedFraction;
+import org.junit.Assert;
+import org.junit.Test;
+
+
+/**
+ */
+public class ContinuedFractionTest {
+
+ @Test
+ public void testGoldenRatio() throws Exception {
+ ContinuedFraction cf = new ContinuedFraction() {
+
+ @Override
+ public double getA(int n, double x) {
+ return 1.0;
+ }
+
+ @Override
+ public double getB(int n, double x) {
+ return 1.0;
+ }
+ };
+
+ double gr = cf.evaluate(0.0, 10e-9);
+ Assert.assertEquals(1.61803399, gr, 10e-9);
+ }
+}
[3/3] commons-numbers git commit: Remove unnecessary default
constructor
Posted by ra...@apache.org.
Remove unnecessary default constructor
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/e3399d1b
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/e3399d1b
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/e3399d1b
Branch: refs/heads/feature-NUMBERS-12
Commit: e3399d1bab7065bdad7ebac80db184b5ef758808
Parents: 9602e36
Author: Ray DeCampo <ra...@decampo.org>
Authored: Thu Apr 20 06:36:51 2017 -0400
Committer: Ray DeCampo <ra...@decampo.org>
Committed: Thu Apr 20 06:36:51 2017 -0400
----------------------------------------------------------------------
.../apache/commons/numbers/fraction/ContinuedFraction.java | 7 -------
1 file changed, 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/e3399d1b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
index 7608c2a..a2e38a7 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
@@ -36,13 +36,6 @@ public abstract class ContinuedFraction {
private static final double DEFAULT_EPSILON = 10e-9;
/**
- * Default constructor.
- */
- protected ContinuedFraction() {
- super();
- }
-
- /**
* 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.
* @param n the coefficient index to retrieve.
[2/3] commons-numbers git commit: Port ContinuedFraction from commons
math. Converted exceptions to ArithmeticException.
Posted by ra...@apache.org.
Port ContinuedFraction from commons math.
Converted exceptions to ArithmeticException.
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/9602e36b
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/9602e36b
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/9602e36b
Branch: refs/heads/feature-NUMBERS-12
Commit: 9602e36b262f41036c3204b55f1addb91769573f
Parents: 4e1339e
Author: Ray DeCampo <ra...@decampo.org>
Authored: Thu Apr 20 06:34:15 2017 -0400
Committer: Ray DeCampo <ra...@decampo.org>
Committed: Thu Apr 20 06:34:15 2017 -0400
----------------------------------------------------------------------
.../numbers/fraction/ContinuedFraction.java | 37 +++++++++-----------
.../numbers/fraction/ContinuedFractionTest.java | 3 +-
2 files changed, 17 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/9602e36b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
index 56b7267..7608c2a 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/ContinuedFraction.java
@@ -14,11 +14,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.commons.math4.util;
+package org.apache.commons.numbers.fraction;
-import org.apache.commons.math4.exception.ConvergenceException;
-import org.apache.commons.math4.exception.MaxCountExceededException;
-import org.apache.commons.math4.exception.util.LocalizedFormats;
+import org.apache.commons.numbers.core.Precision;
/**
* Provides a generic means to evaluate continued fractions. Subclasses simply
@@ -66,9 +64,9 @@ public abstract class ContinuedFraction {
* Evaluates the continued fraction at the value x.
* @param x the evaluation point.
* @return the value of the continued fraction evaluated at x.
- * @throws ConvergenceException if the algorithm fails to converge.
+ * @throws ArithmeticException if the algorithm fails to converge.
*/
- public double evaluate(double x) throws ConvergenceException {
+ public double evaluate(double x) {
return evaluate(x, DEFAULT_EPSILON, Integer.MAX_VALUE);
}
@@ -77,9 +75,9 @@ public abstract class ContinuedFraction {
* @param x the evaluation point.
* @param epsilon maximum error allowed.
* @return the value of the continued fraction evaluated at x.
- * @throws ConvergenceException if the algorithm fails to converge.
+ * @throws ArithmeticException if the algorithm fails to converge.
*/
- public double evaluate(double x, double epsilon) throws ConvergenceException {
+ public double evaluate(double x, double epsilon) {
return evaluate(x, epsilon, Integer.MAX_VALUE);
}
@@ -88,11 +86,10 @@ public abstract class ContinuedFraction {
* @param x the evaluation point.
* @param maxIterations maximum number of convergents
* @return the value of the continued fraction evaluated at x.
- * @throws ConvergenceException if the algorithm fails to converge.
- * @throws MaxCountExceededException if maximal number of iterations is reached
+ * @throws ArithmeticException if the algorithm fails to converge.
+ * @throws ArithmeticException if maximal number of iterations is reached
*/
- public double evaluate(double x, int maxIterations)
- throws ConvergenceException, MaxCountExceededException {
+ public double evaluate(double x, int maxIterations) {
return evaluate(x, DEFAULT_EPSILON, maxIterations);
}
@@ -116,11 +113,10 @@ public abstract class ContinuedFraction {
* @param epsilon maximum error allowed.
* @param maxIterations maximum number of convergents
* @return the value of the continued fraction evaluated at x.
- * @throws ConvergenceException if the algorithm fails to converge.
- * @throws MaxCountExceededException if maximal number of iterations is reached
+ * @throws ArithmeticException if the algorithm fails to converge.
+ * @throws ArithmeticException if maximal number of iterations is reached
*/
- public double evaluate(double x, double epsilon, int maxIterations)
- throws ConvergenceException, MaxCountExceededException {
+ public double evaluate(double x, double epsilon, int maxIterations) {
final double small = 1e-50;
double hPrev = getA(0, x);
@@ -152,15 +148,15 @@ public abstract class ContinuedFraction {
hN = hPrev * deltaN;
if (Double.isInfinite(hN)) {
- throw new ConvergenceException(LocalizedFormats.CONTINUED_FRACTION_INFINITY_DIVERGENCE,
+ throw new FractionException("Continued fraction convergents diverged to +/- infinity for value {0}",
x);
}
if (Double.isNaN(hN)) {
- throw new ConvergenceException(LocalizedFormats.CONTINUED_FRACTION_NAN_DIVERGENCE,
+ throw new FractionException("Continued fraction diverged to NaN for value {0}",
x);
}
- if (FastMath.abs(deltaN - 1.0) < epsilon) {
+ if (Math.abs(deltaN - 1.0) < epsilon) {
break;
}
@@ -171,8 +167,7 @@ public abstract class ContinuedFraction {
}
if (n >= maxIterations) {
- throw new MaxCountExceededException(LocalizedFormats.NON_CONVERGENT_CONTINUED_FRACTION,
- maxIterations, x);
+ throw new FractionException("maximal count ({0}) exceeded", maxIterations);
}
return hN;
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/9602e36b/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
----------------------------------------------------------------------
diff --git a/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java b/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
index 686fb51..f548fb1 100644
--- a/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
+++ b/commons-numbers-fraction/src/test/java/org/apache/commons/numbers/fraction/ContinuedFractionTest.java
@@ -14,9 +14,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.commons.math4.util;
+package org.apache.commons.numbers.fraction;
-import org.apache.commons.math4.util.ContinuedFraction;
import org.junit.Assert;
import org.junit.Test;