net.openhft.koloboke.function.FloatObjFunction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of koloboke-api-jdk8 Show documentation

Carefully designed and efficient extension of the Java Collections Framework with primitive specializations and more, built for Java 8 (API)

The newest version!

/*
 * Copyright 2014 the original author or authors.
 *
 * 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 net.openhft.koloboke.function;

/**
 * Represents a function that accepts a {@code float}-valued and an object-valued argument
 * and returns a result. This is the {@code (float, reference, reference)} specialization
 * of {@link BiFunction}.
 *
 * @param  the type of the first argument to the function
 * @param  the type of the result of the function
 * @see BiFunction
 */
@FunctionalInterface
public interface FloatObjFunction {

    /**
     * Applies this function to the given arguments.
     *
     * @param v the first function argument
     * @param t the second function argument
     * @return the function result
     */
    R apply(float v, T t);
}