1   /* Copyright 2013-2017 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS 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.orekit.rugged.utils;
18  
19  import java.util.List;
20  
21  import org.hipparchus.analysis.differentiation.DerivativeStructure;
22  import org.orekit.utils.ParameterDriver;
23  
24  /** Generator for {@link DerivativeStructure} instances from {@link ParameterDriver}.
25   * <p>
26   * Note that this interface is for Rugged library internal use only.
27   * </p>
28   * @author Luc Maisonobe
29   * @since 2.0
30   */
31  public interface DSGenerator {
32  
33      /** Get the parameters selected for estimation.
34       * @return parameters selected for estimation
35       */
36      List<ParameterDriver> getSelected();
37  
38      /** Generate a constant {@link DerivativeStructure}.
39       * @param value value of the constant
40       * @return constant {@link DerivativeStructure}
41       */
42      DerivativeStructure constant(double value);
43  
44      /** Generate a {@link DerivativeStructure} representing the
45       * parameter driver either as a canonical variable or a constant.
46       * <p>
47       * The instance created is a variable only if the parameter
48       * has been selected for estimation, otherwise it is a constant.
49       * </p>
50       * @param driver driver for the variable
51       * @return variable {@link DerivativeStructure}
52       */
53      DerivativeStructure variable(ParameterDriver driver);
54  
55  }