com.gs.collections.api.ParallelIterable Maven / Gradle / Ivy
/*
* Copyright 2014 Goldman Sachs.
*
* 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 com.gs.collections.api;
import java.util.Comparator;
import com.gs.collections.api.annotation.Beta;
import com.gs.collections.api.bag.MutableBag;
import com.gs.collections.api.bag.sorted.MutableSortedBag;
import com.gs.collections.api.block.function.Function;
import com.gs.collections.api.block.function.Function0;
import com.gs.collections.api.block.function.Function2;
import com.gs.collections.api.block.function.primitive.DoubleFunction;
import com.gs.collections.api.block.function.primitive.FloatFunction;
import com.gs.collections.api.block.function.primitive.IntFunction;
import com.gs.collections.api.block.function.primitive.LongFunction;
import com.gs.collections.api.block.predicate.Predicate;
import com.gs.collections.api.block.predicate.Predicate2;
import com.gs.collections.api.block.procedure.Procedure;
import com.gs.collections.api.block.procedure.Procedure2;
import com.gs.collections.api.list.MutableList;
import com.gs.collections.api.map.MapIterable;
import com.gs.collections.api.map.MutableMap;
import com.gs.collections.api.map.sorted.MutableSortedMap;
import com.gs.collections.api.multimap.Multimap;
import com.gs.collections.api.set.MutableSet;
import com.gs.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);
// /**
// * Returns a parallel BooleanIterable which will transform the underlying iterable data to boolean values based on the booleanFunction.
// */
// ParallelBooleanIterable collectBoolean(BooleanFunction booleanFunction);
//
// /**
// * Returns a parallel ByteIterable which will transform the underlying iterable data to byte values based on the byteFunction.
// */
// ParallelByteIterable collectByte(ByteFunction byteFunction);
//
// /**
// * Returns a parallel CharIterable which will transform the underlying iterable data to char values based on the charFunction.
// */
// ParallelCharIterable collectChar(CharFunction charFunction);
//
// /**
// * Returns a parallel DoubleIterable which will transform the underlying iterable data to double values based on the doubleFunction.
// */
// ParallelDoubleIterable collectDouble(DoubleFunction doubleFunction);
//
// /**
// * Returns a parallel FloatIterable which will transform the underlying iterable data to float values based on the floatFunction.
// */
// ParallelFloatIterable collectFloat(FloatFunction floatFunction);
//
// /**
// * Returns a parallel IntIterable which will transform the underlying iterable data to int values based on the intFunction.
// */
// ParallelIntIterable collectInt(IntFunction intFunction);
//
// /**
// * Returns a parallel LongIterable which will transform the underlying iterable data to long values based on the longFunction.
// */
// ParallelLongIterable collectLong(LongFunction longFunction);
//
// /**
// * Returns a parallel ShortIterable which will transform the underlying iterable data to short values based on the shortFunction.
// */
// ParallelShortIterable collectShort(ShortFunction shortFunction);
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();
MutableList 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);
Object[] toArray();
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);
String makeString();
String makeString(String separator);
String makeString(String start, String separator, String end);
void appendString(Appendable appendable);
void appendString(Appendable appendable, String 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);
}