final class NonEmptySet[T] extends AnyVal

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

The purpose of NonEmptySet is to allow you to express in a type that a Set 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 NonEmptySets

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

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

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

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

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

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

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

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

Working with NonEmptySets

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

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

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

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

NonEmptySet(1, 2, 3).filter(_ < 10) // Result: Set(1, 2, 3)
NonEmptySet(1, 2, 3).filter(_ > 10) // Result: Set()

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

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

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

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

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

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

Source
NonEmptySet.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NonEmptySet
  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. final def +(elem1: T, elem2: T, elems: T*): NonEmptySet[T]

    Returns a new NonEmptySet with the given element added.

    Returns a new NonEmptySet with the given element added.

    elem1

    the first element to add.

    elem2

    the second element to add.

    elems

    the remaining elements to add.

    returns

    a new NonEmptySet with the given elements added, omitting duplicates.

  4. final def +(element: T): NonEmptySet[T]

    Returns a new NonEmptySet with the given element added.

    Returns a new NonEmptySet with the given element added.

    element

    the element to add to this NonEmptySet

    returns

    a new NonEmptySet consisting of element and all elements of this NonEmptySet.

  5. def ++(other: IterableOnce[T]): NonEmptySet[T]

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

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

    other

    the GenTraversableOnce to append

    returns

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

  6. def ++[U >: T](other: Every[U]): NonEmptySet[U]

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

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

    U

    the element type of the returned NonEmptySet

    other

    the Every to append

    returns

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

  7. def ++[U >: T](other: NonEmptySet[U]): NonEmptySet[U]

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

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

    U

    the element type of the returned NonEmptySet

    other

    the NonEmptySet to append

    returns

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

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

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

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

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

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

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

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

    Appends all elements of this NonEmptySet to a string builder.

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

    sb

    the string builder to which elements will be appended

    returns

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

  12. final def apply(elem: T): Boolean

    Check if an element exists at its index in the NonEmptySet.

    Check if an element exists at its index in the NonEmptySet.

    returns

    true if a element exists in NonEmptySet at index idx, where false indicates the element at index idx does not exist.

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

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

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

  15. final def contains(elem: T): Boolean

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

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

    elem

    the element to look for

    returns

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

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

    Copies values of this NonEmptySet to an array.

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

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

    Copies values of this NonEmptySet to an array.

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

    arr

    the array to fill

    start

    the starting index

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

    Copies values of this NonEmptySet to an array.

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

    arr

    the array to fill

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

    Copies all elements of this NonEmptySet to a buffer.

    Copies all elements of this NonEmptySet to a buffer.

    buf

    the buffer to which elements are copied

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

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

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

    p

    the predicate used to test elements.

    returns

    the number of elements satisfying the predicate p.

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

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

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

    p

    the predicate used to test elements.

    returns

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

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

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

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

    p

    the predicate used to test elements

    returns

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

  23. final def flatMap[U](f: (T) => NonEmptySet[U]): NonEmptySet[U]

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

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

    U

    the element type of the returned NonEmptySet

    f

    the function to apply to each element.

    returns

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

  24. final def flatten[B](implicit ev: <:<[T, NonEmptySet[B]]): NonEmptySet[B]

    Converts this NonEmptySet of NonEmptySets into a NonEmptySet formed by the elements of the nested NonEmptySets.

    Converts this NonEmptySet of NonEmptySets into a NonEmptySet formed by the elements of the nested NonEmptySets.

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

    returns

    a new NonEmptySet resulting from concatenating all nested NonEmptySets.

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

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

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

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

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

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

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

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

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

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

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

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

    p

    the predicate used to test elements.

    returns

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

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

    Applies a function f to all elements of this NonEmptySet.

    Applies a function f to all elements of this NonEmptySet.

    f

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

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

    Partitions this NonEmptySet into a map of NonEmptySets according to some discriminator function.

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

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

  32. final def grouped(size: Int): Iterator[NonEmptySet[T]]

    Partitions elements into fixed size NonEmptySets.

    Partitions elements into fixed size NonEmptySets.

    size

    the number of elements per group

    returns

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

  33. final def hasDefiniteSize: Boolean

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

  34. final def head: T

    Selects the first element of this NonEmptySet.

    Selects the first element of this NonEmptySet.

    returns

    the first element of this NonEmptySet.

  35. final def headOption: Option[T]

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

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

    returns

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

  36. final def isEmpty: Boolean

    Returns false to indicate this NonEmptySet, like all NonEmptySets, is non-empty.

    Returns false to indicate this NonEmptySet, like all NonEmptySets, is non-empty.

    returns

    false

  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. final def isTraversableAgain: Boolean

    Returns true to indicate this NonEmptySet, like all NonEmptySets, can be traversed repeatedly.

    Returns true to indicate this NonEmptySet, like all NonEmptySets, can be traversed repeatedly.

    returns

    true

  39. final def iterator: Iterator[T]

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

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

    returns

    the new iterator

  40. final def last: T

    Selects the last element of this NonEmptySet.

    Selects the last element of this NonEmptySet.

    returns

    the last element of this NonEmptySet.

  41. final def lastOption: Option[T]

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

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

    returns

    the last element, wrapped in a Some.

  42. final def map[U](f: (T) => U): NonEmptySet[U]

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

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

    U

    the element type of the returned NonEmptySet.

    f

    the function to apply to each element.

    returns

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

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

    Finds the largest element.

    Finds the largest element.

    returns

    the largest element of this NonEmptySet.

  44. 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 NonEmptySet.

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

    Finds the smallest element.

    Finds the smallest element.

    returns

    the smallest element of this NonEmptySet.

  46. 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 NonEmptySet.

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

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

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

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

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

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

    sep

    the separator string

    returns

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

  49. final def mkString: String

    Displays all elements of this NonEmptySet in a string.

    Displays all elements of this NonEmptySet in a string.

    returns

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

  50. final def nonEmpty: Boolean

    Returns true to indicate this NonEmptySet, like all NonEmptySets, is non-empty.

    Returns true to indicate this NonEmptySet, like all NonEmptySets, is non-empty.

    returns

    true

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

    The result of multiplying all the elements of this NonEmptySet.

    The result of multiplying all the elements of this NonEmptySet.

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

    returns

    the product of all elements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  58. final def sameElements[U >: T](that: NonEmptySet[U]): Boolean

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

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

    that

    the NonEmptySet with which to compare

    returns

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

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

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

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

    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.

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

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

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

    that

    the GenIterable with which to compare

    returns

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

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

    Computes a prefix scan of the elements of this NonEmptySet.

    Computes a prefix scan of the elements of this NonEmptySet.

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

    Here are some examples:

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

    U

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

    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 Set concatenation, 0 for addition, or 1 for multiplication.)

    op

    a binary operator that must be associative

    returns

    a new NonEmptySet containing the prefix scan of the elements in this NonEmptySet

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

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

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

    Here are some examples:

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

    B

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

    z

    the start value.

    op

    the binary operator.

    returns

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

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

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

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

    Here are some examples:

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

    B

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

    z

    the start value

    op

    the binary operator

    returns

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

  64. final def size: Int

    The size of this NonEmptySet.

    The size of this NonEmptySet.

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

    returns

    the number of elements in this NonEmptySet.

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

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

  67. def stringPrefix: String

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

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

    returns

    the string "NonEmptySet"

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

    The result of summing all the elements of this NonEmptySet.

    The result of summing all the elements of this NonEmptySet.

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

    returns

    the sum of all elements

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

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

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

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

    Converts this NonEmptySet to an array.

    Converts this NonEmptySet to an array.

    returns

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

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

    Converts this NonEmptySet to a mutable buffer.

    Converts this NonEmptySet to a mutable buffer.

    returns

    a buffer containing all elements of this NonEmptySet.

  72. final def toIndexedSeq: IndexedSeq[T]

    Converts this NonEmptySet to an immutable IndexedSeq.

    Converts this NonEmptySet to an immutable IndexedSeq.

    returns

    an immutable IndexedSeq containing all elements of this NonEmptySet.

  73. final def toIterable: Iterable[T]

    Converts this NonEmptySet to an iterable collection.

    Converts this NonEmptySet to an iterable collection.

    returns

    an Iterable containing all elements of this NonEmptySet.

  74. final def toIterator: Iterator[T]

    Returns an Iterator over the elements in this NonEmptySet.

    Returns an Iterator over the elements in this NonEmptySet.

    returns

    an Iterator containing all elements of this NonEmptySet.

  75. final def toList: List[T]

    Converts this NonEmptySet to a set.

    Converts this NonEmptySet to a set.

    returns

    a set containing all elements of this NonEmptySet.

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

    Converts this NonEmptySet to a map.

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

  77. final def toSeq: Seq[T]

    Converts this NonEmptySet to an immutable IndexedSeq.

    Converts this NonEmptySet to an immutable IndexedSeq.

    returns

    an immutable IndexedSeq containing all elements of this NonEmptySet.

  78. val toSet: Set[T]
  79. final def toStream: Stream[T]

    Converts this NonEmptySet to a stream.

    Converts this NonEmptySet to a stream.

    returns

    a stream containing all elements of this NonEmptySet.

  80. def toString(): String

    Returns a string representation of this NonEmptySet.

    Returns a string representation of this NonEmptySet.

    returns

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

    Definition Classes
    NonEmptySet → Any
  81. final def toVector: Vector[T]

    Converts this NonEmptySet to a Vector.

    Converts this NonEmptySet to a Vector.

    returns

    a Vector containing all elements of this NonEmptySet.

  82. final def transpose[U](implicit ev: <:<[T, NonEmptySet[U]]): NonEmptySet[NonEmptySet[U]]
  83. final def union(that: GenSet[T]): NonEmptySet[T]

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

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

    NonEmptySetX union ys is equivalent to NonEmptySetX ++ ys.

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

    that

    the GenSet to add.

    returns

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

  84. final def union(that: NonEmptySet[T]): NonEmptySet[T]

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

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

    NonEmptySetX union NonEmptySetY is equivalent to NonEmptySetX ++ NonEmptySetY.

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

    that

    the NonEmptySet to add.

    returns

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

  85. final def union(that: Every[T]): NonEmptySet[T]

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

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

    NonEmptySetX union everyY is equivalent to NonEmptySetX ++ everyY.

    Another way to express this is that NonEmptySetX union everyY computes the order-presevring multi-set union of NonEmptySetX 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 NonEmptySet that contains all elements of this NonEmptySet followed by all elements of that Every.

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

    Converts this NonEmptySet of pairs into two NonEmptySets of the first and second half of each pair.

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

    returns

    a pair of NonEmptySets, containing the first and second half, respectively, of each element pair of this NonEmptySet.

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

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

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

    L

    the type of the first member of the element triples

    M

    the type of the second 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 NonEmptySet is a triple.

    returns

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

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

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

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

    otherElem

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

    returns

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

  89. final def zipWithIndex: NonEmptySet[(T, Int)]

    Zips this NonEmptySet with its indices.

    Zips this NonEmptySet with its indices.

    returns

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

Inherited from AnyVal

Inherited from Any

Ungrouped