org.eclipse.collections.api.ParallelIterable Maven / Gradle / Ivy
/*
* Copyright (c) 2021 Goldman Sachs.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompany this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.eclipse.collections.api;
import java.util.Comparator;
import org.eclipse.collections.api.annotation.Beta;
import org.eclipse.collections.api.bag.MutableBag;
import org.eclipse.collections.api.bag.sorted.MutableSortedBag;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function0;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.block.procedure.Procedure2;
import org.eclipse.collections.api.list.MutableList;
import org.eclipse.collections.api.map.MapIterable;
import org.eclipse.collections.api.map.MutableMap;
import org.eclipse.collections.api.map.sorted.MutableSortedMap;
import org.eclipse.collections.api.multimap.Multimap;
import org.eclipse.collections.api.set.MutableSet;
import org.eclipse.collections.api.set.sorted.MutableSortedSet;
/**
* A ParallelIterable is RichIterable which will defer evaluation for certain methods like select, reject, collect, etc.
* Any methods that do not return a ParallelIterable when called will cause evaluation to be forced. Evaluation occurs
* in parallel. All code blocks passed in must be stateless or thread-safe.
*
* @since 5.0
*/
@Beta
public interface ParallelIterable
{
ParallelIterable asUnique();
/**
* Creates a parallel iterable for selecting elements from the current iterable.
*/
ParallelIterable select(Predicate predicate);
ParallelIterable selectWith(Predicate2 predicate, P parameter);
ParallelIterable selectInstancesOf(Class clazz);
/**
* Creates a parallel iterable for rejecting elements from the current iterable.
*/
ParallelIterable reject(Predicate predicate);
ParallelIterable rejectWith(Predicate2 predicate, P parameter);
/**
* Creates a parallel iterable for collecting elements from the current iterable.
*/
ParallelIterable collect(Function function);
ParallelIterable collectWith(Function2 function, P parameter);
/**
* Creates a parallel iterable for selecting and collecting elements from the current iterable.
*/
ParallelIterable collectIf(Predicate predicate, Function function);
/**
* Creates a parallel flattening iterable for the current iterable.
*/
ParallelIterable flatCollect(Function> function);
void forEach(Procedure procedure);
void forEachWith(Procedure2 procedure, P parameter);
T detect(Predicate predicate);
T detectWith(Predicate2 predicate, P parameter);
T detectIfNone(Predicate predicate, Function0 function);
T detectWithIfNone(Predicate2 predicate, P parameter, Function0 function);
int count(Predicate predicate);
int countWith(Predicate2 predicate, P parameter);
boolean anySatisfy(Predicate predicate);
boolean anySatisfyWith(Predicate2 predicate, P parameter);
boolean allSatisfy(Predicate predicate);
boolean allSatisfyWith(Predicate2 predicate, P parameter);
boolean noneSatisfy(Predicate predicate);
boolean noneSatisfyWith(Predicate2 predicate, P parameter);
MutableList toList();
default MutableList toSortedList()
{
return this.toList().toSortedList();
}
MutableList toSortedList(Comparator comparator);
> MutableList toSortedListBy(Function function);
MutableSet toSet();
MutableSortedSet toSortedSet();
MutableSortedSet toSortedSet(Comparator comparator);
> MutableSortedSet toSortedSetBy(Function function);
MutableBag toBag();
MutableSortedBag toSortedBag();
MutableSortedBag toSortedBag(Comparator comparator);
> MutableSortedBag toSortedBagBy(Function function);
MutableMap toMap(Function keyFunction, Function valueFunction);
MutableSortedMap toSortedMap(Function keyFunction, Function valueFunction);
MutableSortedMap toSortedMap(Comparator comparator, Function keyFunction, Function valueFunction);
default Object[] toArray()
{
throw new UnsupportedOperationException(this.getClass().getSimpleName() + ".toArray() not implemented yet");
}
T1[] toArray(T1[] target);
T min(Comparator comparator);
T max(Comparator comparator);
T min();
T max();
> T minBy(Function function);
> T maxBy(Function function);
/**
* Returns the final long result of evaluating function for each element of the iterable in parallel
* and adding the results together.
*
* @since 6.0
*/
long sumOfInt(IntFunction function);
/**
* Returns the final double result of evaluating function for each element of the iterable in parallel
* and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
*
* @since 6.0
*/
double sumOfFloat(FloatFunction function);
/**
* Returns the final long result of evaluating function for each element of the iterable in parallel
* and adding the results together.
*
* @since 6.0
*/
long sumOfLong(LongFunction function);
/**
* Returns the final double result of evaluating function for each element of the iterable in parallel
* and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
*
* @since 6.0
*/
double sumOfDouble(DoubleFunction function);
default String makeString()
{
return this.makeString(", ");
}
default String makeString(String separator)
{
return this.makeString("", separator, "");
}
default String makeString(String start, String separator, String end)
{
Appendable stringBuilder = new StringBuilder();
this.appendString(stringBuilder, start, separator, end);
return stringBuilder.toString();
}
default String makeString(Function function, String start, String separator, String end)
{
return this.collect(function).makeString(start, separator, end);
}
default void appendString(Appendable appendable)
{
this.appendString(appendable, ", ");
}
default void appendString(Appendable appendable, String separator)
{
this.appendString(appendable, "", separator, "");
}
void appendString(Appendable appendable, String start, String separator, String end);
Multimap groupBy(Function function);
Multimap groupByEach(Function> function);
MapIterable groupByUniqueKey(Function function);
MapIterable aggregateInPlaceBy(Function groupBy, Function0 zeroValueFactory, Procedure2 mutatingAggregator);
MapIterable aggregateBy(Function groupBy, Function0 zeroValueFactory, Function2 nonMutatingAggregator);
}