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.ode;
18
19 import java.io.Serializable;
20
21 /** Simple container pairing a parameter name with a step in order to compute
22 * the associated Jacobian matrix by finite difference.
23 *
24 * @since 3.0
25 */
26 class ParameterConfiguration implements Serializable {
27
28 /** Serializable UID. */
29 private static final long serialVersionUID = 2247518849090889379L;
30
31 /** Parameter name. */
32 private String parameterName;
33
34 /** Parameter step for finite difference computation. */
35 private double hP;
36
37 /** Parameter name and step pair constructor.
38 * @param parameterName parameter name
39 * @param hP parameter step
40 */
41 ParameterConfiguration(final String parameterName, final double hP) {
42 this.parameterName = parameterName;
43 this.hP = hP;
44 }
45
46 /** Get parameter name.
47 * @return parameterName parameter name
48 */
49 public String getParameterName() {
50 return parameterName;
51 }
52
53 /** Get parameter step.
54 * @return hP parameter step
55 */
56 public double getHP() {
57 return hP;
58 }
59
60 /** Set parameter step.
61 * @param hParam parameter step
62 */
63 public void setHP(final double hParam) {
64 this.hP = hParam;
65 }
66 }