View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.math.estimation;
19  
20  /** 
21   * This interface represents an estimation problem.
22   *
23   * <p>This interface should be implemented by all real estimation
24   * problems before they can be handled by the estimators through the
25   * {@link Estimator#estimate Estimator.estimate} method.</p>
26   *
27   * <p>An estimation problem, as seen by a solver is a set of
28   * parameters and a set of measurements. The parameters are adjusted
29   * during the estimation through the {@link #getUnboundParameters
30   * getUnboundParameters} and {@link EstimatedParameter#setEstimate
31   * EstimatedParameter.setEstimate} methods. The measurements both have
32   * a measured value which is generally fixed at construction and a
33   * theoretical value which depends on the model and hence varies as
34   * the parameters are adjusted. The purpose of the solver is to reduce
35   * the residual between these values, it can retrieve the measurements
36   * through the {@link #getMeasurements getMeasurements} method.</p>
37   *
38   * @see Estimator
39   * @see WeightedMeasurement
40   *
41   * @version $Revision: 754732 $ $Date: 2009-03-15 15:30:44 -0400 (Sun, 15 Mar 2009) $
42   * @since 1.2
43   * @deprecated as of 2.0, everything in package org.apache.commons.math.estimation has
44   * been deprecated and replaced by package org.apache.commons.math.optimization.general
45   *
46   */
47  @Deprecated
48  public interface EstimationProblem {
49    /** 
50     * Get the measurements of an estimation problem.
51     * @return measurements
52     */
53    public WeightedMeasurement[] getMeasurements();
54  
55    /** 
56     * Get the unbound parameters of the problem.
57     * @return unbound parameters
58     */
59    public EstimatedParameter[] getUnboundParameters();
60  
61    /** 
62     * Get all the parameters of the problem.
63     * @return parameters
64     */
65    public EstimatedParameter[] getAllParameters();
66  
67  }