Class/Object

org.scalactic.anyvals

NonEmptyList

Related Docs: object NonEmptyList | package anyvals

Permalink

final class NonEmptyList[+T] extends AnyVal

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

The purpose of NonEmptyList is to allow you to express in a type that a List 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 NonEmptyLists

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

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

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

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

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

Note that although Nil is a List[Nothing], End is not a NonEmptyList[Nothing], because no empty NonEmptyList 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: List[Nothing] = Nil
nil: List[Nothing] = List()

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

Working with NonEmptyLists

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

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

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

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

NonEmptyList(1, 2, 3).filter(_ < 10) // Result: List(1, 2, 3)
NonEmptyList(1, 2, 3).filter(_ > 10) // Result: List()

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

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

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

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

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

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

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    Any
  3. def ++[U >: T](other: IterableOnce[U]): NonEmptyList[U]

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    other

    the GenTraversableOnce to append

    returns

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

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

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    other

    the Every to append

    returns

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

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

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    other

    the NonEmptyList to append

    returns

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

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

    Permalink

    Returns a new NonEmptyList with the given element prepended.

    Returns a new NonEmptyList with the given element prepended.

    Note that :-ending operators are right associative. A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

    element

    the element to prepend to this NonEmptyList

    returns

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

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

    Permalink

    Returns a new NonEmptyList with the given element appended.

    Returns a new NonEmptyList with the given element appended.

    Note a mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

    element

    the element to append to this NonEmptyList

    returns

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

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

    Permalink

    Adds an element to the beginning of this NonEmptyList.

    Adds an element to the beginning of this NonEmptyList.

    Note that :-ending operators are right associative. A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.

    element

    the element to prepend to this NonEmptyList

    returns

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

  9. def :::[U >: T](other: GenTraversableOnce[U]): NonEmptyList[U]

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    other

    the GenTraversableOnce to append

    returns

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

  10. def :::[U >: T](other: Every[U]): NonEmptyList[U]

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    other

    the Every to append

    returns

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

  11. def :::[U >: T](other: NonEmptyList[U]): NonEmptyList[U]

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    other

    the NonEmptyList to append

    returns

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

  12. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  13. final def addString(sb: StringBuilder, start: String, sep: String, end: String): StringBuilder

    Permalink

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

    Appends all elements of this NonEmptyList to a string builder using start, end, and separator strings. The written text will consist of a concatenation of the string start; the result of invoking toString on all elements of this NonEmptyList, separated by the string sep; and the string end

    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.

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

    Permalink

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

    Appends all elements of this NonEmptyList to a string builder using a separator string. The written text will consist of a concatenation of the result of invoking toString on of every element of this NonEmptyList, separated by the string sep.

    sb

    the string builder to which elements will be appended

    sep

    the separator string

    returns

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

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

    Permalink

    Appends all elements of this NonEmptyList to a string builder.

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

    sb

    the string builder to which elements will be appended

    returns

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

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

    Permalink

    Selects an element by its index in the NonEmptyList.

    Selects an element by its index in the NonEmptyList.

    returns

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

  17. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  18. final def collectFirst[U](pf: PartialFunction[T, U]): Option[U]

    Permalink

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

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

    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.

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

    Permalink

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

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

    elem

    the element to look for

    returns

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

  20. final def containsSlice[B](that: NonEmptyList[B]): Boolean

    Permalink

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

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

    that

    the NonEmptyList slice to look for

    returns

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

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

    Permalink

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

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

    that

    the Every slice to look for

    returns

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

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

    Permalink

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

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

    that

    the GenSeq slice to look for

    returns

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

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

    Permalink

    Copies values of this NonEmptyList to an array.

    Copies values of this NonEmptyList to an array. Fills the given array arr with at most len elements of this NonEmptyList, beginning at index start. Copying will stop once either the end of the current NonEmptyList is reached, the end of the array is reached, or len elements have been copied.

    arr

    the array to fill

    start

    the starting index

    len

    the maximum number of elements to copy

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

    Permalink

    Copies values of this NonEmptyList to an array.

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

    arr

    the array to fill

    start

    the starting index

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

    Permalink

    Copies values of this NonEmptyList to an array.

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

    arr

    the array to fill

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

    Permalink

    Copies all elements of this NonEmptyList to a buffer.

    Copies all elements of this NonEmptyList to a buffer.

    buf

    the buffer to which elements are copied

  27. final def corresponds[B](that: NonEmptyList[B])(p: (T, B) ⇒ Boolean): Boolean

    Permalink

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

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

    B

    the type of the elements of that

    that

    the NonEmptyList to compare for correspondence

    p

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

    returns

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

  28. final def corresponds[B](that: Every[B])(p: (T, B) ⇒ Boolean): Boolean

    Permalink

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

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

    B

    the type of the elements of that

    that

    the Every to compare for correspondence

    p

    the predicate, which relates elements from this NonEmptyList and the passed Every

    returns

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

  29. final def corresponds[B](that: GenSeq[B])(p: (T, B) ⇒ Boolean): Boolean

    Permalink

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

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

    B

    the type of the elements of that

    that

    the GenSeq to compare for correspondence

    p

    the predicate, which relates elements from this NonEmptyList and the passed GenSeq

    returns

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

  30. final def count(p: (T) ⇒ Boolean): Int

    Permalink

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

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

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

  31. final def distinct: NonEmptyList[T]

    Permalink

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

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

    returns

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

  32. final def endsWith[B](that: NonEmptyList[B]): Boolean

    Permalink

    Indicates whether this NonEmptyList ends with the given NonEmptyList.

    Indicates whether this NonEmptyList ends with the given NonEmptyList.

    that

    the NonEmptyList to test

    returns

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

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

    Permalink

    Indicates whether this NonEmptyList ends with the given Every.

    Indicates whether this NonEmptyList ends with the given Every.

    that

    the Every to test

    returns

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

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

    Permalink

    Indicates whether this NonEmptyList ends with the given GenSeq.

    Indicates whether this NonEmptyList ends with the given GenSeq.

    that

    the sequence to test

    returns

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

  35. final def exists(p: (T) ⇒ Boolean): Boolean

    Permalink

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

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

    returns

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

  36. final def find(p: (T) ⇒ Boolean): Option[T]

    Permalink

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

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

    p

    the predicate used to test elements

    returns

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

  37. final def flatMap[U](f: (T) ⇒ NonEmptyList[U]): NonEmptyList[U]

    Permalink

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

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

    U

    the element type of the returned NonEmptyList

    f

    the function to apply to each element.

    returns

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

  38. final def flatten[B](implicit ev: <:<[T, NonEmptyList[B]]): NonEmptyList[B]

    Permalink

    Converts this NonEmptyList of NonEmptyLists into a NonEmptyList formed by the elements of the nested NonEmptyLists.

    Converts this NonEmptyList of NonEmptyLists into a NonEmptyList formed by the elements of the nested NonEmptyLists.

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

    returns

    a new NonEmptyList resulting from concatenating all nested NonEmptyLists.

  39. final def fold[U >: T](z: U)(op: (U, U) ⇒ U): U

    Permalink

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

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

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

    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

  40. final def foldLeft[B](z: B)(op: (B, T) ⇒ B): B

    Permalink

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

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

    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 NonEmptyList, going left to right, with the start value, z, on the left:

    op(...op(op(z, x_1), x_2), ..., x_n)
    
    where x1, ..., xn are the elements of this NonEmptyList.

  41. final def foldRight[B](z: B)(op: (T, B) ⇒ B): B

    Permalink

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

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

    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 NonEmptyList, going right to left, with the start value, z, on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))
    
    where x1, ..., xn are the elements of this NonEmptyList.

  42. final def forall(p: (T) ⇒ Boolean): Boolean

    Permalink

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

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

    p

    the predicate used to test elements.

    returns

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

  43. final def foreach(f: (T) ⇒ Unit): Unit

    Permalink

    Applies a function f to all elements of this NonEmptyList.

    Applies a function f to all elements of this NonEmptyList.

    f

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

  44. def getClass(): Class[_ <: AnyVal]

    Permalink
    Definition Classes
    AnyVal → Any
  45. final def groupBy[K](f: (T) ⇒ K): Map[K, NonEmptyList[T]]

    Permalink

    Partitions this NonEmptyList into a map of NonEmptyLists according to some discriminator function.

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

    (nonEmptyList.toList partition f)(k) = xs filter (x => f(x) == k)
    
    That is, every key k is bound to a NonEmptyList of those elements x for which f(x) equals k.

  46. final def grouped(size: Int): Iterator[NonEmptyList[T]]

    Permalink

    Partitions elements into fixed size NonEmptyLists.

    Partitions elements into fixed size NonEmptyLists.

    size

    the number of elements per group

    returns

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

  47. final def hasDefiniteSize: Boolean

    Permalink

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

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

  48. final def head: T

    Permalink

    Selects the first element of this NonEmptyList.

    Selects the first element of this NonEmptyList.

    returns

    the first element of this NonEmptyList.

  49. final def headOption: Option[T]

    Permalink

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

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

    returns

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

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

    Permalink

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

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

    elem

    the element value to search for.

    from

    the start index

    returns

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

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

    Permalink

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

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

    elem

    the element value to search for.

    returns

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

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

    Permalink

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

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

    that

    the NonEmptyList defining the slice to look for

    from

    the start index

    returns

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

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

    Permalink

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

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

    that

    the Every defining the slice to look for

    from

    the start index

    returns

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

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

    Permalink

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

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

    that

    the NonEmptyList defining the slice to look for

    returns

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

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

    Permalink

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

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

    that

    the Every defining the slice to look for

    returns

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

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

    Permalink

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

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

    that

    the GenSeq defining the slice to look for

    from

    the start index

    returns

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

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

    Permalink

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

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

    that

    the GenSeq defining the slice to look for

    returns

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

  58. final def indexWhere(p: (T) ⇒ Boolean, from: Int): Int

    Permalink

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

  59. final def indexWhere(p: (T) ⇒ Boolean): Int

    Permalink

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

  60. final def indices: Range

    Permalink

    Produces the range of all indices of this NonEmptyList.

    Produces the range of all indices of this NonEmptyList.

    returns

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

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

    Permalink

    Tests whether this NonEmptyList contains given index.

    Tests whether this NonEmptyList contains given index.

    idx

    the index to test

    returns

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

  62. final def isEmpty: Boolean

    Permalink

    Returns false to indicate this NonEmptyList, like all NonEmptyLists, is non-empty.

    Returns false to indicate this NonEmptyList, like all NonEmptyLists, is non-empty.

    returns

    false

  63. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  64. final def isTraversableAgain: Boolean

    Permalink

    Returns true to indicate this NonEmptyList, like all NonEmptyLists, can be traversed repeatedly.

    Returns true to indicate this NonEmptyList, like all NonEmptyLists, can be traversed repeatedly.

    returns

    true

  65. final def iterator: Iterator[T]

    Permalink

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

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

    returns

    the new iterator

  66. final def last: T

    Permalink

    Selects the last element of this NonEmptyList.

    Selects the last element of this NonEmptyList.

    returns

    the last element of this NonEmptyList.

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

    Permalink

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

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

    elem

    the element value to search for.

    end

    the end index.

    returns

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

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

    Permalink

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

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

    elem

    the element value to search for.

    returns

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

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

    Permalink

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

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

    that

    the NonEmptyList defining the slice to look for

    end

    the end index

    returns

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

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

    Permalink

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

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

    that

    the Every defining the slice to look for

    end

    the end index

    returns

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

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

    Permalink

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

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

    that

    the NonEmptyList defining the slice to look for

    returns

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

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

    Permalink

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

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

    that

    the Every defining the slice to look for

    returns

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

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

    Permalink

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

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

    that

    the GenSeq defining the slice to look for

    end

    the end index

    returns

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

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

    Permalink

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

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

    that

    the GenSeq defining the slice to look for

    returns

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

  75. final def lastIndexWhere(p: (T) ⇒ Boolean, end: Int): Int

    Permalink

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

  76. final def lastIndexWhere(p: (T) ⇒ Boolean): Int

    Permalink

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

  77. final def lastOption: Option[T]

    Permalink

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

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

    returns

    the last element, wrapped in a Some.

  78. final def length: Int

    Permalink

    The length of this NonEmptyList.

    The length of this NonEmptyList.

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

    returns

    the number of elements in this NonEmptyList.

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

    Permalink

    Compares the length of this NonEmptyList to a test value.

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

  80. final def map[U](f: (T) ⇒ U): NonEmptyList[U]

    Permalink

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

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

    U

    the element type of the returned NonEmptyList.

    f

    the function to apply to each element.

    returns

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

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

    Permalink

    Finds the largest element.

    Finds the largest element.

    returns

    the largest element of this NonEmptyList.

  82. final def maxBy[U](f: (T) ⇒ U)(implicit cmp: Ordering[U]): T

    Permalink

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

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

    Permalink

    Finds the smallest element.

    Finds the smallest element.

    returns

    the smallest element of this NonEmptyList.

  84. final def minBy[U](f: (T) ⇒ U)(implicit cmp: Ordering[U]): T

    Permalink

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

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

    Permalink

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

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

    start

    the starting string.

    sep

    the separator string.

    end

    the ending string.

    returns

    a string representation of this NonEmptyList. The resulting string begins with the string start and ends with the string end. Inside, In the resulting string, the result of invoking toString on all elements of this NonEmptyList are separated by the string sep.

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

    Permalink

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

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

    sep

    the separator string

    returns

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

  87. final def mkString: String

    Permalink

    Displays all elements of this NonEmptyList in a string.

    Displays all elements of this NonEmptyList in a string.

    returns

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

  88. final def nonEmpty: Boolean

    Permalink

    Returns true to indicate this NonEmptyList, like all NonEmptyLists, is non-empty.

    Returns true to indicate this NonEmptyList, like all NonEmptyLists, is non-empty.

    returns

    true

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

    Permalink

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

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

    len

    the target length

    elem

    he padding value

    returns

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

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

    Permalink

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

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

    from

    the index of the first replaced element

    that

    the NonEmptyList whose elements should replace a slice in this NonEmptyList

    replaced

    the number of elements to drop in the original NonEmptyList

  91. final def permutations: Iterator[NonEmptyList[T]]

    Permalink

    Iterates over distinct permutations.

    Iterates over distinct permutations.

    Here's an example:

    NonEmptyList('a', 'b', 'b').permutations.toList = List(NonEmptyList(a, b, b), NonEmptyList(b, a, b), NonEmptyList(b, b, a))
    

    returns

    an iterator that traverses the distinct permutations of this NonEmptyList.

  92. final def prefixLength(p: (T) ⇒ Boolean): Int

    Permalink

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

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

    Permalink

    The result of multiplying all the elements of this NonEmptyList.

    The result of multiplying all the elements of this NonEmptyList.

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

    returns

    the product of all elements

  94. final def reduce[U >: T](op: (U, U) ⇒ U): U

    Permalink

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

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

    The order in which operations are performed on elements is unspecified and may be nondeterministic.

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

  95. final def reduceLeft[U >: T](op: (U, T) ⇒ U): U

    Permalink

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

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

    U

    the result type of the binary operator.

    op

    the binary operator.

    returns

    the result of inserting op between consecutive elements of this NonEmptyList, going left to right:

    op(...op(op(x_1, x_2), x_3), ..., x_n)
    
    where x1, ..., xn are the elements of this NonEmptyList.

  96. final def reduceLeftOption[U >: T](op: (U, T) ⇒ U): Option[U]

    Permalink

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

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

    U

    the result type of the binary operator.

    op

    the binary operator.

    returns

    a Some containing the result of reduceLeft(op)

  97. final def reduceOption[U >: T](op: (U, U) ⇒ U): Option[U]

    Permalink
  98. final def reduceRight[U >: T](op: (T, U) ⇒ U): U

    Permalink

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

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

    U

    the result of the binary operator

    op

    the binary operator

    returns

    the result of inserting op between consecutive elements of this NonEmptyList, going right to left:

    op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))
    
    where x1, ..., xn are the elements of this NonEmptyList.

  99. final def reduceRightOption[U >: T](op: (T, U) ⇒ U): Option[U]

    Permalink

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

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

    U

    the result of the binary operator

    op

    the binary operator

    returns

    a Some containing the result of reduceRight(op)

  100. final def reverse: NonEmptyList[T]

    Permalink

    Returns new NonEmptyList with elements in reverse order.

    Returns new NonEmptyList with elements in reverse order.

    returns

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

  101. final def reverseIterator: Iterator[T]

    Permalink

    An iterator yielding elements in reverse order.

    An iterator yielding elements in reverse order.

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

    returns

    an iterator yielding the elements of this NonEmptyList in reversed order

  102. final def reverseMap[U](f: (T) ⇒ U): NonEmptyList[U]

    Permalink

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

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

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

    U

    the element type of the returned NonEmptyList.

    f

    the function to apply to each element.

    returns

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

  103. final def sameElements[U >: T](that: NonEmptyList[U]): Boolean

    Permalink

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

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

    that

    the NonEmptyList with which to compare

    returns

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

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

    Permalink

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

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

    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.

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

    Permalink

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

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

    that

    the GenIterable with which to compare

    returns

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

  106. final def scan[U >: T](z: U)(op: (U, U) ⇒ U): NonEmptyList[U]

    Permalink

    Computes a prefix scan of the elements of this NonEmptyList.

    Computes a prefix scan of the elements of this NonEmptyList.

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

    Here are some examples:

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

    U

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

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

  107. final def scanLeft[B](z: B)(op: (B, T) ⇒ B): NonEmptyList[B]

    Permalink

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

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

    Here are some examples:

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

    B

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

    z

    the start value.

    op

    the binary operator.

    returns

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

  108. final def scanRight[B](z: B)(op: (T, B) ⇒ B): NonEmptyList[B]

    Permalink

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

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

    Here are some examples:

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

    B

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

    z

    the start value

    op

    the binary operator

    returns

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

  109. final def segmentLength(p: (T) ⇒ Boolean, from: Int): Int

    Permalink

    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.

  110. final def size: Int

    Permalink

    The size of this NonEmptyList.

    The size of this NonEmptyList.

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

    returns

    the number of elements in this NonEmptyList.

  111. final def sliding(size: Int, step: Int): Iterator[NonEmptyList[T]]

    Permalink

    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 NonEmptyLists of size size, except the last and the only element will be truncated if there are fewer elements than size.

  112. final def sliding(size: Int): Iterator[NonEmptyList[T]]

    Permalink

    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 NonEmptyLists of size size, except the last and the only element will be truncated if there are fewer elements than size.

  113. final def sortBy[U](f: (T) ⇒ U)(implicit ord: Ordering[U]): NonEmptyList[T]

    Permalink

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

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

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

  114. final def sortWith(lt: (T, T) ⇒ Boolean): NonEmptyList[T]

    Permalink

    Sorts this NonEmptyList according to a comparison function.

    Sorts this NonEmptyList according to a comparison function.

    The sort is stable. That is, elements that are equal (as determined by lt) appear in the same order in the sorted NonEmptyList as in the original.

    returns

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

  115. final def sorted[U >: T](implicit ord: Ordering[U]): NonEmptyList[U]

    Permalink

    Sorts this NonEmptyList according to an Ordering.

    Sorts this NonEmptyList according to an Ordering.

    The sort is stable. That is, elements that are equal (as determined by lt) appear in the same order in the sorted NonEmptyList as in the original.

    ord

    the Ordering to be used to compare elements.

    returns

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

  116. final def startsWith[B](that: NonEmptyList[B], offset: Int): Boolean

    Permalink

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

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

    that

    the NonEmptyList slice to look for in this NonEmptyList

    offset

    the index at which this NonEmptyList is searched.

    returns

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

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

    Permalink

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

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

    that

    the Every slice to look for in this NonEmptyList

    offset

    the index at which this NonEmptyList is searched.

    returns

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

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

    Permalink

    Indicates whether this NonEmptyList starts with the given NonEmptyList.

    Indicates whether this NonEmptyList starts with the given NonEmptyList.

    that

    the NonEmptyList to test

    returns

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

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

    Permalink

    Indicates whether this NonEmptyList starts with the given Every.

    Indicates whether this NonEmptyList starts with the given Every.

    that

    the Every to test

    returns

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

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

    Permalink

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

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

    that

    the GenSeq slice to look for in this NonEmptyList

    offset

    the index at which this NonEmptyList is searched.

    returns

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

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

    Permalink

    Indicates whether this NonEmptyList starts with the given GenSeq.

    Indicates whether this NonEmptyList starts with the given GenSeq.

    that

    the GenSeq slice to look for in this NonEmptyList

    returns

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

  122. def stringPrefix: String

    Permalink

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

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

    returns

    the string "NonEmptyList"

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

    Permalink

    The result of summing all the elements of this NonEmptyList.

    The result of summing all the elements of this NonEmptyList.

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

    returns

    the sum of all elements

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

    Permalink

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

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

    Col

    the collection type to build.

    returns

    a new collection containing all elements of this NonEmptyList.

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

    Permalink

    Converts this NonEmptyList to an array.

    Converts this NonEmptyList to an array.

    returns

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

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

    Permalink

    Converts this NonEmptyList to a mutable buffer.

    Converts this NonEmptyList to a mutable buffer.

    returns

    a buffer containing all elements of this NonEmptyList.

  127. final def toIndexedSeq: IndexedSeq[T]

    Permalink

    Converts this NonEmptyList to an immutable IndexedSeq.

    Converts this NonEmptyList to an immutable IndexedSeq.

    returns

    an immutable IndexedSeq containing all elements of this NonEmptyList.

  128. final def toIterable: Iterable[T]

    Permalink

    Converts this NonEmptyList to an iterable collection.

    Converts this NonEmptyList to an iterable collection.

    returns

    an Iterable containing all elements of this NonEmptyList.

  129. final def toIterator: Iterator[T]

    Permalink

    Returns an Iterator over the elements in this NonEmptyList.

    Returns an Iterator over the elements in this NonEmptyList.

    returns

    an Iterator containing all elements of this NonEmptyList.

  130. val toList: List[T]

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

    Permalink

    Converts this NonEmptyList to a map.

    Converts this NonEmptyList to a map.

    This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair in the map. Duplicate keys will be overwritten by later keys.

    returns

    a map of type immutable.Map[K, V] containing all key/value pairs of type (K, V) of this NonEmptyList.

  132. final def toSeq: Seq[T]

    Permalink

    Converts this NonEmptyList to an immutable IndexedSeq.

    Converts this NonEmptyList to an immutable IndexedSeq.

    returns

    an immutable IndexedSeq containing all elements of this NonEmptyList.

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

    Permalink

    Converts this NonEmptyList to a set.

    Converts this NonEmptyList to a set.

    returns

    a set containing all elements of this NonEmptyList.

  134. final def toStream: Stream[T]

    Permalink

    Converts this NonEmptyList to a stream.

    Converts this NonEmptyList to a stream.

    returns

    a stream containing all elements of this NonEmptyList.

  135. def toString(): String

    Permalink

    Returns a string representation of this NonEmptyList.

    Returns a string representation of this NonEmptyList.

    returns

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

    Definition Classes
    NonEmptyList → Any
  136. final def toVector: Vector[T]

    Permalink

    Converts this NonEmptyList to a Vector.

    Converts this NonEmptyList to a Vector.

    returns

    a Vector containing all elements of this NonEmptyList.

  137. final def transpose[U](implicit ev: <:<[T, NonEmptyList[U]]): NonEmptyList[NonEmptyList[U]]

    Permalink
  138. final def union[U >: T](that: GenSeq[U]): NonEmptyList[U]

    Permalink

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

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

    nonEmptyListX union ys is equivalent to nonEmptyListX ++ ys.

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

    that

    the GenSeq to add.

    returns

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

  139. final def union[U >: T](that: NonEmptyList[U]): NonEmptyList[U]

    Permalink

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

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

    nonEmptyListX union nonEmptyListY is equivalent to nonEmptyListX ++ nonEmptyListY.

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

    that

    the NonEmptyList to add.

    returns

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

  140. final def union[U >: T](that: Every[U]): NonEmptyList[U]

    Permalink

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

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

    nonEmptyListX union everyY is equivalent to nonEmptyListX ++ everyY.

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

    that

    the Every to add.

    returns

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

  141. final def unzip[L, R](implicit asPair: (T) ⇒ (L, R)): (NonEmptyList[L], NonEmptyList[R])

    Permalink

    Converts this NonEmptyList of pairs into two NonEmptyLists of the first and second half of each pair.

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

    returns

    a pair of NonEmptyLists, containing the first and second half, respectively, of each element pair of this NonEmptyList.

  142. final def unzip3[L, M, R](implicit asTriple: (T) ⇒ (L, M, R)): (NonEmptyList[L], NonEmptyList[M], NonEmptyList[R])

    Permalink

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

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

    returns

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

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

    Permalink

    A copy of this NonEmptyList with one single replaced element.

    A copy of this NonEmptyList with one single replaced element.

    idx

    the position of the replacement

    elem

    the replacing element

    returns

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

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

    Permalink

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

    Returns a NonEmptyList formed from this NonEmptyList and an iterable collection by combining corresponding elements in pairs. If one of the two collections is shorter than the other, placeholder elements will be used to extend the shorter collection to the length of the longer.

    other

    the Iterable providing the second half of each result pair

    thisElem

    the element to be used to fill up the result if this NonEmptyList is shorter than that Iterable.

    returns

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

  145. final def zipWithIndex: NonEmptyList[(T, Int)]

    Permalink

    Zips this NonEmptyList with its indices.

    Zips this NonEmptyList with its indices.

    returns

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

