eu.lunisolar.magma.func.function.to.LToLongFunction Maven / Gradle / Ivy
/*
* This file is part of "lunisolar-magma".
*
* (C) Copyright 2014-2019 Lunisolar (http://lunisolar.eu/).
*
* 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 eu.lunisolar.magma.func.function.to;
import javax.annotation.Nonnull; // NOSONAR
import javax.annotation.Nullable; // NOSONAR
import java.util.Comparator; // NOSONAR
import java.util.Objects; // NOSONAR
import eu.lunisolar.magma.basics.*; //NOSONAR
import eu.lunisolar.magma.basics.builder.*; // NOSONAR
import eu.lunisolar.magma.basics.exceptions.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.aType.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.type.*; // NOSONAR
import eu.lunisolar.magma.basics.meta.functional.domain.*; // NOSONAR
import eu.lunisolar.magma.func.IA;
import eu.lunisolar.magma.func.SA;
import eu.lunisolar.magma.func.*; // NOSONAR
import eu.lunisolar.magma.func.tuple.*; // NOSONAR
import java.util.function.*; // NOSONAR
import java.util.*; // NOSONAR
import java.lang.reflect.*;
import eu.lunisolar.magma.func.action.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.bi.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.obj.*; // NOSONAR
import eu.lunisolar.magma.func.consumer.primitives.tri.*; // NOSONAR
import eu.lunisolar.magma.func.function.*; // NOSONAR
import eu.lunisolar.magma.func.function.conversion.*; // NOSONAR
import eu.lunisolar.magma.func.function.from.*; // NOSONAR
import eu.lunisolar.magma.func.function.to.*; // NOSONAR
import eu.lunisolar.magma.func.operator.binary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.ternary.*; // NOSONAR
import eu.lunisolar.magma.func.operator.unary.*; // NOSONAR
import eu.lunisolar.magma.func.predicate.*; // NOSONAR
import eu.lunisolar.magma.func.supplier.*; // NOSONAR
/**
* Non-throwing functional interface (lambda) LToLongFunction for Java 8.
*
* Type: function
*
* Domain (lvl: 1): T a
*
* Co-domain: long
*
* Special case of function that corresponds to expressions like (iterator) -> Iterator::next
*
*/
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LToLongFunction extends ToLongFunction, MetaFunction, MetaInterface.NonThrowing, OFunction, Codomain, Domain1> { // NOSONAR
String DESCRIPTION = "LToLongFunction: long applyAsLong(T a)";
// long applyAsLong(T a) ;
default long applyAsLong(T a) {
// return nestingApplyAsLong(a);
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.nestCheckedAndThrow(e);
}
}
/**
* Implement this, but call applyAsLong(T a)
*/
long applyAsLongX(T a) throws Throwable;
default long tupleApplyAsLong(LSingle args) {
return applyAsLong(args.value());
}
/** Function call that handles exceptions according to the instructions. */
default long handlingApplyAsLong(T a, HandlingInstructions handling) {
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
throw Handler.handleOrNest(e, handling);
}
}
default LToLongFunction handling(HandlingInstructions handling) {
return a -> handlingApplyAsLong(a, handling);
}
default long applyAsLong(T a, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF, newMessage, messageParams);
}
}
default LToLongFunction trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
return a -> applyAsLong(a, exF, newMessage, messageParams);
}
default long applyAsLong(T a, @Nonnull ExWF exF) {
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.wrap(e, exF);
}
}
default LToLongFunction trying(@Nonnull ExWF exF) {
return a -> applyAsLong(a, exF);
}
default long applyAsLongThen(T a, @Nonnull LToLongFunction handler) {
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
return handler.applyAsLong(e);
}
}
default LToLongFunction tryingThen(@Nonnull LToLongFunction handler) {
return a -> applyAsLongThen(a, handler);
}
/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
default long nestingApplyAsLong(T a) {
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.nestCheckedAndThrow(e);
}
}
/** Function call that handles exceptions by always propagating them as is, even when they are undeclared checked ones. */
default long shovingApplyAsLong(T a) {
try {
return this.applyAsLongX(a);
} catch (Throwable e) { // NOSONAR
throw Handling.shoveIt(e);
}
}
static long handlingApplyAsLong(T a, LToLongFunction func, HandlingInstructions handling) { // <-
Null.nonNullArg(func, "func");
return func.handlingApplyAsLong(a, handling);
}
static long tryApplyAsLong(T a, LToLongFunction func) {
Null.nonNullArg(func, "func");
return func.nestingApplyAsLong(a);
}
static long tryApplyAsLong(T a, LToLongFunction func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
Null.nonNullArg(func, "func");
return func.applyAsLong(a, exF, newMessage, messageParams);
}
static long tryApplyAsLong(T a, LToLongFunction func, @Nonnull ExWF exF) {
Null.nonNullArg(func, "func");
return func.applyAsLong(a, exF);
}
static long tryApplyAsLongThen(T a, LToLongFunction func, @Nonnull LToLongFunction handler) {
Null.nonNullArg(func, "func");
return func.applyAsLongThen(a, handler);
}
default long failSafeApplyAsLong(T a, @Nonnull LToLongFunction failSafe) {
try {
return applyAsLong(a);
} catch (Throwable e) { // NOSONAR
Handling.handleErrors(e);
return failSafe.applyAsLong(a);
}
}
static long failSafeApplyAsLong(T a, LToLongFunction func, @Nonnull LToLongFunction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
if (func == null) {
return failSafe.applyAsLong(a);
} else {
return func.failSafeApplyAsLong(a, failSafe);
}
}
static LToLongFunction failSafe(LToLongFunction func, @Nonnull LToLongFunction failSafe) {
Null.nonNullArg(failSafe, "failSafe");
return a -> failSafeApplyAsLong(a, func, failSafe);
}
/** Just to mirror the method: Ensures the result is not null */
default long nonNullApplyAsLong(T a) {
return applyAsLong(a);
}
/** Returns description of the functional interface. */
@Nonnull
default String functionalInterfaceDescription() {
return LToLongFunction.DESCRIPTION;
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTo(int min_i, int max_i, T a, LToLongFunction func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i <= max_i; i++) {
func.applyAsLong(a);
}
} else {
for (int i = min_i; i >= max_i; i--) {
func.applyAsLong(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void fromTill(int min_i, int max_i, T a, LToLongFunction func) {
Null.nonNullArg(func, "func");
if (min_i <= max_i) {
for (int i = min_i; i < max_i; i++) {
func.applyAsLong(a);
}
} else {
for (int i = min_i; i > max_i; i--) {
func.applyAsLong(a);
}
}
}
/** From-To. Intended to be used with non-capturing lambda. */
public static void times(int max_i, T a, LToLongFunction func) {
if (max_i < 0)
return;
fromTill(0, max_i, a, func);
}
/** Cast that removes generics. */
public default LToLongFunction untyped() {
return this;
}
/** Cast that replace generics. */
public default LToLongFunction cast() {
return untyped();
}
/** Cast that replace generics. */
public static LToLongFunction cast(LToLongFunction function) {
return (LToLongFunction) function;
}
/** Captures arguments but delays the evaluation. */
default LLongSupplier capture(T a) {
return () -> this.applyAsLong(a);
}
/** Creates function that always returns the same value. */
static LToLongFunction constant(long r) {
return a -> r;
}
/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
@Nonnull
static LToLongFunction toLongFunc(final @Nonnull LToLongFunction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda;
}
@Nonnull
static LToLongFunction recursive(final @Nonnull LFunction, LToLongFunction> selfLambda) {
final LToLongFunctionSingle single = new LToLongFunctionSingle();
LToLongFunction func = selfLambda.apply(single);
single.target = func;
return func;
}
final class LToLongFunctionSingle implements LSingle>, LToLongFunction {
private LToLongFunction target = null;
@Override
public long applyAsLongX(T a) throws Throwable {
return target.applyAsLongX(a);
}
@Override
public LToLongFunction value() {
return target;
}
}
@Nonnull
static LToLongFunction toLongFuncThrowing(final @Nonnull ExF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce();
};
}
@Nonnull
static LToLongFunction toLongFuncThrowing(final String message, final @Nonnull ExMF exF) {
Null.nonNullArg(exF, "exF");
return a -> {
throw exF.produce(message);
};
}
static long call(T a, final @Nonnull LToLongFunction lambda) {
Null.nonNullArg(lambda, "lambda");
return lambda.applyAsLong(a);
}
//
/** Wraps JRE instance. */
@Nonnull
static LToLongFunction wrap(final ToLongFunction other) {
return other::applyAsLong;
}
//
//
/** Safe instance. That always returns the same value (as produceLong). */
@Nonnull
static LToLongFunction safe() {
return LToLongFunction::produceLong;
}
/** Safe instance supplier. Returns supplier of safe() instance. */
@Nonnull
static LSupplier> safeSupplier() {
return () -> safe();
}
/** Safe wrapping. Either argument function is returned (if it is not null) or safe() instance. */
@Nonnull
static LToLongFunction safe(final @Nullable LToLongFunction other) {
if (other == null) {
return safe();
} else {
return other;
}
}
/** Safe supplier. Either argument supplier is returned (if it is not null) or supplier of safe() instance. */
@Nonnull
static LSupplier> safeSupplier(final @Nullable LSupplier> supplier) {
if (supplier == null) {
return safeSupplier();
} else {
return supplier;
}
}
//
//
/** Allows to manipulate the domain of the function. */
@Nonnull
default LToLongFunction compose(@Nonnull final LFunction super V, ? extends T> before) {
Null.nonNullArg(before, "before");
return v -> this.applyAsLong(before.apply(v));
}
public static LToLongFunction composed(@Nonnull final LFunction super V, ? extends T> before, LToLongFunction after) {
return after.compose(before);
}
//
//
/** Combines two functions together in a order. */
@Nonnull
default LFunction then(@Nonnull LLongFunction extends V> after) {
Null.nonNullArg(after, "after");
return a -> after.apply(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToByteFunction thenToByte(@Nonnull LLongToByteFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsByte(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToSrtFunction thenToSrt(@Nonnull LLongToSrtFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsSrt(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToIntFunction thenToInt(@Nonnull LLongToIntFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsInt(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToLongFunction thenToLong(@Nonnull LLongUnaryOperator after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsLong(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToFltFunction thenToFlt(@Nonnull LLongToFltFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsFlt(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToDblFunction thenToDbl(@Nonnull LLongToDblFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsDbl(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LToCharFunction thenToChar(@Nonnull LLongToCharFunction after) {
Null.nonNullArg(after, "after");
return a -> after.applyAsChar(this.applyAsLong(a));
}
/** Combines two functions together in a order. */
@Nonnull
default LPredicate thenToBool(@Nonnull LLongPredicate after) {
Null.nonNullArg(after, "after");
return a -> after.test(this.applyAsLong(a));
}
//
//
//
/** Does nothing (LToLongFunction) Function */
public static long produceLong(T a) {
return Function4U.defaultLong;
}
/**
* For each element (or tuple) from arguments, calls the function and passes the result to consumer.
* Thread safety, fail-fast, fail-safety of this method is not expected.
*/
default void forEach(IndexedRead> ia, C0 source, LLongConsumer consumer) {
int size = ia.size(source);
LOiFunction