FieldAdaptableInterval.java

/*
 * Licensed to the Hipparchus project under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The Hipparchus project licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.hipparchus.ode.events;

import org.hipparchus.CalculusFieldElement;
import org.hipparchus.ode.FieldODEStateAndDerivative;

/** This interface represents an event checking interval that depends on state.
*
* @see ODEEventDetector
* @since 3.0
* @param <T> the type of the field elements
*/
@FunctionalInterface
public interface FieldAdaptableInterval<T extends CalculusFieldElement<T>> {

    /**
     * Get the current value of maximal time interval between events handler checks.
     *
     * @param state     current state
     * @param isForward true if propagation is forward in independent variable, false otherwise
     * @return current value of maximal time interval between events handler checks (only as a double)
     */
    double currentInterval(FieldODEStateAndDerivative<T> state, boolean isForward);

    /**
     * Create a constant interval from the input.
     * @param <W> field type
     * @param maxCheck maximum check value
     * @return constant interval
     * @since 4.0
     */
    static <W extends CalculusFieldElement<W>> FieldAdaptableInterval<W> of(final double maxCheck) {
        return (state, isForward) -> maxCheck;
    }
}