Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Javadoc.

This commit is contained in:
Gilles Sadowski 2021-06-25 12:12:52 +02:00
parent 03923d2b79
commit cd54910edc
2 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/integration/SimpsonIntegrator.java
View File

@ -21,12 +21,21 @@ import org.apache.commons.math4.legacy.core.jdkmath.AccurateMath;
/** /**
* Implements <a href="http://mathworld.wolfram.com/SimpsonsRule.html"> * Implements <a href="http://mathworld.wolfram.com/SimpsonsRule.html">
* Simpson's Rule</a> for integration of real univariate functions. For * Simpson's Rule</a> for integration of real univariate functions.
* reference, see <b>Introduction to Numerical Analysis</b>, ISBN 038795452X, *
* chapter 3. * See <b>Introduction to Numerical Analysis</b>, ISBN 038795452X, chapter 3.
*
* <p> * <p>
* This implementation employs the basic trapezoid rule to calculate Simpson's * This implementation employs the basic trapezoid rule to calculate Simpson's
* rule.</p> * rule.
*
* <p>
* <em>Caveat:</em> At each iteration, the algorithm refines the estimation by
* evaluating the function twice as many times as in the previous iteration;
* When specifying a {@link #integrate(int,UnivariateFunction,double,double)
* maximum number of function evaluations}, the caller must ensure that it
* is compatible with the {@link #SimpsonIntegrator(int,int) requested minimal
* number of iterations}.
* *
* @since 1.2 * @since 1.2
*/ */
@ -39,9 +48,9 @@ public class SimpsonIntegrator extends BaseAbstractUnivariateIntegrator {
* Build a Simpson integrator with given accuracies and iterations counts. * Build a Simpson integrator with given accuracies and iterations counts.
* @param relativeAccuracy relative accuracy of the result * @param relativeAccuracy relative accuracy of the result
* @param absoluteAccuracy absolute accuracy of the result * @param absoluteAccuracy absolute accuracy of the result
* @param minimalIterationCount minimum number of iterations * @param minimalIterationCount Minimum number of iterations.
* @param maximalIterationCount maximum number of iterations * @param maximalIterationCount Maximum number of iterations.
* (must be less than or equal to {@link #SIMPSON_MAX_ITERATIONS_COUNT}) * It must be less than or equal to {@link #SIMPSON_MAX_ITERATIONS_COUNT}.
* @exception org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException if minimal number of iterations * @exception org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException if minimal number of iterations
* is not strictly positive * is not strictly positive
* @exception org.apache.commons.math4.legacy.exception.NumberIsTooSmallException if maximal number of iterations * @exception org.apache.commons.math4.legacy.exception.NumberIsTooSmallException if maximal number of iterations
@ -62,9 +71,9 @@ public class SimpsonIntegrator extends BaseAbstractUnivariateIntegrator {
/** /**
* Build a Simpson integrator with given iteration counts. * Build a Simpson integrator with given iteration counts.
* @param minimalIterationCount minimum number of iterations * @param minimalIterationCount Minimum number of iterations.
* @param maximalIterationCount maximum number of iterations * @param maximalIterationCount Maximum number of iterations.
* (must be less than or equal to {@link #SIMPSON_MAX_ITERATIONS_COUNT}) * It must be less than or equal to {@link #SIMPSON_MAX_ITERATIONS_COUNT}.
* @exception org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException if minimal number of iterations * @exception org.apache.commons.math4.legacy.exception.NotStrictlyPositiveException if minimal number of iterations
* is not strictly positive * is not strictly positive
* @exception org.apache.commons.math4.legacy.exception.NumberIsTooSmallException if maximal number of iterations * @exception org.apache.commons.math4.legacy.exception.NumberIsTooSmallException if maximal number of iterations

17
commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/analysis/integration/TrapezoidIntegrator.java
View File

@ -21,11 +21,20 @@ import org.apache.commons.math4.legacy.core.jdkmath.AccurateMath;
/** /**
* Implements the <a href="http://mathworld.wolfram.com/TrapezoidalRule.html"> * Implements the <a href="http://mathworld.wolfram.com/TrapezoidalRule.html">
* Trapezoid Rule</a> for integration of real univariate functions. For * Trapezoid Rule</a> for integration of real univariate functions.
* reference, see <b>Introduction to Numerical Analysis</b>, ISBN 038795452X, *
* chapter 3. * See <b>Introduction to Numerical Analysis</b>, ISBN 038795452X, chapter 3.
*
* <p> * <p>
* The function should be integrable.</p> * The function should be integrable.
*
* <p>
* <em>Caveat:</em> At each iteration, the algorithm refines the estimation by
* evaluating the function twice as many times as in the previous iteration;
* When specifying a {@link #integrate(int,UnivariateFunction,double,double)
* maximum number of function evaluations}, the caller must ensure that it
* is compatible with the {@link #TrapezoidIntegrator(int,int) requested
* minimal number of iterations}.
* *
* @since 1.2 * @since 1.2
*/ */