Eclipse Collections 13.0.0 · org.eclipse.collections.api.IntIterable

Method Summary

Modifier and Type	Method and Description
public boolean	allSatisfy(IntPredicate predicate) Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
public boolean	anySatisfy(IntPredicate predicate) Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
public LazyIntIterable	asLazy() Returns a LazyIntIterable adapter wrapping the source IntIterable.
public double	average()
public default double	averageIfEmpty(double defaultValue)
public default RichIterable<IntIterable>	Returns: A `RichIterable` containing `IntIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. chunk(int the number of elements per chunk size) Partitions elements in fixed size chunks.
public <V> RichIterable<V>	collect(IntToObjectFunction<? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
public default <V, R extends Collection<V>> R	collect(IntToObjectFunction<? extends V> function, R target) Same as `collect(IntToObjectFunction)` , only the results are added to the target Collection.
public default <R extends MutableBooleanCollection> R	collectBoolean(IntToBooleanFunction function, R target) Returns the target `MutableBooleanCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableByteCollection> R	collectByte(IntToByteFunction function, R target) Returns the target `MutableByteCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableCharCollection> R	collectChar(IntToCharFunction function, R target) Returns the target `MutableCharCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableDoubleCollection> R	collectDouble(IntToDoubleFunction function, R target) Returns the target `MutableDoubleCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableFloatCollection> R	collectFloat(IntToFloatFunction function, R target) Returns the target `MutableFloatCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableIntCollection> R	collectInt(IntToIntFunction function, R target) Returns the target `MutableIntCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableLongCollection> R	collectLong(IntToLongFunction function, R target) Returns the target `MutableLongCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableShortCollection> R	collectShort(IntToShortFunction function, R target) Returns the target `MutableShortCollection` with the results of applying the specified function on each element of the source collection.
public boolean	contains(int value) Returns true if the value is contained in the IntIterable, and false if it is not.
public default boolean	containsAll(int... source) Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.
public default boolean	containsAll(IntIterable source) Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.
public default boolean	containsAny(int... source) Returns true if any of the values specified in the source array are contained in the IntIterable, and false if they are not.
public default boolean	containsAny(IntIterable source) Returns true if any of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.
public default boolean	containsNone(int... source) Returns true if none of the values specified in the source array are contained in the IntIterable, and false if they are.
public default boolean	containsNone(IntIterable source) Returns true if none of the values specified in the source IntIterable are contained in the IntIterable, and false if they are.
public int	count(IntPredicate predicate) Returns a count of the number of elements in the IntIterable that return true for the specified predicate.
public int	detectIfNone(IntPredicate predicate, int ifNone)
public void	each(IntProcedure procedure) A synonym for forEach.
public default <V, R extends Collection<V>> R	flatCollect(IntToObjectFunction<? extends Iterable<V>> function, R target) `flatCollect` is a special case of `collect(IntToObjectFunction)`.
public default void	forEach(IntProcedure procedure) Applies the IntProcedure to each element in the IntIterable.
public <T> T	injectInto(T injectedValue, ObjectIntToObjectFunction<? super T, ? extends T> function)
public default boolean	injectIntoBoolean(boolean injectedValue, BooleanIntToBooleanFunction function) Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default byte	injectIntoByte(byte injectedValue, ByteIntToByteFunction function) Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default char	injectIntoChar(char injectedValue, CharIntToCharFunction function) Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default double	injectIntoDouble(double injectedValue, DoubleIntToDoubleFunction function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default float	injectIntoFloat(float injectedValue, FloatIntToFloatFunction function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default int	injectIntoInt(int injectedValue, IntIntToIntFunction function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default long	injectIntoLong(long injectedValue, LongIntToLongFunction function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default short	injectIntoShort(short injectedValue, ShortIntToShortFunction function) Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public IntIterator	intIterator() Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.
public int	max()
public int	maxIfEmpty(int defaultValue)
public double	median()
public default double	medianIfEmpty(double defaultValue)
public int	min()
public int	minIfEmpty(int defaultValue)
public default boolean	noneSatisfy(IntPredicate predicate) Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
public default long	reduce(LongIntToLongFunction accumulator)
public default long	reduceIfEmpty(LongIntToLongFunction accumulator, long defaultValue)
public IntIterable	reject(IntPredicate predicate) Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
public default <R extends MutableIntCollection> R	reject(IntPredicate predicate, R target) Same as `reject(IntPredicate)` , only the results are added to the target MutableIntCollection.
public IntIterable	select(IntPredicate predicate) Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
public default <R extends MutableIntCollection> R	select(IntPredicate predicate, R target) Same as `select(IntPredicate)` , only the results are added to the target MutableIntCollection.
public long	sum()
public default IntSummaryStatistics	summaryStatistics()
public default IntIterable	tap(IntProcedure procedure)
public int[]	toArray() Converts the IntIterable to a primitive int array.
public default int[]	toArray(int[] target) Converts the IntIterable to a primitive int array.
public MutableIntBag	toBag() Converts the IntIterable to a new MutableIntBag.
public MutableIntList	toList() Converts the IntIterable to a new MutableIntList.
public MutableIntSet	toSet() Converts the IntIterable to a new MutableIntSet.
public int[]	toSortedArray()
public MutableIntList	toSortedList()
public default MutableIntList	toSortedList(IntComparator comparator) Converts the collection to a MutableIntList implementation sorted using the provided comparator.
public default <T> MutableIntList	toSortedListBy(IntToObjectFunction<T> function) Converts the collection to a MutableIntListImplementation sorted based on the natural order of the key returned by `function`.
public default <T> MutableIntList	toSortedListBy(IntToObjectFunction<T> function, Comparator<? super T> comparator) Converts the collection to a MutableIntList implementation, which is sorted based on the key returned by `function` using the provided `comparator`.

Inherited from org.eclipse.collections.api.PrimitiveIterable:: appendString appendString appendString isEmpty makeString makeString makeString notEmpty size toString

Method Detail

allSatisfy	back to summary
public boolean allSatisfy(IntPredicate predicate) Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

anySatisfy	back to summary
public boolean anySatisfy(IntPredicate predicate) Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

asLazy	back to summary
public LazyIntIterable asLazy() Returns a LazyIntIterable adapter wrapping the source IntIterable.

average	back to summary
public double average()

averageIfEmpty	back to summary
public default double averageIfEmpty(double defaultValue) Since 9.0

chunk back to summary

chunk	back to summary
public default RichIterable<IntIterable> chunk(int size) Partitions elements in fixed size chunks. Parameters size:int the number of elements per chunk Returns:RichIterable<IntIterable> A `RichIterable` containing `IntIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. Since 9.2

public default RichIterable<IntIterable> chunk(int size)

Partitions elements in fixed size chunks.

Parameters

size:int: the number of elements per chunk

Returns:RichIterable<IntIterable>

A RichIterable containing IntIterables of size size, except the last will be truncated if the elements don't divide evenly.

Since

9.2

collect	back to summary
public <V> RichIterable<V> collect(IntToObjectFunction<? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

collect back to summary

collect	back to summary
public default <V, R extends Collection<V>> R collect(IntToObjectFunction<? extends V> function, R target) Same as `collect(IntToObjectFunction)` , only the results are added to the target Collection. Since 8.1.

public default <V, R extends Collection<V>> R collect(IntToObjectFunction<? extends V> function, R target)

Same as collect(IntToObjectFunction) , only the results are added to the target Collection.

Since: 8.1.

collectBoolean back to summary

collectBoolean	back to summary
public default <R extends MutableBooleanCollection> R collectBoolean(IntToBooleanFunction function, R target) Returns the target `MutableBooleanCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableBooleanCollection> R collectBoolean(IntToBooleanFunction function, R target)

Returns the target MutableBooleanCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectByte back to summary

collectByte	back to summary
public default <R extends MutableByteCollection> R collectByte(IntToByteFunction function, R target) Returns the target `MutableByteCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableByteCollection> R collectByte(IntToByteFunction function, R target)

Returns the target MutableByteCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectChar back to summary

collectChar	back to summary
public default <R extends MutableCharCollection> R collectChar(IntToCharFunction function, R target) Returns the target `MutableCharCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableCharCollection> R collectChar(IntToCharFunction function, R target)

Returns the target MutableCharCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectDouble back to summary

collectDouble	back to summary
public default <R extends MutableDoubleCollection> R collectDouble(IntToDoubleFunction function, R target) Returns the target `MutableDoubleCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableDoubleCollection> R collectDouble(IntToDoubleFunction function, R target)

Returns the target MutableDoubleCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectFloat back to summary

collectFloat	back to summary
public default <R extends MutableFloatCollection> R collectFloat(IntToFloatFunction function, R target) Returns the target `MutableFloatCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableFloatCollection> R collectFloat(IntToFloatFunction function, R target)

Returns the target MutableFloatCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectInt back to summary

collectInt	back to summary
public default <R extends MutableIntCollection> R collectInt(IntToIntFunction function, R target) Returns the target `MutableIntCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableIntCollection> R collectInt(IntToIntFunction function, R target)

Returns the target MutableIntCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectLong back to summary

collectLong	back to summary
public default <R extends MutableLongCollection> R collectLong(IntToLongFunction function, R target) Returns the target `MutableLongCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableLongCollection> R collectLong(IntToLongFunction function, R target)

Returns the target MutableLongCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

collectShort back to summary

collectShort	back to summary
public default <R extends MutableShortCollection> R collectShort(IntToShortFunction function, R target) Returns the target `MutableShortCollection` with the results of applying the specified function on each element of the source collection. Since 8.1.

public default <R extends MutableShortCollection> R collectShort(IntToShortFunction function, R target)

Returns the target MutableShortCollection with the results of applying the specified function on each element of the source collection.

Since: 8.1.

contains	back to summary
public boolean contains(int value) Returns true if the value is contained in the IntIterable, and false if it is not.

containsAll	back to summary
public default boolean containsAll(int... source) Returns true if all of the values specified in the source array are contained in the IntIterable, and false if they are not.

containsAll	back to summary
public default boolean containsAll(IntIterable source) Returns true if all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.

containsAny	back to summary
public default boolean containsAny(int... source) Returns true if any of the values specified in the source array are contained in the IntIterable, and false if they are not. Since 11.0

containsAny

back to summary

public default boolean containsAny(int... source)

Returns true if any of the values specified in the source array are contained in the IntIterable, and false if they are not.

Since: 11.0

containsAny	back to summary
public default boolean containsAny(IntIterable source) Returns true if any of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not. Since 11.0

containsAny

back to summary

public default boolean containsAny(IntIterable source)

Returns true if any of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.

Since: 11.0

containsNone	back to summary
public default boolean containsNone(int... source) Returns true if none of the values specified in the source array are contained in the IntIterable, and false if they are. Since 11.0

containsNone

back to summary

public default boolean containsNone(int... source)

Returns true if none of the values specified in the source array are contained in the IntIterable, and false if they are.

Since: 11.0

containsNone	back to summary
public default boolean containsNone(IntIterable source) Returns true if none of the values specified in the source IntIterable are contained in the IntIterable, and false if they are. Since 11.0

containsNone

back to summary

public default boolean containsNone(IntIterable source)

Returns true if none of the values specified in the source IntIterable are contained in the IntIterable, and false if they are.

Since: 11.0

count	back to summary
public int count(IntPredicate predicate) Returns a count of the number of elements in the IntIterable that return true for the specified predicate.

detectIfNone	back to summary
public int detectIfNone(IntPredicate predicate, int ifNone)

each	back to summary
public void each(IntProcedure procedure) A synonym for forEach. Since 7.0.

each

back to summary

public void each(IntProcedure procedure)

A synonym for forEach.

Since: 7.0.

flatCollect back to summary

flatCollect	back to summary
public default <V, R extends Collection<V>> R flatCollect(IntToObjectFunction<? extends Iterable<V>> function, R target) `flatCollect` is a special case of `collect(IntToObjectFunction)`. With `collect`, when the `IntToObjectFunction` returns a collection, the result is a collection of collections. `flatCollect` outputs a single "flattened" collection instead. This method is commonly called flatMap. Since 8.1.

public default <V, R extends Collection<V>> R flatCollect(IntToObjectFunction<? extends Iterable<V>> function, R target)

flatCollect is a special case of collect(IntToObjectFunction). With collect, when the IntToObjectFunction returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Since: 8.1.

forEach	back to summary
public default void forEach(IntProcedure procedure) Applies the IntProcedure to each element in the IntIterable.

injectInto	back to summary
public <T> T injectInto(T injectedValue, ObjectIntToObjectFunction<? super T, ? extends T> function)

injectIntoBoolean	back to summary
public default boolean injectIntoBoolean(boolean injectedValue, BooleanIntToBooleanFunction function) Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoBoolean

back to summary

public default boolean injectIntoBoolean(boolean injectedValue, BooleanIntToBooleanFunction function)

Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoByte	back to summary
public default byte injectIntoByte(byte injectedValue, ByteIntToByteFunction function) Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoByte

back to summary

public default byte injectIntoByte(byte injectedValue, ByteIntToByteFunction function)

Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoChar	back to summary
public default char injectIntoChar(char injectedValue, CharIntToCharFunction function) Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoChar

back to summary

public default char injectIntoChar(char injectedValue, CharIntToCharFunction function)

Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoDouble	back to summary
public default double injectIntoDouble(double injectedValue, DoubleIntToDoubleFunction function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoDouble

back to summary

public default double injectIntoDouble(double injectedValue, DoubleIntToDoubleFunction function)

Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoFloat	back to summary
public default float injectIntoFloat(float injectedValue, FloatIntToFloatFunction function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoFloat

back to summary

public default float injectIntoFloat(float injectedValue, FloatIntToFloatFunction function)

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoInt	back to summary
public default int injectIntoInt(int injectedValue, IntIntToIntFunction function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoInt

back to summary

public default int injectIntoInt(int injectedValue, IntIntToIntFunction function)

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoLong	back to summary
public default long injectIntoLong(long injectedValue, LongIntToLongFunction function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoLong

back to summary

public default long injectIntoLong(long injectedValue, LongIntToLongFunction function)

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoShort	back to summary
public default short injectIntoShort(short injectedValue, ShortIntToShortFunction function) Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoShort

back to summary

public default short injectIntoShort(short injectedValue, ShortIntToShortFunction function)

Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

intIterator	back to summary
public IntIterator intIterator() Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.

max	back to summary
public int max()

maxIfEmpty	back to summary
public int maxIfEmpty(int defaultValue)

median	back to summary
public double median()

medianIfEmpty	back to summary
public default double medianIfEmpty(double defaultValue) Since 9.0

min	back to summary
public int min()

minIfEmpty	back to summary
public int minIfEmpty(int defaultValue)

noneSatisfy	back to summary
public default boolean noneSatisfy(IntPredicate predicate) Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.

reduce	back to summary
public default long reduce(LongIntToLongFunction accumulator) Since 10.0 See Also `RichIterable#reduce(BinaryOperator)`

reduceIfEmpty	back to summary
public default long reduceIfEmpty(LongIntToLongFunction accumulator, long defaultValue) Since 10.0 See Also `reduce(LongIntToLongFunction)`

reject	back to summary
public IntIterable reject(IntPredicate predicate) Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.

reject back to summary

reject	back to summary
public default <R extends MutableIntCollection> R reject(IntPredicate predicate, R target) Same as `reject(IntPredicate)` , only the results are added to the target MutableIntCollection. Since 8.1.

public default <R extends MutableIntCollection> R reject(IntPredicate predicate, R target)

Same as reject(IntPredicate) , only the results are added to the target MutableIntCollection.

Since: 8.1.

select	back to summary
public IntIterable select(IntPredicate predicate) Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.

select back to summary

public default <R extends MutableIntCollection> R select(IntPredicate predicate, R target)

Same as select(IntPredicate) , only the results are added to the target MutableIntCollection.

Since: 8.1.

sum	back to summary
public long sum()

summaryStatistics	back to summary
public default IntSummaryStatistics summaryStatistics() Since 8.0

tap	back to summary
public default IntIterable tap(IntProcedure procedure) Since 9.0.

toArray	back to summary
public int[] toArray() Converts the IntIterable to a primitive int array.

toArray	back to summary
public default int[] toArray(int[] target) Converts the IntIterable to a primitive int array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

toBag	back to summary
public MutableIntBag toBag() Converts the IntIterable to a new MutableIntBag.

toList	back to summary
public MutableIntList toList() Converts the IntIterable to a new MutableIntList.

toSet	back to summary
public MutableIntSet toSet() Converts the IntIterable to a new MutableIntSet.

toSortedArray	back to summary
public int[] toSortedArray()

toSortedList	back to summary
public MutableIntList toSortedList()

toSortedList	back to summary
public default MutableIntList toSortedList(IntComparator comparator) Converts the collection to a MutableIntList implementation sorted using the provided comparator.

toSortedListBy	back to summary
public default <T> MutableIntList toSortedListBy(IntToObjectFunction<T> function) Converts the collection to a MutableIntListImplementation sorted based on the natural order of the key returned by `function`.

toSortedListBy	back to summary
public default <T> MutableIntList toSortedListBy(IntToObjectFunction<T> function, Comparator<? super T> comparator) Converts the collection to a MutableIntList implementation, which is sorted based on the key returned by `function` using the provided `comparator`.

public Interface IntIterable

Method Summary

Method Detail