Fixed wrong position of package description.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1420705 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gilles Sadowski 2012-12-12 14:35:37 +00:00
parent 5968be0da0
commit 4a007942c4
9 changed files with 24 additions and 14 deletions

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.linear;
/** /**
* Optimization algorithms for linear constrained problems. * Optimization algorithms for linear constrained problems.
*/ */
package org.apache.commons.math3.optim.linear;

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.nonlinear.scalar.gradient;
/** /**
* This package provides optimization algorithms that require derivatives. * This package provides optimization algorithms that require derivatives.
*/ */
package org.apache.commons.math3.optim.nonlinear.scalar.gradient;

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.nonlinear.scalar.noderiv;
/** /**
* This package provides optimization algorithms that do not require derivatives. * This package provides optimization algorithms that do not require derivatives.
*/ */
package org.apache.commons.math3.optim.nonlinear.scalar.noderiv;

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.nonlinear.scalar;
/** /**
* Algorithms for optimizing a scalar function. * Algorithms for optimizing a scalar function.
*/ */
package org.apache.commons.math3.optim.nonlinear.scalar;

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.nonlinear.vector.jacobian;
/** /**
* This package provides optimization algorithms that require derivatives. * This package provides optimization algorithms that require derivatives.
*/ */
package org.apache.commons.math3.optim.nonlinear.vector.jacobian;

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.nonlinear.vector;
/** /**
* Algorithms for optimizing a vector function. * Algorithms for optimizing a vector function.
*/ */
package org.apache.commons.math3.optim.nonlinear.vector;

View File

@ -14,13 +14,14 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim;
/** /**
* <p> * <p>
* Generally, optimizers are algorithms that will either * Generally, optimizers are algorithms that will either
* {@link GoalType#MINIMIZE minimize} or {@link GoalType#MAXIMIZE maximize} * {@link org.apache.commons.math3.optim.GoalType#MINIMIZE minimize} or
* a scalar function, called the {@link ObjectiveFunction <em>objective * {@link org.apache.commons.math3.optim.GoalType#MAXIMIZE maximize}
* a scalar function, called the
* {@link org.apache.commons.math3.optim.ObjectiveFunction <em>objective
* function</em>}. * function</em>}.
* <br/> * <br/>
* For some scalar objective functions the gradient can be computed (analytically * For some scalar objective functions the gradient can be computed (analytically
@ -57,10 +58,12 @@ package org.apache.commons.math3.optim;
* *
* <p> * <p>
* This package provides common functionality for the optimization algorithms. * This package provides common functionality for the optimization algorithms.
* Abstract classes ({@link BaseOptimizer} and {@link BaseMultivariateOptimizer}) * Abstract classes ({@link org.apache.commons.math3.optim.BaseOptimizer} and
* define boiler-plate code for storing {@link MaxEval evaluations} and * {@link org.apache.commons.math3.optim.BaseMultivariateOptimizer}) contain
* {@link MaxIter iterations} counters and a user-defined * boiler-plate code for storing {@link org.apache.commons.math3.optim.MaxEval
* {@link ConvergenceChecker convergence checker}. * evaluations} and {@link org.apache.commons.math3.optim.MaxIter iterations}
* counters and a user-defined
* {@link org.apache.commons.math3.optim.ConvergenceChecker convergence checker}.
* </p> * </p>
* *
* <p> * <p>
@ -71,3 +74,4 @@ package org.apache.commons.math3.optim;
* This could be useful to avoid being trapped in a local extremum. * This could be useful to avoid being trapped in a local extremum.
* </p> * </p>
*/ */
package org.apache.commons.math3.optim;

View File

@ -14,8 +14,8 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.apache.commons.math3.optim.univariate;
/** /**
* One-dimensional optimization algorithms. * One-dimensional optimization algorithms.
*/ */
package org.apache.commons.math3.optim.univariate;

View File

@ -15,6 +15,12 @@
* limitations under the License. * limitations under the License.
*/ */
/** /**
* <h2>All classes and sub-packages of this package are deprecated.</h2>
* <h3>Please use their replacements, to be found under
* <ul>
* <li>{@link org.apache.commons.math3.optim}</li>
* <li>{@link org.apache.commons.math3.fitting}</li>
* </h3>
* *
* <p> * <p>
* This package provides common interfaces for the optimization algorithms * This package provides common interfaces for the optimization algorithms