All Downloads are FREE. Search and download functionalities are using the official Maven repository.

eu.lunisolar.magma.func.function.to.LOiToDblFunction Maven / Gradle / Ivy

There is a newer version: 3.0.0
Show newest version
/*
 * 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) LOiToDblFunction for Java 8.
 *
 * Type: function
 *
 * Domain (lvl: 2): T a1,int a2
 *
 * Co-domain: double
 *
 * Special case of function that corresponds to expressions like (list, index) -> List::get
 *
 */
@FunctionalInterface
@SuppressWarnings("UnusedDeclaration")
public interface LOiToDblFunction extends MetaFunction, MetaInterface.NonThrowing, OiFunction, Codomain, Domain2, aInt> { // NOSONAR

	String DESCRIPTION = "LOiToDblFunction: double applyAsDbl(T a1,int a2)";

	// double applyAsDbl(T a1,int a2) ;
	default double applyAsDbl(T a1, int a2) {
		// return nestingApplyAsDbl(a1,a2);
		try {
			return this.applyAsDblX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.nestCheckedAndThrow(e);
		}
	}

	/**
	 * Implement this, but call applyAsDbl(T a1,int a2)
	 */
	double applyAsDblX(T a1, int a2) throws Throwable;

	default double tupleApplyAsDbl(LObjIntPair args) {
		return applyAsDbl(args.first(), args.second());
	}

	/** Function call that handles exceptions according to the instructions. */
	default double handlingApplyAsDbl(T a1, int a2, HandlingInstructions handling) {
		try {
			return this.applyAsDblX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handler.handleOrNest(e, handling);
		}
	}

	default LOiToDblFunction handling(HandlingInstructions handling) {
		return (a1, a2) -> handlingApplyAsDbl(a1, a2, handling);
	}

