Scalactic 3.2.17/org.scalactic.anyvals/NonEmptySet

NonEmptySet

object NonEmptySet

Companion object for class NonEmptySet.

Companion:
class
Source:
NonEmptySet.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[T](firstElement: T, otherElements: T*): NonEmptySet[T]

Constructs a new NonEmptySet given at least one element.

Constructs a new NonEmptySet given at least one element.

Type parameters:
T

the type of the element contained in the new NonEmptySet

Value parameters:
firstElement

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

otherElements

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

Source:
NonEmptySet.scala
def from[T](set: Set[T]): Option[NonEmptySet[T]]

Optionally construct a NonEmptySet containing the elements, if any, of a given GenSet.

Optionally construct a NonEmptySet containing the elements, if any, of a given GenSet.

Value parameters:
set

the GenSet with which to construct a NonEmptySet

Returns:

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

Source:
NonEmptySet.scala
def unapplySeq[T](nonEmptySet: NonEmptySet[T]): Option[Seq[T]]

Variable argument extractor for NonEmptySets.

Variable argument extractor for NonEmptySets.

Value parameters:
nonEmptySet:

the NonEmptySet containing the elements to extract

Returns:

an Seq containing this NonEmptySets elements, wrapped in a Some

Source:
NonEmptySet.scala

Implicits

Implicits

implicit def NonEmptySetToSet[E](NonEmptySet: NonEmptySet[E]): Set[E]

Implicit conversion from NonEmptySet to Set.

Implicit conversion from NonEmptySet to Set.

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

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

the NonEmptySet to convert to a Set

Returns:

a Set containing the elements, in order, of this NonEmptySet

Source:
NonEmptySet.scala