Target.java

  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.math3.optim.nonlinear.vector;

  18. import org.apache.commons.math3.optim.OptimizationData;

  19. /**
  20.  * Target of the optimization procedure.
  21.  * They are the values which the objective vector function must reproduce
  22.  * When the parameters of the model have been optimized.
  23.  * <br/>
  24.  * Immutable class.
  25.  *
  26.  * @since 3.1
  27.  * @deprecated All classes and interfaces in this package are deprecated.
  28.  * The optimizers that were provided here were moved to the
  29.  * {@link org.apache.commons.math3.fitting.leastsquares} package
  30.  * (cf. MATH-1008).
  31.  */
  32. @Deprecated
  33. public class Target implements OptimizationData {
  34.     /** Target values (of the objective vector function). */
  35.     private final double[] target;

  36.     /**
  37.      * @param observations Target values.
  38.      */
  39.     public Target(double[] observations) {
  40.         target = observations.clone();
  41.     }

  42.     /**
  43.      * Gets the initial guess.
  44.      *
  45.      * @return the initial guess.
  46.      */
  47.     public double[] getTarget() {
  48.         return target.clone();
  49.     }
  50. }