ToDoubleFunction1 (core 3.0.0 API)

Type Parameters:

T1 - the type of the input to the function

All Superinterfaces:

Arity, FunctionN<java.lang.Double>, InputChainable<T1>, InputChainableInput<T1>, ResultChainable<java.lang.Double>, ResultChainableResult<java.lang.Double>, ToDoubleFunctionN, UnboxedResult<Function1<T1,java.lang.Double>>, Variant<java.util.function.ToDoubleFunction<T1>>

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 ToDoubleFunction1<T1>
extends ToDoubleFunctionN, InputChainableInput<T1>, UnboxedResult<Function1<T1,java.lang.Double>>, Variant<java.util.function.ToDoubleFunction<T1>>
```
Represents a function that accepts one argument and produces a double-valued result. This is the one-arity specialization of ToDoubleFunctionN. This is the double-producing primitive specialization of Function1.
This is a functional interface whose functional method is applyAsDouble(Object).

Since:

3.0.0

See Also:

Function1, 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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default <V> Function1<T1,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> Function1<T1,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)` Applies this function to the given argument.
`default int`	`arity()` Returns the number of arguments of the function.
`default Function1<T1,java.lang.Double>`	`boxResult()` Returns the boxed version of this object with a boxed result.
`default <V> ToDoubleFunction1<V>`	`compose(Function1<? super V,? extends T1> before)` Returns a chained object that applies the `before` function to its input, and then applies this chainable object to the result.
`default <V> ToDoubleFunction1<V>`	`composeUnchecked(Function1<? super V,? extends T1> before)` Returns a chained object that applies the `before` function to its input, and then applies this chainable object to the result.
`static <T1> ToDoubleFunction1<T1>`	`fromVariant(java.util.function.ToDoubleFunction<T1> function)` Creates an instance of this object from its `ToDoubleFunction` variant.
`default java.util.function.ToDoubleFunction<T1>`	`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)
```
    Applies this function to the given argument.
    
    Parameters:
    
    t1 - the 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> ToDoubleFunction1<T1> fromVariant(java.util.function.ToDoubleFunction<T1> function)
```
    Creates an instance of this object from its ToDoubleFunction variant.
    
    Type Parameters:
    
    T1 - the type of the input to the function
    
    Parameters:
    
    function - the variant of this object
    
    Returns:
    
    an instance of this object
    
    See Also:
    
    ToDoubleFunction
  - toVariant
```
default java.util.function.ToDoubleFunction<T1> toVariant()
```
    Description copied from interface: Variant
    
    Returns the variant of this object.
    
    Specified by:
    
    toVariant in interface Variant<java.util.function.ToDoubleFunction<T1>>
    
    Returns:
    
    the variant of this object
  - boxResult
```
default Function1<T1,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<Function1<T1,java.lang.Double>>
    
    Returns:
    
    the boxed version of this object with a boxed result
    
    See Also:
    
    Function1
  - compose
```
default <V> ToDoubleFunction1<V> compose(Function1<? super V,? extends T1> before)
```
    Description copied from interface: InputChainable
    
    Returns a chained object that applies the before function to its input, and then applies this chainable object to the result. If evaluation of either throws an exception, it is relayed to the caller of the chained object.
    
    Specified by:
    
    compose in interface InputChainable<T1>
    
    Specified by:
    
    compose in interface InputChainableInput<T1>
    
    Type Parameters:
    
    V - the type of the input to the before function, and to then chained object
    
    Parameters:
    
    before - the function to apply before this chainable object is applied
    
    Returns:
    
    a chained object that first applies the before function and then applies this chainable object
  - composeUnchecked
```
default <V> ToDoubleFunction1<V> composeUnchecked(Function1<? super V,? extends T1> before)
```
    Description copied from interface: InputChainable
    
    Returns a chained object that applies the before function to its input, and then applies this chainable object to the 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:
    
    composeUnchecked in interface InputChainable<T1>
    
    Specified by:
    
    composeUnchecked in interface InputChainableInput<T1>
    
    Type Parameters:
    
    V - the type of the input to the before function, and to then chained object
    
    Parameters:
    
    before - the function to apply before this chainable object is applied
    
    Returns:
    
    a chained object that first applies the before function and then applies this chainable object
  - andThen
```
default <V> Function1<T1,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:
    
    Function1
  - andThenUnchecked
```
default <V> Function1<T1,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:
    
    Function1

Interface ToDoubleFunction1<T1>

Nested Class Summary

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

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

Method Summary

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

Methods inherited from interface net.ashwork.functionality.FunctionN

Method Detail

applyAsDouble

applyAllAsDoubleUnchecked

arity

fromVariant

toVariant

boxResult

compose

composeUnchecked

andThen

andThenUnchecked