	default double applyAsDbl(T a1, int a2, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		try {
			return this.applyAsDblX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF, newMessage, messageParams);
		}
	}

	default LOiToDblFunction trying(@Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		return (a1, a2) -> applyAsDbl(a1, a2, exF, newMessage, messageParams);
	}

	default double applyAsDbl(T a1, int a2, @Nonnull ExWF exF) {
		try {
			return this.applyAsDblX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.wrap(e, exF);
		}
	}

	default LOiToDblFunction trying(@Nonnull ExWF exF) {
		return (a1, a2) -> applyAsDbl(a1, a2, exF);
	}

	default double applyAsDblThen(T a1, int a2, @Nonnull LToDblFunction handler) {
		try {
			return this.applyAsDblX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return handler.applyAsDbl(e);
		}
	}

	default LOiToDblFunction tryingThen(@Nonnull LToDblFunction handler) {
		return (a1, a2) -> applyAsDblThen(a1, a2, handler);
	}

	/** Function call that handles exceptions by always nesting checked exceptions and propagating the others as is. */
	default double nestingApplyAsDbl(T a1, int a2) {
		try {
			return this.applyAsDblX(a1, a2);
		} 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 double shovingApplyAsDbl(T a1, int a2) {
		try {
			return this.applyAsDblX(a1, a2);
		} catch (Throwable e) { // NOSONAR
			throw Handling.shoveIt(e);
		}
	}

	static  double handlingApplyAsDbl(T a1, int a2, LOiToDblFunction func, HandlingInstructions handling) { // <-
		Null.nonNullArg(func, "func");
		return func.handlingApplyAsDbl(a1, a2, handling);
	}

	static  double tryApplyAsDbl(T a1, int a2, LOiToDblFunction func) {
		Null.nonNullArg(func, "func");
		return func.nestingApplyAsDbl(a1, a2);
	}

	static  double tryApplyAsDbl(T a1, int a2, LOiToDblFunction func, @Nonnull ExWMF exF, @Nonnull String newMessage, @Nullable Object... messageParams) {
		Null.nonNullArg(func, "func");
		return func.applyAsDbl(a1, a2, exF, newMessage, messageParams);
	}

	static  double tryApplyAsDbl(T a1, int a2, LOiToDblFunction func, @Nonnull ExWF exF) {
		Null.nonNullArg(func, "func");
		return func.applyAsDbl(a1, a2, exF);
	}

	static  double tryApplyAsDblThen(T a1, int a2, LOiToDblFunction func, @Nonnull LToDblFunction handler) {
		Null.nonNullArg(func, "func");
		return func.applyAsDblThen(a1, a2, handler);
	}

	default double failSafeApplyAsDbl(T a1, int a2, @Nonnull LOiToDblFunction failSafe) {
		try {
			return applyAsDbl(a1, a2);
		} catch (Throwable e) { // NOSONAR
			Handling.handleErrors(e);
			return failSafe.applyAsDbl(a1, a2);
		}
	}

	static  double failSafeApplyAsDbl(T a1, int a2, LOiToDblFunction func, @Nonnull LOiToDblFunction failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		if (func == null) {
			return failSafe.applyAsDbl(a1, a2);
		} else {
			return func.failSafeApplyAsDbl(a1, a2, failSafe);
		}
	}

	static  LOiToDblFunction failSafe(LOiToDblFunction func, @Nonnull LOiToDblFunction failSafe) {
		Null.nonNullArg(failSafe, "failSafe");
		return (a1, a2) -> failSafeApplyAsDbl(a1, a2, func, failSafe);
	}

	/** Just to mirror the method: Ensures the result is not null */
	default double nonNullApplyAsDbl(T a1, int a2) {
		return applyAsDbl(a1, a2);
	}

	/** Returns description of the functional interface. */
	@Nonnull
	default String functionalInterfaceDescription() {
		return LOiToDblFunction.DESCRIPTION;
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTo(int min_a2, int max_a2, T a1, LOiToDblFunction func) {
		Null.nonNullArg(func, "func");
		if (min_a2 <= max_a2) {
			for (int a2 = min_a2; a2 <= max_a2; a2++) {
				func.applyAsDbl(a1, a2);
			}
		} else {
			for (int a2 = min_a2; a2 >= max_a2; a2--) {
				func.applyAsDbl(a1, a2);
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void fromTill(int min_a2, int max_a2, T a1, LOiToDblFunction func) {
		Null.nonNullArg(func, "func");
		if (min_a2 <= max_a2) {
			for (int a2 = min_a2; a2 < max_a2; a2++) {
				func.applyAsDbl(a1, a2);
			}
		} else {
			for (int a2 = min_a2; a2 > max_a2; a2--) {
				func.applyAsDbl(a1, a2);
			}
		}
	}

	/** From-To. Intended to be used with non-capturing lambda. */
	public static  void times(int max_a2, T a1, LOiToDblFunction func) {
		if (max_a2 < 0)
			return;
		fromTill(0, max_a2, a1, func);
	}

	public default LIntToDblFunction lShrink(LIntFunction left) {
		return a2 -> applyAsDbl(left.apply(a2), a2);
	}

	public default LIntToDblFunction lShrinkc(T a1) {
		return a2 -> applyAsDbl(a1, a2);
	}

	public static  LIntToDblFunction lShrinked(LIntFunction left, LOiToDblFunction func) {
		return func.lShrink(left);
	}

	public static  LIntToDblFunction lShrinkedc(T a1, LOiToDblFunction func) {
		return func.lShrinkc(a1);
	}

	public default LToDblFunction rShrink(LToIntFunction right) {
		return a1 -> applyAsDbl(a1, right.applyAsInt(a1));
	}

	public default LToDblFunction rShrinkc(int a2) {
		return a1 -> applyAsDbl(a1, a2);
	}

	public static  LToDblFunction rShrinked(LToIntFunction right, LOiToDblFunction func) {
		return func.rShrink(right);
	}

	public static  LToDblFunction rShrinkedc(int a2, LOiToDblFunction func) {
		return func.rShrinkc(a2);
	}

	/**  */
	public static  LOiToDblFunction uncurry(LFunction func) {
		return (T a1, int a2) -> func.apply(a1).applyAsDbl(a2);
	}

	/** Cast that removes generics. */
	public default LOiToDblFunction untyped() {
		return this;
	}

	/** Cast that replace generics. */
	public default  LOiToDblFunction cast() {
		return untyped();
	}

	/** Cast that replace generics. */
	public static  LOiToDblFunction cast(LOiToDblFunction function) {
		return (LOiToDblFunction) function;
	}

	/** Captures arguments but delays the evaluation. */
	default LDblSupplier capture(T a1, int a2) {
		return () -> this.applyAsDbl(a1, a2);
	}

	/** Creates function that always returns the same value. */
	static  LOiToDblFunction constant(double r) {
		return (a1, a2) -> r;
	}

	/** Captures single parameter function into this interface where only 1st parameter will be used. */
	@Nonnull
	static  LOiToDblFunction apply1stAsDbl(@Nonnull LToDblFunction func) {
		return (a1, a2) -> func.applyAsDbl(a1);
	}

	/** Captures single parameter function into this interface where only 2nd parameter will be used. */
	@Nonnull
	static  LOiToDblFunction apply2ndAsDbl(@Nonnull LIntToDblFunction func) {
		return (a1, a2) -> func.applyAsDbl(a2);
	}

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LOiToDblFunction oiToDblFunc(final @Nonnull LOiToDblFunction lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	@Nonnull
	static  LOiToDblFunction recursive(final @Nonnull LFunction, LOiToDblFunction> selfLambda) {
		final LOiToDblFunctionSingle single = new LOiToDblFunctionSingle();
		LOiToDblFunction func = selfLambda.apply(single);
		single.target = func;
		return func;
	}

	final class LOiToDblFunctionSingle implements LSingle>, LOiToDblFunction {
		private LOiToDblFunction target = null;

		@Override
		public double applyAsDblX(T a1, int a2) throws Throwable {
			return target.applyAsDblX(a1, a2);
		}

		@Override
		public LOiToDblFunction value() {
			return target;
		}
	}

	@Nonnull
	static  LOiToDblFunction oiToDblFuncThrowing(final @Nonnull ExF exF) {
		Null.nonNullArg(exF, "exF");
		return (a1, a2) -> {
			throw exF.produce();
		};
	}

	@Nonnull
	static  LOiToDblFunction oiToDblFuncThrowing(final String message, final @Nonnull ExMF exF) {
		Null.nonNullArg(exF, "exF");
		return (a1, a2) -> {
			throw exF.produce(message);
		};
	}

	// 

	/** Convenient method in case lambda expression is ambiguous for the compiler (that might happen for overloaded methods accepting different interfaces). */
	@Nonnull
	static  LIntObjToDblFunc intObjToDblFunc(final @Nonnull LIntObjToDblFunc lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda;
	}

	// 

	static  double call(T a1, int a2, final @Nonnull LOiToDblFunction lambda) {
		Null.nonNullArg(lambda, "lambda");
		return lambda.applyAsDbl(a1, a2);
	}

	// 

	// 

	// 

	/** Safe instance. That always returns the same value (as produceDouble). */
	@Nonnull
	static  LOiToDblFunction safe() {
		return LOiToDblFunction::produceDouble;
	}

	/** 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  LOiToDblFunction safe(final @Nullable LOiToDblFunction 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  LOiToDblFunction compose(@Nonnull final LFunction before1, @Nonnull final LIntUnaryOperator before2) {
		Null.nonNullArg(before1, "before1");
		Null.nonNullArg(before2, "before2");
		return (v1, v2) -> this.applyAsDbl(before1.apply(v1), before2.applyAsInt(v2));
	}

	public static  LOiToDblFunction composed(@Nonnull final LFunction before1, @Nonnull final LIntUnaryOperator before2, LOiToDblFunction after) {
		return after.compose(before1, before2);
	}

	/** Allows to manipulate the domain of the function. */
	@Nonnull
	default  LToDblBiFunction oiToDblFuncCompose(@Nonnull final LFunction before1, @Nonnull final LToIntFunction before2) {
		Null.nonNullArg(before1, "before1");
		Null.nonNullArg(before2, "before2");
		return (v1, v2) -> this.applyAsDbl(before1.apply(v1), before2.applyAsInt(v2));
	}

	public static  LToDblBiFunction composed(@Nonnull final LFunction before1, @Nonnull final LToIntFunction before2, LOiToDblFunction after) {
		return after.oiToDblFuncCompose(before1, before2);
	}

	// 

	// 

	/** Combines two functions together in a order. */
	@Nonnull
	default  LOiFunction then(@Nonnull LDblFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.apply(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToByteFunction thenToByte(@Nonnull LDblToByteFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsByte(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToSrtFunction thenToSrt(@Nonnull LDblToSrtFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsSrt(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToIntFunction thenToInt(@Nonnull LDblToIntFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsInt(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToLongFunction thenToLong(@Nonnull LDblToLongFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsLong(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToFltFunction thenToFlt(@Nonnull LDblToFltFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsFlt(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToDblFunction thenToDbl(@Nonnull LDblUnaryOperator after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsDbl(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LOiToCharFunction thenToChar(@Nonnull LDblToCharFunction after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.applyAsChar(this.applyAsDbl(a1, a2));
	}

	/** Combines two functions together in a order. */
	@Nonnull
	default LObjIntPredicate thenToBool(@Nonnull LDblPredicate after) {
		Null.nonNullArg(after, "after");
		return (a1, a2) -> after.test(this.applyAsDbl(a1, a2));
	}

	// 

	// 

	// 

	// 

	/** Permutation of LOiToDblFunction for method references. */
	@FunctionalInterface
	interface LIntObjToDblFunc extends LOiToDblFunction {

		double applyAsDblIntObj(int a2, T a1);

		@Override
		default double applyAsDblX(T a1, int a2) {
			return this.applyAsDblIntObj(a2, a1);
		}
	}

	// 

	/** Does nothing (LOiToDblFunction) Function */
	public static  double produceDouble(T a1, int a2) {
		return Function4U.defaultDouble;
	}

	/** Does nothing (LOiToDblFunction.LIntObjToDblFunc) Function */
	public static  double produceDouble(int a2, T a1) {
		return Function4U.defaultDouble;
	}

	/**
	* 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> ia1, C1 source1, IndexedRead ia2, C2 source2, LDblConsumer consumer) {
		int size = ia1.size(source1);
		LOiFunction oiFunc1 = (LOiFunction) ia1.getter();
		size = Integer.min(size, ia2.size(source2));
		LOiToIntFunction oiFunc2 = (LOiToIntFunction) ia2.getter();
		int i = 0;
		for (; i < size; i++) {
			T a1 = oiFunc1.apply(source1, i);
			int a2 = oiFunc2.applyAsInt(source2, i);
			consumer.accept(this.applyAsDbl(a1, a2));
		}
	}

	/**
	* 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 iterate(SequentialRead> sa1, C1 source1, IndexedRead ia2, C2 source2, LDblConsumer consumer) {
		Object iterator1 = ((LFunction) sa1.adapter()).apply(source1);
		LPredicate testFunc1 = (LPredicate) sa1.tester();
		LFunction nextFunc1 = (LFunction) sa1.supplier();
		int size = ia2.size(source2);
		LOiToIntFunction oiFunc2 = (LOiToIntFunction) ia2.getter();
		int i = 0;
		while (testFunc1.test(iterator1) && i < size) {
			T a1 = nextFunc1.apply(iterator1);
			int a2 = oiFunc2.applyAsInt(source2, i);
			consumer.accept(this.applyAsDbl(a1, a2));
			i++;
		}
	}

	/**
	* 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 iterate(IndexedRead> ia1, C1 source1, SequentialRead sa2, C2 source2, LDblConsumer consumer) {
		int size = ia1.size(source1);
		LOiFunction oiFunc1 = (LOiFunction) ia1.getter();
		Object iterator2 = ((LFunction) sa2.adapter()).apply(source2);
		LPredicate testFunc2 = (LPredicate) sa2.tester();
		LToIntFunction nextFunc2 = (LToIntFunction) sa2.supplier();
		int i = 0;
		while (i < size && testFunc2.test(iterator2)) {
			T a1 = oiFunc1.apply(source1, i);
			int a2 = nextFunc2.applyAsInt(iterator2);
			consumer.accept(this.applyAsDbl(a1, a2));
			i++;
		}
	}

	/**
	* 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 depends highly on the arguments.
	*/
	default  void iterate(SequentialRead> sa1, C1 source1, SequentialRead sa2, C2 source2, LDblConsumer consumer) {
		Object iterator1 = ((LFunction) sa1.adapter()).apply(source1);
		LPredicate testFunc1 = (LPredicate) sa1.tester();
		LFunction nextFunc1 = (LFunction) sa1.supplier();
		Object iterator2 = ((LFunction) sa2.adapter()).apply(source2);
		LPredicate testFunc2 = (LPredicate) sa2.tester();
		LToIntFunction nextFunc2 = (LToIntFunction) sa2.supplier();
		while (testFunc1.test(iterator1) && testFunc2.test(iterator2)) {
			T a1 = nextFunc1.apply(iterator1);
			int a2 = nextFunc2.applyAsInt(iterator2);
			consumer.accept(this.applyAsDbl(a1, a2));
		}
	}

}