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

Javadoc

This commit is contained in:
Gary Gregory 2024-05-23 09:22:12 -04:00
parent ffcdf39f8f
commit 618358ea77
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/fitting/leastsquares/LeastSquaresBuilder.java
View File

@ -81,7 +81,7 @@ public class LeastSquaresBuilder {
* Configure the max evaluations. * Configure the max evaluations.
* *
* @param newMaxEvaluations the maximum number of evaluations permitted. * @param newMaxEvaluations the maximum number of evaluations permitted.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder maxEvaluations(final int newMaxEvaluations) { public LeastSquaresBuilder maxEvaluations(final int newMaxEvaluations) {
this.maxEvaluations = newMaxEvaluations; this.maxEvaluations = newMaxEvaluations;
@ -92,7 +92,7 @@ public class LeastSquaresBuilder {
* Configure the max iterations. * Configure the max iterations.
* *
* @param newMaxIterations the maximum number of iterations permitted. * @param newMaxIterations the maximum number of iterations permitted.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder maxIterations(final int newMaxIterations) { public LeastSquaresBuilder maxIterations(final int newMaxIterations) {
this.maxIterations = newMaxIterations; this.maxIterations = newMaxIterations;
@ -103,7 +103,7 @@ public class LeastSquaresBuilder {
* Configure the convergence checker. * Configure the convergence checker.
* *
* @param newChecker the convergence checker. * @param newChecker the convergence checker.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder checker(final ConvergenceChecker<Evaluation> newChecker) { public LeastSquaresBuilder checker(final ConvergenceChecker<Evaluation> newChecker) {
this.checker = newChecker; this.checker = newChecker;
@ -116,7 +116,7 @@ public class LeastSquaresBuilder {
* This function is an overloaded version of {@link #checker(ConvergenceChecker)}. * This function is an overloaded version of {@link #checker(ConvergenceChecker)}.
* *
* @param newChecker the convergence checker. * @param newChecker the convergence checker.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder checkerPair(final ConvergenceChecker<PointVectorValuePair> newChecker) { public LeastSquaresBuilder checkerPair(final ConvergenceChecker<PointVectorValuePair> newChecker) {
return this.checker(LeastSquaresFactory.evaluationChecker(newChecker)); return this.checker(LeastSquaresFactory.evaluationChecker(newChecker));
@ -127,7 +127,7 @@ public class LeastSquaresBuilder {
* *
* @param value the model function value * @param value the model function value
* @param jacobian the Jacobian of {@code value} * @param jacobian the Jacobian of {@code value}
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder model(final MultivariateVectorFunction value, public LeastSquaresBuilder model(final MultivariateVectorFunction value,
final MultivariateMatrixFunction jacobian) { final MultivariateMatrixFunction jacobian) {
@ -138,7 +138,7 @@ public class LeastSquaresBuilder {
* Configure the model function. * Configure the model function.
* *
* @param newModel the model function value and Jacobian * @param newModel the model function value and Jacobian
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder model(final MultivariateJacobianFunction newModel) { public LeastSquaresBuilder model(final MultivariateJacobianFunction newModel) {
this.model = newModel; this.model = newModel;
@ -149,7 +149,7 @@ public class LeastSquaresBuilder {
* Configure the observed data. * Configure the observed data.
* *
* @param newTarget the observed data. * @param newTarget the observed data.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder target(final RealVector newTarget) { public LeastSquaresBuilder target(final RealVector newTarget) {
this.target = newTarget; this.target = newTarget;
@ -160,7 +160,7 @@ public class LeastSquaresBuilder {
* Configure the observed data. * Configure the observed data.
* *
* @param newTarget the observed data. * @param newTarget the observed data.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder target(final double[] newTarget) { public LeastSquaresBuilder target(final double[] newTarget) {
return target(new ArrayRealVector(newTarget, false)); return target(new ArrayRealVector(newTarget, false));
@ -170,7 +170,7 @@ public class LeastSquaresBuilder {
* Configure the initial guess. * Configure the initial guess.
* *
* @param newStart the initial guess. * @param newStart the initial guess.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder start(final RealVector newStart) { public LeastSquaresBuilder start(final RealVector newStart) {
this.start = newStart; this.start = newStart;
@ -181,7 +181,7 @@ public class LeastSquaresBuilder {
* Configure the initial guess. * Configure the initial guess.
* *
* @param newStart the initial guess. * @param newStart the initial guess.
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder start(final double[] newStart) { public LeastSquaresBuilder start(final double[] newStart) {
return start(new ArrayRealVector(newStart, false)); return start(new ArrayRealVector(newStart, false));
@ -191,7 +191,7 @@ public class LeastSquaresBuilder {
* Configure the weight matrix. * Configure the weight matrix.
* *
* @param newWeight the weight matrix * @param newWeight the weight matrix
* @return this * @return {@code this} instance.
*/ */
public LeastSquaresBuilder weight(final RealMatrix newWeight) { public LeastSquaresBuilder weight(final RealMatrix newWeight) {
this.weight = newWeight; this.weight = newWeight;