org.orekit.utils.ParameterFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of orekit Show documentation

OREKIT (ORbits Extrapolation KIT) is a low level space dynamics library. It provides basic elements (orbits, dates, attitude, frames ...) and various algorithms to handle them (conversions, analytical and numerical propagation, pointing ...).

There is a newer version: 12.2

Show newest version

/* Copyright 2002-2018 CS Systèmes d'Information
 * Licensed to CS Systèmes d'Information (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS 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
 *
 *   http://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.orekit.utils;

import org.orekit.errors.OrekitException;

/** Interface representing a scalar function depending on a {@link ParameterDriver}.
 * @see Differentiation#differentiate(ParameterFunction, ParameterDriver, int, double)
 * @author Luc Maisonobe
 * @since 8.0
 */
public interface ParameterFunction {

    /** Evaluate the function.
     * @param parameterDriver driver for the parameter.
     * @return scalar value of the function
     * @throws OrekitException if evaluation cannot be performed
     */
    double value(ParameterDriver parameterDriver) throws OrekitException;

}