c

# NonEmptyVector

### Companion object NonEmptyVector

#### final classNonEmptyVector[+T] extends AnyVal

A non-empty list: an ordered, immutable, non-empty collection of elements with LinearSeq performance characteristics.

The purpose of NonEmptyVector is to allow you to express in a type that a Vector is non-empty, thereby eliminating the need for (and potential exception from) a run-time check for non-emptiness. For a non-empty sequence with IndexedSeq performance, see Every.

#### Constructing NonEmptyVectors

You can construct a NonEmptyVector by passing one or more elements to the NonEmptyVector.apply factory method:

scala> NonEmptyVector(1, 2, 3)
res0: org.scalactic.anyvals.NonEmptyVector[Int] = NonEmptyVector(1, 2, 3)

Alternatively you can cons elements onto the End singleton object, similar to making a Vector starting with Nil:

scala> 1 :: 2 :: 3 :: Nil
res0: Vector[Int] = Vector(1, 2, 3)

scala> 1 :: 2 :: 3 :: End res1: org.scalactic.NonEmptyVector[Int] = NonEmptyVector(1, 2, 3)

Note that although Nil is a Vector[Nothing], End is not a NonEmptyVector[Nothing], because no empty NonEmptyVector exists. (A non-empty list is a series of connected links; if you have no links, you have no non-empty list.)

scala> val nil: Vector[Nothing] = Nil
nil: Vector[Nothing] = Vector()

scala> val nada: NonEmptyVector[Nothing] = End <console>:16: error: type mismatch; found : org.scalactic.anyvals.End.type required: org.scalactic.anyvals.NonEmptyVector[Nothing] val nada: NonEmptyVector[Nothing] = End ^

#### Working with NonEmptyVectors

NonEmptyVector 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> Vector(1).tail
res6: Vector[Int] = Vector()

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, NonEmptyVector defines a method corresponding to every such Seq method. Here are some examples:

NonEmptyVector(1, 2, 3).map(_ + 1)                        // Result: NonEmptyVector(2, 3, 4)
NonEmptyVector(1).map(_ + 1)                              // Result: NonEmptyVector(2)
NonEmptyVector(1, 2, 3).containsSlice(NonEmptyVector(2, 3)) // Result: true
NonEmptyVector(1, 2, 3).containsSlice(NonEmptyVector(3, 4)) // Result: false
NonEmptyVector(-1, -2, 3, 4, 5).minBy(_.abs)              // Result: -1

NonEmptyVector does not currently define any methods corresponding to Seq methods that could result in an empty Seq. However, an implicit converison from NonEmptyVector to Vector is defined in the NonEmptyVector 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 NonEmptyVector, even though filter could result in an empty sequence—but the result type will be Vector instead of NonEmptyVector:

NonEmptyVector(1, 2, 3).filter(_ < 10) // Result: Vector(1, 2, 3)
NonEmptyVector(1, 2, 3).filter(_ > 10) // Result: Vector()

You can use NonEmptyVectors in for expressions. The result will be an NonEmptyVector unless you use a filter (an if clause). Because filters are desugared to invocations of filter, the result type will switch to a Vector at that point. Here are some examples:

scala> import org.scalactic.anyvals._
import org.scalactic.anyvals._

scala> for (i <- NonEmptyVector(1, 2, 3)) yield i + 1
res0: org.scalactic.anyvals.NonEmptyVector[Int] = NonEmptyVector(2, 3, 4)

scala> for (i <- NonEmptyVector(1, 2, 3) if i < 10) yield i + 1
res1: Vector[Int] = Vector(2, 3, 4)

scala> for {
|   i <- NonEmptyVector(1, 2, 3)
|   j <- NonEmptyVector('a', 'b', 'c')
| } yield (i, j)
res3: org.scalactic.anyvals.NonEmptyVector[(Int, Char)] =
NonEmptyVector((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))

