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.ode.ODEStateAndDerivative;
21
22 /** This interface represents an event checking interval that depends on state.
23 *
24 * @see ODEEventDetector
25 * @since 3.0
26 *
27 */
28 @FunctionalInterface
29 public interface AdaptableInterval {
30
31 /**
32 * Get the current value of maximal time interval between events handler checks.
33 *
34 * @param state current state
35 * @param isForward true if propagation is forward in independent variable, false otherwise
36 * @return current value of maximal time interval between events handler checks
37 */
38 double currentInterval(ODEStateAndDerivative state, boolean isForward);
39
40 /**
41 * Create a constant interval from the input.
42 * @param maxCheck maximum check value
43 * @return constant interval
44 * @since 4.0
45 */
46 static AdaptableInterval of(final double maxCheck) {
47 return (state, isForward) -> maxCheck;
48 }
49 }