NonEmptyArray

Companion object NonEmptyArray

final class NonEmptyArray[T] extends AnyVal

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 NonEmptyArrays 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))

T: the type of elements contained in this NonEmptyArray

Source: NonEmptyArray.scala

Linear Supertypes

AnyVal, Any

Ordering

Alphabetic
By Inheritance

Inherited

NonEmptyArray
AnyVal
Any

Hide All
Show All

Visibility

Public
Protected

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
Any
final def ##(): Int
Definition Classes
Any
def ++[U >: T](other: IterableOnce[U])(implicit classTag: ClassTag[U]): NonEmptyArray[U]
Returns a new NonEmptyArray containing the elements of this NonEmptyArray followed by the elements of 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.
U
the element type of the returned NonEmptyArray
other
the GenTraversableOnce to append
returns
a new NonEmptyArray that contains all the elements of this NonEmptyArray followed by all elements of other.
def ++[U >: T](other: Every[U])(implicit classTag: ClassTag[U]): NonEmptyArray[U]
Returns a new NonEmptyArray containing the elements of this NonEmptyArray followed by the elements of 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.
U
the element type of the returned NonEmptyArray
other
the Every to append
returns
a new NonEmptyArray that contains all the elements of this NonEmptyArray followed by all elements of other.
def ++[U >: T](other: NonEmptyArray[U])(implicit classTag: ClassTag[U]): NonEmptyArray[U]
Returns a new NonEmptyArray containing the elements of this NonEmptyArray followed by the elements of 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.
U
the element type of the returned NonEmptyArray
other
the NonEmptyArray to append
returns
a new NonEmptyList that contains all the elements of this NonEmptyList followed by all elements of other.
final def +:[U >: T](element: U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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.
element
the element to prepend to this NonEmptyArray
returns
a new NonEmptyArray consisting of element followed by all elements of this NonEmptyArray.
def :+[U >: T](element: U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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.
element
the element to append to this NonEmptyArray
returns
a new NonEmptyArray consisting of all elements of this NonEmptyArray followed by element.
final def ==(arg0: Any): Boolean
Definition Classes
Any
final def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder
Appends all elements of this NonEmptyArray to a string builder using start, end, and separator strings.
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
sb
the string builder to which elements will be appended
start
the ending string
sep
the separator string
returns
the string builder, sb, to which elements were appended.
final def addString(sb: StringBuilder, sep: String): StringBuilder
Appends all elements of this NonEmptyArray to a string builder using a separator string.
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.
sb
the string builder to which elements will be appended
sep
the separator string
returns
the string builder, sb, to which elements were appended.
final def addString(sb: StringBuilder): StringBuilder
Appends all elements of this NonEmptyArray to a string builder.
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.
sb
the string builder to which elements will be appended
returns
the string builder, sb, to which elements were appended.
final def apply(idx: Int): T
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 index idx, where 0 indicates the first element.
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def collectFirst[U](pf: PartialFunction[T, U])(implicit classTagOfU: ClassTag[U]): Option[U]
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.
pf
the partial function
returns
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.
final def contains(elem: T): Boolean
Indicates whether this NonEmptyArray contains a given value as an element.
Indicates whether this NonEmptyArray contains a given value as an element.
elem
the element to look for
returns
true if this NonEmptyArray has an element that is equal (as determined by ==) to elem, false otherwise.
final def containsSlice[B](that: NonEmptyArray[B]): Boolean
Indicates whether this NonEmptyArray contains a given NonEmptyArray as a slice.
Indicates whether this NonEmptyArray contains a given NonEmptyArray as a slice.
that
the NonEmptyArray slice to look for
returns
true if this NonEmptyArray contains a slice with the same elements as that, otherwise false.
final def containsSlice[B](that: Every[B]): Boolean
Indicates whether this NonEmptyArray contains a given Every as a slice.
Indicates whether this NonEmptyArray contains a given Every as a slice.
that
the Every slice to look for
returns
true if this NonEmptyArray contains a slice with the same elements as that, otherwise false.
final def containsSlice[B](that: GenSeq[B]): Boolean
Indicates whether this NonEmptyArray contains a given GenSeq as a slice.
Indicates whether this NonEmptyArray contains a given GenSeq as a slice.
that
the GenSeq slice to look for
returns
true if this NonEmptyArray contains a slice with the same elements as that, otherwise false.
final def copyToArray[U >: T](arr: Array[U], start: Int, len: Int): Unit
Copies values of this NonEmptyArray to an array.
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.
arr
the array to fill
start
the starting index
len
the maximum number of elements to copy
final def copyToArray[U >: T](arr: Array[U], start: Int): Unit
Copies values of this NonEmptyArray to an array.
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.
arr
the array to fill
start
the starting index
final def copyToArray[U >: T](arr: Array[U]): Unit
Copies values of this NonEmptyArray to an array.
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.
arr
the array to fill
final def copyToBuffer[U >: T](buf: Buffer[U]): Unit
Copies all elements of this NonEmptyArray to a buffer.
Copies all elements of this NonEmptyArray to a buffer.
buf
the buffer to which elements are copied
final def corresponds[B](that: NonEmptyArray[B])(p: (T, B) => Boolean): Boolean
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.
B
the type of the elements of that
that
the NonEmptyArray to compare for correspondence
p
the predicate, which relates elements from this and the passed NonEmptyArray
returns
true if this and the passed NonEmptyArray have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyArray and y of that, otherwise false.
final def corresponds[B](that: Every[B])(p: (T, B) => Boolean): Boolean
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.
B
the type of the elements of that
that
the Every to compare for correspondence
p
the predicate, which relates elements from this NonEmptyArray and the passed Every
returns
true if this NonEmptyArray and the passed Every have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyArray and y of that, otherwise false.
final def corresponds[B](that: GenSeq[B])(p: (T, B) => Boolean): Boolean
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.
B
the type of the elements of that
that
the GenSeq to compare for correspondence
p
the predicate, which relates elements from this NonEmptyArray and the passed GenSeq
returns
true if this NonEmptyArray and the passed GenSeq have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyArray and y of that, otherwise false.
final def count(p: (T) => Boolean): Int
Counts the number of elements in this NonEmptyArray that satisfy a predicate.
Counts the number of elements in this NonEmptyArray that satisfy a predicate.
p
the predicate used to test elements.
returns
the number of elements satisfying the predicate p.
final def distinct: NonEmptyArray[T]
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 this NonEmptyArray.
final def endsWith[B](that: NonEmptyArray[B]): Boolean
Indicates whether this NonEmptyArray ends with the given NonEmptyArray.
Indicates whether this NonEmptyArray ends with the given NonEmptyArray.
that
the NonEmptyArray to test
returns
true if this NonEmptyArray has that as a suffix, false otherwise.
final def endsWith[B](that: Every[B]): Boolean
Indicates whether this NonEmptyArray ends with the given Every.
Indicates whether this NonEmptyArray ends with the given Every.
that
the Every to test
returns
true if this NonEmptyArray has that as a suffix, false otherwise.
final def endsWith[B](that: GenSeq[B]): Boolean
Indicates whether this NonEmptyArray ends with the given GenSeq.
Indicates whether this NonEmptyArray ends with the given GenSeq.
that
the sequence to test
returns
true if this NonEmptyArray has that as a suffix, false otherwise.
final def exists(p: (T) => Boolean): Boolean
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.
returns
true if the given predicate p holds for some of the elements of this NonEmptyArray, otherwise false.
final def find(p: (T) => Boolean): Option[T]
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.
p
the predicate used to test elements
returns
an Some containing the first element in this NonEmptyArray that satisfies p, or None if none exists.
final def flatMap[U](f: (T) => NonEmptyArray[U])(implicit classTag: ClassTag[U]): NonEmptyArray[U]
Builds a new NonEmptyArray by applying a function to all elements of this NonEmptyArray and using the elements of the resulting NonEmptyArrays.
Builds a new NonEmptyArray by applying a function to all elements of this NonEmptyArray and using the elements of the resulting NonEmptyArrays.
U
the element type of the returned NonEmptyArray
f
the function to apply to each element.
returns
a new NonEmptyArray containing elements obtained by applying the given function f to each element of this NonEmptyArray and concatenating the elements of resulting NonEmptyArrays.
final def flatten[B](implicit ev: <:<[T, NonEmptyArray[B]], classTag: ClassTag[B]): NonEmptyArray[B]
Converts this NonEmptyArray of NonEmptyArrays into a NonEmptyArray formed by the elements of the nested NonEmptyArrays.
Converts this NonEmptyArray of NonEmptyArrays into a NonEmptyArray formed by the elements of the nested NonEmptyArrays.
Note: You cannot use this flatten method on a NonEmptyArray that contains a GenTraversableOnces, because if all the nested GenTraversableOnces were empty, you'd end up with an empty NonEmptyArray.
returns
a new NonEmptyArray resulting from concatenating all nested NonEmptyArrays.
final def fold[U >: T](z: U)(op: (U, U) => U): U
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.
U
a type parameter for the binary operator, a supertype of T.
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.)
op
a binary operator that must be associative
returns
the result of applying fold operator op between all the elements and z
final def foldLeft[B](z: B)(op: (B, T) => B): B
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.
B
the result type of the binary operator.
z
the start value.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this NonEmptyArray, going left to right, with the start value, z, on the left:
```
op(...op(op(z, x_1), x_2), ..., x_n)
```
where x₁, ..., x_n are the elements of this NonEmptyArray.
final def foldRight[B](z: B)(op: (T, B) => B): B
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.
B
the result of the binary operator
z
the start value
op
the binary operator
returns
the result of inserting op between consecutive elements of this NonEmptyArray, going right to left, with the start value, z, on the right:
```
op(x_1, op(x_2, ... op(x_n, z)...))
```
where x₁, ..., x_n are the elements of this NonEmptyArray.
final def forall(p: (T) => Boolean): Boolean
Indicates whether a predicate holds for all elements of this NonEmptyArray.
Indicates whether a predicate holds for all elements of this NonEmptyArray.
p
the predicate used to test elements.
returns
true if the given predicate p holds for all elements of this NonEmptyArray, otherwise false.
final def foreach(f: (T) => Unit): Unit
Applies a function f to all elements of this NonEmptyArray.
Applies a function f to all elements of this NonEmptyArray.
f
the function that is applied for its side-effect to every element. The result of function f is discarded.
def getClass(): Class[_ <: AnyVal]
Definition Classes
AnyVal → Any
final def groupBy[K](f: (T) => K)(implicit classTag: ClassTag[T]): Map[K, NonEmptyArray[T]]
Partitions this NonEmptyArray into a map of NonEmptyArrays according to some discriminator function.
Partitions this NonEmptyArray into a map of NonEmptyArrays according to some discriminator function.
K
the type of keys returned by the discriminator function.
f
the discriminator function.
returns
A map from keys to NonEmptyArrays 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 a NonEmptyArray of those elements x for which f(x) equals k.
final def grouped(size: Int)(implicit classTag: ClassTag[T]): Iterator[NonEmptyArray[T]]
Partitions elements into fixed size NonEmptyArrays.
Partitions elements into fixed size NonEmptyArrays.
size
the number of elements per group
returns
An iterator producing NonEmptyArrays of size size, except the last will be truncated if the elements don't divide evenly.
final def hasDefiniteSize: Boolean
Returns true to indicate this NonEmptyArray has a definite size, since all NonEmptyArrays are strict collections.
final def head: T
Selects the first element of this NonEmptyArray.
Selects the first element of this NonEmptyArray.
returns
the first element of this NonEmptyArray.
final def headOption: Option[T]
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 a Some.
final def indexOf(elem: T, from: Int): Int
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.
elem
the element value to search for.
from
the start index
returns
the index >= from of the first element of this NonEmptyArray that is equal (as determined by ==) to elem, or -1, if none exists.
final def indexOf(elem: T): Int
Finds index of first occurrence of some value in this NonEmptyArray.
Finds index of first occurrence of some value in this NonEmptyArray.
elem
the element value to search for.
returns
the index of the first element of this NonEmptyArray that is equal (as determined by ==) to elem, or -1, if none exists.
final def indexOfSlice[U >: T](that: NonEmptyArray[U], from: Int): Int
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.
that
the NonEmptyArray defining the slice to look for
from
the start index
returns
the first index >= from such that the elements of this NonEmptyArray starting at this index match the elements of NonEmptyArray that, or -1 of no such subsequence exists.
final def indexOfSlice[U >: T](that: Every[U], from: Int): Int
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.
that
the Every defining the slice to look for
from
the start index
returns
the first index >= from such that the elements of this NonEmptyArray starting at this index match the elements of Every that, or -1 of no such subsequence exists.
final def indexOfSlice[U >: T](that: NonEmptyArray[U]): Int
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.
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 of NonEmptyArray that, or -1 of no such subsequence exists.
final def indexOfSlice[U >: T](that: Every[U]): Int
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.
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 of Every that, or -1 of no such subsequence exists.
final def indexOfSlice[U >: T](that: GenSeq[U], from: Int): Int
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.
that
the GenSeq defining the slice to look for
from
the start index
returns
the first index >= from at which the elements of this NonEmptyArray starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.
final def indexOfSlice[U >: T](that: GenSeq[U]): Int
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.
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 of GenSeq that, or -1 of no such subsequence exists.
final def indexWhere(p: (T) => Boolean, from: Int): Int
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.
p
the predicate used to test elements.
from
the start index
returns
the index >= from of the first element of this NonEmptyArray that satisfies the predicate p, or -1, if none exists.
final def indexWhere(p: (T) => Boolean): Int
Finds index of the first element satisfying some predicate.
Finds index of the first element satisfying some predicate.
p
the predicate used to test elements.
returns
the index of the first element of this NonEmptyArray that satisfies the predicate p, or -1, if none exists.
final def indices: Range
Produces the range of all indices of this NonEmptyArray.
Produces the range of all indices of this NonEmptyArray.
returns
a Range value from 0 to one less than the length of this NonEmptyArray.
final def isDefinedAt(idx: Int): Boolean
Tests whether this NonEmptyArray contains given index.
Tests whether this NonEmptyArray contains given index.
idx
the index to test
returns
true if this NonEmptyArray contains an element at position idx, false otherwise.
final def isEmpty: Boolean
Returns false to indicate this NonEmptyArray, like all NonEmptyArrays, is non-empty.
Returns false to indicate this NonEmptyArray, like all NonEmptyArrays, is non-empty.
returns
false
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def isTraversableAgain: Boolean
Returns true to indicate this NonEmptyArray, like all NonEmptyArrays, can be traversed repeatedly.
Returns true to indicate this NonEmptyArray, like all NonEmptyArrays, can be traversed repeatedly.
returns
true
final def iterator: Iterator[T]
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
final def last: T
Selects the last element of this NonEmptyArray.
Selects the last element of this NonEmptyArray.
returns
the last element of this NonEmptyArray.
final def lastIndexOf(elem: T, end: Int): Int
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.
elem
the element value to search for.
end
the end index.
returns
the index >= end of the last element of this NonEmptyArray that is equal (as determined by ==) to elem, or -1, if none exists.
final def lastIndexOf(elem: T): Int
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.
elem
the element value to search for.
returns
the index of the last element of this NonEmptyArray that is equal (as determined by ==) to elem, or -1, if none exists.
final def lastIndexOfSlice[U >: T](that: NonEmptyArray[U], end: Int): Int
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.
that
the NonEmptyArray defining the slice to look for
end
the end index
returns
the last index >= end at which the elements of this NonEmptyArray starting at that index match the elements of NonEmptyArray that, or -1 of no such subsequence exists.
final def lastIndexOfSlice[U >: T](that: Every[U], end: Int): Int
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.
that
the Every defining the slice to look for
end
the end index
returns
the last index >= end at which the elements of this NonEmptyArray starting at that index match the elements of Every that, or -1 of no such subsequence exists.
final def lastIndexOfSlice[U >: T](that: NonEmptyArray[U]): Int
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.
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 of NonEmptyArray that, or -1 of no such subsequence exists.
final def lastIndexOfSlice[U >: T](that: Every[U]): Int
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.
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 of Every that, or -1 of no such subsequence exists.
final def lastIndexOfSlice[U >: T](that: GenSeq[U], end: Int): Int
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.
that
the GenSeq defining the slice to look for
end
the end index
returns
the last index >= end at which the elements of this NonEmptyArray starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.
final def lastIndexOfSlice[U >: T](that: GenSeq[U]): Int
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.
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 of GenSeq that, or -1 of no such subsequence exists.
final def lastIndexWhere(p: (T) => Boolean, end: Int): Int
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.
p
the predicate used to test elements.
end
the end index
returns
the index >= end of the last element of this NonEmptyArray that satisfies the predicate p, or -1, if none exists.
final def lastIndexWhere(p: (T) => Boolean): Int
Finds index of last element satisfying some predicate.
Finds index of last element satisfying some predicate.
p
the predicate used to test elements.
returns
the index of the last element of this NonEmptyArray that satisfies the predicate p, or -1, if none exists.
final def lastOption: Option[T]
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.
final def length: Int
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.
final def lengthCompare(len: Int): Int
Compares the length of this NonEmptyArray to a test value.
Compares the length of this NonEmptyArray to a test value.
len
the test value that gets compared with the length.
returns
a value x where
```
x < 0 if this.length < len
x == 0 if this.length == len
x > 0 if this.length > len
```
final def map[U](f: (T) => U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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.
U
the element type of the returned NonEmptyArray.
f
the function to apply to each element.
returns
a new NonEmptyArray resulting from applying the given function f to each element of this NonEmptyArray and collecting the results.
final def max[U >: T](implicit cmp: Ordering[U]): T
Finds the largest element.
Finds the largest element.
returns
the largest element of this NonEmptyArray.
final def maxBy[U](f: (T) => U)(implicit cmp: Ordering[U]): T
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.
final def min[U >: T](implicit cmp: Ordering[U]): T
Finds the smallest element.
Finds the smallest element.
returns
the smallest element of this NonEmptyArray.
final def minBy[U](f: (T) => U)(implicit cmp: Ordering[U]): T
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.
final def mkString(start: String, sep: String, end: String): String
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.
start
the starting string.
sep
the separator string.
end
the ending string.
returns
a string representation of this NonEmptyArray. 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 NonEmptyArray are separated by the string sep.
final def mkString(sep: String): String
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.
sep
the separator string
returns
a string representation of this NonEmptyArray. In the resulting string, the result of invoking toString on all elements of this NonEmptyArray are separated by the string sep.
final def mkString: String
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 invoking toString on all elements of this NonEmptyArray follow each other without any separator string.
final def nonEmpty: Boolean
Returns true to indicate this NonEmptyArray, like all NonEmptyArrays, is non-empty.
Returns true to indicate this NonEmptyArray, like all NonEmptyArrays, is non-empty.
returns
true
final def padTo[U >: T](len: Int, elem: U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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.
len
the target length
elem
he padding value
returns
a new NonEmptyArray consisting of all elements of this NonEmptyArray followed by the minimal number of occurrences of elem so that the resulting NonEmptyArray has a length of at least len.
final def patch[U >: T](from: Int, that: NonEmptyArray[U], replaced: Int)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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
from
the index of the first replaced element
that
the NonEmptyArray whose elements should replace a slice in this NonEmptyArray
replaced
the number of elements to drop in the original NonEmptyArray
final def permutations(implicit classTag: ClassTag[T]): Iterator[NonEmptyArray[T]]
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.
final def prefixLength(p: (T) => Boolean): Int
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.
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 predicate p.
final def product[U >: T](implicit num: Numeric[U]): U
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
final def reduce[U >: T](op: (U, U) => U): U
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.
U
a type parameter for the binary operator, a supertype of T.
op
a binary operator that must be associative.
returns
the result of applying reduce operator op between all the elements of this NonEmptyArray.
final def reduceLeft[U >: T](op: (U, T) => U): U
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.
U
the result type of the binary operator.
op
the binary operator.
returns
the result of inserting op between consecutive elements of this NonEmptyArray, going left to right:
```
op(...op(op(x_1, x_2), x_3), ..., x_n)
```
where x₁, ..., x_n are the elements of this NonEmptyArray.
final def reduceLeftOption[U >: T](op: (U, T) => U): Option[U]
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.
U
the result type of the binary operator.
op
the binary operator.
returns
a Some containing the result of reduceLeft(op)
final def reduceOption[U >: T](op: (U, U) => U): Option[U]
final def reduceRight[U >: T](op: (T, U) => U): U
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.
U
the result of the binary operator
op
the binary operator
returns
the result of inserting op between consecutive elements of this NonEmptyArray, going right to left:
```
op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))
```
where x₁, ..., x_n are the elements of this NonEmptyArray.
final def reduceRightOption[U >: T](op: (T, U) => U): Option[U]
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.
U
the result of the binary operator
op
the binary operator
returns
a Some containing the result of reduceRight(op)
final def reverse: NonEmptyArray[T]
Returns new NonEmptyArray with elements in reverse order.
Returns new NonEmptyArray with elements in reverse order.
returns
a new NonEmptyArray with all elements of this NonEmptyArray in reversed order.
final def reverseIterator: Iterator[T]
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
final def reverseMap[U](f: (T) => U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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.
U
the element type of the returned NonEmptyArray.
f
the function to apply to each element.
returns
a new NonEmptyArray resulting from applying the given function f to each element of this NonEmptyArray and collecting the results in reverse order.
final def sameElements[U >: T](that: NonEmptyArray[U]): Boolean
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.
that
the NonEmptyArray with which to compare
returns
true, if both this and the given NonEmptyArray contain the same elements in the same order, false otherwise.
final def sameElements[U >: T](that: Every[U]): Boolean
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.
that
the Every with which to compare
returns
true, if both this and the given Every contain the same elements in the same order, false otherwise.
final def sameElements[U >: T](that: GenIterable[U]): Boolean
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.
that
the GenIterable with which to compare
returns
true, if both this NonEmptyArray and the given GenIterable contain the same elements in the same order, false otherwise.
final def scan[U >: T](z: U)(op: (U, U) => U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
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")
```
U
a type parameter for the binary operator, a supertype of T, and the type of the resulting NonEmptyArray.
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.)
op
a binary operator that must be associative
returns
a new NonEmptyArray containing the prefix scan of the elements in this NonEmptyArray
final def scanLeft[B](z: B)(op: (B, T) => B)(implicit classTag: ClassTag[B]): NonEmptyArray[B]
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")
```
B
the result type of the binary operator and type of the resulting NonEmptyArray
z
the start value.
op
the binary operator.
returns
a new NonEmptyArray containing the intermediate results of inserting op between consecutive elements of this NonEmptyArray, going left to right, with the start value, z, on the left.
final def scanRight[B](z: B)(op: (T, B) => B)(implicit classTag: ClassTag[B]): NonEmptyArray[B]
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")
```
B
the result of the binary operator and type of the resulting NonEmptyArray
z
the start value
op
the binary operator
returns
a new NonEmptyArray containing the intermediate results of inserting op between consecutive elements of this NonEmptyArray, going right to left, with the start value, z, on the right.
final def segmentLength(p: (T) => Boolean, from: Int): Int
Computes length of longest segment whose elements all satisfy some predicate.
Computes length of longest segment whose elements all satisfy some predicate.
p
the predicate used to test elements.
from
the index where the search starts.
final def size: Int
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.
final def sliding(size: Int, step: Int)(implicit classTag: ClassTag[T]): Iterator[NonEmptyArray[T]]
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.
size
the number of elements per group
step
the distance between the first elements of successive groups
returns
an iterator producing NonEmptyArrays of size size, except the last and the only element will be truncated if there are fewer elements than size.
final def sliding(size: Int)(implicit classTag: ClassTag[T]): Iterator[NonEmptyArray[T]]
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.)
size
the number of elements per group
returns
an iterator producing NonEmptyArrays of size size, except the last and the only element will be truncated if there are fewer elements than size.
final def sortBy[U](f: (T) => U)(implicit ord: Ordering[U]): NonEmptyArray[T]
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.
U
the target type of the transformation f, and the type where the Ordering ord is defined.
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 this NonEmptyArray sorted according to the Ordering where x < y if ord.lt(f(x), f(y)).
final def sortWith(lt: (T, T) => Boolean): NonEmptyArray[T]
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.
returns
a NonEmptyArray consisting of the elements of this NonEmptyArray sorted according to the comparison function lt.
final def sorted[U >: T](implicit ord: Ordering[U], classTag: ClassTag[U]): NonEmptyArray[U]
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.
ord
the Ordering to be used to compare elements.
returns
a NonEmptyArray consisting of the elements of this NonEmptyArray sorted according to the comparison function lt.
final def startsWith[B](that: NonEmptyArray[B], offset: Int): Boolean
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.
that
the NonEmptyArray slice to look for in this NonEmptyArray
offset
the index at which this NonEmptyArray is searched.
returns
true if this NonEmptyArray has that as a slice at the index offset, false otherwise.
final def startsWith[B](that: Every[B], offset: Int): Boolean
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.
that
the Every slice to look for in this NonEmptyArray
offset
the index at which this NonEmptyArray is searched.
returns
true if this NonEmptyArray has that as a slice at the index offset, false otherwise.
final def startsWith[B](that: NonEmptyArray[B]): Boolean
Indicates whether this NonEmptyArray starts with the given NonEmptyArray.
Indicates whether this NonEmptyArray starts with the given NonEmptyArray.
that
the NonEmptyArray to test
returns
true if this collection has that as a prefix, false otherwise.
final def startsWith[B](that: Every[B]): Boolean
Indicates whether this NonEmptyArray starts with the given Every.
Indicates whether this NonEmptyArray starts with the given Every.
that
the Every to test
returns
true if this collection has that as a prefix, false otherwise.
final def startsWith[B](that: GenSeq[B], offset: Int): Boolean
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.
that
the GenSeq slice to look for in this NonEmptyArray
offset
the index at which this NonEmptyArray is searched.
returns
true if this NonEmptyArray has that as a slice at the index offset, false otherwise.
final def startsWith[B](that: GenSeq[B]): Boolean
Indicates whether this NonEmptyArray starts with the given GenSeq.
Indicates whether this NonEmptyArray starts with the given GenSeq.
that
the GenSeq slice to look for in this NonEmptyArray
returns
true if this NonEmptyArray has that as a prefix, false otherwise.
def stringPrefix: String
Returns "NonEmptyArray", the prefix of this object's toString representation.
Returns "NonEmptyArray", the prefix of this object's toString representation.
returns
the string "NonEmptyArray"
final def sum[U >: T](implicit num: Numeric[U]): U
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
val toArray: Array[T]
final def toBuffer[U >: T]: Buffer[U]
Converts this NonEmptyArray to a mutable buffer.
Converts this NonEmptyArray to a mutable buffer.
returns
a buffer containing all elements of this NonEmptyArray.
final def toIndexedSeq: IndexedSeq[T]
Converts this NonEmptyArray to an immutable IndexedSeq.
Converts this NonEmptyArray to an immutable IndexedSeq.
returns
an immutable IndexedSeq containing all elements of this NonEmptyArray.
final def toIterable: Iterable[T]
Converts this NonEmptyArray to an iterable collection.
Converts this NonEmptyArray to an iterable collection.
returns
an Iterable containing all elements of this NonEmptyArray.
final def toIterator: Iterator[T]
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 this NonEmptyArray.
final def toList[U >: T]: List[U]
Converts this NonEmptyArray to a list.
Converts this NonEmptyArray to a list.
returns
a list containing all elements of this NonEmptyArray. A ClassTag must be available for the element type of this NonEmptyArray.
final def toMap[K, V](implicit ev: <:<[T, (K, V)]): Map[K, V]
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 this NonEmptyArray.
final def toSeq: Seq[T]
Converts this NonEmptyArray to an immutable IndexedSeq.
Converts this NonEmptyArray to an immutable IndexedSeq.
returns
an immutable IndexedSeq containing all elements of this NonEmptyArray.
final def toSet[U >: T]: Set[U]
Converts this NonEmptyArray to a set.
Converts this NonEmptyArray to a set.
returns
a set containing all elements of this NonEmptyArray.
final def toStream: Stream[T]
Converts this NonEmptyArray to a stream.
Converts this NonEmptyArray to a stream.
returns
a stream containing all elements of this NonEmptyArray.
def toString(): String
Returns a string representation of this NonEmptyArray.
Returns a string representation of this NonEmptyArray.
returns
the string "NonEmptyArray" followed by the result of invoking toString on this NonEmptyArray's elements, surrounded by parentheses.
Definition Classes
NonEmptyArray → Any
final def toVector: Vector[T]
Converts this NonEmptyArray to a Vector.
Converts this NonEmptyArray to a Vector.
returns
a Vector containing all elements of this NonEmptyArray.
final def transpose[U](implicit ev: <:<[T, NonEmptyArray[U]], classTag: ClassTag[U]): NonEmptyArray[NonEmptyArray[U]]
final def unzip[L, R](implicit asPair: (T) => (L, R), classTagL: ClassTag[L], classTagR: ClassTag[R]): (NonEmptyArray[L], NonEmptyArray[R])
Converts this NonEmptyArray of pairs into two NonEmptyArrays of the first and second half of each pair.
Converts this NonEmptyArray of pairs into two NonEmptyArrays of the first and second half of each pair.
L
the type of the first half of the element pairs
R
the type of the second half of the element pairs
asPair
an implicit conversion that asserts that the element type of this NonEmptyArray is a pair.
returns
a pair of NonEmptyArrays, containing the first and second half, respectively, of each element pair of this NonEmptyArray.
final def unzip3[L, M, R](implicit asTriple: (T) => (L, M, R), classTagL: ClassTag[L], classTagM: ClassTag[M], classTagR: ClassTag[R]): (NonEmptyArray[L], NonEmptyArray[M], NonEmptyArray[R])
Converts this NonEmptyArray of triples into three NonEmptyArrays of the first, second, and and third element of each triple.
Converts this NonEmptyArray of triples into three NonEmptyArrays of the first, second, and and third element of each triple.
L
the type of the first member of the element triples
R
the type of the third member of the element triples
asTriple
an implicit conversion that asserts that the element type of this NonEmptyArray is a triple.
returns
a triple of NonEmptyArrays, containing the first, second, and third member, respectively, of each element triple of this NonEmptyArray.
final def updated[U >: T](idx: Int, elem: U)(implicit classTag: ClassTag[U]): NonEmptyArray[U]
A copy of this NonEmptyArray with one single replaced element.
A copy of this NonEmptyArray with one single replaced element.
idx
the position of the replacement
elem
the replacing element
returns
a copy of this NonEmptyArray with the element at position idx replaced by elem.
Exceptions thrown
IndexOutOfBoundsException if the passed index is greater than or equal to the length of this NonEmptyArray
final def zipAll[O, U >: T](other: Iterable[O], thisElem: U, otherElem: O): NonEmptyArray[(U, O)]
Returns a NonEmptyArray formed from this NonEmptyArray and an iterable collection by combining corresponding elements in pairs.
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.
other
the Iterable providing the second half of each result pair
thisElem
the element to be used to fill up the result if this NonEmptyArray is shorter than that Iterable.
returns
a new NonEmptyArray containing pairs consisting of corresponding elements of this NonEmptyArray and that. The length of the returned collection is the maximum of the lengths of this NonEmptyArray and that. If this NonEmptyArray is shorter than that, thisElem values are used to pad the result. If that is shorter than this NonEmptyArray, thatElem values are used to pad the result.
final def zipWithIndex: NonEmptyArray[(T, Int)]
Zips this NonEmptyArray with its indices.
Zips this NonEmptyArray with its indices.
returns
A new NonEmptyArray containing pairs consisting of all elements of this NonEmptyArray paired with their index. Indices start at 0.

Packages

NonEmptyArray

Companion object NonEmptyArray

final class NonEmptyArray[T] extends AnyVal

Constructing `NonEmptyArray`s

Working with `NonEmptyArray`s

Value Members

Inherited from AnyVal

Inherited from Any

Ungrouped

Packages

NonEmptyArray

Companion object NonEmptyArray

final class NonEmptyArray[T] extends AnyVal

Constructing NonEmptyArrays

Working with NonEmptyArrays

Value Members

Inherited from AnyVal

Inherited from Any

Ungrouped

NonEmptyArray

Constructing `NonEmptyArray`s

Working with `NonEmptyArray`s