Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed GenTraversableOnce
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed GenTraversableOnce
.
The element type of the resulting NonEmptyList
is the most specific superclass encompassing the element types of this NonEmptyList
and the passed GenTraversableOnce
.
the element type of the returned NonEmptyList
the GenTraversableOnce
to append
a new NonEmptyList
that contains all the elements of this NonEmptyList
followed by all elements of other
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed Every
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed Every
.
The element type of the resulting NonEmptyList
is the most specific superclass encompassing the element types of this NonEmptyList
and the passed Every
.
the element type of the returned NonEmptyList
the Every
to append
a new NonEmptyList
that contains all the elements of this NonEmptyList
followed by all elements of other
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed NonEmptyList
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed NonEmptyList
.
The element type of the resulting NonEmptyList
is the most specific superclass encompassing the element types of this and the passed NonEmptyList
.
the element type of the returned NonEmptyList
the NonEmptyList
to append
a new NonEmptyList
that contains all the elements of this NonEmptyList
followed by all elements of other
.
Returns a new NonEmptyList
with the given element prepended.
Returns a new NonEmptyList
with the given element prepended.
Note that :-ending operators are right associative. A mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
the element to prepend to this NonEmptyList
a new NonEmptyList
consisting of element
followed by all elements of this NonEmptyList
.
Returns a new NonEmptyList
with the given element appended.
Returns a new NonEmptyList
with the given element appended.
Note a mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
the element to append to this NonEmptyList
a new NonEmptyList
consisting of all elements of this NonEmptyList
followed by element
.
Adds an element to the beginning of this NonEmptyList
.
Adds an element to the beginning of this NonEmptyList
.
Note that :-ending operators are right associative. A mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
the element to prepend to this NonEmptyList
a NonEmptyList
that contains element
as first element and that continues with this NonEmptyList
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed GenTraversableOnce
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed GenTraversableOnce
.
The element type of the resulting NonEmptyList
is the most specific superclass encompassing the element types of this NonEmptyList
and the passed GenTraversableOnce
.
the element type of the returned NonEmptyList
the GenTraversableOnce
to append
a new NonEmptyList
that contains all the elements of this NonEmptyList
followed by all elements of other
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed Every
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed Every
.
The element type of the resulting NonEmptyList
is the most specific superclass encompassing the element types of this and the passed Every
.
the element type of the returned NonEmptyList
the Every
to append
a new NonEmptyList
that contains all the elements of this NonEmptyList
followed by all elements of other
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed NonEmptyList
.
Returns a new NonEmptyList
containing the elements of this NonEmptyList
followed by the elements of the passed NonEmptyList
.
The element type of the resulting NonEmptyList
is the most specific superclass encompassing the element types of this and the passed NonEmptyList
.
the element type of the returned NonEmptyList
the NonEmptyList
to append
a new NonEmptyList
that contains all the elements of this NonEmptyList
followed by all elements of other
.
Appends all elements of this NonEmptyList
to a string builder using start, end, and separator strings.
Appends all elements of this NonEmptyList
to a string builder using start, end, and separator strings. The written text will consist of a concatenation of
the string start
; the result of invoking toString
on all elements of this NonEmptyList
,
separated by the string sep
; and the string end
the string builder to which elements will be appended
the ending string
the separator string
the string builder, sb
, to which elements were appended.
Appends all elements of this NonEmptyList
to a string builder using a separator string.
Appends all elements of this NonEmptyList
to a string builder using a separator string. The written text will consist of a concatenation of the
result of invoking toString
on of every element of this NonEmptyList
, separated by the string sep
.
the string builder to which elements will be appended
the separator string
the string builder, sb
, to which elements were appended.
Appends all elements of this NonEmptyList
to a string builder.
Appends all elements of this NonEmptyList
to a string builder. The written text will consist of a concatenation of the result of invoking toString
on of every element of this NonEmptyList
, without any separator string.
the string builder to which elements will be appended
the string builder, sb
, to which elements were appended.
Selects an element by its index in the NonEmptyList
.
Selects an element by its index in the NonEmptyList
.
the element of this NonEmptyList
at index idx
, where 0 indicates the first element.
Finds the first element of this NonEmptyList
for which the given partial function is defined, if any, and applies the partial function to it.
Finds the first element of this NonEmptyList
for which the given partial function is defined, if any, and applies the partial function to it.
the partial function
an Option
containing pf
applied to the first element for which it is defined, or None
if
the partial function was not defined for any element.
Indicates whether this NonEmptyList
contains a given value as an element.
Indicates whether this NonEmptyList
contains a given value as an element.
the element to look for
true if this NonEmptyList
has an element that is equal (as determined by ==)
to elem
, false otherwise.
Indicates whether this NonEmptyList
contains a given NonEmptyList
as a slice.
Indicates whether this NonEmptyList
contains a given NonEmptyList
as a slice.
the NonEmptyList
slice to look for
true if this NonEmptyList
contains a slice with the same elements as that
, otherwise false
.
Indicates whether this NonEmptyList
contains a given Every
as a slice.
Indicates whether this NonEmptyList
contains a given Every
as a slice.
the Every
slice to look for
true if this NonEmptyList
contains a slice with the same elements as that
, otherwise false
.
Indicates whether this NonEmptyList
contains a given GenSeq
as a slice.
Indicates whether this NonEmptyList
contains a given GenSeq
as a slice.
the GenSeq
slice to look for
true if this NonEmptyList
contains a slice with the same elements as that
, otherwise false
.
Copies values of this NonEmptyList
to an array.
Copies values of this NonEmptyList
to an array. Fills the given array arr
with at most len
elements of this NonEmptyList
, beginning at
index start
. Copying will stop once either the end of the current NonEmptyList
is reached, the end of the array is reached, or
len
elements have been copied.
the array to fill
the starting index
the maximum number of elements to copy
Copies values of this NonEmptyList
to an array.
Copies values of this NonEmptyList
to an array. Fills the given array arr
with values of this NonEmptyList
, beginning at
index start
. Copying will stop once either the end of the current NonEmptyList
is reached, or the end of the array is reached.
the array to fill
the starting index
Copies values of this NonEmptyList
to an array.
Copies values of this NonEmptyList
to an array. Fills the given array arr
with values of this NonEmptyList
. Copying
will stop once either the end of the current NonEmptyList
is reached, or the end of the array is reached.
the array to fill
Copies all elements of this NonEmptyList
to a buffer.
Copies all elements of this NonEmptyList
to a buffer.
the buffer to which elements are copied
Indicates whether every element of this NonEmptyList
relates to the corresponding element of a given NonEmptyList
by satisfying a given predicate.
Indicates whether every element of this NonEmptyList
relates to the corresponding element of a given NonEmptyList
by satisfying a given predicate.
the type of the elements of that
the NonEmptyList
to compare for correspondence
the predicate, which relates elements from this and the passed NonEmptyList
true if this and the passed NonEmptyList
have the same length and p(x, y)
is true
for all corresponding elements x
of this NonEmptyList
and y
of that, otherwise false
.
Indicates whether every element of this NonEmptyList
relates to the corresponding element of a given Every
by satisfying a given predicate.
Indicates whether every element of this NonEmptyList
relates to the corresponding element of a given Every
by satisfying a given predicate.
the type of the elements of that
the Every
to compare for correspondence
the predicate, which relates elements from this NonEmptyList
and the passed Every
true if this NonEmptyList
and the passed Every
have the same length and p(x, y)
is true
for all corresponding elements x
of this NonEmptyList
and y
of that, otherwise false
.
Indicates whether every element of this NonEmptyList
relates to the corresponding element of a given GenSeq
by satisfying a given predicate.
Indicates whether every element of this NonEmptyList
relates to the corresponding element of a given GenSeq
by satisfying a given predicate.
the type of the elements of that
the GenSeq
to compare for correspondence
the predicate, which relates elements from this NonEmptyList
and the passed GenSeq
true if this NonEmptyList
and the passed GenSeq
have the same length and p(x, y)
is true
for all corresponding elements x
of this NonEmptyList
and y
of that, otherwise false
.
Counts the number of elements in this NonEmptyList
that satisfy a predicate.
Counts the number of elements in this NonEmptyList
that satisfy a predicate.
the predicate used to test elements.
the number of elements satisfying the predicate p
.
Builds a new NonEmptyList
from this NonEmptyList
without any duplicate elements.
Builds a new NonEmptyList
from this NonEmptyList
without any duplicate elements.
A new NonEmptyList
that contains the first occurrence of every element of this NonEmptyList
.
Indicates whether this NonEmptyList
ends with the given NonEmptyList
.
Indicates whether this NonEmptyList
ends with the given NonEmptyList
.
the NonEmptyList
to test
true
if this NonEmptyList
has that
as a suffix, false
otherwise.
Indicates whether this NonEmptyList
ends with the given Every
.
Indicates whether this NonEmptyList
ends with the given Every
.
the Every
to test
true
if this NonEmptyList
has that
as a suffix, false
otherwise.
Indicates whether this NonEmptyList
ends with the given GenSeq
.
Indicates whether this NonEmptyList
ends with the given GenSeq
.
the sequence to test
true
if this NonEmptyList
has that
as a suffix, false
otherwise.
Indicates whether a predicate holds for at least one of the elements of this NonEmptyList
.
Indicates whether a predicate holds for at least one of the elements of this NonEmptyList
.
true
if the given predicate p
holds for some of the elements of this NonEmptyList
, otherwise false
.
Finds the first element of this NonEmptyList
that satisfies the given predicate, if any.
Finds the first element of this NonEmptyList
that satisfies the given predicate, if any.
the predicate used to test elements
an Some
containing the first element in this NonEmptyList
that satisfies p
, or None
if none exists.
Builds a new NonEmptyList
by applying a function to all elements of this NonEmptyList
and using the elements of the resulting NonEmptyList
s.
Builds a new NonEmptyList
by applying a function to all elements of this NonEmptyList
and using the elements of the resulting NonEmptyList
s.
the element type of the returned NonEmptyList
the function to apply to each element.
a new NonEmptyList
containing elements obtained by applying the given function f
to each element of this NonEmptyList
and concatenating
the elements of resulting NonEmptyList
s.
Converts this NonEmptyList
of NonEmptyList
s into a NonEmptyList
formed by the elements of the nested NonEmptyList
s.
Converts this NonEmptyList
of NonEmptyList
s into a NonEmptyList
formed by the elements of the nested NonEmptyList
s.
Note: You cannot use this flatten
method on a NonEmptyList
that contains a GenTraversableOnce
s, because
if all the nested GenTraversableOnce
s were empty, you'd end up with an empty NonEmptyList
.
a new NonEmptyList
resulting from concatenating all nested NonEmptyList
s.
Folds the elements of this NonEmptyList
using the specified associative binary operator.
Folds the elements of this NonEmptyList
using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
a type parameter for the binary operator, a supertype of T.
a neutral element for the fold operation; may be added to the result an arbitrary number of
times, and must not change the result (e.g., Nil
for list concatenation,
0 for addition, or 1 for multiplication.)
a binary operator that must be associative
the result of applying fold operator op
between all the elements and z
Applies a binary operator to a start value and all elements of this NonEmptyList
, going left to right.
Applies a binary operator to a start value and all elements of this NonEmptyList
, going left to right.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op
between consecutive elements of this NonEmptyList
, going left to right, with the start value,
z
, on the left:
op(...op(op(z, x_1), x_2), ..., x_n)where x1, ..., xn are the elements of this
NonEmptyList
.Applies a binary operator to all elements of this NonEmptyList
and a start value, going right to left.
Applies a binary operator to all elements of this NonEmptyList
and a start value, going right to left.
the result of the binary operator
the start value
the binary operator
the result of inserting op
between consecutive elements of this NonEmptyList
, going right to left, with the start value,
z
, on the right:
op(x_1, op(x_2, ... op(x_n, z)...))where x1, ..., xn are the elements of this
NonEmptyList
.Indicates whether a predicate holds for all elements of this NonEmptyList
.
Indicates whether a predicate holds for all elements of this NonEmptyList
.
the predicate used to test elements.
true
if the given predicate p
holds for all elements of this NonEmptyList
, otherwise false
.
Applies a function f
to all elements of this NonEmptyList
.
Applies a function f
to all elements of this NonEmptyList
.
the function that is applied for its side-effect to every element. The result of function f
is discarded.
Partitions this NonEmptyList
into a map of NonEmptyList
s according to some discriminator function.
Partitions this NonEmptyList
into a map of NonEmptyList
s according to some discriminator function.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to NonEmptyList
s such that the following invariant holds:
(nonEmptyList.toList partition f)(k) = xs filter (x => f(x) == k)That is, every key
k
is bound to a NonEmptyList
of those elements x
for which f(x)
equals k
.Partitions elements into fixed size NonEmptyList
s.
Partitions elements into fixed size NonEmptyList
s.
the number of elements per group
An iterator producing NonEmptyList
s of size size
, except the last will be truncated if the elements don't divide evenly.
Returns true
to indicate this NonEmptyList
has a definite size, since all NonEmptyList
s are strict collections.
Returns true
to indicate this NonEmptyList
has a definite size, since all NonEmptyList
s are strict collections.
Selects the first element of this NonEmptyList
.
Selects the first element of this NonEmptyList
.
the first element of this NonEmptyList
.
Selects the first element of this NonEmptyList
and returns it wrapped in a Some
.
Selects the first element of this NonEmptyList
and returns it wrapped in a Some
.
the first element of this NonEmptyList
, wrapped in a Some
.
Finds index of first occurrence of some value in this NonEmptyList
after or at some start index.
Finds index of first occurrence of some value in this NonEmptyList
after or at some start index.
the element value to search for.
the start index
the index >=
from
of the first element of this NonEmptyList
that is equal (as determined by ==
) to elem
,
or -1
, if none exists.
Finds index of first occurrence of some value in this NonEmptyList
.
Finds index of first occurrence of some value in this NonEmptyList
.
the element value to search for.
the index of the first element of this NonEmptyList
that is equal (as determined by ==
) to elem
,
or -1
, if none exists.
Finds first index after or at a start index where this NonEmptyList
contains a given NonEmptyList
as a slice.
Finds first index after or at a start index where this NonEmptyList
contains a given NonEmptyList
as a slice.
the NonEmptyList
defining the slice to look for
the start index
the first index >=
from
such that the elements of this NonEmptyList
starting at this index match the elements of
NonEmptyList
that
, or -1
of no such subsequence exists.
Finds first index after or at a start index where this NonEmptyList
contains a given Every
as a slice.
Finds first index after or at a start index where this NonEmptyList
contains a given Every
as a slice.
the Every
defining the slice to look for
the start index
the first index >=
from
such that the elements of this NonEmptyList
starting at this index match the elements of
Every
that
, or -1
of no such subsequence exists.
Finds first index where this NonEmptyList
contains a given NonEmptyList
as a slice.
Finds first index where this NonEmptyList
contains a given NonEmptyList
as a slice.
the NonEmptyList
defining the slice to look for
the first index such that the elements of this NonEmptyList
starting at this index match the elements of
NonEmptyList
that
, or -1
of no such subsequence exists.
Finds first index where this NonEmptyList
contains a given Every
as a slice.
Finds first index where this NonEmptyList
contains a given Every
as a slice.
the Every
defining the slice to look for
the first index such that the elements of this NonEmptyList
starting at this index match the elements of
Every
that
, or -1
of no such subsequence exists.
Finds first index after or at a start index where this NonEmptyList
contains a given GenSeq
as a slice.
Finds first index after or at a start index where this NonEmptyList
contains a given GenSeq
as a slice.
the GenSeq
defining the slice to look for
the start index
the first index >=
from
at which the elements of this NonEmptyList
starting at that index match the elements of
GenSeq
that
, or -1
of no such subsequence exists.
Finds first index where this NonEmptyList
contains a given GenSeq
as a slice.
Finds first index where this NonEmptyList
contains a given GenSeq
as a slice.
the GenSeq
defining the slice to look for
the first index at which the elements of this NonEmptyList
starting at that index match the elements of
GenSeq
that
, or -1
of no such subsequence exists.
Finds index of the first element satisfying some predicate after or at some start index.
Finds index of the first element satisfying some predicate after or at some start index.
the predicate used to test elements.
the start index
the index >=
from
of the first element of this NonEmptyList
that satisfies the predicate p
,
or -1
, if none exists.
Finds index of the first element satisfying some predicate.
Finds index of the first element satisfying some predicate.
the predicate used to test elements.
the index of the first element of this NonEmptyList
that satisfies the predicate p
,
or -1
, if none exists.
Produces the range of all indices of this NonEmptyList
.
Produces the range of all indices of this NonEmptyList
.
a Range
value from 0
to one less than the length of this NonEmptyList
.
Tests whether this NonEmptyList
contains given index.
Tests whether this NonEmptyList
contains given index.
the index to test
true if this NonEmptyList
contains an element at position idx
, false
otherwise.
Returns false
to indicate this NonEmptyList
, like all NonEmptyList
s, is non-empty.
Returns false
to indicate this NonEmptyList
, like all NonEmptyList
s, is non-empty.
false
Returns true
to indicate this NonEmptyList
, like all NonEmptyList
s, can be traversed repeatedly.
Returns true
to indicate this NonEmptyList
, like all NonEmptyList
s, can be traversed repeatedly.
true
Creates and returns a new iterator over all elements contained in this NonEmptyList
.
Creates and returns a new iterator over all elements contained in this NonEmptyList
.
the new iterator
Selects the last element of this NonEmptyList
.
Selects the last element of this NonEmptyList
.
the last element of this NonEmptyList
.
Finds the index of the last occurrence of some value in this NonEmptyList
before or at a given end
index.
Finds the index of the last occurrence of some value in this NonEmptyList
before or at a given end
index.
the element value to search for.
the end index.
the index >=
end
of the last element of this NonEmptyList
that is equal (as determined by ==
)
to elem
, or -1
, if none exists.
Finds the index of the last occurrence of some value in this NonEmptyList
.
Finds the index of the last occurrence of some value in this NonEmptyList
.
the element value to search for.
the index of the last element of this NonEmptyList
that is equal (as determined by ==
) to elem
,
or -1
, if none exists.
Finds the last index before or at a given end index where this NonEmptyList
contains a given NonEmptyList
as a slice.
Finds the last index before or at a given end index where this NonEmptyList
contains a given NonEmptyList
as a slice.
the NonEmptyList
defining the slice to look for
the end index
the last index >=
end
at which the elements of this NonEmptyList
starting at that index match the elements of
NonEmptyList
that
, or -1
of no such subsequence exists.
Finds the last index before or at a given end index where this NonEmptyList
contains a given Every
as a slice.
Finds the last index before or at a given end index where this NonEmptyList
contains a given Every
as a slice.
the Every
defining the slice to look for
the end index
the last index >=
end
at which the elements of this NonEmptyList
starting at that index match the elements of
Every
that
, or -1
of no such subsequence exists.
Finds the last index where this NonEmptyList
contains a given NonEmptyList
as a slice.
Finds the last index where this NonEmptyList
contains a given NonEmptyList
as a slice.
the NonEmptyList
defining the slice to look for
the last index at which the elements of this NonEmptyList
starting at that index match the elements of
NonEmptyList
that
, or -1
of no such subsequence exists.
Finds the last index where this NonEmptyList
contains a given Every
as a slice.
Finds the last index where this NonEmptyList
contains a given Every
as a slice.
the Every
defining the slice to look for
the last index at which the elements of this NonEmptyList
starting at that index match the elements of
Every
that
, or -1
of no such subsequence exists.
Finds the last index before or at a given end index where this NonEmptyList
contains a given GenSeq
as a slice.
Finds the last index before or at a given end index where this NonEmptyList
contains a given GenSeq
as a slice.
the GenSeq
defining the slice to look for
the end index
the last index >=
end
at which the elements of this NonEmptyList
starting at that index match the elements of
GenSeq
that
, or -1
of no such subsequence exists.
Finds the last index where this NonEmptyList
contains a given GenSeq
as a slice.
Finds the last index where this NonEmptyList
contains a given GenSeq
as a slice.
the GenSeq
defining the slice to look for
the last index at which the elements of this NonEmptyList
starting at that index match the elements of
GenSeq
that
, or -1
of no such subsequence exists.
Finds index of last element satisfying some predicate before or at given end index.
Finds index of last element satisfying some predicate before or at given end index.
the predicate used to test elements.
the end index
the index >=
end
of the last element of this NonEmptyList
that satisfies the predicate p
,
or -1
, if none exists.
Finds index of last element satisfying some predicate.
Finds index of last element satisfying some predicate.
the predicate used to test elements.
the index of the last element of this NonEmptyList
that satisfies the predicate p
, or -1
, if none exists.
Returns the last element of this NonEmptyList
, wrapped in a Some
.
Returns the last element of this NonEmptyList
, wrapped in a Some
.
the last element, wrapped in a Some
.
The length of this NonEmptyList
.
The length of this NonEmptyList
.
Note: length
and size
yield the same result, which will be >
= 1.
the number of elements in this NonEmptyList
.
Compares the length of this NonEmptyList
to a test value.
Compares the length of this NonEmptyList
to a test value.
the test value that gets compared with the length.
a value x
where
x < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len
Builds a new NonEmptyList
by applying a function to all elements of this NonEmptyList
.
Builds a new NonEmptyList
by applying a function to all elements of this NonEmptyList
.
the element type of the returned NonEmptyList
.
the function to apply to each element.
a new NonEmptyList
resulting from applying the given function f
to each element of this NonEmptyList
and collecting the results.
Finds the largest element.
Finds the largest element.
the largest element of this NonEmptyList
.
Finds the largest result after applying the given function to every element.
Finds the largest result after applying the given function to every element.
the largest result of applying the given function to every element of this NonEmptyList
.
Finds the smallest element.
Finds the smallest element.
the smallest element of this NonEmptyList
.
Finds the smallest result after applying the given function to every element.
Finds the smallest result after applying the given function to every element.
the smallest result of applying the given function to every element of this NonEmptyList
.
Displays all elements of this NonEmptyList
in a string using start, end, and separator strings.
Displays all elements of this NonEmptyList
in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this NonEmptyList
. The resulting string begins with the string start
and ends with the string
end
. Inside, In the resulting string, the result of invoking toString
on all elements of this NonEmptyList
are
separated by the string sep
.
Displays all elements of this NonEmptyList
in a string using a separator string.
Displays all elements of this NonEmptyList
in a string using a separator string.
the separator string
a string representation of this NonEmptyList
. In the resulting string, the result of invoking toString
on all elements of this
NonEmptyList
are separated by the string sep
.
Displays all elements of this NonEmptyList
in a string.
Displays all elements of this NonEmptyList
in a string.
a string representation of this NonEmptyList
. In the resulting string, the result of invoking toString
on all elements of this
NonEmptyList
follow each other without any separator string.
Returns true
to indicate this NonEmptyList
, like all NonEmptyList
s, is non-empty.
Returns true
to indicate this NonEmptyList
, like all NonEmptyList
s, is non-empty.
true
A copy of this NonEmptyList
with an element value appended until a given target length is reached.
A copy of this NonEmptyList
with an element value appended until a given target length is reached.
the target length
he padding value
a new NonEmptyList
consisting of all elements of this NonEmptyList
followed by the minimal number of occurrences
of elem
so that the resulting NonEmptyList
has a length of at least len
.
Produces a new NonEmptyList
where a slice of elements in this NonEmptyList
is replaced by another NonEmptyList
Produces a new NonEmptyList
where a slice of elements in this NonEmptyList
is replaced by another NonEmptyList
the index of the first replaced element
the NonEmptyList
whose elements should replace a slice in this NonEmptyList
the number of elements to drop in the original NonEmptyList
Iterates over distinct permutations.
Iterates over distinct permutations.
Here's an example:
NonEmptyList('a', 'b', 'b').permutations.toList = List(NonEmptyList(a, b, b), NonEmptyList(b, a, b), NonEmptyList(b, b, a))
an iterator that traverses the distinct permutations of this NonEmptyList
.
Returns the length of the longest prefix whose elements all satisfy some predicate.
Returns the length of the longest prefix whose elements all satisfy some predicate.
the predicate used to test elements.
the length of the longest prefix of this NonEmptyList
such that every element
of the segment satisfies the predicate p
.
The result of multiplying all the elements of this NonEmptyList
.
The result of multiplying all the elements of this NonEmptyList
.
This method can be invoked for any NonEmptyList[T]
for which an implicit Numeric[T]
exists.
the product of all elements
Reduces the elements of this NonEmptyList
using the specified associative binary operator.
Reduces the elements of this NonEmptyList
using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
a type parameter for the binary operator, a supertype of T.
a binary operator that must be associative.
the result of applying reduce operator op
between all the elements of this NonEmptyList
.
Applies a binary operator to all elements of this NonEmptyList
, going left to right.
Applies a binary operator to all elements of this NonEmptyList
, going left to right.
the result type of the binary operator.
the binary operator.
the result of inserting op
between consecutive elements of this NonEmptyList
, going left to right:
op(...op(op(x_1, x_2), x_3), ..., x_n)where x1, ..., xn are the elements of this
NonEmptyList
.Applies a binary operator to all elements of this NonEmptyList
, going left to right, returning the result in a Some
.
Applies a binary operator to all elements of this NonEmptyList
, going left to right, returning the result in a Some
.
the result type of the binary operator.
the binary operator.
a Some
containing the result of reduceLeft(op)
Applies a binary operator to all elements of this NonEmptyList
, going right to left.
Applies a binary operator to all elements of this NonEmptyList
, going right to left.
the result of the binary operator
the binary operator
the result of inserting op
between consecutive elements of this NonEmptyList
, going right to left:
op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))where x1, ..., xn are the elements of this
NonEmptyList
.Applies a binary operator to all elements of this NonEmptyList
, going right to left, returning the result in a Some
.
Applies a binary operator to all elements of this NonEmptyList
, going right to left, returning the result in a Some
.
the result of the binary operator
the binary operator
a Some
containing the result of reduceRight(op)
Returns new NonEmptyList
with elements in reverse order.
Returns new NonEmptyList
with elements in reverse order.
a new NonEmptyList
with all elements of this NonEmptyList
in reversed order.
An iterator yielding elements in reverse order.
An iterator yielding elements in reverse order.
Note: nonEmptyList.reverseIterator
is the same as nonEmptyList.reverse.iterator
, but might be more efficient.
an iterator yielding the elements of this NonEmptyList
in reversed order
Builds a new NonEmptyList
by applying a function to all elements of this NonEmptyList
and collecting the results in reverse order.
Builds a new NonEmptyList
by applying a function to all elements of this NonEmptyList
and collecting the results in reverse order.
Note: nonEmptyList.reverseMap(f)
is the same as nonEmptyList.reverse.map(f)
, but might be more efficient.
the element type of the returned NonEmptyList
.
the function to apply to each element.
a new NonEmptyList
resulting from applying the given function f
to each element of this NonEmptyList
and collecting the results in reverse order.
Checks if the given NonEmptyList
contains the same elements in the same order as this NonEmptyList
.
Checks if the given NonEmptyList
contains the same elements in the same order as this NonEmptyList
.
the NonEmptyList
with which to compare
true
, if both this and the given NonEmptyList
contain the same elements
in the same order, false
otherwise.
Checks if the given Every
contains the same elements in the same order as this NonEmptyList
.
Checks if the given Every
contains the same elements in the same order as this NonEmptyList
.
the Every
with which to compare
true
, if both this and the given Every
contain the same elements
in the same order, false
otherwise.
Checks if the given GenIterable
contains the same elements in the same order as this NonEmptyList
.
Checks if the given GenIterable
contains the same elements in the same order as this NonEmptyList
.
the GenIterable
with which to compare
true
, if both this NonEmptyList
and the given GenIterable
contain the same elements
in the same order, false
otherwise.
Computes a prefix scan of the elements of this NonEmptyList
.
Computes a prefix scan of the elements of this NonEmptyList
.
Note: The neutral element z may be applied more than once.
Here are some examples:
NonEmptyList(1, 2, 3).scan(0)(_ + _) == NonEmptyList(0, 1, 3, 6) NonEmptyList(1, 2, 3).scan("z")(_ + _.toString) == NonEmptyList("z", "z1", "z12", "z123")
a type parameter for the binary operator, a supertype of T, and the type of the resulting NonEmptyList
.
a neutral element for the scan operation; may be added to the result an arbitrary number of
times, and must not change the result (e.g., Nil
for list concatenation,
0 for addition, or 1 for multiplication.)
a binary operator that must be associative
a new NonEmptyList
containing the prefix scan of the elements in this NonEmptyList
Produces a NonEmptyList
containing cumulative results of applying the operator going left to right.
Produces a NonEmptyList
containing cumulative results of applying the operator going left to right.
Here are some examples:
NonEmptyList(1, 2, 3).scanLeft(0)(_ + _) == NonEmptyList(0, 1, 3, 6) NonEmptyList(1, 2, 3).scanLeft("z")(_ + _) == NonEmptyList("z", "z1", "z12", "z123")
the result type of the binary operator and type of the resulting NonEmptyList
the start value.
the binary operator.
a new NonEmptyList
containing the intermediate results of inserting op
between consecutive elements of this NonEmptyList
,
going left to right, with the start value, z
, on the left.
Produces a NonEmptyList
containing cumulative results of applying the operator going right to left.
Produces a NonEmptyList
containing cumulative results of applying the operator going right to left.
Here are some examples:
NonEmptyList(1, 2, 3).scanRight(0)(_ + _) == NonEmptyList(6, 5, 3, 0) NonEmptyList(1, 2, 3).scanRight("z")(_ + _) == NonEmptyList("123z", "23z", "3z", "z")
the result of the binary operator and type of the resulting NonEmptyList
the start value
the binary operator
a new NonEmptyList
containing the intermediate results of inserting op
between consecutive elements of this NonEmptyList
,
going right to left, with the start value, z
, on the right.
Computes length of longest segment whose elements all satisfy some predicate.
Computes length of longest segment whose elements all satisfy some predicate.
the predicate used to test elements.
the index where the search starts.
The size of this NonEmptyList
.
The size of this NonEmptyList
.
Note: length
and size
yield the same result, which will be >
= 1.
the number of elements in this NonEmptyList
.
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.),
moving the sliding window by a given step
each time.
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.),
moving the sliding window by a given step
each time.
the number of elements per group
the distance between the first elements of successive groups
an iterator producing NonEmptyList
s of size size
, except the last and the only element will be truncated
if there are fewer elements than size
.
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)
Groups elements in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)
the number of elements per group
an iterator producing NonEmptyList
s of size size
, except the last and the only element will be truncated
if there are fewer elements than size
.
Sorts this NonEmptyList
according to the Ordering
of the result of applying the given function to every element.
Sorts this NonEmptyList
according to the Ordering
of the result of applying the given function to every element.
the target type of the transformation f
, and the type where the Ordering
ord
is defined.
the transformation function mapping elements to some other domain U
.
the ordering assumed on domain U
.
a NonEmptyList
consisting of the elements of this NonEmptyList
sorted according to the Ordering
where
x < y if ord.lt(f(x), f(y))
.
Sorts this NonEmptyList
according to a comparison function.
Sorts this NonEmptyList
according to a comparison function.
The sort is stable. That is, elements that are equal (as determined by lt
) appear in the same order in the
sorted NonEmptyList
as in the original.
a NonEmptyList
consisting of the elements of this NonEmptyList
sorted according to the comparison function lt
.
Sorts this NonEmptyList
according to an Ordering
.
Sorts this NonEmptyList
according to an Ordering
.
The sort is stable. That is, elements that are equal (as determined by lt
) appear in the same order in the
sorted NonEmptyList
as in the original.
the Ordering
to be used to compare elements.
a NonEmptyList
consisting of the elements of this NonEmptyList
sorted according to the comparison function lt
.
Indicates whether this NonEmptyList
starts with the given NonEmptyList
at the given index.
Indicates whether this NonEmptyList
starts with the given NonEmptyList
at the given index.
the NonEmptyList
slice to look for in this NonEmptyList
the index at which this NonEmptyList
is searched.
true
if this NonEmptyList
has that
as a slice at the index offset
, false
otherwise.
Indicates whether this NonEmptyList
starts with the given Every
at the given index.
Indicates whether this NonEmptyList
starts with the given Every
at the given index.
the Every
slice to look for in this NonEmptyList
the index at which this NonEmptyList
is searched.
true
if this NonEmptyList
has that
as a slice at the index offset
, false
otherwise.
Indicates whether this NonEmptyList
starts with the given NonEmptyList
.
Indicates whether this NonEmptyList
starts with the given NonEmptyList
.
the NonEmptyList
to test
true
if this collection has that
as a prefix, false
otherwise.
Indicates whether this NonEmptyList
starts with the given Every
.
Indicates whether this NonEmptyList
starts with the given Every
.
the Every
to test
true
if this collection has that
as a prefix, false
otherwise.
Indicates whether this NonEmptyList
starts with the given GenSeq
at the given index.
Indicates whether this NonEmptyList
starts with the given GenSeq
at the given index.
the GenSeq
slice to look for in this NonEmptyList
the index at which this NonEmptyList
is searched.
true
if this NonEmptyList
has that
as a slice at the index offset
, false
otherwise.
Indicates whether this NonEmptyList
starts with the given GenSeq
.
Indicates whether this NonEmptyList
starts with the given GenSeq
.
the GenSeq
slice to look for in this NonEmptyList
true
if this NonEmptyList
has that
as a prefix, false
otherwise.
Returns "NonEmptyList"
, the prefix of this object's toString
representation.
Returns "NonEmptyList"
, the prefix of this object's toString
representation.
the string "NonEmptyList"
The result of summing all the elements of this NonEmptyList
.
The result of summing all the elements of this NonEmptyList
.
This method can be invoked for any NonEmptyList[T]
for which an implicit Numeric[T]
exists.
the sum of all elements
Converts this NonEmptyList
into a collection of type Col
by copying all elements.
Converts this NonEmptyList
into a collection of type Col
by copying all elements.
the collection type to build.
a new collection containing all elements of this NonEmptyList
.
Converts this NonEmptyList
to an array.
Converts this NonEmptyList
to an array.
an array containing all elements of this NonEmptyList
. A ClassTag
must be available for the element type of this NonEmptyList
.
Converts this NonEmptyList
to a mutable buffer.
Converts this NonEmptyList
to a mutable buffer.
a buffer containing all elements of this NonEmptyList
.
Converts this NonEmptyList
to an immutable IndexedSeq
.
Converts this NonEmptyList
to an immutable IndexedSeq
.
an immutable IndexedSeq
containing all elements of this NonEmptyList
.
Converts this NonEmptyList
to an iterable collection.
Converts this NonEmptyList
to an iterable collection.
an Iterable
containing all elements of this NonEmptyList
.
Returns an Iterator
over the elements in this NonEmptyList
.
Returns an Iterator
over the elements in this NonEmptyList
.
an Iterator
containing all elements of this NonEmptyList
.
Converts this NonEmptyList
to a map.
Converts this NonEmptyList
to a map.
This method is unavailable unless the elements are members of Tuple2
, each ((K, V))
becoming a key-value pair
in the map. Duplicate keys will be overwritten by later keys.
a map of type immutable.Map[K, V]
containing all key/value pairs of type (K, V)
of this NonEmptyList
.
Converts this NonEmptyList
to an immutable IndexedSeq
.
Converts this NonEmptyList
to an immutable IndexedSeq
.
an immutable IndexedSeq
containing all elements of this NonEmptyList
.
Converts this NonEmptyList
to a set.
Converts this NonEmptyList
to a set.
a set containing all elements of this NonEmptyList
.
Converts this NonEmptyList
to a stream.
Converts this NonEmptyList
to a stream.
a stream containing all elements of this NonEmptyList
.
Returns a string representation of this NonEmptyList
.
Returns a string representation of this NonEmptyList
.
the string "NonEmptyList"
followed by the result of invoking toString
on
this NonEmptyList
's elements, surrounded by parentheses.
Converts this NonEmptyList
to a Vector
.
Converts this NonEmptyList
to a Vector
.
a Vector
containing all elements of this NonEmptyList
.
Produces a new NonEmptyList
that contains all elements of this NonEmptyList
and also all elements of a given GenSeq
.
Produces a new NonEmptyList
that contains all elements of this NonEmptyList
and also all elements of a given GenSeq
.
nonEmptyListX
union
ys
is equivalent to nonEmptyListX
++
ys
.
Another way to express this is that nonEmptyListX
union
ys
computes the order-presevring multi-set union
of nonEmptyListX
and ys
. This union
method is hence a counter-part of diff
and intersect
that
also work on multi-sets.
the GenSeq
to add.
a new NonEmptyList
that contains all elements of this NonEmptyList
followed by all elements of that
GenSeq
.
Produces a new NonEmptyList
that contains all elements of this NonEmptyList
and also all elements of a given NonEmptyList
.
Produces a new NonEmptyList
that contains all elements of this NonEmptyList
and also all elements of a given NonEmptyList
.
nonEmptyListX
union
nonEmptyListY
is equivalent to nonEmptyListX
++
nonEmptyListY
.
Another way to express this is that nonEmptyListX
union
nonEmptyListY
computes the order-presevring multi-set union
of nonEmptyListX
and nonEmptyListY
. This union
method is hence a counter-part of diff
and intersect
that
also work on multi-sets.
the NonEmptyList
to add.
a new NonEmptyList
that contains all elements of this NonEmptyList
followed by all elements of that
.
Produces a new NonEmptyList
that contains all elements of this NonEmptyList
and also all elements of a given Every
.
Produces a new NonEmptyList
that contains all elements of this NonEmptyList
and also all elements of a given Every
.
nonEmptyListX
union
everyY
is equivalent to nonEmptyListX
++
everyY
.
Another way to express this is that nonEmptyListX
union
everyY
computes the order-presevring multi-set union
of nonEmptyListX
and everyY
. This union
method is hence a counter-part of diff
and intersect
that
also work on multi-sets.
the Every
to add.
a new NonEmptyList
that contains all elements of this NonEmptyList
followed by all elements of that
Every
.
Converts this NonEmptyList
of pairs into two NonEmptyList
s of the first and second half of each pair.
Converts this NonEmptyList
of pairs into two NonEmptyList
s of the first and second half of each pair.
the type of the first half of the element pairs
the type of the second half of the element pairs
an implicit conversion that asserts that the element type of this NonEmptyList
is a pair.
a pair of NonEmptyList
s, containing the first and second half, respectively, of each element pair of this NonEmptyList
.
Converts this NonEmptyList
of triples into three NonEmptyList
s of the first, second, and and third element of each triple.
Converts this NonEmptyList
of triples into three NonEmptyList
s of the first, second, and and third element of each triple.
the type of the first member of the element triples
the type of the third member of the element triples
an implicit conversion that asserts that the element type of this NonEmptyList
is a triple.
a triple of NonEmptyList
s, containing the first, second, and third member, respectively, of each element triple of this NonEmptyList
.
A copy of this NonEmptyList
with one single replaced element.
A copy of this NonEmptyList
with one single replaced element.
the position of the replacement
the replacing element
a copy of this NonEmptyList
with the element at position idx
replaced by elem
.
IndexOutOfBoundsException
if the passed index is greater than or equal to the length of this NonEmptyList
Returns a NonEmptyList
formed from this NonEmptyList
and an iterable collection by combining corresponding
elements in pairs.
Returns a NonEmptyList
formed from this NonEmptyList
and an iterable collection by combining corresponding
elements in pairs. If one of the two collections is shorter than the other, placeholder elements will be used to extend the
shorter collection to the length of the longer.
the Iterable
providing the second half of each result pair
the element to be used to fill up the result if this NonEmptyList
is shorter than that
Iterable
.
a new NonEmptyList
containing pairs consisting of corresponding elements of this NonEmptyList
and that
. The
length of the returned collection is the maximum of the lengths of this NonEmptyList
and that
. If this NonEmptyList
is shorter than that
, thisElem
values are used to pad the result. If that
is shorter than this
NonEmptyList
, thatElem
values are used to pad the result.
Zips this NonEmptyList
with its indices.
Zips this NonEmptyList
with its indices.
A new NonEmptyList
containing pairs consisting of all elements of this NonEmptyList
paired with their index. Indices start at 0.
The /:
method has been deprecated and will be removed in a future version of Scalactic. Please use
foldLeft
instead.
The /:
method has been deprecated and will be removed in a future version of Scalactic. Please use
foldLeft
instead.
This method has been deprecated for consistency with Scala 2.13's collections API.
Fold left: applies a binary operator to a start value, z
, and all elements of this NonEmptyList
, going left to right.
Note: /:
is alternate syntax for the foldLeft
method; z
/:
non-empty list
is the
same as non-empty list
foldLeft
z
.
the result of the binary operator
the start value
the binary operator
the result of inserting op
between consecutive elements of this NonEmptyList
, going left to right, with the start value,
z
, on the left:
op(...op(op(z, x_1), x_2), ..., x_n)where x1, ..., xn are the elements of this
NonEmptyList
.(Since version 3.1.x) The /: method has been deprecated and will be removed in a future version of Scalactic. Please use foldLeft instead.
The :\\
method has been deprecated and will be removed in a future version of Scalactic. Please use
foldRight
instead.
The :\\
method has been deprecated and will be removed in a future version of Scalactic. Please use
foldRight
instead.
This method has been deprecated for consistency with Scala 2.13's collections API.
Fold right: applies a binary operator to all elements of this NonEmptyList
and a start value, going right to left.
Note: :\
is alternate syntax for the foldRight
method; non-empty list
:\
z
is the same
as non-empty list
foldRight
z
.
the result of the binary operator
the start value
the binary operator
the result of inserting op
between consecutive elements of this NonEmptyList
, going right to left, with the start value,
z
, on the right:
op(x_1, op(x_2, ... op(x_n, z)...))where x1, ..., xn are the elements of this
NonEmptyList
.(Since version 3.1.x) The :\ method has been deprecated and will be removed in a future version of Scalactic. Please use foldRight instead.
A non-empty list: an ordered, immutable, non-empty collection of elements with
LinearSeq
performance characteristics.The purpose of
NonEmptyList
is to allow you to express in a type that aList
is non-empty, thereby eliminating the need for (and potential exception from) a run-time check for non-emptiness. For a non-empty sequence withIndexedSeq
performance, seeEvery
.Constructing
NonEmptyList
sYou can construct a
NonEmptyList
by passing one or more elements to theNonEmptyList.apply
factory method:Alternatively you can cons elements onto the
End
singleton object, similar to making aList
starting withNil
:Note that although
Nil
is aList[Nothing]
,End
is not aNonEmptyList[Nothing]
, because no emptyNonEmptyList
exists. (A non-empty list is a series of connected links; if you have no links, you have no non-empty list.)Working with
NonEmptyList
sNonEmptyList
does not extend Scala'sSeq
orTraversable
traits because these require that implementations may be empty. For example, if you invoketail
on aSeq
that contains just one element, you'll get an emptySeq
:On the other hand, many useful methods exist on
Seq
that when invoked on a non-emptySeq
are guaranteed to not result in an emptySeq
. For convenience,NonEmptyList
defines a method corresponding to every suchSeq
method. Here are some examples:NonEmptyList
does not currently define any methods corresponding toSeq
methods that could result in an emptySeq
. However, an implicit converison fromNonEmptyList
toList
is defined in theNonEmptyList
companion object that will be applied if you attempt to call one of the missing methods. As a result, you can invokefilter
on anNonEmptyList
, even thoughfilter
could result in an empty sequence—but the result type will beList
instead ofNonEmptyList
:You can use
NonEmptyList
s infor
expressions. The result will be anNonEmptyList
unless you use a filter (anif
clause). Because filters are desugared to invocations offilter
, the result type will switch to aList
at that point. Here are some examples:the type of elements contained in this
NonEmptyList