Skip to content

Commit

Permalink
Javadoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
maisonobe committed Oct 28, 2024
1 parent c3e5d3a commit 30d1f9b
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 30d1f9b

Please sign in to comment.