Author: psteitz
Date: Sun Feb 10 11:28:59 2008
New Revision: 620312
URL: http://svn.apache.org/viewvc?rev=620312&view=rev
Log:
Javadoc only. Added @since tags.
Modified:
commons/proper/math/trunk/src/java/org/apache/commons/math/ArgumentOutsideDomainException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ConvergenceException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/DimensionMismatchException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/DuplicateSampleAbscissaException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/FunctionEvaluationException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/MathConfigurationException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/MaxIterationsExceededException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/MessagesResources_fr.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/LaguerreSolver.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/MullerSolver.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/NevilleInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RiddersSolver.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RombergIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/SimpsonIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/TrapezoidIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegratorImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/complex/Complex.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java
commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java
commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/FractionConversionException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/CardanEulerSingularityException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/NotARotationMatrixException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Rotation.java
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/RotationOrder.java
commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AdaptiveStepsizeIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ContinuousOutputModel.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DerivativeException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54Integrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853Integrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepHandler.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EmbeddedRungeKuttaIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderConverter.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderDifferentialEquations.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FixedStepHandler.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54Integrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/IntegratorException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderDifferentialEquations.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepHandler.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepNormalizer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SwitchState.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SwitchingFunction.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SwitchingFunctionsHandler.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesIntegrator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ThreeEighthesStepInterpolator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/ConvergenceChecker.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/CostException.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/CostFunction.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/DirectSearchOptimizer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/MultiDirectional.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/NelderMead.java
commons/proper/math/trunk/src/java/org/apache/commons/math/optimization/PointCostPair.java
commons/proper/math/trunk/src/java/org/apache/commons/math/random/CorrelatedRandomVectorGenerator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/random/GaussianRandomGenerator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/random/NormalizedRandomGenerator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/random/UncorrelatedRandomVectorGenerator.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/DescriptiveStatistics.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/descriptive/SummaryStatistics.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/inference/ChiSquareTestImpl.java
commons/proper/math/trunk/src/java/org/apache/commons/math/stat/inference/UnknownDistributionChiSquareTest.java
commons/proper/math/trunk/src/java/org/apache/commons/math/transform/FastCosineTransformer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/transform/FastFourierTransformer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/transform/FastSineTransformer.java
commons/proper/math/trunk/src/java/org/apache/commons/math/util/MathUtils.java
commons/proper/math/trunk/src/site/xdoc/changes.xml
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ArgumentOutsideDomainException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ArgumentOutsideDomainException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ArgumentOutsideDomainException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ArgumentOutsideDomainException.java Sun Feb 10 11:28:59 2008
@@ -20,6 +20,7 @@
/**
* Error thrown when a method is called with an out of bounds argument.
*
+ * @since 1.2
* @version $Revision$ $Date$
*/
public class ArgumentOutsideDomainException extends FunctionEvaluationException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ConvergenceException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ConvergenceException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ConvergenceException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ConvergenceException.java Sun Feb 10 11:28:59 2008
@@ -39,6 +39,7 @@
* Message formatting is delegated to {@link java.text.MessageFormat}.
* @param pattern format specifier
* @param arguments format arguments
+ * @since 1.2
*/
public ConvergenceException(String pattern, Object[] arguments) {
super(pattern, arguments);
@@ -58,6 +59,7 @@
* @param pattern format specifier
* @param arguments format arguments
* @param cause the exception or error that caused this exception to be thrown
+ * @since 1.2
*/
public ConvergenceException(String pattern, Object[] arguments, Throwable cause) {
super(pattern, arguments, cause);
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/DimensionMismatchException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/DimensionMismatchException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/DimensionMismatchException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/DimensionMismatchException.java Sun Feb 10 11:28:59 2008
@@ -18,6 +18,8 @@
/**
* Error thrown when two dimensions differ.
+ *
+ * @since 1.2
* @version $Revision$ $Date$
*/
public class DimensionMismatchException extends MathException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/DuplicateSampleAbscissaException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/DuplicateSampleAbscissaException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/DuplicateSampleAbscissaException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/DuplicateSampleAbscissaException.java Sun Feb 10 11:28:59 2008
@@ -18,6 +18,8 @@
/**
* Exeption thrown when a sample contains several entries at the same abscissa.
+ *
+ * @since 1.2
* @version $Revision$ $Date$
*/
public class DuplicateSampleAbscissaException extends MathException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/FunctionEvaluationException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/FunctionEvaluationException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/FunctionEvaluationException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/FunctionEvaluationException.java Sun Feb 10 11:28:59 2008
@@ -63,6 +63,7 @@
* @param argument the failing function argument
* @param pattern format specifier
* @param arguments format arguments
+ * @since 1.2
*/
public FunctionEvaluationException(double argument,
String pattern, Object[] arguments) {
@@ -89,6 +90,7 @@
* Message formatting is delegated to {@link java.text.MessageFormat}.
* @param argument the failing function argument
* @param cause the exception or error that caused this exception to be thrown
+ * @since 1.2
*/
public FunctionEvaluationException(double argument, Throwable cause) {
super(cause);
@@ -102,6 +104,7 @@
* @param pattern format specifier
* @param arguments format arguments
* @param cause the exception or error that caused this exception to be thrown
+ * @since 1.2
*/
public FunctionEvaluationException(double argument,
String pattern, Object[] arguments,
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/MathConfigurationException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/MathConfigurationException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/MathConfigurationException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/MathConfigurationException.java Sun Feb 10 11:28:59 2008
@@ -47,6 +47,7 @@
* Message formatting is delegated to {@link java.text.MessageFormat}.
* @param pattern format specifier
* @param arguments format arguments
+ * @since 1.2
*/
public MathConfigurationException(String pattern, Object[] arguments) {
super(pattern, arguments);
@@ -76,6 +77,7 @@
* @param pattern format specifier
* @param arguments format arguments
* @param cause the exception or error that caused this exception to be thrown
+ * @since 1.2
*/
public MathConfigurationException(String pattern, Object[] arguments, Throwable cause) {
super(pattern, arguments, cause);
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/MathException.java Sun Feb 10 11:28:59 2008
@@ -191,8 +191,9 @@
* Message formatting is delegated to {@link java.text.MessageFormat}.
* @param pattern format specifier
* @param arguments format arguments
- * @param rootCause the exception or error that caused this exception
- * to be thrown.
+ * @param rootCause the exception or error that caused this exception
+ * to be thrown.
+ * @since 1.2
*/
public MathException(String pattern, Object[] arguments, Throwable rootCause) {
super(buildMessage(pattern, arguments, Locale.US));
@@ -204,6 +205,7 @@
/** Gets the pattern used to build the message of this throwable.
*
* @return the pattern used to build the message of this throwable
+ * @since 1.2
*/
public String getPattern() {
return pattern;
@@ -212,6 +214,7 @@
/** Gets the arguments used to build the message of this throwable.
*
* @return the arguments used to build the message of this throwable
+ * @since 1.2
*/
public Object[] getArguments() {
return (Object[]) arguments.clone();
@@ -222,6 +225,7 @@
* @param locale Locale in which the message should be translated
*
* @return localized message
+ * @since 1.2
*/
public String getMessage(Locale locale) {
return (pattern == null) ? null : buildMessage(pattern, arguments, locale);
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/MaxIterationsExceededException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/MaxIterationsExceededException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/MaxIterationsExceededException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/MaxIterationsExceededException.java Sun Feb 10 11:28:59 2008
@@ -24,6 +24,7 @@
* number of iterations.
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class MaxIterationsExceededException extends ConvergenceException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/MessagesResources_fr.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/MessagesResources_fr.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/MessagesResources_fr.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/MessagesResources_fr.java Sun Feb 10 11:28:59 2008
@@ -19,18 +19,22 @@
import java.util.ListResourceBundle;
-/** French localization message resources for the commons-math library.
+/**
+ * French localization message resources for the commons-math library.
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class MessagesResources_fr
extends ListResourceBundle {
- /** Simple constructor.
+ /**
+ * Simple constructor.
*/
public MessagesResources_fr() {
}
- /** Get the non-translated/translated messages arrays from this resource bundle.
+ /**
+ * Get the non-translated/translated messages arrays from this resource bundle.
* @return non-translated/translated messages arrays
*/
public Object[][] getContents() {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/DividedDifferenceInterpolator.java Sun Feb 10 11:28:59 2008
@@ -31,6 +31,7 @@
* this class provides an easy-to-use interface to it.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class DividedDifferenceInterpolator implements UnivariateRealInterpolator,
Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/LaguerreSolver.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/LaguerreSolver.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/LaguerreSolver.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/LaguerreSolver.java Sun Feb 10 11:28:59 2008
@@ -31,6 +31,7 @@
* approximation and be able to solve all roots from that point.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class LaguerreSolver extends UnivariateRealSolverImpl {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/MullerSolver.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/MullerSolver.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/MullerSolver.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/MullerSolver.java Sun Feb 10 11:28:59 2008
@@ -31,6 +31,7 @@
* real zeros, using different ways to bypass complex arithmetics.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class MullerSolver extends UnivariateRealSolverImpl {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/NevilleInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/NevilleInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/NevilleInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/NevilleInterpolator.java Sun Feb 10 11:28:59 2008
@@ -29,6 +29,7 @@
* this class provides an easy-to-use interface to it.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class NevilleInterpolator implements UnivariateRealInterpolator,
Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionLagrangeForm.java Sun Feb 10 11:28:59 2008
@@ -31,6 +31,7 @@
* to work well. Otherwise, consider using splines instead.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class PolynomialFunctionLagrangeForm implements UnivariateRealFunction,
Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/PolynomialFunctionNewtonForm.java Sun Feb 10 11:28:59 2008
@@ -30,6 +30,7 @@
* Note that the length of a[] is one more than the length of c[]</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class PolynomialFunctionNewtonForm implements UnivariateRealFunction,
Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RiddersSolver.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RiddersSolver.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RiddersSolver.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RiddersSolver.java Sun Feb 10 11:28:59 2008
@@ -30,6 +30,7 @@
* The function should be continuous but not necessarily smooth.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class RiddersSolver extends UnivariateRealSolverImpl {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RombergIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RombergIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RombergIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/RombergIntegrator.java Sun Feb 10 11:28:59 2008
@@ -30,6 +30,7 @@
* is a special case of k = 2.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class RombergIntegrator extends UnivariateRealIntegratorImpl {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/SimpsonIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/SimpsonIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/SimpsonIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/SimpsonIntegrator.java Sun Feb 10 11:28:59 2008
@@ -29,6 +29,7 @@
* calculate the Simpson's rule of alternating 2/3 and 4/3.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class SimpsonIntegrator extends UnivariateRealIntegratorImpl {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/TrapezoidIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/TrapezoidIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/TrapezoidIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/TrapezoidIntegrator.java Sun Feb 10 11:28:59 2008
@@ -28,6 +28,7 @@
* The function should be integrable.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class TrapezoidIntegrator extends UnivariateRealIntegratorImpl {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegrator.java Sun Feb 10 11:28:59 2008
@@ -23,6 +23,7 @@
* Interface for univariate real integration algorithms.
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public interface UnivariateRealIntegrator {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegratorImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegratorImpl.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegratorImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/analysis/UnivariateRealIntegratorImpl.java Sun Feb 10 11:28:59 2008
@@ -22,6 +22,7 @@
* Provide a default implementation for several generic functions.
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public abstract class UnivariateRealIntegratorImpl implements
UnivariateRealIntegrator, Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/complex/Complex.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/complex/Complex.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/complex/Complex.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/complex/Complex.java Sun Feb 10 11:28:59 2008
@@ -34,7 +34,6 @@
* or imaginary part - e.g., <pre>
* <code>1 + NaNi == NaN + i == NaN + NaNi.</code></pre></p>
*
- * @author Apache Software Foundation
* @version $Revision$ $Date$
*/
public class Complex implements Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/AbstractEstimator.java Sun Feb 10 11:28:59 2008
@@ -27,6 +27,7 @@
* <p>This base class handles the boilerplates methods associated to thresholds
* settings, jacobian and error estimation.</p>
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
public abstract class AbstractEstimator implements Estimator {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimatedParameter.java Sun Feb 10 11:28:59 2008
@@ -28,6 +28,7 @@
* satisfy convergence criterions specific to each solver.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationException.java Sun Feb 10 11:28:59 2008
@@ -23,6 +23,7 @@
* This class represents exceptions thrown by the estimation solvers.
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/EstimationProblem.java Sun Feb 10 11:28:59 2008
@@ -39,6 +39,7 @@
* @see WeightedMeasurement
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/Estimator.java Sun Feb 10 11:28:59 2008
@@ -31,6 +31,7 @@
* @see EstimationProblem
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/GaussNewtonEstimator.java Sun Feb 10 11:28:59 2008
@@ -31,6 +31,7 @@
* Gauss-Newton algorithm.</p>
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/LevenbergMarquardtEstimator.java Sun Feb 10 11:28:59 2008
@@ -94,7 +94,8 @@
* @author Jorge J. More (original fortran)
* @version $Revision$ $Date$
-
+ * @since 1.2
+ *
*/
public class LevenbergMarquardtEstimator extends AbstractEstimator implements Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/SimpleEstimationProblem.java Sun Feb 10 11:28:59 2008
@@ -36,6 +36,7 @@
* various parameters and their current estimate.</p>
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class SimpleEstimationProblem implements EstimationProblem {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/estimation/WeightedMeasurement.java Sun Feb 10 11:28:59 2008
@@ -45,6 +45,7 @@
* @see EstimationProblem
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/FractionConversionException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/FractionConversionException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/FractionConversionException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/fraction/FractionConversionException.java Sun Feb 10 11:28:59 2008
@@ -24,6 +24,7 @@
* in the allowed number of iterations.
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class FractionConversionException extends ConvergenceException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/CardanEulerSingularityException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/CardanEulerSingularityException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/CardanEulerSingularityException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/CardanEulerSingularityException.java Sun Feb 10 11:28:59 2008
@@ -23,12 +23,13 @@
* or Euler angles from a rotation.
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class CardanEulerSingularityException
extends MathException {
- /** Simple constructor.
+ /**
+ * Simple constructor.
* build an exception with a default message.
* @param isCardan if true, the rotation is related to Cardan angles,
* if false it is related to EulerAngles
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/NotARotationMatrixException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/NotARotationMatrixException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/NotARotationMatrixException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/NotARotationMatrixException.java Sun Feb 10 11:28:59 2008
@@ -19,17 +19,19 @@
import org.apache.commons.math.MathException;
-/** This class represents exceptions thrown while building rotations
+/**
+ * This class represents exceptions thrown while building rotations
* from matrices.
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class NotARotationMatrixException
extends MathException {
- /** Simple constructor.
+ /**
+ * Simple constructor.
* Build an exception by translating and formating a message
* @param specifier format specifier (to be translated)
* @param parts to insert in the format (no translation)
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Rotation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Rotation.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Rotation.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Rotation.java Sun Feb 10 11:28:59 2008
@@ -21,7 +21,7 @@
/**
* This class implements rotations in a three-dimensional space.
-
+ *
* <p>Rotations can be represented by several different mathematical
* entities (matrices, axe and angle, Cardan or Euler angles,
* quaternions). This class presents an higher level abstraction, more
@@ -59,14 +59,14 @@
* need to transform the observing direction in the topocentric frame into the
* observing direction in inertial frame taking into account the observatory
* location and the Earth rotation.</p>
-
+ *
* <p>These examples show that a rotation is what the user wants it to be, so this
* class does not push the user towards one specific definition and hence does not
* provide methods like <code>projectVectorIntoDestinationFrame</code> or
* <code>computeTransformedDirection</code>. It provides simpler and more generic
* methods: {@link #applyTo(Vector3D) applyTo(Vector3D)} and {@link
* #applyInverseTo(Vector3D) applyInverseTo(Vector3D)}.</p>
-
+ *
* <p>Since a rotation is basically a vectorial operator, several rotations can be
* composed together and the composite operation <code>r = r<sub>1</sub> o
* r<sub>2</sub></code> (which means that for each vector <code>u</code>,
@@ -77,13 +77,13 @@
* we get is <code>r = r<sub>1</sub> o r<sub>2</sub></code>. For this purpose, the
* class provides the methods: {@link #applyTo(Rotation) applyTo(Rotation)} and
* {@link #applyInverseTo(Rotation) applyInverseTo(Rotation)}.</p>
-
+ *
* <p>Rotations are guaranteed to be immutable objects.</p>
-
+ *
* @version $Revision$ $Date$
* @see Vector3D
* @see RotationOrder
-
+ * @since 1.2
*/
public class Rotation implements Serializable {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/RotationOrder.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/RotationOrder.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/RotationOrder.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/RotationOrder.java Sun Feb 10 11:28:59 2008
@@ -20,14 +20,14 @@
/**
* This class is a utility representing a rotation order specification
* for Cardan or Euler angles specification.
-
+ *
* This class cannot be instanciated by the user. He can only use one
* of the twelve predefined supported orders as an argument to either
* the {@link Rotation#Rotation(RotationOrder,double,double,double)}
* constructor or the {@link Rotation#getAngles} method.
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public final class RotationOrder {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/geometry/Vector3D.java Sun Feb 10 11:28:59 2008
@@ -19,9 +19,11 @@
import java.io.Serializable;
-/** This class implements vectors in a three-dimensional space.
+/**
+ * This class implements vectors in a three-dimensional space.
* <p>Instance of this class are guaranteed to be immutable.</p>
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class Vector3D
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecomposition.java Sun Feb 10 11:28:59 2008
@@ -23,8 +23,8 @@
*
* @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
* @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a>
- *
* @version $Revision$ $Date$
+ * @since 1.2
*/
public interface QRDecomposition {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/linear/QRDecompositionImpl.java Sun Feb 10 11:28:59 2008
@@ -23,13 +23,13 @@
* orthogonal (Q<sup>T</sup>Q = I), and R is upper triangular. If A is
* m×n, Q is m×m and R m×n.
* <p>
- * Implemented using Householder reflectors.
- *
+ * Implemented using Householder reflectors.</p>
*
* @see <a href="http://mathworld.wolfram.com/QRDecomposition.html">MathWorld</a>
* @see <a href="http://en.wikipedia.org/wiki/QR_decomposition">Wikipedia</a>
*
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class QRDecompositionImpl implements QRDecomposition {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AbstractStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -34,6 +34,7 @@
* @see StepHandler
*
* @version $Revision$ $Date$
+ * @since 1.2
*
*/
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AdaptiveStepsizeIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AdaptiveStepsizeIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AdaptiveStepsizeIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/AdaptiveStepsizeIntegrator.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This abstract class holds the common part of all adaptive
* stepsize integrators for Ordinary Differential Equations.
-
+ *
* <p>These algorithms perform integration with stepsize control, which
* means the user does not specify the integration step but rather a
* tolerance on error. The error threshold is computed as
@@ -31,18 +31,19 @@
* state vector and relTol_i is the relative tolerance for the same
* component. The user can also use only two scalar values absTol and
* relTol which will be used for all components.</p>
-
+ *
* <p>If the estimated error for ym+1 is such that
* <pre>
* sqrt((sum (errEst_i / threshold_i)^2 ) / n) < 1
* </pre>
-
+ *
* (where n is the state vector dimension) then the step is accepted,
* otherwise the step is rejected and a new attempt is made with a new
* stepsize.</p>
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
+ *
*/
public abstract class AdaptiveStepsizeIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaIntegrator.java Sun Feb 10 11:28:59 2008
@@ -21,7 +21,7 @@
* This class implements the classical fourth order Runge-Kutta
* integrator for Ordinary Differential Equations (it is the most
* often used Runge-Kutta method).
-
+ *
* <p>This method is an explicit Runge-Kutta method, its Butcher-array
* is the following one :
* <pre>
@@ -33,14 +33,13 @@
* | 1/6 1/3 1/3 1/6
* </pre>
* </p>
-
+ *
* @see EulerIntegrator
* @see GillIntegrator
* @see MidpointIntegrator
* @see ThreeEighthesIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class ClassicalRungeKuttaIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ClassicalRungeKuttaStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This class implements a step interpolator for the classical fourth
* order Runge-Kutta integrator.
-
+ *
* <p>This interpolator allows to compute dense output inside the last
* step computed. The interpolation equation is consistent with the
* integration scheme :
@@ -32,15 +32,14 @@
* -(4 theta^2 + theta + 1) y'_4
* ]
* </pre>
-
+ *
* where theta belongs to [0 ; 1] and where y'_1 to y'_4 are the four
* evaluations of the derivatives already computed during the
* step.</p>
-
+ *
* @see ClassicalRungeKuttaIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
class ClassicalRungeKuttaStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ContinuousOutputModel.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ContinuousOutputModel.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ContinuousOutputModel.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/ContinuousOutputModel.java Sun Feb 10 11:28:59 2008
@@ -25,7 +25,7 @@
* This class stores all information provided by an ODE integrator
* during the integration process and build a continuous model of the
* solution from this.
-
+ *
* <p>This class act as a step handler from the integrator point of
* view. It is called iteratively during the integration process and
* stores a copy of all steps information in a sorted collection for
@@ -36,14 +36,14 @@
* integration to be over before attempting to call {@link
* #setInterpolatedTime setInterpolatedTime} because some internal
* variables are set only once the last step has been handled.</p>
-
+ *
* <p>This is useful for example if the main loop of the user
* application should remain independent from the integration process
* or if one needs to mimic the behaviour of an analytical model
* despite a numerical model is used (i.e. one needs the ability to
* get the model value at any time or to navigate through the
* data).</p>
-
+ *
* <p>If problem modelization is done with several separate
* integration phases for contiguous intervals, the same
* ContinuousOutputModel can be used as step handler for all
@@ -57,7 +57,7 @@
* output model handles the steps of all integration phases, the user
* do not need to bother when the maneuver begins or ends, he has all
* the data available in a transparent manner.</p>
-
+ *
* <p>An important feature of this class is that it implements the
* <code>Serializable</code> interface. This means that the result of
* an integration can be serialized and reused later (if stored into a
@@ -65,18 +65,17 @@
* sent to another application). Only the result of the integration is
* stored, there is no reference to the integrated problem by
* itself.</p>
-
+ *
* <p>One should be aware that the amount of data stored in a
* ContinuousOutputModel instance can be important if the state vector
* is large, if the integration interval is long or if the steps are
* small (which can result from small tolerance settings in {@link
* AdaptiveStepsizeIntegrator adaptive step size integrators}).</p>
-
+ *
* @see StepHandler
* @see StepInterpolator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class ContinuousOutputModel
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DerivativeException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DerivativeException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DerivativeException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DerivativeException.java Sun Feb 10 11:28:59 2008
@@ -24,6 +24,7 @@
* the error conditions that are trigegred while computing
* the differential equations.
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class DerivativeException
extends MathException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54Integrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54Integrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54Integrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54Integrator.java Sun Feb 10 11:28:59 2008
@@ -29,7 +29,7 @@
* is an <i>fsal</i>, the last evaluation of one step is the same as
* the first evaluation of the next step and hence can be avoided. So
* the cost is really 6 functions evaluations per step.</p>
-
+ *
* <p>This method has been published (whithout the continuous output
* that was added by Shampine in 1986) in the following article :
* <pre>
@@ -38,9 +38,9 @@
* Journal of Computational and Applied Mathematics
* volume 6, no 1, 1980, pp. 19-26
* </pre></p>
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class DormandPrince54Integrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince54StepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -24,7 +24,7 @@
* @see DormandPrince54Integrator
*
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
class DormandPrince54StepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853Integrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853Integrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853Integrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853Integrator.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This class implements the 8(5,3) Dormand-Prince integrator for Ordinary
* Differential Equations.
-
+ *
* <p>This integrator is an embedded Runge-Kutta integrator
* of order 8(5,3) used in local extrapolation mode (i.e. the solution
* is computed using the high order formula) with stepsize control
@@ -33,7 +33,7 @@
* <i>fsal</i>. Hence, despite we have 13 stages here, the cost is
* really 12 evaluations per step even if no interpolation is done,
* and the overcost of interpolation is only 3 evaluations.</p>
-
+ *
* <p>This method is based on an 8(6) method by Dormand and Prince
* (i.e. order 8 for the integration and order 6 for error estimation)
* modified by Hairer and Wanner to use a 5th order error estimator
@@ -46,9 +46,9 @@
* Problems) of the reference book by Hairer, Norsett and Wanner:
* <i>Solving Ordinary Differential Equations</i> (Springer-Verlag,
* ISBN 3-540-56670-8).</p>
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class DormandPrince853Integrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DormandPrince853StepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -28,7 +28,7 @@
* @see DormandPrince853Integrator
*
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
class DormandPrince853StepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepHandler.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepHandler.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepHandler.java Sun Feb 10 11:28:59 2008
@@ -25,16 +25,15 @@
* <p>This class is provided as a convenience for users who are only
* interested in the final state of an integration and not in the
* intermediate steps. Its handleStep method does nothing.</p>
-
+ *
* <p>Since this class has no internal state, it is implemented using
* the Singleton design pattern. This means that only one instance is
* ever created, which can be retrieved using the getInstance
* method. This explains why there is no public constructor.</p>
-
+ *
* @see StepHandler
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class DummyStepHandler
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/DummyStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -32,7 +32,7 @@
* @see StepHandler
*
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
public class DummyStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EmbeddedRungeKuttaIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EmbeddedRungeKuttaIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EmbeddedRungeKuttaIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EmbeddedRungeKuttaIntegrator.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This class implements the common part of all embedded Runge-Kutta
* integrators for Ordinary Differential Equations.
-
+ *
* <p>These methods are embedded explicit Runge-Kutta methods with two
* sets of coefficients allowing to estimate the error, their Butcher
* arrays are as follows :
@@ -35,11 +35,11 @@
* | b'1 b'2 ... b's-1 b's
* </pre>
* </p>
-
+ *
* <p>In fact, we rather use the array defined by ej = bj - b'j to
* compute directly the error rather than computing two estimates and
* then comparing them.</p>
-
+ *
* <p>Some methods are qualified as <i>fsal</i> (first same as last)
* methods. This means the last evaluation of the derivatives in one
* step is the same as the first in the next step. Then, this
@@ -49,9 +49,9 @@
* the step is rejected after the error estimation phase, no
* evaluation is saved. For an <i>fsal</i> method, we have cs = 1 and
* asi = bi for all i.</p>
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public abstract class EmbeddedRungeKuttaIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerIntegrator.java Sun Feb 10 11:28:59 2008
@@ -20,30 +20,29 @@
/**
* This class implements a simple Euler integrator for Ordinary
* Differential Equations.
-
+ *
* <p>The Euler algorithm is the simplest one that can be used to
* integrate ordinary differential equations. It is a simple inversion
* of the forward difference expression :
* <code>f'=(f(t+h)-f(t))/h</code> which leads to
* <code>f(t+h)=f(t)+hf'</code>. The interpolation scheme used for
* dense output is the linear scheme already used for integration.</p>
-
+ *
* <p>This algorithm looks cheap because it needs only one function
* evaluation per step. However, as it uses linear estimates, it needs
* very small steps to achieve high accuracy, and small steps lead to
* numerical errors and instabilities.</p>
-
+ *
* <p>This algorithm is almost never used and has been included in
* this package only as a comparison reference for more useful
* integrators.</p>
-
+ *
* @see MidpointIntegrator
* @see ClassicalRungeKuttaIntegrator
* @see GillIntegrator
* @see ThreeEighthesIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class EulerIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/EulerStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -19,22 +19,21 @@
/**
* This class implements a linear interpolator for step.
-
+ *
* <p>This interpolator allow to compute dense output inside the last
* step computed. The interpolation equation is consistent with the
* integration scheme :
-
+ *
* <pre>
* y(t_n + theta h) = y (t_n + h) - (1-theta) h y'
* </pre>
-
+ *
* where theta belongs to [0 ; 1] and where y' is the evaluation of
* the derivatives already computed during the step.</p>
-
+ *
* @see EulerIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
class EulerStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderConverter.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderConverter.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderConverter.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderConverter.java Sun Feb 10 11:28:59 2008
@@ -19,11 +19,11 @@
/** This class converts second order differential equations to first
* order ones.
-
+ *
* <p>This class is a wrapper around a {@link
* SecondOrderDifferentialEquations} which allow to use a {@link
* FirstOrderIntegrator} to integrate it.</p>
-
+ *
* <p>The transformation is done by changing the n dimension state
* vector to a 2n dimension vector, where the first n components are
* the initial state variables and the n last components are their
@@ -31,7 +31,7 @@
* vector then really contains both the first and second time
* derivative of the initial state vector, which can be handled by the
* underlying second order equations set.</p>
-
+ *
* <p>One should be aware that the data is duplicated during the
* transformation process and that for each call to {@link
* #computeDerivatives computeDerivatives}, this wrapper does copy 4n
@@ -45,13 +45,12 @@
* avoid this duplication is to perform the transformation at the
* problem level, i.e. to implement the problem as a first order one
* and then avoid using this class.</p>
-
+ *
* @see FirstOrderIntegrator
* @see FirstOrderDifferentialEquations
* @see SecondOrderDifferentialEquations
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class FirstOrderConverter
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderDifferentialEquations.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderDifferentialEquations.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderDifferentialEquations.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderDifferentialEquations.java Sun Feb 10 11:28:59 2008
@@ -41,7 +41,7 @@
* @see SecondOrderDifferentialEquations
*
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
public interface FirstOrderDifferentialEquations {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FirstOrderIntegrator.java Sun Feb 10 11:28:59 2008
@@ -24,13 +24,12 @@
* equations should implement this interface. The problems which can
* be handled should implement the {@link
* FirstOrderDifferentialEquations} interface.</p>
-
+ *
* @see FirstOrderDifferentialEquations
* @see StepHandler
* @see SwitchingFunction
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public interface FirstOrderIntegrator {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FixedStepHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FixedStepHandler.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FixedStepHandler.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/FixedStepHandler.java Sun Feb 10 11:28:59 2008
@@ -29,12 +29,11 @@
* {@link StepNormalizer} object is called according to the integrator
* internal algorithms and it calls objects implementing this
* interface as necessary at fixed time steps.</p>
-
+ *
* @see StepHandler
* @see StepNormalizer
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public interface FixedStepHandler {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillIntegrator.java Sun Feb 10 11:28:59 2008
@@ -32,14 +32,13 @@
* | 1/6 (2-q)/6 (2+q)/6 1/6
* </pre>
* where q = sqrt(2)</p>
-
+ *
* @see EulerIntegrator
* @see ClassicalRungeKuttaIntegrator
* @see MidpointIntegrator
* @see ThreeEighthesIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class GillIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GillStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -20,11 +20,11 @@
/**
* This class implements a step interpolator for the Gill fourth
* order Runge-Kutta integrator.
-
+ *
* <p>This interpolator allows to compute dense output inside the last
* step computed. The interpolation equation is consistent with the
* integration scheme :
-
+ *
* <pre>
* y(t_n + theta h) = y (t_n + h)
* - (1 - theta) (h/6) [ (1 - theta) (1 - 4 theta) y'_1
@@ -35,11 +35,10 @@
* where theta belongs to [0 ; 1], q = sqrt(2) and where y'_1 to y'_4
* are the four evaluations of the derivatives already computed during
* the step.</p>
-
+ *
* @see GillIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
class GillStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerIntegrator.java Sun Feb 10 11:28:59 2008
@@ -20,12 +20,12 @@
/**
* This class implements a Gragg-Bulirsch-Stoer integrator for
* Ordinary Differential Equations.
-
+ *
* <p>The Gragg-Bulirsch-Stoer algorithm is one of the most efficient
* ones currently available for smooth problems. It uses Richardson
* extrapolation to estimate what would be the solution if the step
* size could be decreased down to zero.</p>
-
+ *
* <p>
* This method changes both the step size and the order during
* integration, in order to minimize computation cost. It is
@@ -41,7 +41,7 @@
* bodies (pleiades problem, involving quasi-collisions for which
* <i>automatic step size control is essential</i>).
* </p>
-
+ *
* <p>
* This implementation is basically a reimplementation in Java of the
* <a
@@ -51,10 +51,10 @@
* href="http://www.unige.ch/~hairer/prog/licence.txt">here</a>, for
* convenience, it is reproduced below.</p>
* </p>
-
+ *
* <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0">
* <tr><td>Copyright (c) 2004, Ernst Hairer</td></tr>
-
+ *
* <tr><td>Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
@@ -65,7 +65,7 @@
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.</li>
* </ul></td></tr>
-
+ *
* <tr><td><strong>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
@@ -78,10 +78,10 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</strong></td></tr>
* </table>
-
+ *
* @author E. Hairer and G. Wanner (fortran version)
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class GraggBulirschStoerIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/GraggBulirschStoerStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -24,10 +24,10 @@
/**
* This class implements an interpolator for the Gragg-Bulirsch-Stoer
* integrator.
-
+ *
* <p>This interpolator compute dense output inside the last step
* produced by a Gragg-Bulirsch-Stoer integrator.</p>
-
+ *
* <p>
* This implementation is basically a reimplementation in Java of the
* <a
@@ -37,10 +37,10 @@
* href="http://www.unige.ch/~hairer/prog/licence.txt">here</a>, for
* convenience, it is reproduced below.</p>
* </p>
-
+ *
* <table border="0" width="80%" cellpadding="10" align="center" bgcolor="#E0E0E0">
* <tr><td>Copyright (c) 2004, Ernst Hairer</td></tr>
-
+ *
* <tr><td>Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
@@ -51,7 +51,7 @@
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.</li>
* </ul></td></tr>
-
+ *
* <tr><td><strong>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
@@ -64,12 +64,11 @@
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</strong></td></tr>
* </table>
-
+ *
* @see GraggBulirschStoerIntegrator
-
* @version $Revision$ $Date$
* @author E. Hairer and G. Wanner (fortran version)
-
+ * @since 1.2
*/
class GraggBulirschStoerStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54Integrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54Integrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54Integrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54Integrator.java Sun Feb 10 11:28:59 2008
@@ -20,15 +20,15 @@
/**
* This class implements the 5(4) Higham and Hall integrator for
* Ordinary Differential Equations.
-
+ *
* <p>This integrator is an embedded Runge-Kutta integrator
* of order 5(4) used in local extrapolation mode (i.e. the solution
* is computed using the high order formula) with stepsize control
* (and automatic step initialization) and continuous output. This
* method uses 7 functions evaluations per step.</p>
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class HighamHall54Integrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/HighamHall54StepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -24,7 +24,7 @@
* @see HighamHall54Integrator
*
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
class HighamHall54StepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/IntegratorException.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/IntegratorException.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/IntegratorException.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/IntegratorException.java Sun Feb 10 11:28:59 2008
@@ -23,6 +23,7 @@
* This exception is made available to users to report
* the error conditions that are triggered during integration
* @version $Revision$ $Date$
+ * @since 1.2
*/
public class IntegratorException
extends MathException {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointIntegrator.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This class implements a second order Runge-Kutta integrator for
* Ordinary Differential Equations.
-
+ *
* <p>This method is an explicit Runge-Kutta method, its Butcher-array
* is the following one :
* <pre>
@@ -30,13 +30,13 @@
* | 0 1
* </pre>
* </p>
-
+ *
* @see EulerIntegrator
* @see ClassicalRungeKuttaIntegrator
* @see GillIntegrator
-
+ *
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public class MidpointIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/MidpointStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -20,23 +20,22 @@
/**
* This class implements a step interpolator for second order
* Runge-Kutta integrator.
-
+ *
* <p>This interpolator allow to compute dense output inside the last
* step computed. The interpolation equation is consistent with the
* integration scheme :
-
+ *
* <pre>
* y(t_n + theta h) = y (t_n + h) + (1-theta) h [theta y'_1 - (1+theta) y'_2]
* </pre>
-
+ *
* where theta belongs to [0 ; 1] and where y'_1 and y'_2 are the two
* evaluations of the derivatives already computed during the
* step.</p>
-
+ *
* @see MidpointIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
class MidpointStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaIntegrator.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This class implements the common part of all fixed step Runge-Kutta
* integrators for Ordinary Differential Equations.
-
+ *
* <p>These methods are explicit Runge-Kutta methods, their Butcher
* arrays are as follows :
* <pre>
@@ -33,14 +33,13 @@
* | b1 b2 ... bs-1 bs
* </pre>
* </p>
-
+ *
* @see EulerIntegrator
* @see ClassicalRungeKuttaIntegrator
* @see GillIntegrator
* @see MidpointIntegrator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public abstract class RungeKuttaIntegrator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaStepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaStepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/RungeKuttaStepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -28,7 +28,7 @@
* @see EmbeddedRungeKuttaIntegrator
*
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
abstract class RungeKuttaStepInterpolator
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderDifferentialEquations.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderDifferentialEquations.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderDifferentialEquations.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderDifferentialEquations.java Sun Feb 10 11:28:59 2008
@@ -22,7 +22,7 @@
* <p>This interface should be implemented by all real second order
* differential equation problems before they can be handled by the
* integrators {@link SecondOrderIntegrator#integrate} method.</p>
-
+ *
* <p>A second order differential equations problem, as seen by an
* integrator is the second time derivative <code>d2Y/dt^2</code> of a
* state vector <code>Y</code>, both being one dimensional
@@ -30,19 +30,18 @@
* only on the current time <code>t</code>, on the state vector
* <code>Y</code> and on the first time derivative of the state
* vector.</p>
-
+ *
* <p>For real problems, the derivative depends also on parameters
* that do not belong to the state vector (dynamical model constants
* for example). These constants are completely outside of the scope
* of this interface, the classes that implement it are allowed to
* handle them as they want.</p>
-
+ *
* @see SecondOrderIntegrator
* @see FirstOrderConverter
* @see FirstOrderDifferentialEquations
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public interface SecondOrderDifferentialEquations {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderIntegrator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderIntegrator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/SecondOrderIntegrator.java Sun Feb 10 11:28:59 2008
@@ -19,16 +19,15 @@
/** This interface represents a second order integrator for
* differential equations.
-
+ *
* <p>The classes which are devoted to solve second order differential
* equations should implement this interface. The problems which can
* be handled should implement the {@link
* SecondOrderDifferentialEquations} interface.</p>
-
+ *
* @see SecondOrderDifferentialEquations
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public interface SecondOrderIntegrator {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepHandler.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepHandler.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepHandler.java Sun Feb 10 11:28:59 2008
@@ -20,7 +20,7 @@
/**
* This interface represents a handler that should be called after
* each successful step.
-
+ *
* <p>The ODE integrators compute the evolution of the state vector at
* some grid points that depend on their own internal algorithm. Once
* they have found a new grid point (possibly after having computed
@@ -29,13 +29,12 @@
* typically either ignore the intermediate steps and wait for the
* last one, store the points in an ephemeris, or forward them to
* specialized processing or output methods.</p>
-
+ *
* @see FirstOrderIntegrator
* @see SecondOrderIntegrator
* @see StepInterpolator
-
* @version $Revision$ $Date$
-
+ * @since 1.2
*/
public interface StepHandler {
Modified: commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepInterpolator.java?rev=620312&r1=620311&r2=620312&view=diff
==============================================================================
--- commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepInterpolator.java (original)
+++ commons/proper/math/trunk/src/java/org/apache/commons/math/ode/StepInterpolator.java Sun Feb 10 11:28:59 2008
@@ -32,9 +32,8 @@
* @see FirstOrderIntegrator
* @see SecondOrderIntegrator
* @see StepHandler
- *
* @version $Revision$ $Date$
- *
+ * @since 1.2
*/
public interface StepInterpolator
|