scala> for {
|   i <- NonEmptyVector(1, 2, 3) if i < 10
|   j <- NonEmptyVector('a', 'b', 'c')
| } yield (i, j)
res6: Vector[(Int, Char)] =
Vector((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 NonEmptyVector

Source
NonEmptyVector.scala
Linear Supertypes
AnyVal, Any
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. NonEmptyVector
2. AnyVal
3. Any
1. Hide All
2. Show All
Visibility
1. Public
2. Protected

### Value Members

1. final def !=(arg0: Any): Boolean
Definition Classes
Any
2. final def ##(): Int
Definition Classes
Any
3. def ++[U >: T](other: GenTraversableOnce[U]): NonEmptyVector[U]

Returns a new NonEmptyVector containing the elements of this NonEmptyVector followed by the elements of the passed GenTraversableOnce.

Returns a new NonEmptyVector containing the elements of this NonEmptyVector followed by the elements of the passed GenTraversableOnce. The element type of the resulting NonEmptyVector is the most specific superclass encompassing the element types of this NonEmptyVector and the passed GenTraversableOnce.

U

the element type of the returned NonEmptyVector

other

the GenTraversableOnce to append

returns

a new NonEmptyVector that contains all the elements of this NonEmptyVector followed by all elements of other.

4. def ++[U >: T](other: Every[U]): NonEmptyVector[U]

Returns a new NonEmptyVector containing the elements of this NonEmptyVector followed by the elements of the passed Every.

Returns a new NonEmptyVector containing the elements of this NonEmptyVector followed by the elements of the passed Every. The element type of the resulting NonEmptyVector is the most specific superclass encompassing the element types of this NonEmptyVector and the passed Every.

U

the element type of the returned NonEmptyVector

other

the Every to append

returns

a new NonEmptyVector that contains all the elements of this NonEmptyVector followed by all elements of other.

5. def ++[U >: T](other: NonEmptyVector[U]): NonEmptyVector[U]

Returns a new NonEmptyVector containing the elements of this NonEmptyVector followed by the elements of the passed NonEmptyVector.

Returns a new NonEmptyVector containing the elements of this NonEmptyVector followed by the elements of the passed NonEmptyVector. The element type of the resulting NonEmptyVector is the most specific superclass encompassing the element types of this and the passed NonEmptyVector.

U

the element type of the returned NonEmptyVector

other

the NonEmptyVector to append

returns

a new NonEmptyVector that contains all the elements of this NonEmptyVector followed by all elements of other.

6. final def +:[U >: T](element: U): NonEmptyVector[U]

Returns a new NonEmptyVector with the given element prepended.

Returns a new NonEmptyVector 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 NonEmptyVector

returns

a new NonEmptyVector consisting of element followed by all elements of this NonEmptyVector.

7. def :+[U >: T](element: U): NonEmptyVector[U]

Returns a new NonEmptyVector with the given element appended.

Returns a new NonEmptyVector 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 NonEmptyVector

returns

a new NonEmptyVector consisting of all elements of this NonEmptyVector followed by element.

8. final def ::[U >: T](element: U): NonEmptyVector[U]

Adds an element to the beginning of this NonEmptyVector.

Adds an element to the beginning of this NonEmptyVector.

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 NonEmptyVector

returns

a NonEmptyVector that contains element as first element and that continues with this NonEmptyVector.

9. final def ==(arg0: Any): Boolean
Definition Classes
Any
10. final def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

Appends all elements of this NonEmptyVector to a string builder using start, end, and separator strings.

Appends all elements of this NonEmptyVector 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 NonEmptyVector, 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.

11. final def addString(sb: StringBuilder, sep: String): StringBuilder

Appends all elements of this NonEmptyVector to a string builder using a separator string.

Appends all elements of this NonEmptyVector 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 NonEmptyVector, 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.

12. final def addString(sb: StringBuilder): StringBuilder

Appends all elements of this NonEmptyVector to a string builder.

Appends all elements of this NonEmptyVector to a string builder. The written text will consist of a concatenation of the result of invoking toString on of every element of this NonEmptyVector, without any separator string.

sb

the string builder to which elements will be appended

returns

the string builder, sb, to which elements were appended.

13. final def apply(idx: Int): T

Selects an element by its index in the NonEmptyVector.

Selects an element by its index in the NonEmptyVector.

returns

the element of this NonEmptyVector at index idx, where 0 indicates the first element.

14. final def asInstanceOf[T0]: T0
Definition Classes
Any
15. final def collectFirst[U](pf: PartialFunction[T, U]): Option[U]

Finds the first element of this NonEmptyVector for which the given partial function is defined, if any, and applies the partial function to it.

Finds the first element of this NonEmptyVector 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.

16. final def contains(elem: Any): Boolean

Indicates whether this NonEmptyVector contains a given value as an element.

Indicates whether this NonEmptyVector contains a given value as an element.

elem

the element to look for

returns

true if this NonEmptyVector has an element that is equal (as determined by ==) to elem, false otherwise.

17. final def containsSlice[B](that: NonEmptyVector[B]): Boolean

Indicates whether this NonEmptyVector contains a given NonEmptyVector as a slice.

Indicates whether this NonEmptyVector contains a given NonEmptyVector as a slice.

that

the NonEmptyVector slice to look for

returns

true if this NonEmptyVector contains a slice with the same elements as that, otherwise false.

18. final def containsSlice[B](that: Every[B]): Boolean

Indicates whether this NonEmptyVector contains a given Every as a slice.

Indicates whether this NonEmptyVector contains a given Every as a slice.

that

the Every slice to look for

returns

true if this NonEmptyVector contains a slice with the same elements as that, otherwise false.

19. final def containsSlice[B](that: GenSeq[B]): Boolean

Indicates whether this NonEmptyVector contains a given GenSeq as a slice.

Indicates whether this NonEmptyVector contains a given GenSeq as a slice.

that

the GenSeq slice to look for

returns

true if this NonEmptyVector contains a slice with the same elements as that, otherwise false.

20. final def copyToArray[U >: T](arr: Array[U], start: Int, len: Int): Unit

Copies values of this NonEmptyVector to an array.

Copies values of this NonEmptyVector to an array. Fills the given array arr with at most len elements of this NonEmptyVector, beginning at index start. Copying will stop once either the end of the current NonEmptyVector 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

21. final def copyToArray[U >: T](arr: Array[U], start: Int): Unit

Copies values of this NonEmptyVector to an array.

Copies values of this NonEmptyVector to an array. Fills the given array arr with values of this NonEmptyVector, beginning at index start. Copying will stop once either the end of the current NonEmptyVector is reached, or the end of the array is reached.

arr

the array to fill

start

the starting index

22. final def copyToArray[U >: T](arr: Array[U]): Unit

Copies values of this NonEmptyVector to an array.

Copies values of this NonEmptyVector to an array. Fills the given array arr with values of this NonEmptyVector. Copying will stop once either the end of the current NonEmptyVector is reached, or the end of the array is reached.

arr

the array to fill

23. final def copyToBuffer[U >: T](buf: Buffer[U]): Unit

Copies all elements of this NonEmptyVector to a buffer.

Copies all elements of this NonEmptyVector to a buffer.

buf

the buffer to which elements are copied

24. final def corresponds[B](that: NonEmptyVector[B])(p: (T, B) => Boolean): Boolean

Indicates whether every element of this NonEmptyVector relates to the corresponding element of a given NonEmptyVector by satisfying a given predicate.

Indicates whether every element of this NonEmptyVector relates to the corresponding element of a given NonEmptyVector by satisfying a given predicate.

B

the type of the elements of that

that

the NonEmptyVector to compare for correspondence

p

the predicate, which relates elements from this and the passed NonEmptyVector

returns

true if this and the passed NonEmptyVector have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyVector and y of that, otherwise false.

25. final def corresponds[B](that: Every[B])(p: (T, B) => Boolean): Boolean

Indicates whether every element of this NonEmptyVector relates to the corresponding element of a given Every by satisfying a given predicate.

Indicates whether every element of this NonEmptyVector 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 NonEmptyVector and the passed Every

returns

true if this NonEmptyVector and the passed Every have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyVector and y of that, otherwise false.

26. final def corresponds[B](that: GenSeq[B])(p: (T, B) => Boolean): Boolean

Indicates whether every element of this NonEmptyVector relates to the corresponding element of a given GenSeq by satisfying a given predicate.

Indicates whether every element of this NonEmptyVector 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 NonEmptyVector and the passed GenSeq

returns

true if this NonEmptyVector and the passed GenSeq have the same length and p(x, y) is true for all corresponding elements x of this NonEmptyVector and y of that, otherwise false.

27. final def count(p: (T) => Boolean): Int

Counts the number of elements in this NonEmptyVector that satisfy a predicate.

Counts the number of elements in this NonEmptyVector that satisfy a predicate.

p

the predicate used to test elements.

returns

the number of elements satisfying the predicate p.

28. final def distinct: NonEmptyVector[T]

Builds a new NonEmptyVector from this NonEmptyVector without any duplicate elements.

Builds a new NonEmptyVector from this NonEmptyVector without any duplicate elements.

returns

A new NonEmptyVector that contains the first occurrence of every element of this NonEmptyVector.

29. final def endsWith[B](that: NonEmptyVector[B]): Boolean

Indicates whether this NonEmptyVector ends with the given NonEmptyVector.

Indicates whether this NonEmptyVector ends with the given NonEmptyVector.

that

the NonEmptyVector to test

returns

true if this NonEmptyVector has that as a suffix, false otherwise.

30. final def endsWith[B](that: Every[B]): Boolean

Indicates whether this NonEmptyVector ends with the given Every.

Indicates whether this NonEmptyVector ends with the given Every.

that

the Every to test

returns

true if this NonEmptyVector has that as a suffix, false otherwise.

31. final def endsWith[B](that: GenSeq[B]): Boolean

Indicates whether this NonEmptyVector ends with the given GenSeq.

Indicates whether this NonEmptyVector ends with the given GenSeq.

that

the sequence to test

returns

true if this NonEmptyVector has that as a suffix, false otherwise.

32. final def exists(p: (T) => Boolean): Boolean

Indicates whether a predicate holds for at least one of the elements of this NonEmptyVector.

Indicates whether a predicate holds for at least one of the elements of this NonEmptyVector.

returns

true if the given predicate p holds for some of the elements of this NonEmptyVector, otherwise false.

33. final def find(p: (T) => Boolean): Option[T]

Finds the first element of this NonEmptyVector that satisfies the given predicate, if any.

Finds the first element of this NonEmptyVector that satisfies the given predicate, if any.

p

the predicate used to test elements

returns

an Some containing the first element in this NonEmptyVector that satisfies p, or None if none exists.

34. final def flatMap[U](f: (T) => NonEmptyVector[U]): NonEmptyVector[U]

Builds a new NonEmptyVector by applying a function to all elements of this NonEmptyVector and using the elements of the resulting NonEmptyVectors.

Builds a new NonEmptyVector by applying a function to all elements of this NonEmptyVector and using the elements of the resulting NonEmptyVectors.

U

the element type of the returned NonEmptyVector

f

the function to apply to each element.

returns

a new NonEmptyVector containing elements obtained by applying the given function f to each element of this NonEmptyVector and concatenating the elements of resulting NonEmptyVectors.

35. final def flatten[B](implicit ev: <:<[T, NonEmptyVector[B]]): NonEmptyVector[B]

Converts this NonEmptyVector of NonEmptyVectors into a NonEmptyVector formed by the elements of the nested NonEmptyVectors.

Converts this NonEmptyVector of NonEmptyVectors into a NonEmptyVector formed by the elements of the nested NonEmptyVectors.

Note: You cannot use this flatten method on a NonEmptyVector that contains a GenTraversableOnces, because if all the nested GenTraversableOnces were empty, you'd end up with an empty NonEmptyVector.

returns

a new NonEmptyVector resulting from concatenating all nested NonEmptyVectors.

36. final def fold[U >: T](z: U)(op: (U, U) => U): U

Folds the elements of this NonEmptyVector using the specified associative binary operator.

Folds the elements of this NonEmptyVector 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

37. final def foldLeft[B](z: B)(op: (B, T) => B): B

Applies a binary operator to a start value and all elements of this NonEmptyVector, going left to right.

Applies a binary operator to a start value and all elements of this NonEmptyVector, 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 NonEmptyVector, 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 NonEmptyVector.

38. final def foldRight[B](z: B)(op: (T, B) => B): B

Applies a binary operator to all elements of this NonEmptyVector and a start value, going right to left.

Applies a binary operator to all elements of this NonEmptyVector 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 NonEmptyVector, 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 NonEmptyVector.

39. final def forall(p: (T) => Boolean): Boolean

Indicates whether a predicate holds for all elements of this NonEmptyVector.

Indicates whether a predicate holds for all elements of this NonEmptyVector.

p

the predicate used to test elements.

returns

true if the given predicate p holds for all elements of this NonEmptyVector, otherwise false.

40. final def foreach(f: (T) => Unit): Unit

Applies a function f to all elements of this NonEmptyVector.

Applies a function f to all elements of this NonEmptyVector.

f

the function that is applied for its side-effect to every element. The result of function f is discarded.

41. def getClass(): Class[_ <: AnyVal]
Definition Classes
AnyVal → Any
42. final def groupBy[K](f: (T) => K): Map[K, NonEmptyVector[T]]

Partitions this NonEmptyVector into a map of NonEmptyVectors according to some discriminator function.

Partitions this NonEmptyVector into a map of NonEmptyVectors 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 NonEmptyVectors such that the following invariant holds:

(nonEmptyVector.toVector partition f)(k) = xs filter (x => f(x) == k)

That is, every key k is bound to a NonEmptyVector of those elements x for which f(x) equals k.

43. final def grouped(size: Int): Iterator[NonEmptyVector[T]]

Partitions elements into fixed size NonEmptyVectors.

Partitions elements into fixed size NonEmptyVectors.

size

the number of elements per group

returns

An iterator producing NonEmptyVectors of size size, except the last will be truncated if the elements don't divide evenly.

44. final def hasDefiniteSize: Boolean

Returns true to indicate this NonEmptyVector has a definite size, since all NonEmptyVectors are strict collections.

Selects the first element of this NonEmptyVector.

Selects the first element of this NonEmptyVector.

returns

the first element of this NonEmptyVector.

Selects the first element of this NonEmptyVector and returns it wrapped in a Some.

Selects the first element of this NonEmptyVector and returns it wrapped in a Some.

returns

the first element of this NonEmptyVector, wrapped in a Some.

47. final def indexOf[U >: T](elem: U, from: Int): Int

Finds index of first occurrence of some value in this NonEmptyVector after or at some start index.

Finds index of first occurrence of some value in this NonEmptyVector 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 NonEmptyVector that is equal (as determined by ==) to elem, or -1, if none exists.

48. final def indexOf[U >: T](elem: U): Int

Finds index of first occurrence of some value in this NonEmptyVector.

Finds index of first occurrence of some value in this NonEmptyVector.

elem

the element value to search for.

returns

the index of the first element of this NonEmptyVector that is equal (as determined by ==) to elem, or -1, if none exists.

49. final def indexOfSlice[U >: T](that: NonEmptyVector[U], from: Int): Int

Finds first index after or at a start index where this NonEmptyVector contains a given NonEmptyVector as a slice.

Finds first index after or at a start index where this NonEmptyVector contains a given NonEmptyVector as a slice.

that

the NonEmptyVector defining the slice to look for

from

the start index

returns

the first index >= from such that the elements of this NonEmptyVector starting at this index match the elements of NonEmptyVector that, or -1 of no such subsequence exists.

50. final def indexOfSlice[U >: T](that: Every[U], from: Int): Int

Finds first index after or at a start index where this NonEmptyVector contains a given Every as a slice.

Finds first index after or at a start index where this NonEmptyVector 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 NonEmptyVector starting at this index match the elements of Every that, or -1 of no such subsequence exists.

51. final def indexOfSlice[U >: T](that: NonEmptyVector[U]): Int

Finds first index where this NonEmptyVector contains a given NonEmptyVector as a slice.

Finds first index where this NonEmptyVector contains a given NonEmptyVector as a slice.

that

the NonEmptyVector defining the slice to look for

returns

the first index such that the elements of this NonEmptyVector starting at this index match the elements of NonEmptyVector that, or -1 of no such subsequence exists.

52. final def indexOfSlice[U >: T](that: Every[U]): Int

Finds first index where this NonEmptyVector contains a given Every as a slice.

Finds first index where this NonEmptyVector 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 NonEmptyVector starting at this index match the elements of Every that, or -1 of no such subsequence exists.

53. final def indexOfSlice[U >: T](that: GenSeq[U], from: Int): Int

Finds first index after or at a start index where this NonEmptyVector contains a given GenSeq as a slice.

Finds first index after or at a start index where this NonEmptyVector 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 NonEmptyVector starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

54. final def indexOfSlice[U >: T](that: GenSeq[U]): Int

Finds first index where this NonEmptyVector contains a given GenSeq as a slice.

Finds first index where this NonEmptyVector 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 NonEmptyVector starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

55. 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 NonEmptyVector that satisfies the predicate p, or -1, if none exists.

56. 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 NonEmptyVector that satisfies the predicate p, or -1, if none exists.

57. final def indices: Range

Produces the range of all indices of this NonEmptyVector.

Produces the range of all indices of this NonEmptyVector.

returns

a Range value from 0 to one less than the length of this NonEmptyVector.

58. final def isDefinedAt(idx: Int): Boolean

Tests whether this NonEmptyVector contains given index.

Tests whether this NonEmptyVector contains given index.

idx

the index to test

returns

true if this NonEmptyVector contains an element at position idx, false otherwise.

59. final def isEmpty: Boolean

Returns false to indicate this NonEmptyVector, like all NonEmptyVectors, is non-empty.

Returns false to indicate this NonEmptyVector, like all NonEmptyVectors, is non-empty.

returns

false

60. final def isInstanceOf[T0]: Boolean
Definition Classes
Any
61. final def isTraversableAgain: Boolean

Returns true to indicate this NonEmptyVector, like all NonEmptyVectors, can be traversed repeatedly.

Returns true to indicate this NonEmptyVector, like all NonEmptyVectors, can be traversed repeatedly.

returns

true

62. final def iterator: Iterator[T]

Creates and returns a new iterator over all elements contained in this NonEmptyVector.

Creates and returns a new iterator over all elements contained in this NonEmptyVector.

returns

the new iterator

63. final def last: T

Selects the last element of this NonEmptyVector.

Selects the last element of this NonEmptyVector.

returns

the last element of this NonEmptyVector.

64. final def lastIndexOf[U >: T](elem: U, end: Int): Int

Finds the index of the last occurrence of some value in this NonEmptyVector before or at a given end index.

Finds the index of the last occurrence of some value in this NonEmptyVector 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 NonEmptyVector that is equal (as determined by ==) to elem, or -1, if none exists.

65. final def lastIndexOf[U >: T](elem: U): Int

Finds the index of the last occurrence of some value in this NonEmptyVector.

Finds the index of the last occurrence of some value in this NonEmptyVector.

elem

the element value to search for.

returns

the index of the last element of this NonEmptyVector that is equal (as determined by ==) to elem, or -1, if none exists.

66. final def lastIndexOfSlice[U >: T](that: NonEmptyVector[U], end: Int): Int

Finds the last index before or at a given end index where this NonEmptyVector contains a given NonEmptyVector as a slice.

Finds the last index before or at a given end index where this NonEmptyVector contains a given NonEmptyVector as a slice.

that

the NonEmptyVector defining the slice to look for

end

the end index

returns

the last index >= end at which the elements of this NonEmptyVector starting at that index match the elements of NonEmptyVector that, or -1 of no such subsequence exists.

67. final def lastIndexOfSlice[U >: T](that: Every[U], end: Int): Int

Finds the last index before or at a given end index where this NonEmptyVector contains a given Every as a slice.

Finds the last index before or at a given end index where this NonEmptyVector 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 NonEmptyVector starting at that index match the elements of Every that, or -1 of no such subsequence exists.

68. final def lastIndexOfSlice[U >: T](that: NonEmptyVector[U]): Int

Finds the last index where this NonEmptyVector contains a given NonEmptyVector as a slice.

Finds the last index where this NonEmptyVector contains a given NonEmptyVector as a slice.

that

the NonEmptyVector defining the slice to look for

returns

the last index at which the elements of this NonEmptyVector starting at that index match the elements of NonEmptyVector that, or -1 of no such subsequence exists.

69. final def lastIndexOfSlice[U >: T](that: Every[U]): Int

Finds the last index where this NonEmptyVector contains a given Every as a slice.

Finds the last index where this NonEmptyVector 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 NonEmptyVector starting at that index match the elements of Every that, or -1 of no such subsequence exists.

70. final def lastIndexOfSlice[U >: T](that: GenSeq[U], end: Int): Int

Finds the last index before or at a given end index where this NonEmptyVector contains a given GenSeq as a slice.

Finds the last index before or at a given end index where this NonEmptyVector 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 NonEmptyVector starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

71. final def lastIndexOfSlice[U >: T](that: GenSeq[U]): Int

Finds the last index where this NonEmptyVector contains a given GenSeq as a slice.

Finds the last index where this NonEmptyVector 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 NonEmptyVector starting at that index match the elements of GenSeq that, or -1 of no such subsequence exists.

72. 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 NonEmptyVector that satisfies the predicate p, or -1, if none exists.

73. 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 NonEmptyVector that satisfies the predicate p, or -1, if none exists.

74. final def lastOption: Option[T]

Returns the last element of this NonEmptyVector, wrapped in a Some.

Returns the last element of this NonEmptyVector, wrapped in a Some.

returns

the last element, wrapped in a Some.

75. final def length: Int

The length of this NonEmptyVector.

The length of this NonEmptyVector.

Note: length and size yield the same result, which will be >= 1.

returns

the number of elements in this NonEmptyVector.

76. final def lengthCompare(len: Int): Int

Compares the length of this NonEmptyVector to a test value.

Compares the length of this NonEmptyVector 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

77. final def map[U](f: (T) => U): NonEmptyVector[U]

Builds a new NonEmptyVector by applying a function to all elements of this NonEmptyVector.

Builds a new NonEmptyVector by applying a function to all elements of this NonEmptyVector.

U

the element type of the returned NonEmptyVector.

f

the function to apply to each element.

returns

a new NonEmptyVector resulting from applying the given function f to each element of this NonEmptyVector and collecting the results.

78. final def max[U >: T](implicit cmp: Ordering[U]): T

Finds the largest element.

Finds the largest element.

returns

the largest element of this NonEmptyVector.

79. 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 NonEmptyVector.

80. final def min[U >: T](implicit cmp: Ordering[U]): T

Finds the smallest element.

Finds the smallest element.

returns

the smallest element of this NonEmptyVector.

81. 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 NonEmptyVector.

82. final def mkString(start: String, sep: String, end: String): String

Displays all elements of this NonEmptyVector in a string using start, end, and separator strings.

Displays all elements of this NonEmptyVector 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 NonEmptyVector. 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 NonEmptyVector are separated by the string sep.

83. final def mkString(sep: String): String

Displays all elements of this NonEmptyVector in a string using a separator string.

Displays all elements of this NonEmptyVector in a string using a separator string.

sep

the separator string

returns

a string representation of this NonEmptyVector. In the resulting string, the result of invoking toString on all elements of this NonEmptyVector are separated by the string sep.

84. final def mkString: String

Displays all elements of this NonEmptyVector in a string.

Displays all elements of this NonEmptyVector in a string.

returns

a string representation of this NonEmptyVector. In the resulting string, the result of invoking toString on all elements of this NonEmptyVector follow each other without any separator string.

85. final def nonEmpty: Boolean

Returns true to indicate this NonEmptyVector, like all NonEmptyVectors, is non-empty.

Returns true to indicate this NonEmptyVector, like all NonEmptyVectors, is non-empty.

returns

true

86. final def padTo[U >: T](len: Int, elem: U): NonEmptyVector[U]

A copy of this NonEmptyVector with an element value appended until a given target length is reached.

A copy of this NonEmptyVector with an element value appended until a given target length is reached.

len

the target length

elem

returns

a new NonEmptyVector consisting of all elements of this NonEmptyVector followed by the minimal number of occurrences of elem so that the resulting NonEmptyVector has a length of at least len.

87. final def patch[U >: T](from: Int, that: NonEmptyVector[U], replaced: Int): NonEmptyVector[U]

Produces a new NonEmptyVector where a slice of elements in this NonEmptyVector is replaced by another NonEmptyVector

Produces a new NonEmptyVector where a slice of elements in this NonEmptyVector is replaced by another NonEmptyVector

from

the index of the first replaced element

that

the NonEmptyVector whose elements should replace a slice in this NonEmptyVector

replaced

the number of elements to drop in the original NonEmptyVector

88. final def permutations: Iterator[NonEmptyVector[T]]

Iterates over distinct permutations.

Iterates over distinct permutations.

Here's an example:

NonEmptyVector('a', 'b', 'b').permutations.toVector = Vector(NonEmptyVector(a, b, b), NonEmptyVector(b, a, b), NonEmptyVector(b, b, a))

returns

an iterator that traverses the distinct permutations of this NonEmptyVector.

89. 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 NonEmptyVector such that every element of the segment satisfies the predicate p.

90. final def product[U >: T](implicit num: Numeric[U]): U

The result of multiplying all the elements of this NonEmptyVector.

The result of multiplying all the elements of this NonEmptyVector.

This method can be invoked for any NonEmptyVector[T] for which an implicit Numeric[T] exists.

returns

the product of all elements

91. final def reduce[U >: T](op: (U, U) => U): U

Reduces the elements of this NonEmptyVector using the specified associative binary operator.

Reduces the elements of this NonEmptyVector 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 NonEmptyVector.

92. final def reduceLeft[U >: T](op: (U, T) => U): U

Applies a binary operator to all elements of this NonEmptyVector, going left to right.

Applies a binary operator to all elements of this NonEmptyVector, 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 NonEmptyVector, going left to right:

op(...op(op(x_1, x_2), x_3), ..., x_n)

where x1, ..., xn are the elements of this NonEmptyVector.

93. final def reduceLeftOption[U >: T](op: (U, T) => U): Option[U]

Applies a binary operator to all elements of this NonEmptyVector, going left to right, returning the result in a Some.

Applies a binary operator to all elements of this NonEmptyVector, 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)

94. final def reduceOption[U >: T](op: (U, U) => U): Option[U]
95. final def reduceRight[U >: T](op: (T, U) => U): U

Applies a binary operator to all elements of this NonEmptyVector, going right to left.

Applies a binary operator to all elements of this NonEmptyVector, 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 NonEmptyVector, going right to left:

op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))

