A non-empty array: an ordered, mutable, non-empty collection of elements with IndexedSeq
performance characteristics.
The purpose of NonEmptyArray
is to allow you to express in a type that an Array
is non-empty, thereby eliminating the
need for (and potential exception from) a run-time check for non-emptiness. For a non-empty immutable sequence with IndexedSeq
performance, see Every
.
== Constructing NonEmptyArray
s ==
You can construct a NonEmptyArray
by passing one or more elements to the NonEmptyArray.apply
factory method:
scala> NonEmptyArray(1, 2, 3) res0: org.scalactic.anyvals.NonEmptyArray[Int] = NonEmptyArray(1, 2, 3)
== Working with NonEmptyArray
s ==
NonEmptyArray
does not extend Scala's Seq
or Traversable
traits because these require that
implementations may be empty. For example, if you invoke tail
on a Seq
that contains just one element,
you'll get an empty Seq
:
scala> Array(1).tail res6: Array[Int] = Array()
On the other hand, many useful methods exist on Seq
that when invoked on a non-empty Seq
are guaranteed
to not result in an empty Seq
. For convenience, NonEmptyArray
defines a method corresponding to every such Seq
method. Here are some examples:
NonEmptyArray(1, 2, 3).map(_ + 1) // Result: NonEmptyArray(2, 3, 4) NonEmptyArray(1).map(_ + 1) // Result: NonEmptyArray(2) NonEmptyArray(1, 2, 3).containsSlice(NonEmptyArray(2, 3)) // Result: true NonEmptyArray(1, 2, 3).containsSlice(NonEmptyArray(3, 4)) // Result: false NonEmptyArray(-1, -2, 3, 4, 5).minBy(_.abs) // Result: -1
NonEmptyArray
does not currently define any methods corresponding to Seq
methods that could result in
an empty Seq
. However, an implicit converison from NonEmptyArray
to Array
is defined in the NonEmptyArray
companion object that will be applied if you attempt to call one of the missing methods. As a
result, you can invoke filter
on an NonEmptyArray
, even though filter
could result
in an empty sequence—but the result type will be Array
instead of NonEmptyArray
:
NonEmptyArray(1, 2, 3).filter(_ < 10) // Result: Array(1, 2, 3) NonEmptyArray(1, 2, 3).filter(_ > 10) // Result: Array()
You can use NonEmptyArray
s in for
expressions. The result will be an NonEmptyArray
unless
you use a filter (an if
clause). Because filters are desugared to invocations of filter
, the
result type will switch to a Array
at that point. Here are some examples:
scala> import org.scalactic.anyvals._ import org.scalactic.anyvals._ scala> for (i <- NonEmptyArray(1, 2, 3)) yield i + 1 res0: org.scalactic.anyvals.NonEmptyArray[Int] = NonEmptyArray(2, 3, 4) scala> for (i <- NonEmptyArray(1, 2, 3) if i < 10) yield i + 1 res1: Array[Int] = Array(2, 3, 4) scala> for { | i <- NonEmptyArray(1, 2, 3) | j <- NonEmptyArray('a', 'b', 'c') | } yield (i, j) res3: org.scalactic.anyvals.NonEmptyArray[(Int, Char)] = NonEmptyArray((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c)) scala> for { | i <- NonEmptyArray(1, 2, 3) if i < 10 | j <- NonEmptyArray('a', 'b', 'c') | } yield (i, j) res6: Array[(Int, Char)] = Array((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))
- Type parameters:
- T
the type of elements contained in this
NonEmptyArray
- Companion:
- object
- Source:
- NonEmptyArray.scala
Value members
Concrete methods
Returns a new NonEmptyArray
containing the elements of this NonEmptyArray
followed by the elements of the passed NonEmptyArray
.
The element type of the resulting NonEmptyArray
is the most specific superclass encompassing the element types of this and the passed NonEmptyArray
.
Returns a new NonEmptyArray
containing the elements of this NonEmptyArray
followed by the elements of the passed NonEmptyArray
.
The element type of the resulting NonEmptyArray
is the most specific superclass encompassing the element types of this and the passed NonEmptyArray
.
- Type parameters:
- U
the element type of the returned
NonEmptyArray
- Value parameters:
- other
the
NonEmptyArray
to append
- Returns:
a new
NonEmptyList
that contains all the elements of thisNonEmptyList
followed by all elements ofother
.- Source:
- NonEmptyArray.scala
Returns a new NonEmptyArray
containing the elements of this NonEmptyArray
followed by the elements of the passed Every
.
The element type of the resulting NonEmptyArray
is the most specific superclass encompassing the element types of this NonEmptyArray
and the passed Every
.
Returns a new NonEmptyArray
containing the elements of this NonEmptyArray
followed by the elements of the passed Every
.
The element type of the resulting NonEmptyArray
is the most specific superclass encompassing the element types of this NonEmptyArray
and the passed Every
.
- Type parameters:
- U
the element type of the returned
NonEmptyArray
- Value parameters:
- other
the
Every
to append
- Returns:
a new
NonEmptyArray
that contains all the elements of thisNonEmptyArray
followed by all elements ofother
.- Source:
- NonEmptyArray.scala
Returns a new NonEmptyArray
containing the elements of this NonEmptyArray
followed by the elements of the passed GenTraversableOnce
.
The element type of the resulting NonEmptyArray
is the most specific superclass encompassing the element types of this NonEmptyArray
and the passed GenTraversableOnce
.
Returns a new NonEmptyArray
containing the elements of this NonEmptyArray
followed by the elements of the passed GenTraversableOnce
.
The element type of the resulting NonEmptyArray
is the most specific superclass encompassing the element types of this NonEmptyArray
and the passed GenTraversableOnce
.
- Type parameters:
- U
the element type of the returned
NonEmptyArray
- Value parameters:
- other
the
GenTraversableOnce
to append
- Returns:
a new
NonEmptyArray
that contains all the elements of thisNonEmptyArray
followed by all elements ofother
.- Source:
- NonEmptyArray.scala
Returns a new NonEmptyArray
with the given element prepended.
Returns a new NonEmptyArray
with the given element prepended.
Note that :-ending operators are right associative. A mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
- Value parameters:
- element
the element to prepend to this
NonEmptyArray
- Returns:
a new
NonEmptyArray
consisting ofelement
followed by all elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Returns a new NonEmptyArray
with the given element appended.
Returns a new NonEmptyArray
with the given element appended.
Note a mnemonic for +:
vs. :+
is: the COLon goes on the COLlection side.
- Value parameters:
- element
the element to append to this
NonEmptyArray
- Returns:
a new
NonEmptyArray
consisting of all elements of thisNonEmptyArray
followed byelement
.- Source:
- NonEmptyArray.scala
Appends all elements of this NonEmptyArray
to a string builder. The written text will consist of a concatenation of the result of invoking toString
on of every element of this NonEmptyArray
, without any separator string.
Appends all elements of this NonEmptyArray
to a string builder. The written text will consist of a concatenation of the result of invoking toString
on of every element of this NonEmptyArray
, without any separator string.
- Value parameters:
- sb
the string builder to which elements will be appended
- Returns:
the string builder,
sb
, to which elements were appended.- Source:
- NonEmptyArray.scala
Appends all elements of this NonEmptyArray
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 NonEmptyArray
, separated by the string sep
.
Appends all elements of this NonEmptyArray
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 NonEmptyArray
, separated by the string sep
.
- Value parameters:
- sb
the string builder to which elements will be appended
- sep
the separator string
- Returns:
the string builder,
sb
, to which elements were appended.- Source:
- NonEmptyArray.scala
Appends all elements of this NonEmptyArray
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 NonEmptyArray
,
separated by the string sep
; and the string end
Appends all elements of this NonEmptyArray
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 NonEmptyArray
,
separated by the string sep
; and the string end
- Value parameters:
- sb
the string builder to which elements will be appended
- sep
the separator string
- start
the ending string
- Returns:
the string builder,
sb
, to which elements were appended.- Source:
- NonEmptyArray.scala
Selects an element by its index in the NonEmptyArray
.
Selects an element by its index in the NonEmptyArray
.
- Returns:
the element of this
NonEmptyArray
at indexidx
, where 0 indicates the first element.- Source:
- NonEmptyArray.scala
Finds the first element of this NonEmptyArray
for which the given partial function is defined, if any, and applies the partial function to it.
Finds the first element of this NonEmptyArray
for which the given partial function is defined, if any, and applies the partial function to it.
- Value parameters:
- pf
the partial function
- Returns:
an
Option
containingpf
applied to the first element for which it is defined, orNone
if the partial function was not defined for any element.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
contains a given value as an element.
Indicates whether this NonEmptyArray
contains a given value as an element.
- Value parameters:
- elem
the element to look for
- Returns:
true if this
NonEmptyArray
has an element that is equal (as determined by==)
toelem
, false otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
contains a given GenSeq
as a slice.
Indicates whether this NonEmptyArray
contains a given GenSeq
as a slice.
- Value parameters:
- that
the
GenSeq
slice to look for
- Returns:
true if this
NonEmptyArray
contains a slice with the same elements asthat
, otherwisefalse
.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
contains a given Every
as a slice.
Indicates whether this NonEmptyArray
contains a given Every
as a slice.
- Value parameters:
- that
the
Every
slice to look for
- Returns:
true if this
NonEmptyArray
contains a slice with the same elements asthat
, otherwisefalse
.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
contains a given NonEmptyArray
as a slice.
Indicates whether this NonEmptyArray
contains a given NonEmptyArray
as a slice.
- Value parameters:
- that
the
NonEmptyArray
slice to look for
- Returns:
true if this
NonEmptyArray
contains a slice with the same elements asthat
, otherwisefalse
.- Source:
- NonEmptyArray.scala
Copies values of this NonEmptyArray
to an array. Fills the given array arr
with values of this NonEmptyArray
. Copying
will stop once either the end of the current NonEmptyArray
is reached, or the end of the array is reached.
Copies values of this NonEmptyArray
to an array. Fills the given array arr
with values of this NonEmptyArray
. Copying
will stop once either the end of the current NonEmptyArray
is reached, or the end of the array is reached.
- Value parameters:
- arr
the array to fill
- Source:
- NonEmptyArray.scala
Copies values of this NonEmptyArray
to an array. Fills the given array arr
with values of this NonEmptyArray
, beginning at
index start
. Copying will stop once either the end of the current NonEmptyArray
is reached, or the end of the array is reached.
Copies values of this NonEmptyArray
to an array. Fills the given array arr
with values of this NonEmptyArray
, beginning at
index start
. Copying will stop once either the end of the current NonEmptyArray
is reached, or the end of the array is reached.
- Value parameters:
- arr
the array to fill
- start
the starting index
- Source:
- NonEmptyArray.scala
Copies values of this NonEmptyArray
to an array. Fills the given array arr
with at most len
elements of this NonEmptyArray
, beginning at
index start
. Copying will stop once either the end of the current NonEmptyArray
is reached, the end of the array is reached, or
len
elements have been copied.
Copies values of this NonEmptyArray
to an array. Fills the given array arr
with at most len
elements of this NonEmptyArray
, beginning at
index start
. Copying will stop once either the end of the current NonEmptyArray
is reached, the end of the array is reached, or
len
elements have been copied.
- Value parameters:
- arr
the array to fill
- len
the maximum number of elements to copy
- start
the starting index
- Source:
- NonEmptyArray.scala
Copies all elements of this NonEmptyArray
to a buffer.
Copies all elements of this NonEmptyArray
to a buffer.
- Value parameters:
- buf
the buffer to which elements are copied
- Source:
- NonEmptyArray.scala
Indicates whether every element of this NonEmptyArray
relates to the corresponding element of a given GenSeq
by satisfying a given predicate.
Indicates whether every element of this NonEmptyArray
relates to the corresponding element of a given GenSeq
by satisfying a given predicate.
- Type parameters:
- B
the type of the elements of
that
- Value parameters:
- p
the predicate, which relates elements from this
NonEmptyArray
and the passedGenSeq
- that
the
GenSeq
to compare for correspondence
- Returns:
true if this
NonEmptyArray
and the passedGenSeq
have the same length andp(x, y)
istrue
for all corresponding elementsx
of thisNonEmptyArray
andy
of that, otherwisefalse
.- Source:
- NonEmptyArray.scala
Indicates whether every element of this NonEmptyArray
relates to the corresponding element of a given Every
by satisfying a given predicate.
Indicates whether every element of this NonEmptyArray
relates to the corresponding element of a given Every
by satisfying a given predicate.
- Type parameters:
- B
the type of the elements of
that
- Value parameters:
- p
the predicate, which relates elements from this
NonEmptyArray
and the passedEvery
- that
the
Every
to compare for correspondence
- Returns:
true if this
NonEmptyArray
and the passedEvery
have the same length andp(x, y)
istrue
for all corresponding elementsx
of thisNonEmptyArray
andy
of that, otherwisefalse
.- Source:
- NonEmptyArray.scala
Indicates whether every element of this NonEmptyArray
relates to the corresponding element of a given NonEmptyArray
by satisfying a given predicate.
Indicates whether every element of this NonEmptyArray
relates to the corresponding element of a given NonEmptyArray
by satisfying a given predicate.
- Type parameters:
- B
the type of the elements of
that
- Value parameters:
- p
the predicate, which relates elements from this and the passed
NonEmptyArray
- that
the
NonEmptyArray
to compare for correspondence
- Returns:
true if this and the passed
NonEmptyArray
have the same length andp(x, y)
istrue
for all corresponding elementsx
of thisNonEmptyArray
andy
of that, otherwisefalse
.- Source:
- NonEmptyArray.scala
Counts the number of elements in this NonEmptyArray
that satisfy a predicate.
Counts the number of elements in this NonEmptyArray
that satisfy a predicate.
- Value parameters:
- p
the predicate used to test elements.
- Returns:
the number of elements satisfying the predicate
p
.- Source:
- NonEmptyArray.scala
Builds a new NonEmptyArray
from this NonEmptyArray
without any duplicate elements.
Builds a new NonEmptyArray
from this NonEmptyArray
without any duplicate elements.
- Returns:
A new
NonEmptyArray
that contains the first occurrence of every element of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
ends with the given GenSeq
.
Indicates whether this NonEmptyArray
ends with the given GenSeq
.
- Value parameters:
- that
the sequence to test
- Returns:
true
if thisNonEmptyArray
hasthat
as a suffix,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
ends with the given Every
.
Indicates whether this NonEmptyArray
ends with the given Every
.
- Value parameters:
- that
the
Every
to test
- Returns:
true
if thisNonEmptyArray
hasthat
as a suffix,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
ends with the given NonEmptyArray
.
Indicates whether this NonEmptyArray
ends with the given NonEmptyArray
.
- Value parameters:
- that
the
NonEmptyArray
to test
- Returns:
true
if thisNonEmptyArray
hasthat
as a suffix,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether a predicate holds for at least one of the elements of this NonEmptyArray
.
Indicates whether a predicate holds for at least one of the elements of this NonEmptyArray
.
- Value parameters:
- the
predicate used to test elements.
- Returns:
true
if the given predicatep
holds for some of the elements of thisNonEmptyArray
, otherwisefalse
.- Source:
- NonEmptyArray.scala
Finds the first element of this NonEmptyArray
that satisfies the given predicate, if any.
Finds the first element of this NonEmptyArray
that satisfies the given predicate, if any.
- Value parameters:
- p
the predicate used to test elements
- Returns:
an
Some
containing the first element in thisNonEmptyArray
that satisfiesp
, orNone
if none exists.- Source:
- NonEmptyArray.scala
Builds a new NonEmptyArray
by applying a function to all elements of this NonEmptyArray
and using the elements of the resulting NonEmptyArray
s.
Builds a new NonEmptyArray
by applying a function to all elements of this NonEmptyArray
and using the elements of the resulting NonEmptyArray
s.
- Type parameters:
- U
the element type of the returned
NonEmptyArray
- Value parameters:
- f
the function to apply to each element.
- Returns:
a new
NonEmptyArray
containing elements obtained by applying the given functionf
to each element of thisNonEmptyArray
and concatenating the elements of resultingNonEmptyArray
s.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
of NonEmptyArray
s into a NonEmptyArray
formed by the elements of the nested NonEmptyArray
s.
Converts this NonEmptyArray
of NonEmptyArray
s into a NonEmptyArray
formed by the elements of the nested NonEmptyArray
s.
Note: You cannot use this flatten
method on a NonEmptyArray
that contains a GenTraversableOnce
s, because
if all the nested GenTraversableOnce
s were empty, you'd end up with an empty NonEmptyArray
.
- Returns:
a new
NonEmptyArray
resulting from concatenating all nestedNonEmptyArray
s.- Source:
- NonEmptyArray.scala
Folds the elements of this NonEmptyArray
using the specified associative binary operator.
Folds the elements of this NonEmptyArray
using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- Type parameters:
- U
a type parameter for the binary operator, a supertype of T.
- Value parameters:
- op
a binary operator that must be associative
- z
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.)
- Returns:
the result of applying fold operator
op
between all the elements andz
- Source:
- NonEmptyArray.scala
Applies a binary operator to a start value and all elements of this NonEmptyArray
, going left to right.
Applies a binary operator to a start value and all elements of this NonEmptyArray
, going left to right.
- Type parameters:
- B
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- z
the start value.
- Returns:
the result of inserting
op
between consecutive elements of thisNonEmptyArray
, 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
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Applies a binary operator to all elements of this NonEmptyArray
and a start value, going right to left.
Applies a binary operator to all elements of this NonEmptyArray
and a start value, going right to left.
- Type parameters:
- B
the result of the binary operator
- Value parameters:
- op
the binary operator
- z
the start value
- Returns:
the result of inserting
op
between consecutive elements of thisNonEmptyArray
, 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
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Indicates whether a predicate holds for all elements of this NonEmptyArray
.
Indicates whether a predicate holds for all elements of this NonEmptyArray
.
- Value parameters:
- p
the predicate used to test elements.
- Returns:
true
if the given predicatep
holds for all elements of thisNonEmptyArray
, otherwisefalse
.- Source:
- NonEmptyArray.scala
Applies a function f
to all elements of this NonEmptyArray
.
Applies a function f
to all elements of this NonEmptyArray
.
- Value parameters:
- f
the function that is applied for its side-effect to every element. The result of function
f
is discarded.
- Source:
- NonEmptyArray.scala
Partitions this NonEmptyArray
into a map of NonEmptyArray
s according to some discriminator function.
Partitions this NonEmptyArray
into a map of NonEmptyArray
s according to some discriminator function.
- Type parameters:
- K
the type of keys returned by the discriminator function.
- Value parameters:
- f
the discriminator function.
- Returns:
A map from keys to
NonEmptyArray
s such that the following invariant holds:(nonEmptyArray.toArray partition f)(k) = xs filter (x => f(x) == k)
That is, every key
k
is bound to aNonEmptyArray
of those elementsx
for whichf(x)
equalsk
.- Source:
- NonEmptyArray.scala
Partitions elements into fixed size NonEmptyArray
s.
Partitions elements into fixed size NonEmptyArray
s.
- Value parameters:
- size
the number of elements per group
- Returns:
An iterator producing
NonEmptyArray
s of sizesize
, except the last will be truncated if the elements don't divide evenly.- Source:
- NonEmptyArray.scala
Returns true
to indicate this NonEmptyArray
has a definite size, since all NonEmptyArray
s are strict collections.
Returns true
to indicate this NonEmptyArray
has a definite size, since all NonEmptyArray
s are strict collections.
- Source:
- NonEmptyArray.scala
Selects the first element of this NonEmptyArray
.
Selects the first element of this NonEmptyArray
.
- Returns:
the first element of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Selects the first element of this NonEmptyArray
and returns it wrapped in a Some
.
Selects the first element of this NonEmptyArray
and returns it wrapped in a Some
.
- Returns:
the first element of this
NonEmptyArray
, wrapped in aSome
.- Source:
- NonEmptyArray.scala
Finds index of first occurrence of some value in this NonEmptyArray
.
Finds index of first occurrence of some value in this NonEmptyArray
.
- Value parameters:
- elem
the element value to search for.
- Returns:
the index of the first element of this
NonEmptyArray
that is equal (as determined by==
) toelem
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
Finds index of first occurrence of some value in this NonEmptyArray
after or at some start index.
Finds index of first occurrence of some value in this NonEmptyArray
after or at some start index.
- Value parameters:
- elem
the element value to search for.
- from
the start index
- Returns:
the index
>=
from
of the first element of thisNonEmptyArray
that is equal (as determined by==
) toelem
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
Finds first index where this NonEmptyArray
contains a given GenSeq
as a slice.
Finds first index where this NonEmptyArray
contains a given GenSeq
as a slice.
- Value parameters:
- that
the
GenSeq
defining the slice to look for
- Returns:
the first index at which the elements of this
NonEmptyArray
starting at that index match the elements ofGenSeq
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds first index after or at a start index where this NonEmptyArray
contains a given GenSeq
as a slice.
Finds first index after or at a start index where this NonEmptyArray
contains a given GenSeq
as a slice.
- Value parameters:
- from
the start index
- that
the
GenSeq
defining the slice to look for
- Returns:
the first index
>=
from
at which the elements of thisNonEmptyArray
starting at that index match the elements ofGenSeq
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds first index where this NonEmptyArray
contains a given Every
as a slice.
Finds first index where this NonEmptyArray
contains a given Every
as a slice.
- Value parameters:
- that
the
Every
defining the slice to look for
- Returns:
the first index such that the elements of this
NonEmptyArray
starting at this index match the elements ofEvery
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds first index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
Finds first index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
- Value parameters:
- that
the
NonEmptyArray
defining the slice to look for
- Returns:
the first index such that the elements of this
NonEmptyArray
starting at this index match the elements ofNonEmptyArray
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds first index after or at a start index where this NonEmptyArray
contains a given Every
as a slice.
Finds first index after or at a start index where this NonEmptyArray
contains a given Every
as a slice.
- Value parameters:
- from
the start index
- that
the
Every
defining the slice to look for
- Returns:
the first index
>=
from
such that the elements of thisNonEmptyArray
starting at this index match the elements ofEvery
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds first index after or at a start index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
Finds first index after or at a start index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
- Value parameters:
- from
the start index
- that
the
NonEmptyArray
defining the slice to look for
- Returns:
the first index
>=
from
such that the elements of thisNonEmptyArray
starting at this index match the elements ofNonEmptyArray
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds index of the first element satisfying some predicate.
Finds index of the first element satisfying some predicate.
- Value parameters:
- p
the predicate used to test elements.
- Returns:
the index of the first element of this
NonEmptyArray
that satisfies the predicatep
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
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.
- Value parameters:
- from
the start index
- p
the predicate used to test elements.
- Returns:
the index
>=
from
of the first element of thisNonEmptyArray
that satisfies the predicatep
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
Produces the range of all indices of this NonEmptyArray
.
Produces the range of all indices of this NonEmptyArray
.
- Returns:
a
Range
value from0
to one less than the length of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Tests whether this NonEmptyArray
contains given index.
Tests whether this NonEmptyArray
contains given index.
- Value parameters:
- idx
the index to test
- Returns:
true if this
NonEmptyArray
contains an element at positionidx
,false
otherwise.- Source:
- NonEmptyArray.scala
Returns false
to indicate this NonEmptyArray
, like all NonEmptyArray
s, is non-empty.
Returns false
to indicate this NonEmptyArray
, like all NonEmptyArray
s, is non-empty.
- Returns:
false
- Source:
- NonEmptyArray.scala
Returns true
to indicate this NonEmptyArray
, like all NonEmptyArray
s, can be traversed repeatedly.
Returns true
to indicate this NonEmptyArray
, like all NonEmptyArray
s, can be traversed repeatedly.
- Returns:
true
- Source:
- NonEmptyArray.scala
Creates and returns a new iterator over all elements contained in this NonEmptyArray
.
Creates and returns a new iterator over all elements contained in this NonEmptyArray
.
- Returns:
the new iterator
- Source:
- NonEmptyArray.scala
Selects the last element of this NonEmptyArray
.
Selects the last element of this NonEmptyArray
.
- Returns:
the last element of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Finds the index of the last occurrence of some value in this NonEmptyArray
.
Finds the index of the last occurrence of some value in this NonEmptyArray
.
- Value parameters:
- elem
the element value to search for.
- Returns:
the index of the last element of this
NonEmptyArray
that is equal (as determined by==
) toelem
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
Finds the index of the last occurrence of some value in this NonEmptyArray
before or at a given end
index.
Finds the index of the last occurrence of some value in this NonEmptyArray
before or at a given end
index.
- Value parameters:
- elem
the element value to search for.
- end
the end index.
- Returns:
the index
>=
end
of the last element of thisNonEmptyArray
that is equal (as determined by==
) toelem
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
Finds the last index where this NonEmptyArray
contains a given GenSeq
as a slice.
Finds the last index where this NonEmptyArray
contains a given GenSeq
as a slice.
- Value parameters:
- that
the
GenSeq
defining the slice to look for
- Returns:
the last index at which the elements of this
NonEmptyArray
starting at that index match the elements ofGenSeq
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds the last index before or at a given end index where this NonEmptyArray
contains a given GenSeq
as a slice.
Finds the last index before or at a given end index where this NonEmptyArray
contains a given GenSeq
as a slice.
- Value parameters:
- end
the end index
- that
the
GenSeq
defining the slice to look for
- Returns:
the last index
>=
end
at which the elements of thisNonEmptyArray
starting at that index match the elements ofGenSeq
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds the last index where this NonEmptyArray
contains a given Every
as a slice.
Finds the last index where this NonEmptyArray
contains a given Every
as a slice.
- Value parameters:
- that
the
Every
defining the slice to look for
- Returns:
the last index at which the elements of this
NonEmptyArray
starting at that index match the elements ofEvery
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds the last index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
Finds the last index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
- Value parameters:
- that
the
NonEmptyArray
defining the slice to look for
- Returns:
the last index at which the elements of this
NonEmptyArray
starting at that index match the elements ofNonEmptyArray
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds the last index before or at a given end index where this NonEmptyArray
contains a given Every
as a slice.
Finds the last index before or at a given end index where this NonEmptyArray
contains a given Every
as a slice.
- Value parameters:
- end
the end index
- that
the
Every
defining the slice to look for
- Returns:
the last index
>=
end
at which the elements of thisNonEmptyArray
starting at that index match the elements ofEvery
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds the last index before or at a given end index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
Finds the last index before or at a given end index where this NonEmptyArray
contains a given NonEmptyArray
as a slice.
- Value parameters:
- end
the end index
- that
the
NonEmptyArray
defining the slice to look for
- Returns:
the last index
>=
end
at which the elements of thisNonEmptyArray
starting at that index match the elements ofNonEmptyArray
that
, or-1
of no such subsequence exists.- Source:
- NonEmptyArray.scala
Finds index of last element satisfying some predicate.
Finds index of last element satisfying some predicate.
- Value parameters:
- p
the predicate used to test elements.
- Returns:
the index of the last element of this
NonEmptyArray
that satisfies the predicatep
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
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.
- Value parameters:
- end
the end index
- p
the predicate used to test elements.
- Returns:
the index
>=
end
of the last element of thisNonEmptyArray
that satisfies the predicatep
, or-1
, if none exists.- Source:
- NonEmptyArray.scala
Returns the last element of this NonEmptyArray
, wrapped in a Some
.
Returns the last element of this NonEmptyArray
, wrapped in a Some
.
- Returns:
the last element, wrapped in a
Some
.- Source:
- NonEmptyArray.scala
The length of this NonEmptyArray
.
The length of this NonEmptyArray
.
Note: length
and size
yield the same result, which will be >
= 1.
- Returns:
the number of elements in this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Compares the length of this NonEmptyArray
to a test value.
Compares the length of this NonEmptyArray
to a test value.
- Value parameters:
- len
the test value that gets compared with the length.
- Returns:
a value
x
wherex < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len
- Source:
- NonEmptyArray.scala
Builds a new NonEmptyArray
by applying a function to all elements of this NonEmptyArray
.
Builds a new NonEmptyArray
by applying a function to all elements of this NonEmptyArray
.
- Type parameters:
- U
the element type of the returned
NonEmptyArray
.
- Value parameters:
- f
the function to apply to each element.
- Returns:
a new
NonEmptyArray
resulting from applying the given functionf
to each element of thisNonEmptyArray
and collecting the results.- Source:
- NonEmptyArray.scala
Finds the largest element.
Finds the largest element.
- Returns:
the largest element of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Finds the largest result after applying the given function to every element.
Finds the largest result after applying the given function to every element.
- Returns:
the largest result of applying the given function to every element of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Finds the smallest element.
Finds the smallest element.
- Returns:
the smallest element of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Finds the smallest result after applying the given function to every element.
Finds the smallest result after applying the given function to every element.
- Returns:
the smallest result of applying the given function to every element of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Displays all elements of this NonEmptyArray
in a string.
Displays all elements of this NonEmptyArray
in a string.
- Returns:
a string representation of this
NonEmptyArray
. In the resulting string, the result of invokingtoString
on all elements of thisNonEmptyArray
follow each other without any separator string.- Source:
- NonEmptyArray.scala
Displays all elements of this NonEmptyArray
in a string using a separator string.
Displays all elements of this NonEmptyArray
in a string using a separator string.
- Value parameters:
- sep
the separator string
- Returns:
a string representation of this
NonEmptyArray
. In the resulting string, the result of invokingtoString
on all elements of thisNonEmptyArray
are separated by the stringsep
.- Source:
- NonEmptyArray.scala
Displays all elements of this NonEmptyArray
in a string using start, end, and separator strings.
Displays all elements of this NonEmptyArray
in a string using start, end, and separator strings.
- Value parameters:
- end
the ending string.
- sep
the separator string.
- start
the starting string.
- Returns:
a string representation of this
NonEmptyArray
. The resulting string begins with the stringstart
and ends with the stringend
. Inside, In the resulting string, the result of invokingtoString
on all elements of thisNonEmptyArray
are separated by the stringsep
.- Source:
- NonEmptyArray.scala
Returns true
to indicate this NonEmptyArray
, like all NonEmptyArray
s, is non-empty.
Returns true
to indicate this NonEmptyArray
, like all NonEmptyArray
s, is non-empty.
- Returns:
true
- Source:
- NonEmptyArray.scala
A copy of this NonEmptyArray
with an element value appended until a given target length is reached.
A copy of this NonEmptyArray
with an element value appended until a given target length is reached.
- Value parameters:
- elem
he padding value
- len
the target length
- Returns:
a new
NonEmptyArray
consisting of all elements of thisNonEmptyArray
followed by the minimal number of occurrences ofelem
so that the resultingNonEmptyArray
has a length of at leastlen
.- Source:
- NonEmptyArray.scala
Produces a new NonEmptyArray
where a slice of elements in this NonEmptyArray
is replaced by another NonEmptyArray
Produces a new NonEmptyArray
where a slice of elements in this NonEmptyArray
is replaced by another NonEmptyArray
- Value parameters:
- from
the index of the first replaced element
- replaced
the number of elements to drop in the original
NonEmptyArray
- that
the
NonEmptyArray
whose elements should replace a slice in thisNonEmptyArray
- Source:
- NonEmptyArray.scala
Iterates over distinct permutations.
Iterates over distinct permutations.
Here's an example:
NonEmptyArray('a', 'b', 'b').permutations.toArray = Array(NonEmptyArray(a, b, b), NonEmptyArray(b, a, b), NonEmptyArray(b, b, a))
- Returns:
an iterator that traverses the distinct permutations of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
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.
- Value parameters:
- p
the predicate used to test elements.
- Returns:
the length of the longest prefix of this
NonEmptyArray
such that every element of the segment satisfies the predicatep
.- Source:
- NonEmptyArray.scala
The result of multiplying all the elements of this NonEmptyArray
.
The result of multiplying all the elements of this NonEmptyArray
.
This method can be invoked for any NonEmptyArray[T]
for which an implicit Numeric[T]
exists.
- Returns:
the product of all elements
- Source:
- NonEmptyArray.scala
Reduces the elements of this NonEmptyArray
using the specified associative binary operator.
Reduces the elements of this NonEmptyArray
using the specified associative binary operator.
The order in which operations are performed on elements is unspecified and may be nondeterministic.
- Type parameters:
- U
a type parameter for the binary operator, a supertype of T.
- Value parameters:
- op
a binary operator that must be associative.
- Returns:
the result of applying reduce operator
op
between all the elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Applies a binary operator to all elements of this NonEmptyArray
, going left to right.
Applies a binary operator to all elements of this NonEmptyArray
, going left to right.
- Type parameters:
- U
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- Returns:
the result of inserting
op
between consecutive elements of thisNonEmptyArray
, going left to right:op(...op(op(x_1, x_2), x_3), ..., x_n)
where x1, ..., xn are the elements of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Applies a binary operator to all elements of this NonEmptyArray
, going left to right, returning the result in a Some
.
Applies a binary operator to all elements of this NonEmptyArray
, going left to right, returning the result in a Some
.
- Type parameters:
- U
the result type of the binary operator.
- Value parameters:
- op
the binary operator.
- Returns:
a
Some
containing the result ofreduceLeft(op)
- Source:
- NonEmptyArray.scala
Applies a binary operator to all elements of this NonEmptyArray
, going right to left.
Applies a binary operator to all elements of this NonEmptyArray
, going right to left.
- Type parameters:
- U
the result of the binary operator
- Value parameters:
- op
the binary operator
- Returns:
the result of inserting
op
between consecutive elements of thisNonEmptyArray
, going right to left:op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))
where x1, ..., xn are the elements of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Applies a binary operator to all elements of this NonEmptyArray
, going right to left, returning the result in a Some
.
Applies a binary operator to all elements of this NonEmptyArray
, going right to left, returning the result in a Some
.
- Type parameters:
- U
the result of the binary operator
- Value parameters:
- op
the binary operator
- Returns:
a
Some
containing the result ofreduceRight(op)
- Source:
- NonEmptyArray.scala
Returns new NonEmptyArray
with elements in reverse order.
Returns new NonEmptyArray
with elements in reverse order.
- Returns:
a new
NonEmptyArray
with all elements of thisNonEmptyArray
in reversed order.- Source:
- NonEmptyArray.scala
An iterator yielding elements in reverse order.
An iterator yielding elements in reverse order.
Note: nonEmptyArray.reverseIterator
is the same as nonEmptyArray.reverse.iterator
, but might be more efficient.
- Returns:
an iterator yielding the elements of this
NonEmptyArray
in reversed order- Source:
- NonEmptyArray.scala
Builds a new NonEmptyArray
by applying a function to all elements of this NonEmptyArray
and collecting the results in reverse order.
Builds a new NonEmptyArray
by applying a function to all elements of this NonEmptyArray
and collecting the results in reverse order.
Note: nonEmptyArray.reverseMap(f)
is the same as nonEmptyArray.reverse.map(f)
, but might be more efficient.
- Type parameters:
- U
the element type of the returned
NonEmptyArray
.
- Value parameters:
- f
the function to apply to each element.
- Returns:
a new
NonEmptyArray
resulting from applying the given functionf
to each element of thisNonEmptyArray
and collecting the results in reverse order.- Source:
- NonEmptyArray.scala
Checks if the given GenIterable
contains the same elements in the same order as this NonEmptyArray
.
Checks if the given GenIterable
contains the same elements in the same order as this NonEmptyArray
.
- Value parameters:
- that
the
GenIterable
with which to compare
- Returns:
true
, if both thisNonEmptyArray
and the givenGenIterable
contain the same elements in the same order,false
otherwise.- Source:
- NonEmptyArray.scala
Checks if the given Every
contains the same elements in the same order as this NonEmptyArray
.
Checks if the given Every
contains the same elements in the same order as this NonEmptyArray
.
- Value parameters:
- that
the
Every
with which to compare
- Returns:
true
, if both this and the givenEvery
contain the same elements in the same order,false
otherwise.- Source:
- NonEmptyArray.scala
Checks if the given NonEmptyArray
contains the same elements in the same order as this NonEmptyArray
.
Checks if the given NonEmptyArray
contains the same elements in the same order as this NonEmptyArray
.
- Value parameters:
- that
the
NonEmptyArray
with which to compare
- Returns:
true
, if both this and the givenNonEmptyArray
contain the same elements in the same order,false
otherwise.- Source:
- NonEmptyArray.scala
Computes a prefix scan of the elements of this NonEmptyArray
.
Computes a prefix scan of the elements of this NonEmptyArray
.
Note: The neutral element z may be applied more than once.
Here are some examples:
NonEmptyArray(1, 2, 3).scan(0)(_ + _) == NonEmptyArray(0, 1, 3, 6) NonEmptyArray(1, 2, 3).scan("z")(_ + _.toString) == NonEmptyArray("z", "z1", "z12", "z123")
- Type parameters:
- U
a type parameter for the binary operator, a supertype of T, and the type of the resulting
NonEmptyArray
.
- Value parameters:
- op
a binary operator that must be associative
- z
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.)
- Returns:
a new
NonEmptyArray
containing the prefix scan of the elements in thisNonEmptyArray
- Source:
- NonEmptyArray.scala
Produces a NonEmptyArray
containing cumulative results of applying the operator going left to right.
Produces a NonEmptyArray
containing cumulative results of applying the operator going left to right.
Here are some examples:
NonEmptyArray(1, 2, 3).scanLeft(0)(_ + _) == NonEmptyArray(0, 1, 3, 6) NonEmptyArray(1, 2, 3).scanLeft("z")(_ + _) == NonEmptyArray("z", "z1", "z12", "z123")
- Type parameters:
- B
the result type of the binary operator and type of the resulting
NonEmptyArray
- Value parameters:
- op
the binary operator.
- z
the start value.
- Returns:
a new
NonEmptyArray
containing the intermediate results of insertingop
between consecutive elements of thisNonEmptyArray
, going left to right, with the start value,z
, on the left.- Source:
- NonEmptyArray.scala
Produces a NonEmptyArray
containing cumulative results of applying the operator going right to left.
Produces a NonEmptyArray
containing cumulative results of applying the operator going right to left.
Here are some examples:
NonEmptyArray(1, 2, 3).scanRight(0)(_ + _) == NonEmptyArray(6, 5, 3, 0) NonEmptyArray(1, 2, 3).scanRight("z")(_ + _) == NonEmptyArray("123z", "23z", "3z", "z")
- Type parameters:
- B
the result of the binary operator and type of the resulting
NonEmptyArray
- Value parameters:
- op
the binary operator
- z
the start value
- Returns:
a new
NonEmptyArray
containing the intermediate results of insertingop
between consecutive elements of thisNonEmptyArray
, going right to left, with the start value,z
, on the right.- Source:
- NonEmptyArray.scala
Computes length of longest segment whose elements all satisfy some predicate.
Computes length of longest segment whose elements all satisfy some predicate.
- Value parameters:
- from
the index where the search starts.
- p
the predicate used to test elements.
- the
length of the longest segment of this
NonEmptyArray
starting from indexfrom
such that every element of the segment satisfies the predicatep
.
- Source:
- NonEmptyArray.scala
The size of this NonEmptyArray
.
The size of this NonEmptyArray
.
Note: length
and size
yield the same result, which will be >
= 1.
- Returns:
the number of elements in this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
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.)
- Value parameters:
- size
the number of elements per group
- Returns:
an iterator producing
NonEmptyArray
s of sizesize
, except the last and the only element will be truncated if there are fewer elements thansize
.- Source:
- NonEmptyArray.scala
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.
- Value parameters:
- size
the number of elements per group
- step
the distance between the first elements of successive groups
- Returns:
an iterator producing
NonEmptyArray
s of sizesize
, except the last and the only element will be truncated if there are fewer elements thansize
.- Source:
- NonEmptyArray.scala
Sorts this NonEmptyArray
according to the Ordering
of the result of applying the given function to every element.
Sorts this NonEmptyArray
according to the Ordering
of the result of applying the given function to every element.
- Type parameters:
- U
the target type of the transformation
f
, and the type where theOrdering
ord
is defined.
- Value parameters:
- f
the transformation function mapping elements to some other domain
U
.- ord
the ordering assumed on domain
U
.
- Returns:
a
NonEmptyArray
consisting of the elements of thisNonEmptyArray
sorted according to theOrdering
wherex < y if ord.lt(f(x), f(y))
.- Source:
- NonEmptyArray.scala
Sorts this NonEmptyArray
according to a comparison function.
Sorts this NonEmptyArray
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 NonEmptyArray
as in the original.
- Value parameters:
- the
comparison function that tests whether its first argument precedes its second argument in the desired ordering.
- Returns:
a
NonEmptyArray
consisting of the elements of thisNonEmptyArray
sorted according to the comparison functionlt
.- Source:
- NonEmptyArray.scala
Sorts this NonEmptyArray
according to an Ordering
.
Sorts this NonEmptyArray
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 NonEmptyArray
as in the original.
- Value parameters:
- ord
the
Ordering
to be used to compare elements.- the
comparison function that tests whether its first argument precedes its second argument in the desired ordering.
- Returns:
a
NonEmptyArray
consisting of the elements of thisNonEmptyArray
sorted according to the comparison functionlt
.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
starts with the given GenSeq
.
Indicates whether this NonEmptyArray
starts with the given GenSeq
.
- Value parameters:
- that
the
GenSeq
slice to look for in thisNonEmptyArray
- Returns:
true
if thisNonEmptyArray
hasthat
as a prefix,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
starts with the given GenSeq
at the given index.
Indicates whether this NonEmptyArray
starts with the given GenSeq
at the given index.
- Value parameters:
- offset
the index at which this
NonEmptyArray
is searched.- that
the
GenSeq
slice to look for in thisNonEmptyArray
- Returns:
true
if thisNonEmptyArray
hasthat
as a slice at the indexoffset
,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
starts with the given Every
.
Indicates whether this NonEmptyArray
starts with the given Every
.
- Value parameters:
- that
the
Every
to test
- Returns:
true
if this collection hasthat
as a prefix,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
starts with the given NonEmptyArray
.
Indicates whether this NonEmptyArray
starts with the given NonEmptyArray
.
- Value parameters:
- that
the
NonEmptyArray
to test
- Returns:
true
if this collection hasthat
as a prefix,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
starts with the given Every
at the given index.
Indicates whether this NonEmptyArray
starts with the given Every
at the given index.
- Value parameters:
- offset
the index at which this
NonEmptyArray
is searched.- that
the
Every
slice to look for in thisNonEmptyArray
- Returns:
true
if thisNonEmptyArray
hasthat
as a slice at the indexoffset
,false
otherwise.- Source:
- NonEmptyArray.scala
Indicates whether this NonEmptyArray
starts with the given NonEmptyArray
at the given index.
Indicates whether this NonEmptyArray
starts with the given NonEmptyArray
at the given index.
- Value parameters:
- offset
the index at which this
NonEmptyArray
is searched.- that
the
NonEmptyArray
slice to look for in thisNonEmptyArray
- Returns:
true
if thisNonEmptyArray
hasthat
as a slice at the indexoffset
,false
otherwise.- Source:
- NonEmptyArray.scala
Returns "NonEmptyArray"
, the prefix of this object's toString
representation.
Returns "NonEmptyArray"
, the prefix of this object's toString
representation.
- Returns:
the string
"NonEmptyArray"
- Source:
- NonEmptyArray.scala
The result of summing all the elements of this NonEmptyArray
.
The result of summing all the elements of this NonEmptyArray
.
This method can be invoked for any NonEmptyArray[T]
for which an implicit Numeric[T]
exists.
- Returns:
the sum of all elements
- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to a mutable buffer.
Converts this NonEmptyArray
to a mutable buffer.
- Returns:
a buffer containing all elements of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to an immutable IndexedSeq
.
Converts this NonEmptyArray
to an immutable IndexedSeq
.
- Returns:
an immutable
IndexedSeq
containing all elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to an iterable collection.
Converts this NonEmptyArray
to an iterable collection.
- Returns:
an
Iterable
containing all elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Returns an Iterator
over the elements in this NonEmptyArray
.
Returns an Iterator
over the elements in this NonEmptyArray
.
- Returns:
an
Iterator
containing all elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to a list.
Converts this NonEmptyArray
to a list.
- Returns:
a list containing all elements of this
NonEmptyArray
. AClassTag
must be available for the element type of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to a map.
Converts this NonEmptyArray
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.
- Returns:
a map of type
immutable.Map[K, V]
containing all key/value pairs of type(K, V)
of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to an immutable IndexedSeq
.
Converts this NonEmptyArray
to an immutable IndexedSeq
.
- Returns:
an immutable
IndexedSeq
containing all elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to a set.
Converts this NonEmptyArray
to a set.
- Returns:
a set containing all elements of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to a stream.
Converts this NonEmptyArray
to a stream.
- Returns:
a stream containing all elements of this
NonEmptyArray
.- Source:
- NonEmptyArray.scala
Returns a string representation of this NonEmptyArray
.
Returns a string representation of this NonEmptyArray
.
- Returns:
the string
"NonEmptyArray"
followed by the result of invokingtoString
on thisNonEmptyArray
's elements, surrounded by parentheses.- Definition Classes
- Any
- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
to a Vector
.
Converts this NonEmptyArray
to a Vector
.
- Returns:
a
Vector
containing all elements of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
of pairs into two NonEmptyArray
s of the first and second half of each pair.
Converts this NonEmptyArray
of pairs into two NonEmptyArray
s of the first and second half of each pair.
- Type parameters:
- L
the type of the first half of the element pairs
- R
the type of the second half of the element pairs
- Value parameters:
- asPair
an implicit conversion that asserts that the element type of this
NonEmptyArray
is a pair.
- Returns:
a pair of
NonEmptyArray
s, containing the first and second half, respectively, of each element pair of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
Converts this NonEmptyArray
of triples into three NonEmptyArray
s of the first, second, and and third element of each triple.
Converts this NonEmptyArray
of triples into three NonEmptyArray
s of the first, second, and and third element of each triple.
- Type parameters:
- L
the type of the first member of the element triples
- R
the type of the third member of the element triples
- Value parameters:
- asTriple
an implicit conversion that asserts that the element type of this
NonEmptyArray
is a triple.
- Returns:
a triple of
NonEmptyArray
s, containing the first, second, and third member, respectively, of each element triple of thisNonEmptyArray
.- Source:
- NonEmptyArray.scala
A copy of this NonEmptyArray
with one single replaced element.
A copy of this NonEmptyArray
with one single replaced element.
- Value parameters:
- elem
the replacing element
- idx
the position of the replacement
- Returns:
a copy of this
NonEmptyArray
with the element at positionidx
replaced byelem
.- Throws:
- IndexOutOfBoundsException
if the passed index is greater than or equal to the length of this
NonEmptyArray
- Source:
- NonEmptyArray.scala
Returns a NonEmptyArray
formed from this NonEmptyArray
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.
Returns a NonEmptyArray
formed from this NonEmptyArray
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.
- Value parameters:
- other
the
Iterable
providing the second half of each result pair- thatElem
the element to be used to fill up the result if
that
Iterable
is shorter than thisNonEmptyArray
.- thisElem
the element to be used to fill up the result if this
NonEmptyArray
is shorter thanthat
Iterable
.
- Returns:
a new
NonEmptyArray
containing pairs consisting of corresponding elements of thisNonEmptyArray
andthat
. The length of the returned collection is the maximum of the lengths of thisNonEmptyArray
andthat
. If thisNonEmptyArray
is shorter thanthat
,thisElem
values are used to pad the result. Ifthat
is shorter than thisNonEmptyArray
,thatElem
values are used to pad the result.- Source:
- NonEmptyArray.scala
Zips this NonEmptyArray
with its indices.
Zips this NonEmptyArray
with its indices.
- Returns:
A new
NonEmptyArray
containing pairs consisting of all elements of thisNonEmptyArray
paired with their index. Indices start at 0.- Source:
- NonEmptyArray.scala