commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1067500 - in /commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math: geometry/Rotation.java ode/events/EventHandler.java ode/nonstiff/GraggBulirschStoerIntegrator.java ode/sampling/AbstractStepInterpolator.java
Date Sat, 05 Feb 2011 20:11:31 GMT
Author: sebb
Date: Sat Feb  5 20:11:30 2011
New Revision: 1067500

URL: http://svn.apache.org/viewvc?rev=1067500&view=rev
Log:
Javadoc tidyup

Modified:
    commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/geometry/Rotation.java
    commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/events/EventHandler.java
    commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
    commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/sampling/AbstractStepInterpolator.java

Modified: commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/geometry/Rotation.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/geometry/Rotation.java?rev=1067500&r1=1067499&r2=1067500&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/geometry/Rotation.java
(original)
+++ commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/geometry/Rotation.java
Sat Feb  5 20:11:30 2011
@@ -194,7 +194,7 @@ public class Rotation implements Seriali
    * coefficients. The module of the determinant of unit matrices is
    * 1, among the orthogonal 3X3 matrices, only the ones having a
    * positive determinant (+1) are rotation matrices.</p>
-
+   *
    * <p>When a rotation is defined by a matrix with truncated values
    * (typically when it is extracted from a technical sheet where only
    * four to five significant digits are available), the matrix is not
@@ -204,18 +204,18 @@ public class Rotation implements Seriali
    * the Frobenius norm of the correction needed is above the given
    * threshold, then the matrix is considered to be too far from a
    * true rotation matrix and an exception is thrown.<p>
-
+   *
    * @param m rotation matrix
    * @param threshold convergence threshold for the iterative
    * orthogonality correction (convergence is reached when the
    * difference between two steps of the Frobenius norm of the
    * correction is below this threshold)
-
+   *
    * @exception NotARotationMatrixException if the matrix is not a 3X3
    * matrix, or if it cannot be transformed into an orthogonal matrix
    * with the given threshold, or if the determinant of the resulting
    * orthogonal matrix is negative