where x1, ..., xn are the elements of this NonEmptyVector.

96. final def reduceRightOption[U >: T](op: (T, U) => U): Option[U]

Applies a binary operator to all elements of this NonEmptyVector, going right to left, returning the result in a Some.

Applies a binary operator to all elements of this NonEmptyVector, 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)

97. final def reverse: NonEmptyVector[T]

Returns new NonEmptyVector with elements in reverse order.

Returns new NonEmptyVector with elements in reverse order.

returns

a new NonEmptyVector with all elements of this NonEmptyVector in reversed order.

98. final def reverseIterator: Iterator[T]

An iterator yielding elements in reverse order.

An iterator yielding elements in reverse order.

Note: nonEmptyVector.reverseIterator is the same as nonEmptyVector.reverse.iterator, but might be more efficient.

returns

an iterator yielding the elements of this NonEmptyVector in reversed order

99. final def reverseMap[U](f: (T) => U): NonEmptyVector[U]

Builds a new NonEmptyVector by applying a function to all elements of this NonEmptyVector and collecting the results in reverse order.

Builds a new NonEmptyVector by applying a function to all elements of this NonEmptyVector and collecting the results in reverse order.

Note: nonEmptyVector.reverseMap(f) is the same as nonEmptyVector.reverse.map(f), but might be more efficient.

