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  package org.apache.commons.math4.legacy.fitting.leastsquares;
18  
19  import org.apache.commons.math4.legacy.linear.RealVector;
20  import org.apache.commons.math4.legacy.optim.ConvergenceChecker;
21  import org.apache.commons.math4.legacy.core.IntegerSequence;
22  
23  /**
24   * An adapter that delegates to another implementation of {@link LeastSquaresProblem}.
25   *
26   * @since 3.3
27   */
28  public class LeastSquaresAdapter implements LeastSquaresProblem {
29  
30      /** the delegate problem. */
31      private final LeastSquaresProblem problem;
32  
33      /**
34       * Delegate the {@link LeastSquaresProblem} interface to the given implementation.
35       *
36       * @param problem the delegate
37       */
38      public LeastSquaresAdapter(final LeastSquaresProblem problem) {
39          this.problem = problem;
40      }
41  
42      /** {@inheritDoc} */
43      @Override
44      public RealVector getStart() {
45          return problem.getStart();
46      }
47  
48      /** {@inheritDoc} */
49      @Override
50      public int getObservationSize() {
51          return problem.getObservationSize();
52      }
53  
54      /** {@inheritDoc} */
55      @Override
56      public int getParameterSize() {
57          return problem.getParameterSize();
58      }
59  
60      /** {@inheritDoc}
61       */
62      @Override
63      public Evaluation evaluate(final RealVector point) {
64          return problem.evaluate(point);
65      }
66  
67      /** {@inheritDoc} */
68      @Override
69      public IntegerSequence.Incrementor getEvaluationCounter() {
70          return problem.getEvaluationCounter();
71      }
72  
73      /** {@inheritDoc} */
74      @Override
75      public IntegerSequence.Incrementor getIterationCounter() {
76          return problem.getIterationCounter();
77      }
78  
79      /** {@inheritDoc} */
80      @Override
81      public ConvergenceChecker<Evaluation> getConvergenceChecker() {
82          return problem.getConvergenceChecker();
83      }
84  }