Scalactic is brought to you by:

object NonEmptyVector

Companion object for class NonEmptyVector.

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

Value Members

  1. def apply[T](firstElement: T, otherElements: T*): NonEmptyVector[T]

    Constructs a new NonEmptyVector given at least one element.

    Constructs a new NonEmptyVector given at least one element.

    T

    the type of the element contained in the new NonEmptyVector

    firstElement

    the first element (with index 0) contained in this NonEmptyVector

    otherElements

    a varargs of zero or more other elements (with index 1, 2, 3, ...) contained in this NonEmptyVector

  2. def from[T](seq: GenSeq[T]): Option[NonEmptyVector[T]]

    Optionally construct a NonEmptyVector containing the elements, if any, of a given GenSeq.

    Optionally construct a NonEmptyVector containing the elements, if any, of a given GenSeq.

    seq

    the GenSeq with which to construct a NonEmptyVector

    returns

    a NonEmptyVector containing the elements of the given GenSeq, if non-empty, wrapped in a Some; else None if the GenSeq is empty

  3. implicit def nonEmptyVectorToVector[E](nonEmptyVector: NonEmptyVector[E]): Vector[E]

    Implicit conversion from NonEmptyVector to Vector.

    Implicit conversion from NonEmptyVector to Vector.

    One use case for this implicit conversion is to enable GenSeq[NonEmptyVector]s to be flattened. Here's an example:

    scala> Vector(NonEmptyVector(1, 2, 3), NonEmptyVector(3, 4), NonEmptyVector(5, 6, 7, 8)).flatten
res0: scala.collection.immutable.Vector[Int] = Vector(1, 2, 3, 3, 4, 5, 6, 7, 8)

    nonEmptyVector

    the NonEmptyVector to convert to a Vector

    returns

    a Vector containing the elements, in order, of this NonEmptyVector

  4. def unapplySeq[T](nonEmptyVector: NonEmptyVector[T]): Option[Seq[T]]

    Variable argument extractor for NonEmptyVectors.

    Variable argument extractor for NonEmptyVectors.

    returns

    an Seq containing this NonEmptyVectors elements, wrapped in a Some