-
+   *
    */
   public Rotation(double[][] m, double threshold)
     throws NotARotationMatrixException {
@@ -297,13 +297,13 @@ public class Rotation implements Seriali
    * <p>Except for possible scale factors, if the instance were applied to
    * the pair (u<sub>1</sub>, u<sub>2</sub>) it will produce the
pair
    * (v<sub>1</sub>, v<sub>2</sub>).</p>
-
+   *
    * <p>If the angular separation between u<sub>1</sub> and u<sub>2</sub>
is
    * not the same as the angular separation between v<sub>1</sub> and
    * v<sub>2</sub>, then a corrected v'<sub>2</sub> will be used
rather than
    * v<sub>2</sub>, the corrected vector will be in the (v<sub>1</sub>,
    * v<sub>2</sub>) plane.</p>
-
+   *
    * @param u1 first vector of the origin pair
    * @param u2 second vector of the origin pair
    * @param v1 desired image of u1 by the rotation
@@ -440,7 +440,7 @@ public class Rotation implements Seriali
    * one with the smallest associated angle (i.e. the one whose axis
    * is orthogonal to the (u, v) plane). If u and v are colinear, an
    * arbitrary rotation axis is chosen.</p>
-
+   *
    * @param u origin vector
    * @param v desired image of u by the rotation
    * @exception IllegalArgumentException if the norm of one of the vectors is zero
@@ -487,7 +487,7 @@ public class Rotation implements Seriali
    * for what really are Cardan angles (this confusion is especially
    * widespread in the aerospace business where Roll, Pitch and Yaw angles
    * are often wrongly tagged as Euler angles).</p>
-
+   *
    * @param order order of rotations to use
    * @param alpha1 angle of the first elementary rotation
    * @param alpha2 angle of the second elementary rotation
@@ -589,7 +589,7 @@ public class Rotation implements Seriali
    *   <li>for Euler angles, the chosen set is the one for which the
    *   second angle is between 0 and &pi; (i.e its sine is positive).</li>
    * </ul>
-
+   *
    * <p>Cardan and Euler angle have a very disappointing drawback: all
    * of them have singularities. This means that if the instance is
    * too close to the singularities corresponding to the given
@@ -602,7 +602,7 @@ public class Rotation implements Seriali
    * -&pi;/2 or +&pi;/2, for Euler angle singularities occur when the
    * second angle is close to 0 or &pi;, this implies that the identity
    * rotation is always singular for Euler angles!</p>
-
+   *
    * @param order rotation order to use
    * @return an array of three angles, in the order specified by the set
    * @exception CardanEulerSingularityException if the rotation is

Modified: commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/events/EventHandler.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/events/EventHandler.java?rev=1067500&r1=1067499&r2=1067500&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/events/EventHandler.java
(original)
+++ commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/events/EventHandler.java
Sat Feb  5 20:11:30 2011
@@ -90,7 +90,7 @@ public interface EventHandler  {
    * The switching function must be continuous in its roots neighborhood
    * (but not necessarily smooth), as the integrator will need to find its
    * roots to locate precisely the events.</p>
-
+   *
    * @param t current value of the independent <i>time</i> variable
    * @param y array containing the current value of the state vector
    * @return value of the g switching function
@@ -109,7 +109,7 @@ public interface EventHandler  {
    * differential equations} to switch the derivatives computation in
    * case of discontinuity), or to direct the integrator to either stop
    * or continue integration, possibly with a reset state or derivatives.</p>
-
+   *
    * <ul>
    *   <li>if {@link #STOP} is returned, the step handler will be called
    *   with the <code>isLast</code> flag of the {@link
@@ -125,7 +125,7 @@ public interface EventHandler  {
    *   be taken (apart from having called this method) and integration
    *   will continue.</li>
    * </ul>
-
+   *
    * <p>The scheduling between this method and the {@link
    * org.apache.commons.math.ode.sampling.StepHandler StepHandler} method {@link
    * org.apache.commons.math.ode.sampling.StepHandler#handleStep(
@@ -149,7 +149,7 @@ public interface EventHandler  {
    * org.apache.commons.math.ode.sampling.StepHandler variable step handlers} and
    * to the size of the fixed step for {@link
    * org.apache.commons.math.ode.sampling.FixedStepHandler fixed step handlers}.</p>
-
+   *
    * @param t current value of the independent <i>time</i> variable
    * @param y array containing the current value of the state vector
    * @param increasing if true, the value of the switching function increases
@@ -172,7 +172,7 @@ public interface EventHandler  {
    * step. If the {@link #eventOccurred} never returns the {@link
    * #RESET_STATE} indicator, this function will never be called, and it is
    * safe to leave its body empty.</p>
-
+   *
    * @param t current value of the independent <i>time</i> variable
    * @param y array containing the current value of the state vector
    * the new state should be put in the same array

Modified: commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java?rev=1067500&r1=1067499&r2=1067500&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
(original)
+++ commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/nonstiff/GraggBulirschStoerIntegrator.java
Sat Feb  5 20:11:30 2011
@@ -401,7 +401,7 @@ public class GraggBulirschStoerIntegrato
    * The interpolation order for dense output is 2k - mudif + 1. The
    * default value for mudif is 4 and the interpolation error is used
    * in stepsize control by default.
-
+   *
    * @param useInterpolationErrorForControl if true, interpolation error is used
    * for stepsize control
    * @param mudifControlParameter interpolation order control parameter (the parameter

Modified: commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/sampling/AbstractStepInterpolator.java
URL: http://svn.apache.org/viewvc/commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/sampling/AbstractStepInterpolator.java?rev=1067500&r1=1067499&r2=1067500&view=diff
==============================================================================
--- commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/sampling/AbstractStepInterpolator.java
(original)
+++ commons/proper/math/branches/MATH_2_X/src/main/java/org/apache/commons/math/ode/sampling/AbstractStepInterpolator.java
Sat Feb  5 20:11:30 2011
@@ -140,12 +140,12 @@ public abstract class AbstractStepInterp
    * don't want this method to modify the state of the copied
    * interpolator, finalization is <strong>not</strong> done
    * automatically, it remains under user control.</p>
-
+   *
    * <p>The copy is a deep copy: its arrays are separated from the
    * original arrays of the instance.</p>
-
+   *
    * @param interpolator interpolator to copy from.
-
+   *
    */
   protected AbstractStepInterpolator(final AbstractStepInterpolator interpolator) {
 
@@ -355,7 +355,7 @@ public abstract class AbstractStepInterp
 
   /**
    * Finalize the step.
-
+   *
    * <p>Some embedded Runge-Kutta integrators need fewer functions
    * evaluations than their counterpart step interpolators. These
    * interpolators should perform the last evaluations they need by
@@ -363,7 +363,7 @@ public abstract class AbstractStepInterp
    * extra evaluations. It can be called directly by the user step
    * handler and it is called automatically if {@link
    * #setInterpolatedTime} is called.</p>
-
+   *
    * <p>Once this method has been called, <strong>no</strong> other
    * evaluation will be performed on this step. If there is a need to
    * have some side effects between the step handler and the
@@ -373,7 +373,7 @@ public abstract class AbstractStepInterp
    * effects are set up. If the step handler induces no side effect,
    * then this method can safely be ignored, it will be called
    * transparently as needed.</p>
-
+   *
    * <p><strong>Warning</strong>: since the step interpolator provided
    * to the step handler as a parameter of the {@link
    * StepHandler#handleStep handleStep} is valid only for the duration
@@ -381,7 +381,7 @@ public abstract class AbstractStepInterp
    * simply store a reference and reuse it later. One should first
    * finalize the instance, then copy this finalized instance into a
    * new object that can be kept.</p>
-
+   *
    * <p>This method calls the protected <code>doFinalize</code> method
    * if it has never been called during this step and set a flag
    * indicating that it has been called once. It is the <code>
@@ -390,7 +390,7 @@ public abstract class AbstractStepInterp
    * times and hence evaluating the differential equations too often.
    * Therefore, subclasses are not allowed not reimplement it, they
    * should rather reimplement <code>doFinalize</code>.</p>
-
+   *
    * @throws MathUserException this exception is propagated to the
    * caller if the underlying user function triggers one
    */



Mime
View raw message