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  
18  package org.hipparchus.ode.events;
19  
20  import org.hipparchus.CalculusFieldElement;
21  import org.hipparchus.ode.FieldODEStateAndDerivative;
22  
23  /** This interface represents an event checking interval that depends on state.
24  *
25  * @see ODEEventDetector
26  * @since 3.0
27  * @param <T> the type of the field elements
28  */
29  @FunctionalInterface
30  public interface FieldAdaptableInterval<T extends CalculusFieldElement<T>> {
31  
32      /** Get the current value of maximal time interval between events handler checks.
33       * @param state current state
34       * @return current value of maximal time interval between events handler checks (only as a double)
35       */
36      double currentInterval(FieldODEStateAndDerivative<T> state);
37  
38  }