1 /*
2 * Licensed to the Hipparchus project 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 Hipparchus project 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 * https://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.hipparchus.ode;
18
19 /** Simple container pairing a parameter name with a step in order to compute
20 * the associated Jacobian matrix by finite difference.
21 * <p>
22 * Instances of this class are guaranteed to be immutable.
23 * </p>
24 */
25 public class ParameterConfiguration {
26
27 /** Parameter name. */
28 private final String parameterName;
29
30 /** Parameter step for finite difference computation. */
31 private final double hP;
32
33 /** Parameter name and step pair constructor.
34 * @param parameterName parameter name
35 * @param hP parameter step
36 */
37 ParameterConfiguration(final String parameterName, final double hP) {
38 this.parameterName = parameterName;
39 this.hP = hP;
40 }
41
42 /** Get parameter name.
43 * @return parameterName parameter name
44 */
45 public String getParameterName() {
46 return parameterName;
47 }
48
49 /** Get parameter step.
50 * @return hP parameter step
51 */
52 public double getHP() {
53 return hP;
54 }
55
56 }