/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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.apache.beam.sdk.extensions.euphoria.core.client.functional;

import java.io.Serializable;
import org.apache.beam.sdk.extensions.euphoria.core.annotation.audience.Audience;

/**
 * Function of two arguments.
 *
 * @param <LeftT> the type of the left operand
 * @param <RightT> the type of the right operand
 * @param <OutputT> the type of the result of the function application
 */
@Audience(Audience.Type.CLIENT)
@FunctionalInterface
public interface BinaryFunction<LeftT, RightT, OutputT> extends Serializable {

  /**
   * Applies this function to the given arguments.
   *
   * @param left the "left" parameter of the operation
   * @param right the "right" parameter of the operation
   * @return the result of applying "left" and "right" to an operation
   */
  OutputT apply(LeftT left, RightT right);
}