Deprecated Value Members

  1. final def /:[B](z: B)(op: (B, T) ⇒ B): B

    Permalink

    The /: method has been deprecated and will be removed in a future version of Scalactic. Please use foldLeft instead.

    The /: method has been deprecated and will be removed in a future version of Scalactic. Please use foldLeft instead.

    This method has been deprecated for consistency with Scala 2.13's collections API.

    Fold left: applies a binary operator to a start value, z, and all elements of this NonEmptyList, going left to right.

    Note: /: is alternate syntax for the foldLeft method; z /: non-empty list is the same as non-empty list foldLeft z.

    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 NonEmptyList, going left to right, with the start value, z, on the left:

    op(...op(op(z, x_1), x_2), ..., x_n)
    
    where x1, ..., xn are the elements of this NonEmptyList.

    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.x) The /: method has been deprecated and will be removed in a future version of Scalactic. Please use foldLeft instead.

  2. final def :\[B](z: B)(op: (T, B) ⇒ B): B

    Permalink

    The :\\ method has been deprecated and will be removed in a future version of Scalactic. Please use foldRight instead.

    The :\\ method has been deprecated and will be removed in a future version of Scalactic. Please use foldRight instead.

    This method has been deprecated for consistency with Scala 2.13's collections API.

    Fold right: applies a binary operator to all elements of this NonEmptyList and a start value, going right to left.

    Note: :\ is alternate syntax for the foldRight method; non-empty list :\ z is the same as non-empty list foldRight z.

    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 NonEmptyList, going right to left, with the start value, z, on the right:

    op(x_1, op(x_2, ... op(x_n, z)...))
    
    where x1, ..., xn are the elements of this NonEmptyList.

    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.x) The :\ method has been deprecated and will be removed in a future version of Scalactic. Please use foldRight instead.

Inherited from AnyVal

Inherited from Any

Ungrouped