final class NonEmptySeq[+A] extends AnyVal with NonEmptyCollection[A, Seq, NonEmptySeq]
A data type which represents a Seq guaranteed to contain at least one element.
Note that the constructor is private to prevent accidental construction of an empty
NonEmptySeq. However, due to https://issues.scala-lang.org/browse/SI-6601, on
Scala 2.10, this may be bypassed due to a compiler bug.
- Source
- NonEmptySeq.scala
- Alphabetic
- By Inheritance
- NonEmptySeq
- NonEmptyCollection
- AnyVal
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- Any
-
final
def
##(): Int
- Definition Classes
- Any
-
def
++[AA >: A](other: Seq[AA]): NonEmptySeq[AA]
Alias for concat
-
def
++:[AA >: A](other: NonEmptySeq[AA]): NonEmptySeq[AA]
Append this NESeq to another NESeq, producing a new
NonEmptySeq.Append this NESeq to another NESeq, producing a new
NonEmptySeq.scala> import cats.data.NonEmptySeq scala> val neSeq = NonEmptySeq.of(1, 2, 3) scala> neSeq ++: NonEmptySeq.of(4, 5) res0: cats.data.NonEmptySeq[Int] = NonEmptySeq(1, 2, 3, 4, 5)
-
def
+:[AA >: A](a: AA): NonEmptySeq[AA]
Alias for prepend
-
def
:+[AA >: A](a: AA): NonEmptySeq[AA]
Alias for append
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- Any
-
def
===[AA >: A](that: NonEmptySeq[AA])(implicit A: Eq[AA]): Boolean
Typesafe equality operator.
Typesafe equality operator.
This method is similar to == except that it only allows two NonEmptySeq[A] values to be compared to each other, and uses equality provided by Eq[_] instances, rather than using the universal equality provided by .equals.
-
def
append[AA >: A](a: AA): NonEmptySeq[AA]
Append an item to this, producing a new
NonEmptySeq.Append an item to this, producing a new
NonEmptySeq.- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
collect[B](pf: PartialFunction[A, B]): Seq[B]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
concat[AA >: A](other: Seq[AA]): NonEmptySeq[AA]
Append another
Seqto this, producing a newNonEmptySeq. -
def
concatNeSeq[AA >: A](other: NonEmptySeq[AA]): NonEmptySeq[AA]
Append another
NonEmptySeqto this, producing a newNonEmptySeq. -
def
distinct[AA >: A](implicit O: Order[AA]): NonEmptySeq[AA]
Remove duplicates.
Remove duplicates. Duplicates are checked using
Order[_]instance.- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
exists(f: (A) ⇒ Boolean): Boolean
Check whether at least one element satisfies the predicate.
Check whether at least one element satisfies the predicate.
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
filter(f: (A) ⇒ Boolean): Seq[A]
Remove elements not matching the predicate
Remove elements not matching the predicate
scala> import cats.data.NonEmptySeq scala> val neSeq = NonEmptySeq.of(1, 2, 3, 4, 5) scala> neSeq.filter(_ < 3) res0: scala.collection.immutable.Seq[Int] = List(1, 2)
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
filterNot(f: (A) ⇒ Boolean): Seq[A]
Remove elements matching the predicate
Remove elements matching the predicate
scala> import cats.data.NonEmptySeq scala> val neSeq = NonEmptySeq.of(1, 2, 3, 4, 5) scala> neSeq.filterNot(_ < 3) res0: scala.collection.immutable.Seq[Int] = List(3, 4, 5)
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
find(f: (A) ⇒ Boolean): Option[A]
Find the first element matching the predicate, if one exists
Find the first element matching the predicate, if one exists
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
flatMap[B](f: (A) ⇒ NonEmptySeq[B]): NonEmptySeq[B]
Applies f to all elements and combines the result
-
def
foldLeft[B](b: B)(f: (B, A) ⇒ B): B
Left-associative fold using f.
Left-associative fold using f.
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
foldRight[B](lb: Eval[B])(f: (A, Eval[B]) ⇒ Eval[B]): Eval[B]
Right-associative fold using f.
-
def
forall(f: (A) ⇒ Boolean): Boolean
Check whether all elements satisfy the predicate.
Check whether all elements satisfy the predicate.
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
get(i: Int): Option[A]
Gets the element at the index, if it exists
-
def
getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
-
def
getUnsafe(i: Int): A
Gets the element at the index, or throws an exception if none exists
-
final
def
groupBy[B](f: (A) ⇒ B)(implicit B: Order[B]): SortedMap[B, NonEmptySeq[A]]
Groups elements inside this
NonEmptySeqaccording to theOrderof the keys produced by the given mapping function.Groups elements inside this
NonEmptySeqaccording to theOrderof the keys produced by the given mapping function.scala> import scala.collection.immutable.SortedMap scala> import cats.data.NonEmptySeq scala> import cats.implicits._ scala> val neSeq = NonEmptySeq.of(12, -2, 3, -5) scala> val expectedResult = SortedMap(false -> NonEmptySeq.of(-2, -5), true -> NonEmptySeq.of(12, 3)) scala> val result = neSeq.groupBy(_ >= 0) scala> result === expectedResult res0: Boolean = true
-
final
def
groupByNem[B](f: (A) ⇒ B)(implicit B: Order[B]): NonEmptyMap[B, NonEmptySeq[A]]
Groups elements inside this
NonEmptySeqaccording to theOrderof the keys produced by the given mapping function.Groups elements inside this
NonEmptySeqaccording to theOrderof the keys produced by the given mapping function.scala> import cats.data.{NonEmptyMap, NonEmptySeq} scala> import cats.implicits._ scala> val nel = NonEmptySeq.of(12, -2, 3, -5) scala> val expectedResult = NonEmptyMap.of(false -> NonEmptySeq.of(-2, -5), true -> NonEmptySeq.of(12, 3)) scala> val result = nel.groupByNem(_ >= 0) scala> result === expectedResult res0: Boolean = true
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
grouped(size: Int): Iterator[NonEmptySeq[A]]
Partitions elements in fixed size
NonEmptySeqs.Partitions elements in fixed size
NonEmptySeqs.scala> import cats.data.NonEmptySeq scala> import cats.implicits._ scala> val nel = NonEmptySeq.of(12, -2, 3, -5) scala> val expectedResult = List(NonEmptySeq.of(12, -2), NonEmptySeq.of(3, -5)) scala> val result = nel.grouped(2) scala> result.toList === expectedResult res0: Boolean = true
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
head: A
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
init: Seq[A]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
iterator: Iterator[A]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
last: A
- Definition Classes
- NonEmptySeq → NonEmptyCollection
- def length: Int
-
def
map[B](f: (A) ⇒ B): NonEmptySeq[B]
Applies f to all the elements
Applies f to all the elements
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
prepend[AA >: A](a: AA): NonEmptySeq[AA]
Prepend an item to this, producing a new
NonEmptySeq.Prepend an item to this, producing a new
NonEmptySeq.- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
prependSeq[AA >: A](Seq: Seq[AA]): NonEmptySeq[AA]
Prepend a
Seqto this, producing a newNonEmptySeq. -
def
reduce[AA >: A](implicit S: Semigroup[AA]): AA
Reduce using the Semigroup of A
Reduce using the Semigroup of A
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
reduceLeft[AA >: A](f: (AA, AA) ⇒ AA): AA
Left-associative reduce using f.
-
def
reverse: NonEmptySeq[A]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
show[AA >: A](implicit AA: Show[AA]): String
Typesafe stringification method.
Typesafe stringification method.
This method is similar to .toString except that it stringifies values according to Show[_] instances, rather than using the universal .toString method.
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
sortBy[B](f: (A) ⇒ B)(implicit B: Order[B]): NonEmptySeq[A]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
sorted[AA >: A](implicit AA: Order[AA]): NonEmptySeq[AA]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
tail: Seq[A]
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
final
def
toNem[T, U](implicit ev: <:<[A, (T, U)], order: Order[T]): NonEmptyMap[T, U]
Creates new
NonEmptyMap, similarly to List#toMap from scala standard library.Creates new
NonEmptyMap, similarly to List#toMap from scala standard library.scala> import cats.data.{NonEmptyMap, NonEmptySeq} scala> import cats.implicits._ scala> import scala.collection.immutable.Seq scala> val neSeq = NonEmptySeq((0, "a"), Seq((1, "b"),(0, "c"), (2, "d"))) scala> val expectedResult = NonEmptyMap.of(0 -> "c", 1 -> "b", 2 -> "d") scala> val result = neSeq.toNem scala> result === expectedResult res0: Boolean = true
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
final
def
toNes[B >: A](implicit order: Order[B]): NonEmptySet[B]
Creates new
NonEmptySet, similarly to List#toSet from scala standard library.Creates new
NonEmptySet, similarly to List#toSet from scala standard library.scala> import cats.data._ scala> import cats.instances.int._ scala> import scala.collection.immutable.Seq scala> val neSeq = NonEmptySeq(1, Seq(2,2,3,4)) scala> neSeq.toNes res0: cats.data.NonEmptySet[Int] = TreeSet(1, 2, 3, 4)
- Definition Classes
- NonEmptySeq → NonEmptyCollection
- val toSeq: Seq[A]
-
def
toString(): String
- Definition Classes
- NonEmptySeq → Any
-
def
updated[AA >: A](i: Int, a: AA): Option[NonEmptySeq[AA]]
Updates the element at the index, if it exists
-
def
updatedUnsafe[AA >: A](i: Int, a: AA): NonEmptySeq[AA]
Updates the element at the index, or throws an
IndexOutOfBoundsExceptionif none exists (ifidoes not satisfy0 <= i < length). -
def
zipWith[B, C](b: NonEmptySeq[B])(f: (A, B) ⇒ C): NonEmptySeq[C]
Zips this
NonEmptySeqwith anotherNonEmptySeqand applies a function for each pair of elements.Zips this
NonEmptySeqwith anotherNonEmptySeqand applies a function for each pair of elements.scala> import cats.data.NonEmptySeq scala> val as = NonEmptySeq.of(1, 2, 3) scala> val bs = NonEmptySeq.of("A", "B", "C") scala> as.zipWith(bs)(_.toString + _) res0: cats.data.NonEmptySeq[String] = NonEmptySeq(1A, 2B, 3C)
- Definition Classes
- NonEmptySeq → NonEmptyCollection
-
def
zipWithIndex: NonEmptySeq[(A, Int)]
- Definition Classes
- NonEmptySeq → NonEmptyCollection