src/main/java/org/apache/commons/math3/fitting/leastsquares/package-info.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * This package provides algorithms that minimize the residuals
 * between observations and model values.
 * The {@link org.apache.commons.math3.fitting.leastsquares.LeastSquaresOptimizer
 * least-squares optimizers} minimize the distance (called
 * <em>cost</em> or <em>&chi;<sup>2</sup></em>) between model and
 * observations.
 *
 * <br/>
 * Algorithms in this category need access to a <em>problem</em>
 * (represented by a {@link org.apache.commons.math3.fitting.leastsquares.LeastSquaresProblem
 * LeastSquaresProblem}).
 * Such a model predicts a set of values which the algorithm tries to match
 * with a set of given set of observed values.
 * <br/>
 * The problem can be created progressively using a {@link
 * org.apache.commons.math3.fitting.leastsquares.LeastSquaresBuilder builder} or it can
 * be created at once using a {@link org.apache.commons.math3.fitting.leastsquares.LeastSquaresFactory
 * factory}.
 * @since 3.3
 */
package org.apache.commons.math3.fitting.leastsquares;