net.ashwork.functionality.primitive.doubles

Interface ToDoubleFunction2<T1,T2>

Type Parameters:

T1 - the type of the input to the function

T2 - the type of the second argument to the function

All Superinterfaces:

Arity, FunctionN<java.lang.Double>, ResultChainable<java.lang.Double>, ResultChainableResult<java.lang.Double>, ToDoubleFunctionN, UnboxedResult<Function2<T1,T2,java.lang.Double>>, Variant<java.util.function.ToDoubleBiFunction<T1,T2>>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ToDoubleFunction2<T1,T2>
extends ToDoubleFunctionN, UnboxedResult<Function2<T1,T2,java.lang.Double>>, Variant<java.util.function.ToDoubleBiFunction<T1,T2>>

Represents a function that accepts two arguments and produces a double-valued result. This is the two-arity specialization of ToDoubleFunctionN. This is the double-producing primitive specialization of Function2.

This is a functional interface whose functional method is applyAsDouble(Object, Object).

Since:

3.0.0

See Also:

Function2, ToDoubleFunctionN

Nested Class Summary

Nested classes/interfaces inherited from interface net.ashwork.functionality.primitive.doubles.ToDoubleFunctionN

ToDoubleFunctionN.Instance

Nested classes/interfaces inherited from interface net.ashwork.functionality.FunctionN

FunctionN.FunctionSizeException

Method Summary

Modifier and Type	Method and Description
default <V> Function2<T1,T2,V>	andThen(Function1<? super java.lang.Double,? extends V> after) Returns a chained object that applies this chainable object, and then applies the after function to ths result.
default <V> Function2<T1,T2,V>	andThenUnchecked(Function1<? super java.lang.Double,? extends V> after) Returns a chained object that applies this chainable object, and then applies the after function to ths result.
default double	applyAllAsDoubleUnchecked(java.lang.Object... args) Applies this function to the given arguments.
double	applyAsDouble(T1 t1, T2 t2) Applies this function to the given arguments.
default int	arity() Returns the number of arguments of the function.
default Function2<T1,T2,java.lang.Double>	boxResult() Returns the boxed version of this object with a boxed result.
static <T1,T2> ToDoubleFunction2<T1,T2>	fromVariant(java.util.function.ToDoubleBiFunction<T1,T2> function) Creates an instance of this object from its ToDoubleBiFunction variant.
default java.util.function.ToDoubleBiFunction<T1,T2>	toVariant() Returns the variant of this object.

Methods inherited from interface net.ashwork.functionality.primitive.doubles.ToDoubleFunctionN

applyAllUnchecked

Methods inherited from interface net.ashwork.functionality.FunctionN

checkSize, checkSize, sizedApplyAllUnchecked

Method Detail

applyAsDouble

double applyAsDouble(T1 t1,
                     T2 t2)

Applies this function to the given arguments.

Parameters:

t1 - the first function argument

t2 - the second function argument

Returns:

the function result

applyAllAsDoubleUnchecked

default double applyAllAsDoubleUnchecked(java.lang.Object... args)

Description copied from interface: ToDoubleFunctionN

Applies this function to the given arguments. Makes no assumptions of the arguments passed in and whether a value will compute successfully.

Specified by:

applyAllAsDoubleUnchecked in interface ToDoubleFunctionN

Parameters:

args - the function arguments

Returns:

the function result

arity

default int arity()

Description copied from interface: FunctionN

Returns the number of arguments of the function. If used as a functional interface with a non-specific number of arguments, this will return -1.

Specified by:

arity in interface Arity

Specified by:

arity in interface FunctionN<java.lang.Double>

Returns:

the number of arguments of the function

fromVariant

static <T1,T2> ToDoubleFunction2<T1,T2> fromVariant(java.util.function.ToDoubleBiFunction<T1,T2> function)

Creates an instance of this object from its ToDoubleBiFunction variant.

Type Parameters:

T1 - the type of the input to the function

T2 - the type of the second argument to the function

Parameters:

function - the variant of this object

Returns:

an instance of this object

See Also:

ToDoubleBiFunction

toVariant

default java.util.function.ToDoubleBiFunction<T1,T2> toVariant()

Description copied from interface: Variant

Returns the variant of this object.

Specified by:

toVariant in interface Variant<java.util.function.ToDoubleBiFunction<T1,T2>>

Returns:

the variant of this object

boxResult

default Function2<T1,T2,java.lang.Double> boxResult()

Description copied from interface: UnboxedResult

Returns the boxed version of this object with a boxed result.

Specified by:

boxResult in interface UnboxedResult<Function2<T1,T2,java.lang.Double>>

Returns:

the boxed version of this object with a boxed result

See Also:

Function2

andThen

default <V> Function2<T1,T2,V> andThen(Function1<? super java.lang.Double,? extends V> after)

Description copied from interface: ResultChainable

Returns a chained object that applies this chainable object, and then applies the after function to ths result. If evaluation of either throws an exception, it is relayed to the caller of the chained object.

Specified by:

andThen in interface FunctionN<java.lang.Double>

Specified by:

andThen in interface ResultChainable<java.lang.Double>

Specified by:

andThen in interface ResultChainableResult<java.lang.Double>

Type Parameters:

V - the type of the output of the after function, and of the chained object

Parameters:

after - the function to apply after this chainable object is applied

Returns:

a chained object that applies this chainable object and then applies the after function

See Also:

Function2

andThenUnchecked

default <V> Function2<T1,T2,V> andThenUnchecked(Function1<? super java.lang.Double,? extends V> after)

Description copied from interface: ResultChainable

Returns a chained object that applies this chainable object, and then applies the after function to ths result. If evaluation of either throws an exception, it is relayed to the caller of the chained object. This makes no assumptions on the arguments of this method.

Specified by:

andThenUnchecked in interface FunctionN<java.lang.Double>

Specified by:

andThenUnchecked in interface ResultChainable<java.lang.Double>

Specified by:

andThenUnchecked in interface ResultChainableResult<java.lang.Double>

Type Parameters:

V - the type of the output of the after function, and of the chained object

Parameters:

after - the function to apply after this chainable object is applied

Returns:

a chained object that applies this chainable object and then applies the after function

See Also:

Function2