U

the element type of the returned NonEmptyVector.

f

the function to apply to each element.

returns

a new NonEmptyVector resulting from applying the given function f to each element of this NonEmptyVector and collecting the results in reverse order.

100. final def sameElements[U >: T](that: NonEmptyVector[U]): Boolean

Checks if the given NonEmptyVector contains the same elements in the same order as this NonEmptyVector.

Checks if the given NonEmptyVector contains the same elements in the same order as this NonEmptyVector.

that

the NonEmptyVector with which to compare

returns

true, if both this and the given NonEmptyVector contain the same elements in the same order, false otherwise.

101. final def sameElements[U >: T](that: Every[U]): Boolean

Checks if the given Every contains the same elements in the same order as this NonEmptyVector.

Checks if the given Every contains the same elements in the same order as this NonEmptyVector.

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.

102. final def sameElements[U >: T](that: GenIterable[U]): Boolean

Checks if the given GenIterable contains the same elements in the same order as this NonEmptyVector.

Checks if the given GenIterable contains the same elements in the same order as this NonEmptyVector.

that

the GenIterable with which to compare

returns

true, if both this NonEmptyVector and the given GenIterable contain the same elements in the same order, false otherwise.

103. final def scan[U >: T](z: U)(op: (U, U) => U): NonEmptyVector[U]

