T
- Component typepublic final class Array<T> extends Object implements Kind1<Array<?>,T>, IndexedSeq<T>, Serializable
Object[]
containing elements of type T
.λ.Memoized
Modifier and Type | Method and Description |
---|---|
Array<T> |
append(T element)
Appends an element to this.
|
Array<T> |
appendAll(Iterable<? extends T> elements)
Appends all given elements to this.
|
static <T> Collector<T,ArrayList<T>,Array<T>> |
collector()
Returns a
Collector which may be used in conjunction with
Stream.collect(java.util.stream.Collector) to obtain a Array . |
Array<Array<T>> |
combinations()
Returns the union of all combinations from k = 0 to length().
|
Array<Array<T>> |
combinations(int k)
Returns the k-combination of this traversable, i.e.
|
Iterator<Array<T>> |
crossProduct(int power)
Calculates the n-ary cartesian power (or cross product or simply product) of this.
|
Array<T> |
distinct()
Returns a new version of this which contains no duplicates.
|
Array<T> |
distinctBy(Comparator<? super T> comparator)
Returns a new version of this which contains no duplicates.
|
<U> Array<T> |
distinctBy(Function<? super T,? extends U> keyExtractor)
Returns a new version of this which contains no duplicates.
|
Array<T> |
drop(int n)
Drops the first n elements of this or all elements, if this length < n.
|
Array<T> |
dropRight(int n)
Drops the last n elements of this or all elements, if this length < n.
|
Array<T> |
dropUntil(Predicate<? super T> predicate)
Drops elements until the predicate holds for the current element.
|
Array<T> |
dropWhile(Predicate<? super T> predicate)
Drops elements while the predicate holds for the current element.
|
static <T> Array<T> |
empty() |
boolean |
equals(Object o)
Clarifies that values have a proper equals() method implemented.
|
static <T> Array<T> |
fill(int n,
Supplier<? extends T> s)
Returns an Array containing
n values supplied by a given Supplier s . |
Array<T> |
filter(Predicate<? super T> predicate)
Returns a new traversable consisting of all elements which satisfy the given predicate.
|
<U> Array<U> |
flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)
FlatMaps this Traversable.
|
T |
get(int index)
Returns the element at the specified index.
|
<C> Map<C,Array<T>> |
groupBy(Function<? super T,? extends C> classifier)
Groups this elements by classifying the elements.
|
Iterator<Array<T>> |
grouped(int size)
Groups this
Traversable into fixed size blocks. |
boolean |
hasDefiniteSize()
Checks if this Traversable is known to have a finite size.
|
int |
hashCode()
Clarifies that values have a proper hashCode() method implemented.
|
T |
head()
Returns the first element of a non-empty Traversable.
|
int |
indexOf(T element,
int from)
Returns the index of the first occurrence of the given element after or at some start index
or -1 if this does not contain the given element.
|
Array<T> |
init()
Dual of Traversable.tail(), returning all elements except the last.
|
Option<Array<T>> |
initOption()
Dual of Traversable.tailOption(), returning all elements except the last as
Option . |
Array<T> |
insert(int index,
T element)
Inserts the given element at the specified index.
|
Array<T> |
insertAll(int index,
Iterable<? extends T> elements)
Inserts the given elements at the specified index.
|
Array<T> |
intersperse(T element)
Inserts an element between all elements of this Traversable.
|
boolean |
isEmpty()
Checks if this Traversable is empty.
|
boolean |
isTraversableAgain()
Checks if this Traversable can be repeatedly traversed.
|
Iterator<T> |
iterator()
An iterator by means of head() and tail().
|
int |
lastIndexOf(T element,
int end)
Returns the index of the last occurrence of the given element before or at a given end index
or -1 if this does not contain the given element.
|
Array<T> |
leftPadTo(int length,
T element)
A copy of this sequence with an element prepended until a given target length is reached.
|
int |
length()
Computes the number of elements of this Traversable.
|
<U> Array<U> |
map(Function<? super T,? extends U> mapper)
Maps the elements of this
Traversable to elements of a new type preserving their order, if any. |
static <T> Array<T> |
narrow(Array<? extends T> array)
Narrows a widened
Array<? extends T> to Array<T>
by performing a type-safe cast. |
static <T> Array<T> |
of(T... elements)
Creates a Array of the given elements.
|
static <T> Array<T> |
of(T element)
Returns a singleton
Array , i.e. |
static Array<Boolean> |
ofAll(boolean[] array)
Creates a Array based on the elements of a boolean array.
|
static Array<Byte> |
ofAll(byte[] array)
Creates a Array based on the elements of a byte array.
|
static Array<Character> |
ofAll(char[] array)
Creates a Array based on the elements of a char array.
|
static Array<Double> |
ofAll(double[] array)
Creates a Array based on the elements of a double array.
|
static Array<Float> |
ofAll(float[] array)
Creates a Array based on the elements of a float array.
|
static Array<Integer> |
ofAll(int[] array)
Creates a Array based on the elements of an int array.
|
static <T> Array<T> |
ofAll(Iterable<? extends T> elements)
Creates a Array of the given elements.
|
static Array<Long> |
ofAll(long[] array)
Creates a Array based on the elements of a long array.
|
static Array<Short> |
ofAll(short[] array)
Creates a Array based on the elements of a short array.
|
static <T> Array<T> |
ofAll(Stream<? extends T> javaStream)
Creates a Array that contains the elements of the given
Stream . |
Array<T> |
padTo(int length,
T element)
A copy of this sequence with an element appended until a given target length is reached.
|
Tuple2<Array<T>,Array<T>> |
partition(Predicate<? super T> predicate)
Creates a partition of this
Traversable by splitting this elements in two in distinct tarversables
according to a predicate. |
Array<T> |
patch(int from,
Iterable<? extends T> that,
int replaced)
Produces a new list where a slice of elements in this list is replaced by another sequence.
|
Array<T> |
peek(Consumer<? super T> action)
Performs the given
action on the first element if this is an eager implementation. |
Array<Array<T>> |
permutations()
Computes all unique permutations.
|
Array<T> |
prepend(T element)
Prepends an element to this.
|
Array<T> |
prependAll(Iterable<? extends T> elements)
Prepends all given elements to this.
|
static Array<Character> |
range(char from,
char toExclusive) |
static Array<Integer> |
range(int from,
int toExclusive)
Creates a Array of int numbers starting from
from , extending to toExclusive - 1 . |
static Array<Long> |
range(long from,
long toExclusive)
Creates a Array of long numbers starting from
from , extending to toExclusive - 1 . |
static Array<Character> |
rangeBy(char from,
char toExclusive,
int step) |
static Array<Double> |
rangeBy(double from,
double toExclusive,
double step) |
static Array<Integer> |
rangeBy(int from,
int toExclusive,
int step)
Creates a Array of int numbers starting from
from , extending to toExclusive - 1 ,
with step . |
static Array<Long> |
rangeBy(long from,
long toExclusive,
long step)
Creates a Array of long numbers starting from
from , extending to toExclusive - 1 ,
with step . |
static Array<Character> |
rangeClosed(char from,
char toInclusive) |
static Array<Integer> |
rangeClosed(int from,
int toInclusive)
Creates a Array of int numbers starting from
from , extending to toInclusive . |
static Array<Long> |
rangeClosed(long from,
long toInclusive)
Creates a Array of long numbers starting from
from , extending to toInclusive . |
static Array<Character> |
rangeClosedBy(char from,
char toInclusive,
int step) |
static Array<Double> |
rangeClosedBy(double from,
double toInclusive,
double step) |
static Array<Integer> |
rangeClosedBy(int from,
int toInclusive,
int step)
Creates a Array of int numbers starting from
from , extending to toInclusive ,
with step . |
static Array<Long> |
rangeClosedBy(long from,
long toInclusive,
long step)
Creates a Array of long numbers starting from
from , extending to toInclusive ,
with step . |
Array<T> |
remove(T element)
Removes the first occurrence of the given element.
|
Array<T> |
removeAll(Iterable<? extends T> elements)
Removes all occurrences of the given elements.
|
Array<T> |
removeAll(Predicate<? super T> predicate)
Returns a new Seq consisting of all elements which do not satisfy the given predicate.
|
Array<T> |
removeAll(T element)
Removes all occurrences of the given element.
|
Array<T> |
removeAt(int index)
Removes the element at the specified position in this sequence.
|
Array<T> |
removeFirst(Predicate<T> predicate)
Removes the first occurrence that satisfy predicate
|
Array<T> |
removeLast(Predicate<T> predicate)
Removes the last occurrence that satisfy predicate
|
Array<T> |
replace(T currentElement,
T newElement)
Replaces the first occurrence (if exists) of the given currentElement with newElement.
|
Array<T> |
replaceAll(T currentElement,
T newElement)
Replaces all occurrences of the given currentElement with newElement.
|
Array<T> |
retainAll(Iterable<? extends T> elements)
Keeps all occurrences of the given elements from this.
|
Array<T> |
reverse()
Reverses the order of elements.
|
Array<T> |
scan(T zero,
BiFunction<? super T,? super T,? extends T> operation)
Computes a prefix scan of the elements of the collection.
|
<U> Array<U> |
scanLeft(U zero,
BiFunction<? super U,? super T,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going left to right.
|
<U> Array<U> |
scanRight(U zero,
BiFunction<? super T,? super U,? extends U> operation)
Produces a collection containing cumulative results of applying the
operator going right to left.
|
Array<T> |
shuffle()
Randomize the order of the elements in the current sequence.
|
Array<T> |
slice(int beginIndex,
int endIndex)
Returns a Seq that is a slice of this.
|
Iterator<Array<T>> |
sliding(int size)
Slides a window of a specific
size and step size 1 over this Traversable by calling
Traversable.sliding(int, int) . |
Iterator<Array<T>> |
sliding(int size,
int step)
Slides a window of a specific
size and step size over this Traversable . |
<U> Array<T> |
sortBy(Comparator<? super U> comparator,
Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper . |
<U extends Comparable<? super U>> |
sortBy(Function<? super T,? extends U> mapper)
Sorts this elements by comparing the elements in a different domain, using the given
mapper . |
Array<T> |
sorted()
Sorts this elements according to their natural order.
|
Array<T> |
sorted(Comparator<? super T> comparator)
Sorts this elements according to the provided
Comparator . |
Tuple2<Array<T>,Array<T>> |
span(Predicate<? super T> predicate)
Returns a tuple where the first element is the longest prefix of elements that satisfy the given
predicate and the second element is the remainder. |
Tuple2<Array<T>,Array<T>> |
splitAt(int n)
Splits a Seq at the specified index.
|
Tuple2<Array<T>,Array<T>> |
splitAt(Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate , e.g. |
Tuple2<Array<T>,Array<T>> |
splitAtInclusive(Predicate<? super T> predicate)
Splits a sequence at the first element which satisfies the
Predicate , e.g. |
Spliterator<T> |
spliterator() |
String |
stringPrefix()
Returns the name of this Value type, which is used by toString().
|
Array<T> |
subSequence(int beginIndex)
Returns a Seq that is a subsequence of this.
|
Array<T> |
subSequence(int beginIndex,
int endIndex)
Returns a Seq that is a subsequence of this.
|
static <T> Array<T> |
tabulate(int n,
Function<? super Integer,? extends T> f)
Returns an Array containing
n values of a given Function f
over a range of integer values from 0 to n - 1 . |
Array<T> |
tail()
Drops the first element of a non-empty Traversable.
|
Option<Array<T>> |
tailOption()
Drops the first element of a non-empty Traversable and returns an
Option . |
Array<T> |
take(int n)
Takes the first n elements of this or all elements, if this length < n.
|
Array<T> |
takeRight(int n)
Takes the last n elements of this or all elements, if this length < n.
|
Array<T> |
takeUntil(Predicate<? super T> predicate)
Takes elements until the predicate holds for the current element.
|
Array<T> |
takeWhile(Predicate<? super T> predicate)
Takes elements while the predicate holds for the current element.
|
String |
toString()
Clarifies that values have a proper toString() method implemented.
|
<U> U |
transform(Function<? super Array<T>,? extends U> f)
Transforms this
Array . |
static <T> Array<T> |
unfold(T seed,
Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
Creates an Array from a seed value and a function.
|
static <T,U> Array<U> |
unfoldLeft(T seed,
Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
Creates an Array from a seed value and a function.
|
static <T,U> Array<U> |
unfoldRight(T seed,
Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
Creates a Array from a seed value and a function.
|
<U> Array<U> |
unit(Iterable<? extends U> iterable) |
<T1,T2> Tuple2<Array<T1>,Array<T2>> |
unzip(Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Unzips this elements by mapping this elements to pairs which are subsequently split into two distinct
sets.
|
<T1,T2,T3> Tuple3<Array<T1>,Array<T2>,Array<T3>> |
unzip3(Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Unzips this elements by mapping this elements to triples which are subsequently split into three distinct
sets.
|
Array<T> |
update(int index,
T element)
Updates the given element at the specified index.
|
<U> Array<Tuple2<T,U>> |
zip(Iterable<? extends U> that)
Returns a traversable formed from this traversable and another Iterable collection by combining
corresponding elements in pairs.
|
<U> Array<Tuple2<T,U>> |
zipAll(Iterable<? extends U> that,
T thisElem,
U thatElem)
Returns a traversable formed from this traversable and another Iterable by combining corresponding elements in
pairs.
|
<U,R> Array<R> |
zipWith(Iterable<? extends U> that,
BiFunction<? super T,? super U,? extends R> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
Array<Tuple2<T,Integer>> |
zipWithIndex()
Zips this traversable with its indices.
|
<U> Array<U> |
zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)
Returns a traversable formed from this traversable and another Iterable collection by mapping elements.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
endsWith, indexWhere, last, lastIndexOfSlice, lastIndexWhere, narrow, reverseIterator, search, search, segmentLength, startsWith
apply, containsSlice, crossProduct, crossProduct, foldRight, indexOf, indexOfOption, indexOfOption, indexOfSlice, indexOfSlice, indexOfSliceOption, indexOfSliceOption, indexWhere, indexWhereOption, indexWhereOption, iterator, lastIndexOf, lastIndexOfOption, lastIndexOfOption, lastIndexOfSlice, lastIndexOfSliceOption, lastIndexOfSliceOption, lastIndexWhere, lastIndexWhereOption, lastIndexWhereOption, lift, narrow, prefixLength, startsWith, withDefault, withDefaultValue
average, containsAll, count, existsUnique, find, findLast, foldLeft, get, hash, headOption, isDistinct, isOrdered, isSingleValued, lastOption, max, maxBy, maxBy, min, minBy, minBy, mkCharSeq, mkCharSeq, mkCharSeq, mkString, mkString, mkString, narrow, nonEmpty, product, reduceLeft, reduceLeftOption, reduceRight, reduceRightOption, single, singleOption, size, sum
fold, reduce, reduceOption
collect, collect, contains, corresponds, eq, exists, forAll, forEach, getOption, getOrElse, getOrElse, getOrElseThrow, getOrElseTry, narrow, out, out, stderr, stdout, toArray, toCharSeq, toEither, toEither, toInvalid, toInvalid, toJavaArray, toJavaArray, toJavaCollection, toJavaList, toJavaList, toJavaMap, toJavaMap, toJavaMap, toJavaOptional, toJavaParallelStream, toJavaSet, toJavaSet, toJavaStream, toLeft, toLeft, toLinkedMap, toLinkedMap, toLinkedSet, toList, toMap, toMap, toOption, toPriorityQueue, toPriorityQueue, toQueue, toRight, toRight, toSet, toSortedMap, toSortedMap, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toStack, toStream, toTree, toTry, toTry, toValid, toValid, toValidation, toValidation, toVector
andThen, arity, compose, constant, curried, identity, lift, liftTry, memoized, reversed, tupled
isMemoized
public static <T> Collector<T,ArrayList<T>,Array<T>> collector()
Collector
which may be used in conjunction with
Stream.collect(java.util.stream.Collector)
to obtain a Array
.T
- Component type of the Array.Array
Collector.public static <T> Array<T> empty()
public static <T> Array<T> narrow(Array<? extends T> array)
Array<? extends T>
to Array<T>
by performing a type-safe cast. This is eligible because immutable/read-only
collections are covariant.T
- Component type of the Array
.array
- An Array
.array
instance as narrowed type Array<T>
.public static <T> Array<T> of(T element)
Array
, i.e. a Array
of one element.@SafeVarargs public static <T> Array<T> of(T... elements)
T
- Component type of the Array.elements
- Zero or more elements.NullPointerException
- if elements
is nullpublic static <T> Array<T> ofAll(Iterable<? extends T> elements)
The resulting Array has the same iteration order as the given iterable of elements if the iteration order of the elements is stable.
T
- Component type of the Array.elements
- An Iterable of elements.NullPointerException
- if elements
is nullpublic static <T> Array<T> ofAll(Stream<? extends T> javaStream)
Stream
.T
- Component type of the Stream.javaStream
- A Stream
public static Array<Boolean> ofAll(boolean[] array)
array
- a boolean arraypublic static Array<Byte> ofAll(byte[] array)
array
- a byte arraypublic static Array<Character> ofAll(char[] array)
array
- a char arraypublic static Array<Double> ofAll(double[] array)
array
- a double arraypublic static Array<Float> ofAll(float[] array)
array
- a float arraypublic static Array<Integer> ofAll(int[] array)
array
- an int arraypublic static Array<Long> ofAll(long[] array)
array
- a long arraypublic static Array<Short> ofAll(short[] array)
array
- a short arraypublic static <T> Array<T> tabulate(int n, Function<? super Integer,? extends T> f)
n
values of a given Function f
over a range of integer values from 0 to n - 1
.T
- Component type of the Arrayn
- The number of elements in the Arrayf
- The Function computing element valuesf(0),f(1), ..., f(n - 1)
NullPointerException
- if f
is nullpublic static <T> Array<T> fill(int n, Supplier<? extends T> s)
n
values supplied by a given Supplier s
.T
- Component type of the Arrayn
- The number of elements in the Arrays
- The Supplier computing element valuesn
, where each element contains the result supplied by s
.NullPointerException
- if s
is null@GwtIncompatible public static Array<Double> rangeBy(double from, double toExclusive, double step)
public static Array<Integer> range(int from, int toExclusive)
from
, extending to toExclusive - 1
.
Examples:
Array.range(0, 0) // = Array()
Array.range(2, 0) // = Array()
Array.range(-2, 2) // = Array(-2, -1, 0, 1)
from
- the first numbertoExclusive
- the last number + 1from >= toExclusive
public static Array<Integer> rangeBy(int from, int toExclusive, int step)
from
, extending to toExclusive - 1
,
with step
.
Examples:
Array.rangeBy(1, 3, 1) // = Array(1, 2)
Array.rangeBy(1, 4, 2) // = Array(1, 3)
Array.rangeBy(4, 1, -2) // = Array(4, 2)
Array.rangeBy(4, 1, 2) // = Array()
from
- the first numbertoExclusive
- the last number + 1step
- the stepfrom >= toInclusive
and step > 0
orfrom <= toInclusive
and step < 0
IllegalArgumentException
- if step
is zeropublic static Array<Long> range(long from, long toExclusive)
from
, extending to toExclusive - 1
.
Examples:
Array.range(0L, 0L) // = Array()
Array.range(2L, 0L) // = Array()
Array.range(-2L, 2L) // = Array(-2L, -1L, 0L, 1L)
from
- the first numbertoExclusive
- the last number + 1from >= toExclusive
public static Array<Long> rangeBy(long from, long toExclusive, long step)
from
, extending to toExclusive - 1
,
with step
.
Examples:
Array.rangeBy(1L, 3L, 1L) // = Array(1L, 2L)
Array.rangeBy(1L, 4L, 2L) // = Array(1L, 3L)
Array.rangeBy(4L, 1L, -2L) // = Array(4L, 2L)
Array.rangeBy(4L, 1L, 2L) // = Array()
from
- the first numbertoExclusive
- the last number + 1step
- the stepfrom >= toInclusive
and step > 0
orfrom <= toInclusive
and step < 0
IllegalArgumentException
- if step
is zero@GwtIncompatible public static Array<Double> rangeClosedBy(double from, double toInclusive, double step)
public static Array<Integer> rangeClosed(int from, int toInclusive)
from
, extending to toInclusive
.
Examples:
Array.rangeClosed(0, 0) // = Array(0)
Array.rangeClosed(2, 0) // = Array()
Array.rangeClosed(-2, 2) // = Array(-2, -1, 0, 1, 2)
from
- the first numbertoInclusive
- the last numberfrom > toInclusive
public static Array<Integer> rangeClosedBy(int from, int toInclusive, int step)
from
, extending to toInclusive
,
with step
.
Examples:
Array.rangeClosedBy(1, 3, 1) // = Array(1, 2, 3)
Array.rangeClosedBy(1, 4, 2) // = Array(1, 3)
Array.rangeClosedBy(4, 1, -2) // = Array(4, 2)
Array.rangeClosedBy(4, 1, 2) // = Array()
from
- the first numbertoInclusive
- the last numberstep
- the stepfrom > toInclusive
and step > 0
orfrom < toInclusive
and step < 0
IllegalArgumentException
- if step
is zeropublic static Array<Long> rangeClosed(long from, long toInclusive)
from
, extending to toInclusive
.
Examples:
Array.rangeClosed(0L, 0L) // = Array(0L)
Array.rangeClosed(2L, 0L) // = Array()
Array.rangeClosed(-2L, 2L) // = Array(-2L, -1L, 0L, 1L, 2L)
from
- the first numbertoInclusive
- the last numberfrom > toInclusive
public static Array<Long> rangeClosedBy(long from, long toInclusive, long step)
from
, extending to toInclusive
,
with step
.
Examples:
Array.rangeClosedBy(1L, 3L, 1L) // = Array(1L, 2L, 3L)
Array.rangeClosedBy(1L, 4L, 2L) // = Array(1L, 3L)
Array.rangeClosedBy(4L, 1L, -2L) // = Array(4L, 2L)
Array.rangeClosedBy(4L, 1L, 2L) // = Array()
from
- the first numbertoInclusive
- the last numberstep
- the stepfrom > toInclusive
and step > 0
orfrom < toInclusive
and step < 0
IllegalArgumentException
- if step
is zeropublic static <T,U> Array<U> unfoldRight(T seed, Function<? super T,Option<Tuple2<? extends U,? extends T>>> f)
None
when it's
done generating the Array, otherwise Some
Tuple
of the element for the next call and the value to add to the
resulting Array.
Example:
Array.unfoldRight(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<gt;(x, x-1)));
// Array(10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
T
- type of seedsU
- type of unfolded valuesseed
- the start value for the iterationf
- the function to get the next step of the iterationNullPointerException
- if f
is nullpublic static <T,U> Array<U> unfoldLeft(T seed, Function<? super T,Option<Tuple2<? extends T,? extends U>>> f)
None
when it's
done generating the list, otherwise Some
Tuple
of the value to add to the resulting list and
the element for the next call.
Example:
Array.unfoldLeft(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<gt;(x-1, x)));
// Array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
T
- type of seedsU
- type of unfolded valuesseed
- the start value for the iterationf
- the function to get the next step of the iterationNullPointerException
- if f
is nullpublic static <T> Array<T> unfold(T seed, Function<? super T,Option<Tuple2<? extends T,? extends T>>> f)
None
when it's
done generating the list, otherwise Some
Tuple
of the value to add to the resulting list and
the element for the next call.
Example:
Array.unfold(10, x -> x == 0
? Option.none()
: Option.of(new Tuple2<gt;(x-1, x)));
// Array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))
T
- type of seeds and unfolded valuesseed
- the start value for the iterationf
- the function to get the next step of the iterationNullPointerException
- if f
is nullpublic Array<T> append(T element)
Seq
public Array<T> appendAll(Iterable<? extends T> elements)
Seq
public boolean hasDefiniteSize()
Traversable
This method should be implemented by classes only, i.e. not by interfaces.
hasDefiniteSize
in interface Traversable<T>
public boolean isTraversableAgain()
Traversable
This method should be implemented by classes only, i.e. not by interfaces.
isTraversableAgain
in interface Traversable<T>
public Iterator<T> iterator()
Traversable
public Array<Array<T>> combinations()
Seq
Examples:
[].combinations() = [[]]
[1,2,3].combinations() = [
[], // k = 0
[1], [2], [3], // k = 1
[1,2], [1,3], [2,3], // k = 2
[1,2,3] // k = 3
]
combinations
in interface IndexedSeq<T>
combinations
in interface Seq<T>
public Array<Array<T>> combinations(int k)
Seq
combinations
in interface IndexedSeq<T>
combinations
in interface Seq<T>
k
- Size of subsetspublic Iterator<Array<T>> crossProduct(int power)
Seq
Example:
// = ((A,A), (A,B), (A,C), ..., (B,A), (B,B), ..., (Z,Y), (Z,Z))
CharSeq.rangeClosed('A', 'Z').crossProduct(2);
Cartesian power of negative value will return empty iterator.
Example:
// = ()
CharSeq.rangeClosed('A', 'Z').crossProduct(-1);
crossProduct
in interface IndexedSeq<T>
crossProduct
in interface Seq<T>
power
- the number of cartesian multiplicationspublic T get(int index)
Seq
public Array<T> distinct()
Traversable
equals
.distinct
in interface IndexedSeq<T>
distinct
in interface Seq<T>
distinct
in interface Traversable<T>
Traversable
containing this elements without duplicatespublic Array<T> distinctBy(Comparator<? super T> comparator)
Traversable
comparator
.distinctBy
in interface IndexedSeq<T>
distinctBy
in interface Seq<T>
distinctBy
in interface Traversable<T>
comparator
- A comparatorTraversable
containing this elements without duplicatespublic <U> Array<T> distinctBy(Function<? super T,? extends U> keyExtractor)
Traversable
equals
.
The elements of the result are determined in the order of their occurrence - first match wins.
distinctBy
in interface IndexedSeq<T>
distinctBy
in interface Seq<T>
distinctBy
in interface Traversable<T>
U
- key typekeyExtractor
- A key extractorTraversable
containing this elements without duplicatespublic Array<T> drop(int n)
Traversable
drop
in interface IndexedSeq<T>
drop
in interface Seq<T>
drop
in interface Traversable<T>
n
- The number of elements to drop.public Array<T> dropRight(int n)
Traversable
dropRight
in interface IndexedSeq<T>
dropRight
in interface Seq<T>
dropRight
in interface Traversable<T>
n
- The number of elements to drop.public Array<T> dropUntil(Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as dropWhile(predicate.negate())
. It is intended to be used with
method references, which cannot be negated directly.
dropUntil
in interface IndexedSeq<T>
dropUntil
in interface Seq<T>
dropUntil
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Array<T> dropWhile(Predicate<? super T> predicate)
Traversable
dropWhile
in interface IndexedSeq<T>
dropWhile
in interface Seq<T>
dropWhile
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements starting with the first.public Array<T> filter(Predicate<? super T> predicate)
Traversable
filter
in interface IndexedSeq<T>
filter
in interface Seq<T>
filter
in interface Traversable<T>
predicate
- A predicatepublic <U> Array<U> flatMap(Function<? super T,? extends Iterable<? extends U>> mapper)
Traversable
flatMap
in interface IndexedSeq<T>
flatMap
in interface Seq<T>
flatMap
in interface Traversable<T>
U
- The resulting component type.mapper
- A mapperpublic <C> Map<C,Array<T>> groupBy(Function<? super T,? extends C> classifier)
Traversable
groupBy
in interface IndexedSeq<T>
groupBy
in interface Seq<T>
groupBy
in interface Traversable<T>
C
- classified class typeclassifier
- A function which classifies elements into classespublic Iterator<Array<T>> grouped(int size)
Traversable
Traversable
into fixed size blocks.
Let length be the length of this Iterable. Then grouped is defined as follows:
this.isEmpty()
, the resulting Iterator
is empty.size <= length
, the resulting Iterator
will contain length / size
blocks of size
size
and maybe a non-empty block of size length % size
, if there are remaining elements.size > length
, the resulting Iterator
will contain one block of size length
.
[].grouped(1) = []
[].grouped(0) throws
[].grouped(-1) throws
[1,2,3,4].grouped(2) = [[1,2],[3,4]]
[1,2,3,4,5].grouped(2) = [[1,2],[3,4],[5]]
[1,2,3,4].grouped(5) = [[1,2,3,4]]
Please note that grouped(int)
is a special case of Traversable.sliding(int, int), i.e.
grouped(size)
is the same as sliding(size, size)
.grouped
in interface IndexedSeq<T>
grouped
in interface Seq<T>
grouped
in interface Traversable<T>
size
- a positive block sizepublic T head()
Traversable
head
in interface Traversable<T>
public int indexOf(T element, int from)
Seq
public Array<T> init()
Traversable
init
in interface IndexedSeq<T>
init
in interface Seq<T>
init
in interface Traversable<T>
public Option<Array<T>> initOption()
Traversable
Option
.initOption
in interface IndexedSeq<T>
initOption
in interface Seq<T>
initOption
in interface Traversable<T>
Some(traversable)
or None
if this is empty.public boolean isEmpty()
Traversable
public Array<T> insert(int index, T element)
Seq
public Array<T> insertAll(int index, Iterable<? extends T> elements)
Seq
public Array<T> intersperse(T element)
Seq
intersperse
in interface IndexedSeq<T>
intersperse
in interface Seq<T>
element
- An element.public int lastIndexOf(T element, int end)
Seq
lastIndexOf
in interface Seq<T>
element
- an elementend
- the end indexpublic int length()
Traversable
Same as Traversable.size()
.
length
in interface Traversable<T>
public <U> Array<U> map(Function<? super T,? extends U> mapper)
Traversable
Traversable
to elements of a new type preserving their order, if any.public Array<T> padTo(int length, T element)
Seq
Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
padTo
in interface IndexedSeq<T>
padTo
in interface Seq<T>
length
- the target lengthelement
- the padding elementelement
so that the resulting sequence has a length of at least length
.public Array<T> leftPadTo(int length, T element)
Seq
Note: lazily-evaluated Seq implementations need to process all elements in order to gather the overall length.
leftPadTo
in interface Seq<T>
length
- the target lengthelement
- the padding elementelement
so that the resulting sequence has a length of at least length
.public Array<T> patch(int from, Iterable<? extends T> that, int replaced)
Seq
public Tuple2<Array<T>,Array<T>> partition(Predicate<? super T> predicate)
Traversable
Traversable
by splitting this elements in two in distinct tarversables
according to a predicate.partition
in interface IndexedSeq<T>
partition
in interface Seq<T>
partition
in interface Traversable<T>
predicate
- A predicate which classifies an element if it is in the first or the second traversable.Traversable
contains all elements that satisfy the given predicate
, the second Traversable
contains all elements that don't. The original order of elements is preserved.public Array<T> peek(Consumer<? super T> action)
Value
action
on the first element if this is an eager implementation.
Performs the given action
on all elements (the first immediately, successive deferred),
if this is a lazy implementation.public Array<Array<T>> permutations()
Seq
Example:
[].permutations() = []
[1,2,3].permutations() = [
[1,2,3],
[1,3,2],
[2,1,3],
[2,3,1],
[3,1,2],
[3,2,1]
]
permutations
in interface IndexedSeq<T>
permutations
in interface Seq<T>
public Array<T> prepend(T element)
Seq
public Array<T> prependAll(Iterable<? extends T> elements)
Seq
prependAll
in interface IndexedSeq<T>
prependAll
in interface Seq<T>
elements
- An Iterable of elementspublic Array<T> remove(T element)
Seq
public Array<T> removeFirst(Predicate<T> predicate)
Seq
removeFirst
in interface IndexedSeq<T>
removeFirst
in interface Seq<T>
predicate
- an predicatepublic Array<T> removeLast(Predicate<T> predicate)
Seq
removeLast
in interface IndexedSeq<T>
removeLast
in interface Seq<T>
predicate
- an predicatepublic Array<T> removeAt(int index)
Seq
public Array<T> removeAll(T element)
Seq
public Array<T> removeAll(Iterable<? extends T> elements)
Seq
public Array<T> removeAll(Predicate<? super T> predicate)
Seq
public Array<T> replace(T currentElement, T newElement)
Traversable
replace
in interface IndexedSeq<T>
replace
in interface Seq<T>
replace
in interface Traversable<T>
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.public Array<T> replaceAll(T currentElement, T newElement)
Traversable
replaceAll
in interface IndexedSeq<T>
replaceAll
in interface Seq<T>
replaceAll
in interface Traversable<T>
currentElement
- An element to be substituted.newElement
- A replacement for currentElement.public Array<T> retainAll(Iterable<? extends T> elements)
Traversable
retainAll
in interface IndexedSeq<T>
retainAll
in interface Seq<T>
retainAll
in interface Traversable<T>
elements
- Elements to be kept.public Array<T> reverse()
Seq
public Array<T> scan(T zero, BiFunction<? super T,? super T,? extends T> operation)
Traversable
scan
in interface IndexedSeq<T>
scan
in interface Seq<T>
scan
in interface Traversable<T>
zero
- neutral element for the operator opoperation
- the associative operator for the scanpublic <U> Array<U> scanLeft(U zero, BiFunction<? super U,? super T,? extends U> operation)
Traversable
scanLeft
in interface IndexedSeq<T>
scanLeft
in interface Seq<T>
scanLeft
in interface Traversable<T>
U
- the type of the elements in the resulting collectionzero
- the initial valueoperation
- the binary operator applied to the intermediate result and the elementpublic <U> Array<U> scanRight(U zero, BiFunction<? super T,? super U,? extends U> operation)
Traversable
scanRight
in interface IndexedSeq<T>
scanRight
in interface Seq<T>
scanRight
in interface Traversable<T>
U
- the type of the elements in the resulting collectionzero
- the initial valueoperation
- the binary operator applied to the intermediate result and the elementpublic Array<T> shuffle()
Seq
public Array<T> slice(int beginIndex, int endIndex)
Seq
beginIndex
and extends to the element at index endIndex - 1
.
Examples:
List.of(1, 2, 3, 4).slice(1, 3); // = (2, 3)
List.of(1, 2, 3, 4).slice(0, 4); // = (1, 2, 3, 4)
List.of(1, 2, 3, 4).slice(2, 2); // = ()
List.of(1, 2).slice(1, 0); // = ()
List.of(1, 2).slice(-10, 10); // = (1, 2)
See also Seq.subSequence(int, int)
which throws in some cases instead of returning a sequence.public Iterator<Array<T>> sliding(int size)
Traversable
size
and step size 1 over this Traversable
by calling
Traversable.sliding(int, int)
.sliding
in interface IndexedSeq<T>
sliding
in interface Seq<T>
sliding
in interface Traversable<T>
size
- a positive window sizepublic Iterator<Array<T>> sliding(int size, int step)
Traversable
size
and step
size over this Traversable
.
Examples:
[].sliding(1,1) = []
[1,2,3,4,5].sliding(2,3) = [[1,2],[4,5]]
[1,2,3,4,5].sliding(2,4) = [[1,2],[5]]
[1,2,3,4,5].sliding(2,5) = [[1,2]]
[1,2,3,4].sliding(5,3) = [[1,2,3,4],[4]]
sliding
in interface IndexedSeq<T>
sliding
in interface Seq<T>
sliding
in interface Traversable<T>
size
- a positive window sizestep
- a positive step sizepublic Array<T> sorted()
Seq
Comparable
, a java.lang.ClassCastException
may be thrown.public Array<T> sorted(Comparator<? super T> comparator)
Seq
Comparator
. If this elements are not
Comparable
, a java.lang.ClassCastException
may be thrown.public <U extends Comparable<? super U>> Array<T> sortBy(Function<? super T,? extends U> mapper)
Seq
mapper
.public <U> Array<T> sortBy(Comparator<? super U> comparator, Function<? super T,? extends U> mapper)
Seq
mapper
.public Tuple2<Array<T>,Array<T>> splitAt(int n)
Seq
splitAt(n)
is equivalent to
Tuple.of(take(n), drop(n))
.public Tuple2<Array<T>,Array<T>> splitAt(Predicate<? super T> predicate)
Seq
Predicate
, e.g. Tuple(init, element+tail).public Tuple2<Array<T>,Array<T>> splitAtInclusive(Predicate<? super T> predicate)
Seq
Predicate
, e.g. Tuple(init+element, tail).splitAtInclusive
in interface Seq<T>
predicate
- An predicateTuple
containing divided sequencespublic Spliterator<T> spliterator()
spliterator
in interface Iterable<T>
public Tuple2<Array<T>,Array<T>> span(Predicate<? super T> predicate)
Traversable
predicate
and the second element is the remainder.span
in interface IndexedSeq<T>
span
in interface Seq<T>
span
in interface Traversable<T>
predicate
- A predicate.public Array<T> subSequence(int beginIndex)
Seq
beginIndex
and extends to the end of this Seq.
Examples:
List.of(1, 2).subSequence(0); // = (1, 2)
List.of(1, 2).subSequence(1); // = (2)
List.of(1, 2).subSequence(2); // = ()
List.of(1, 2).subSequence(10); // throws IndexOutOfBoundsException
List.of(1, 2).subSequence(-10); // throws IndexOutOfBoundsException
See also Seq.drop(int)
which is similar but does not throw.subSequence
in interface IndexedSeq<T>
subSequence
in interface Seq<T>
beginIndex
- the beginning index, inclusivepublic Array<T> subSequence(int beginIndex, int endIndex)
Seq
beginIndex
and extends to the element at index endIndex - 1
.
Examples:
List.of(1, 2, 3, 4).subSequence(1, 3); // = (2, 3)
List.of(1, 2, 3, 4).subSequence(0, 4); // = (1, 2, 3, 4)
List.of(1, 2, 3, 4).subSequence(2, 2); // = ()
List.of(1, 2).subSequence(1, 0); // throws IndexOutOfBoundsException
List.of(1, 2).subSequence(-10, 1); // throws IndexOutOfBoundsException
List.of(1, 2).subSequence(0, 10); // throws IndexOutOfBoundsException
See also Seq.slice(int, int)
which returns an empty sequence instead of throwing.subSequence
in interface IndexedSeq<T>
subSequence
in interface Seq<T>
beginIndex
- the beginning index, inclusiveendIndex
- the end index, exclusivepublic Array<T> tail()
Traversable
tail
in interface IndexedSeq<T>
tail
in interface Seq<T>
tail
in interface Traversable<T>
public Option<Array<T>> tailOption()
Traversable
Option
.tailOption
in interface IndexedSeq<T>
tailOption
in interface Seq<T>
tailOption
in interface Traversable<T>
Some(traversable)
or None
if this is empty.public Array<T> take(int n)
Traversable
The result is equivalent to sublist(0, max(0, min(length(), n)))
but does not throw if n < 0
or
n > length()
.
In the case of n < 0
the empty instance is returned, in the case of n > length()
this is returned.
take
in interface IndexedSeq<T>
take
in interface Seq<T>
take
in interface Traversable<T>
n
- The number of elements to take.public Array<T> takeRight(int n)
Traversable
The result is equivalent to sublist(max(0, min(length(), length() - n)), n)
, i.e. takeRight will not
throw if n < 0
or n > length()
.
In the case of n < 0
the empty instance is returned, in the case of n > length()
this is returned.
takeRight
in interface IndexedSeq<T>
takeRight
in interface Seq<T>
takeRight
in interface Traversable<T>
n
- The number of elements to take.public Array<T> takeUntil(Predicate<? super T> predicate)
Traversable
Note: This is essentially the same as takeWhile(predicate.negate())
. It is intended to be used with
method references, which cannot be negated directly.
takeUntil
in interface IndexedSeq<T>
takeUntil
in interface Seq<T>
takeUntil
in interface Traversable<T>
predicate
- A condition tested subsequently for this elements.public Array<T> takeWhile(Predicate<? super T> predicate)
Traversable
takeWhile
in interface IndexedSeq<T>
takeWhile
in interface Seq<T>
takeWhile
in interface Traversable<T>
predicate
- A condition tested subsequently for the contained elements.public <U> U transform(Function<? super Array<T>,? extends U> f)
Array
.U
- Type of transformation resultf
- A transformationU
NullPointerException
- if f
is nullpublic <T1,T2> Tuple2<Array<T1>,Array<T2>> unzip(Function<? super T,Tuple2<? extends T1,? extends T2>> unzipper)
Traversable
unzip
in interface IndexedSeq<T>
unzip
in interface Seq<T>
unzip
in interface Traversable<T>
T1
- 1st element type of a pair returned by unzipperT2
- 2nd element type of a pair returned by unzipperunzipper
- a function which converts elements of this to pairspublic <T1,T2,T3> Tuple3<Array<T1>,Array<T2>,Array<T3>> unzip3(Function<? super T,Tuple3<? extends T1,? extends T2,? extends T3>> unzipper)
Traversable
unzip3
in interface IndexedSeq<T>
unzip3
in interface Seq<T>
unzip3
in interface Traversable<T>
T1
- 1st element type of a triplet returned by unzipperT2
- 2nd element type of a triplet returned by unzipperT3
- 3rd element type of a triplet returned by unzipperunzipper
- a function which converts elements of this to pairspublic Array<T> update(int index, T element)
Seq
public <U> Array<Tuple2<T,U>> zip(Iterable<? extends U> that)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zip
in interface IndexedSeq<T>
zip
in interface Seq<T>
zip
in interface Traversable<T>
U
- The type of the second half of the returned pairs.that
- The Iterable providing the second half of each result pair.that
iterable.public <U,R> Array<R> zipWith(Iterable<? extends U> that, BiFunction<? super T,? super U,? extends R> mapper)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zipWith
in interface IndexedSeq<T>
zipWith
in interface Seq<T>
zipWith
in interface Traversable<T>
U
- The type of the second parameter of the mapper.R
- The type of the mapped elements.that
- The Iterable providing the second parameter of the mapper.mapper
- a mapper.that
iterable.public <U> Array<Tuple2<T,U>> zipAll(Iterable<? extends U> that, T thisElem, U thatElem)
Traversable
The length of the returned traversable is the maximum of the lengths of this traversable and that
iterable.
Special case: if this traversable is shorter than that elements, and that elements contains duplicates, the resulting traversable may be shorter than the maximum of the lengths of this and that because a traversable contains an element at most once.
If this Traversable is shorter than that, thisElem values are used to fill the result. If that is shorter than this Traversable, thatElem values are used to fill the result.
zipAll
in interface IndexedSeq<T>
zipAll
in interface Seq<T>
zipAll
in interface Traversable<T>
U
- The type of the second half of the returned pairs.that
- The Iterable providing the second half of each result pair.thisElem
- The element to be used to fill up the result if this traversable is shorter than that.thatElem
- The element to be used to fill up the result if that is shorter than this traversable.public Array<Tuple2<T,Integer>> zipWithIndex()
Traversable
zipWithIndex
in interface IndexedSeq<T>
zipWithIndex
in interface Seq<T>
zipWithIndex
in interface Traversable<T>
public <U> Array<U> zipWithIndex(BiFunction<? super T,? super Integer,? extends U> mapper)
Traversable
The length of the returned traversable is the minimum of the lengths of this traversable and that
iterable.
zipWithIndex
in interface IndexedSeq<T>
zipWithIndex
in interface Seq<T>
zipWithIndex
in interface Traversable<T>
U
- The type of the mapped elements.mapper
- a mapper.that
iterable.public boolean equals(Object o)
Value
public int hashCode()
Value
See Object.hashCode().
public String stringPrefix()
Value
stringPrefix
in interface Value<T>
Copyright © 2016. All Rights Reserved.