math.fun.DBiFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of math-base Show documentation

Elementary math utilities with a focus on random number generation, non-linear optimization, interpolation and solvers

The newest version!

/*
 * Copyright 2020 Stefan Zobel
 *
 * Licensed 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 math.fun;

/**
 * Represents a function that accepts two arguments and produces a result. This
 * is the two-arity specialization of {@link DFunction}.
 */
public interface DBiFunction {
    /**
     * Applies this function to the given arguments.
     *
     * @param x1
     *            the first function argument
     * @param x2
     *            the second function argument
     * @return the function result
     */
    double apply(double x1, double x2);
}