Computes a prefix scan of the elements of this NonEmptyVector.

Computes a prefix scan of the elements of this NonEmptyVector.

Note: The neutral element z may be applied more than once.

Here are some examples:

NonEmptyVector(1, 2, 3).scan(0)(_ + _) == NonEmptyVector(0, 1, 3, 6)
NonEmptyVector(1, 2, 3).scan("z")(_ + _.toString) == NonEmptyVector("z", "z1", "z12", "z123")

U

a type parameter for the binary operator, a supertype of T, and the type of the resulting NonEmptyVector.

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 NonEmptyVector containing the prefix scan of the elements in this NonEmptyVector

104. final def scanLeft[B](z: B)(op: (B, T) => B): NonEmptyVector[B]

Produces a NonEmptyVector containing cumulative results of applying the operator going left to right.

Produces a NonEmptyVector containing cumulative results of applying the operator going left to right.

Here are some examples:

NonEmptyVector(1, 2, 3).scanLeft(0)(_ + _) == NonEmptyVector(0, 1, 3, 6)
NonEmptyVector(1, 2, 3).scanLeft("z")(_ + _) == NonEmptyVector("z", "z1", "z12", "z123")

B

the result type of the binary operator and type of the resulting NonEmptyVector

z

the start value.

op

the binary operator.

