From 30d1f9bf20d2532527dc087d6ed0211435f45353 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@orekit.org>
Date: Mon, 28 Oct 2024 19:49:27 +0100
Subject: [PATCH] Javadoc.

---
 .../analysis/differentiation/DerivativeStructure.java | 10 ++++++----
 .../analysis/differentiation/FieldGradient.java       | 11 ++++++-----
 .../differentiation/FieldUnivariateDerivative1.java   | 11 ++++++-----
 .../differentiation/FieldUnivariateDerivative2.java   | 11 ++++++-----
 .../hipparchus/analysis/differentiation/Gradient.java |  9 +++++----
 .../differentiation/UnivariateDerivative1.java        |  9 +++++----
 .../differentiation/UnivariateDerivative2.java        |  9 +++++----
 7 files changed, 39 insertions(+), 31 deletions(-)

diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/DerivativeStructure.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/DerivativeStructure.java
index 77ba7a0d8..a70dcd7f9 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/DerivativeStructure.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/DerivativeStructure.java
@@ -48,10 +48,12 @@
  * <p>{@link DerivativeStructure} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves. Implementing complex expression can also be done by developing computation
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
+ * <p>Implementing complex expression can also be done by developing computation
  * code using standard primitive double values and to use {@link
  * UnivariateFunctionDifferentiator differentiators} to create the {@link
  * DerivativeStructure}-based instances. This method is simpler but may be limited in
diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldGradient.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldGradient.java
index a62f5be70..63de91a25 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldGradient.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldGradient.java
@@ -38,10 +38,11 @@
  * <p>{@link FieldGradient} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves.</p>
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
  * <p>Instances of this class are guaranteed to be immutable.</p>
  * @param <T> the type of the function parameters and value
  * @see DerivativeStructure
@@ -80,7 +81,7 @@ public FieldGradient(final T value, final T... gradient) {
         System.arraycopy(gradient, 0, grad, 0, grad.length);
     }
 
-    /** Build an instance from a {@link DerivativeStructure}.
+    /** Build an instance from a {@link FieldDerivativeStructure}.
      * @param ds derivative structure
      * @exception MathIllegalArgumentException if {@code ds} order
      * is not 1
diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative1.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative1.java
index 4529c1ee2..9b44c3622 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative1.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative1.java
@@ -35,10 +35,11 @@
  * <p>{@link FieldUnivariateDerivative1} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves.</p>
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
  * <p>Instances of this class are guaranteed to be immutable.</p>
  * @param <T> the type of the function parameters and value
  * @see DerivativeStructure
@@ -69,7 +70,7 @@ public FieldUnivariateDerivative1(final T f0, final T f1) {
         this.f1 = f1;
     }
 
-    /** Build an instance from a {@link DerivativeStructure}.
+    /** Build an instance from a {@link FieldDerivativeStructure}.
      * @param ds derivative structure
      * @exception MathIllegalArgumentException if either {@code ds} parameters
      * is not 1 or {@code ds} order is not 1
diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative2.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative2.java
index 2caf1db4c..5a5ebe605 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative2.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/FieldUnivariateDerivative2.java
@@ -37,10 +37,11 @@
  * <p>{@link FieldUnivariateDerivative2} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves.</p>
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
  * <p>Instances of this class are guaranteed to be immutable.</p>
  * @param <T> the type of the function parameters and value
  * @see DerivativeStructure
@@ -75,7 +76,7 @@ public FieldUnivariateDerivative2(final T f0, final T f1, final T f2) {
         this.f2 = f2;
     }
 
-    /** Build an instance from a {@link DerivativeStructure}.
+    /** Build an instance from a {@link FieldDerivativeStructure}.
      * @param ds derivative structure
      * @exception MathIllegalArgumentException if either {@code ds} parameters
      * is not 1 or {@code ds} order is not 2
diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/Gradient.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/Gradient.java
index 396227fc6..68d8f82e3 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/Gradient.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/Gradient.java
@@ -39,10 +39,11 @@
  * <p>{@link Gradient} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves.</p>
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
  * <p>Instances of this class are guaranteed to be immutable.</p>
  * @see DerivativeStructure
  * @see UnivariateDerivative1
diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative1.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative1.java
index a5c8d9262..4094eed84 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative1.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative1.java
@@ -33,10 +33,11 @@
  * <p>{@link UnivariateDerivative1} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves.</p>
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
  * <p>Instances of this class are guaranteed to be immutable.</p>
  * @see DerivativeStructure
  * @see UnivariateDerivative2
diff --git a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative2.java b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative2.java
index 6b8d8d4cc..8184b5822 100644
--- a/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative2.java
+++ b/hipparchus-core/src/main/java/org/hipparchus/analysis/differentiation/UnivariateDerivative2.java
@@ -37,10 +37,11 @@
  * <p>{@link UnivariateDerivative2} instances can be used directly thanks to
  * the arithmetic operators to the mathematical functions provided as
  * methods by this class (+, -, *, /, %, sin, cos ...).</p>
- * <p>Implementing complex expressions by hand using these classes is
- * a tedious and error-prone task but has the advantage of having no limitation
- * on the derivation order despite not requiring users to compute the derivatives by
- * themselves.</p>
+ * <p>Implementing complex expressions by hand using {@link Derivative}-based
+ * classes (or in fact any {@link org.hipparchus.CalculusFieldElement} class) is
+ * a tedious and error-prone task but has the advantage of not requiring users
+ * to compute the derivatives by themselves and allowing to switch for one
+ * derivative implementation to another as they all share the same filed API.</p>
  * <p>Instances of this class are guaranteed to be immutable.</p>
  * @see DerivativeStructure
  * @see UnivariateDerivative2