View Javadoc
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.filtering.kalman.unscented;
18  
19  import org.hipparchus.linear.RealVector;
20  
21  /**
22   * Container for {@link UnscentedProcess unscented process} evolution data.
23   * @see UnscentedProcess
24   * @since 2.2
25   */
26  public class UnscentedEvolution {
27  
28      /** Current time. */
29      private final double currentTime;
30  
31      /** State vectors at current time. */
32      private final RealVector[] currentStates;
33  
34      /**
35       * Constructor.
36       * @param currentTime current time
37       * @param currentStates state vectors at current time
38       */
39      public UnscentedEvolution(final double currentTime, final RealVector[] currentStates) {
40          this.currentTime         = currentTime;
41          this.currentStates       = currentStates.clone();
42      }
43  
44      /** Get current time.
45       * @return current time
46       */
47      public double getCurrentTime() {
48          return currentTime;
49      }
50  
51      /** Get current states.
52       * @return current states
53       */
54      public RealVector[] getCurrentStates() {
55          return currentStates.clone();
56      }
57  
58  }