returns

a new NonEmptyVector containing the intermediate results of inserting op between consecutive elements of this NonEmptyVector, going left to right, with the start value, z, on the left.

105. final def scanRight[B](z: B)(op: (T, B) => B): NonEmptyVector[B]

Produces a NonEmptyVector containing cumulative results of applying the operator going right to left.

Produces a NonEmptyVector containing cumulative results of applying the operator going right to left.

Here are some examples:

NonEmptyVector(1, 2, 3).scanRight(0)(_ + _) == NonEmptyVector(6, 5, 3, 0)
NonEmptyVector(1, 2, 3).scanRight("z")(_ + _) == NonEmptyVector("123z", "23z", "3z", "z")

B

the result of the binary operator and type of the resulting NonEmptyVector

z

the start value

op

the binary operator

returns

a new NonEmptyVector containing the intermediate results of inserting op between consecutive elements of this NonEmptyVector, going right to left, with the start value, z, on the right.

106. 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.

107. final def size: Int

The size of this NonEmptyVector.

The size of this NonEmptyVector.

Note: length and size yield the same result, which will be >= 1.

returns

the number of elements in this NonEmptyVector.

108. final def sliding(size: Int, step: Int): Iterator[NonEmptyVector[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 NonEmptyVectors of size size, except the last and the only element will be truncated if there are fewer elements than size.

109. final def sliding(size: Int): Iterator[NonEmptyVector[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 NonEmptyVectors of size size, except the last and the only element will be truncated if there are fewer elements than size.

110. final def sortBy[U](f: (T) => U)(implicit ord: Ordering[U]): NonEmptyVector[T]

Sorts this NonEmptyVector according to the Ordering of the result of applying the given function to every element.

Sorts this NonEmptyVector 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 NonEmptyVector consisting of the elements of this NonEmptyVector sorted according to the Ordering where x < y if ord.lt(f(x), f(y)).

111. final def sortWith(lt: (T, T) => Boolean): NonEmptyVector[T]

Sorts this NonEmptyVector according to a comparison function.

Sorts this NonEmptyVector 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 NonEmptyVector as in the original.

returns

a NonEmptyVector consisting of the elements of this NonEmptyVector sorted according to the comparison function lt.

112. final def sorted[U >: T](implicit ord: Ordering[U]): NonEmptyVector[U]

Sorts this NonEmptyVector according to an Ordering.

Sorts this NonEmptyVector 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 NonEmptyVector as in the original.

ord

the Ordering to be used to compare elements.

returns

a NonEmptyVector consisting of the elements of this NonEmptyVector sorted according to the comparison function lt.

113. final def startsWith[B](that: NonEmptyVector[B], offset: Int): Boolean

Indicates whether this NonEmptyVector starts with the given NonEmptyVector at the given index.

Indicates whether this NonEmptyVector starts with the given NonEmptyVector at the given index.

that

the NonEmptyVector slice to look for in this NonEmptyVector

offset

the index at which this NonEmptyVector is searched.

returns

true if this NonEmptyVector has that as a slice at the index offset, false otherwise.

114. final def startsWith[B](that: Every[B], offset: Int): Boolean

Indicates whether this NonEmptyVector starts with the given Every at the given index.

Indicates whether this NonEmptyVector starts with the given Every at the given index.

that

the Every slice to look for in this NonEmptyVector

offset

the index at which this NonEmptyVector is searched.

returns

true if this NonEmptyVector has that as a slice at the index offset, false otherwise.

115. final def startsWith[B](that: NonEmptyVector[B]): Boolean

Indicates whether this NonEmptyVector starts with the given NonEmptyVector.

Indicates whether this NonEmptyVector starts with the given NonEmptyVector.

that

the NonEmptyVector to test

returns

true if this collection has that as a prefix, false otherwise.

116. final def startsWith[B](that: Every[B]): Boolean

Indicates whether this NonEmptyVector starts with the given Every.

Indicates whether this NonEmptyVector starts with the given Every.

that

the Every to test

returns

true if this collection has that as a prefix, false otherwise.

117. final def startsWith[B](that: GenSeq[B], offset: Int): Boolean

Indicates whether this NonEmptyVector starts with the given GenSeq at the given index.

Indicates whether this NonEmptyVector starts with the given GenSeq at the given index.

that

the GenSeq slice to look for in this NonEmptyVector

offset

the index at which this NonEmptyVector is searched.

returns

true if this NonEmptyVector has that as a slice at the index offset, false otherwise.

118. final def startsWith[B](that: GenSeq[B]): Boolean

Indicates whether this NonEmptyVector starts with the given GenSeq.

Indicates whether this NonEmptyVector starts with the given GenSeq.

that

the GenSeq slice to look for in this NonEmptyVector

returns

true if this NonEmptyVector has that as a prefix, false otherwise.

119. def stringPrefix: String

Returns "NonEmptyVector", the prefix of this object's toString representation.

Returns "NonEmptyVector", the prefix of this object's toString representation.

returns

the string "NonEmptyVector"

120. final def sum[U >: T](implicit num: Numeric[U]): U

The result of summing all the elements of this NonEmptyVector.

The result of summing all the elements of this NonEmptyVector.

This method can be invoked for any NonEmptyVector[T] for which an implicit Numeric[T] exists.

returns

the sum of all elements

121. final def to[Col[_]](factory: Factory[T, Col[T]]): Col[T]

Converts this NonEmptyVector into a collection of type Col by copying all elements.

Converts this NonEmptyVector into a collection of type Col by copying all elements.

Col

the collection type to build.

returns

a new collection containing all elements of this NonEmptyVector.

122. final def toArray[U >: T](implicit classTag: ClassTag[U]): Array[U]

Converts this NonEmptyVector to an array.

Converts this NonEmptyVector to an array.

returns

an array containing all elements of this NonEmptyVector. A ClassTag must be available for the element type of this NonEmptyVector.

123. final def toBuffer[U >: T]: Buffer[U]

Converts this NonEmptyVector to a mutable buffer.

Converts this NonEmptyVector to a mutable buffer.

returns

a buffer containing all elements of this NonEmptyVector.

124. final def toIndexedSeq: IndexedSeq[T]

Converts this NonEmptyVector to an immutable IndexedSeq.

Converts this NonEmptyVector to an immutable IndexedSeq.

returns

an immutable IndexedSeq containing all elements of this NonEmptyVector.

125. final def toIterable: Iterable[T]

Converts this NonEmptyVector to an iterable collection.

Converts this NonEmptyVector to an iterable collection.

returns

an Iterable containing all elements of this NonEmptyVector.

126. final def toIterator: Iterator[T]

Returns an Iterator over the elements in this NonEmptyVector.

Returns an Iterator over the elements in this NonEmptyVector.

returns

an Iterator containing all elements of this NonEmptyVector.

127. final def toList: List[T]

Converts this NonEmptyVector to a Vector.

Converts this NonEmptyVector to a Vector.

returns

a Vector containing all elements of this NonEmptyVector.

128. final def toMap[K, V](implicit ev: <:<[T, (K, V)]): Map[K, V]

Converts this NonEmptyVector to a map.

Converts this NonEmptyVector 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 NonEmptyVector.

129. final def toSeq: Seq[T]

Converts this NonEmptyVector to an immutable IndexedSeq.

Converts this NonEmptyVector to an immutable IndexedSeq.

returns

an immutable IndexedSeq containing all elements of this NonEmptyVector.

130. final def toSet[U >: T]: Set[U]

Converts this NonEmptyVector to a set.

Converts this NonEmptyVector to a set.

returns

a set containing all elements of this NonEmptyVector.

131. final def toStream: Stream[T]

Converts this NonEmptyVector to a stream.

Converts this NonEmptyVector to a stream.

returns

a stream containing all elements of this NonEmptyVector.

132. def toString(): String

Returns a string representation of this NonEmptyVector.

Returns a string representation of this NonEmptyVector.

returns

the string "NonEmptyVector" followed by the result of invoking toString on this NonEmptyVector's elements, surrounded by parentheses.

Definition Classes
NonEmptyVector → Any
133. val toVector: Vector[T]
134. final def transpose[U](implicit ev: <:<[T, NonEmptyVector[U]])
135. final def union[U >: T](that: GenSeq[U])(implicit cbf: CanBuildFrom[Vector[T], U, Vector[U]]): NonEmptyVector[U]

Produces a new NonEmptyVector that contains all elements of this NonEmptyVector and also all elements of a given GenSeq.

Produces a new NonEmptyVector that contains all elements of this NonEmptyVector and also all elements of a given GenSeq.

nonEmptyVectorX union ys is equivalent to nonEmptyVectorX ++ ys.

Another way to express this is that nonEmptyVectorX union ys computes the order-presevring multi-set union of nonEmptyVectorX and ys. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

that

returns

a new NonEmptyVector that contains all elements of this NonEmptyVector followed by all elements of that GenSeq.

136. final def union[U >: T](that: NonEmptyVector[U]): NonEmptyVector[U]

Produces a new NonEmptyVector that contains all elements of this NonEmptyVector and also all elements of a given NonEmptyVector.

Produces a new NonEmptyVector that contains all elements of this NonEmptyVector and also all elements of a given NonEmptyVector.

nonEmptyVectorX union nonEmptyVectorY is equivalent to nonEmptyVectorX ++ nonEmptyVectorY.

Another way to express this is that nonEmptyVectorX union nonEmptyVectorY computes the order-presevring multi-set union of nonEmptyVectorX and nonEmptyVectorY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

that

returns

a new NonEmptyVector that contains all elements of this NonEmptyVector followed by all elements of that.

137. final def union[U >: T](that: Every[U]): NonEmptyVector[U]

Produces a new NonEmptyVector that contains all elements of this NonEmptyVector and also all elements of a given Every.

Produces a new NonEmptyVector that contains all elements of this NonEmptyVector and also all elements of a given Every.

nonEmptyVectorX union everyY is equivalent to nonEmptyVectorX ++ everyY.

Another way to express this is that nonEmptyVectorX union everyY computes the order-presevring multi-set union of nonEmptyVectorX and everyY. This union method is hence a counter-part of diff and intersect that also work on multi-sets.

that

returns

a new NonEmptyVector that contains all elements of this NonEmptyVector followed by all elements of that Every.

138. final def unzip[L, R](implicit asPair: (T) => (L, R)): (NonEmptyVector[L], NonEmptyVector[R])

Converts this NonEmptyVector of pairs into two NonEmptyVectors of the first and second half of each pair.

Converts this NonEmptyVector of pairs into two NonEmptyVectors 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 NonEmptyVector is a pair.

returns

a pair of NonEmptyVectors, containing the first and second half, respectively, of each element pair of this NonEmptyVector.

139. final def unzip3[L, M, R](implicit asTriple: (T) => (L, M, R)): (NonEmptyVector[L], NonEmptyVector[M], NonEmptyVector[R])

Converts this NonEmptyVector of triples into three NonEmptyVectors of the first, second, and and third element of each triple.

Converts this NonEmptyVector of triples into three NonEmptyVectors 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 NonEmptyVector is a triple.

returns

a triple of NonEmptyVectors, containing the first, second, and third member, respectively, of each element triple of this NonEmptyVector.

140. final def updated[U >: T](idx: Int, elem: U): NonEmptyVector[U]

A copy of this NonEmptyVector with one single replaced element.

A copy of this NonEmptyVector with one single replaced element.

idx

the position of the replacement

elem

the replacing element

returns

a copy of this NonEmptyVector 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 NonEmptyVector

141. final def zipAll[O, U >: T](other: Iterable[O], thisElem: U, otherElem: O): NonEmptyVector[(U, O)]

Returns a NonEmptyVector formed from this NonEmptyVector and an iterable collection by combining corresponding elements in pairs.

Returns a NonEmptyVector formed from this NonEmptyVector 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 NonEmptyVector is shorter than that Iterable.

returns

a new NonEmptyVector containing pairs consisting of corresponding elements of this NonEmptyVector and that. The length of the returned collection is the maximum of the lengths of this NonEmptyVector and that. If this NonEmptyVector is shorter than that, thisElem values are used to pad the result. If that is shorter than this NonEmptyVector, thatElem values are used to pad the result.

142. final def zipWithIndex: NonEmptyVector[(T, Int)]

Zips this NonEmptyVector with its indices.

Zips this NonEmptyVector with its indices.

returns

A new NonEmptyVector containing pairs consisting of all elements of this NonEmptyVector paired with their index. Indices start at 0.