DoubleBinaryOperator.java revision 4b92e5b21380a5344e5808b17ddffb994f855288 
1/*
2 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package java.util.function;
26
27/**
28 * Represents an operation upon two {@code double}-valued operands and producing a
29 * {@code double}-valued result.   This is the primitive type specialization of
30 * {@link BinaryOperator} for {@code double}.
31 *
32 * <p>This is a <a href="package-summary.html">functional interface</a>
33 * whose functional method is {@link #applyAsDouble(double, double)}.
34 *
35 * @see BinaryOperator
36 * @see DoubleUnaryOperator
37 * @since 1.8
38 */
39@FunctionalInterface
40public interface DoubleBinaryOperator {
41    /**
42     * Applies this operator to the given operands.
43     *
44     * @param left the first operand
45     * @param right the second operand
46     * @return the operator result
47     */
48    double applyAsDouble(double left, double right);
49}
50