IsGivenInstance

eu.throup.couldbe.IsGivenInstance
class IsGivenInstance extends NonEmptyTraverse[IsGiven] with InvariantMonoidal[IsGiven] with Bimonad[IsGiven] with CommutativeMonad[IsGiven]

Attributes

Graph
Supertypes
trait CommutativeMonad[IsGiven]
trait CommutativeApplicative[IsGiven]
trait CommutativeFlatMap[IsGiven]
trait CommutativeApply[IsGiven]
trait Bimonad[IsGiven]
trait Comonad[IsGiven]
trait CoflatMap[IsGiven]
trait Monad[IsGiven]
trait Applicative[IsGiven]
trait FlatMap[IsGiven]
trait FlatMapArityFunctions[IsGiven]
trait Apply[IsGiven]
trait ApplyArityFunctions[IsGiven]
trait InvariantMonoidal[IsGiven]
trait InvariantSemigroupal[IsGiven]
trait Semigroupal[IsGiven]
trait NonEmptyTraverse[IsGiven]
trait Reducible[IsGiven]
trait Traverse[IsGiven]
trait UnorderedTraverse[IsGiven]
trait Foldable[IsGiven]
trait FoldableNFunctions[IsGiven]
trait UnorderedFoldable[IsGiven]
trait Functor[IsGiven]
trait Invariant[IsGiven]
trait Serializable
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def ap[A, B](ff: IsGiven[A => B])(fa: IsGiven[A]): IsGiven[B]

Given a value and a function in the Apply context, applies the function to the value.

Given a value and a function in the Apply context, applies the function to the value.

Example:

scala> import cats.implicits._

scala> val someF: Option[Int => Long] = Some(_.toLong + 1L)
scala> val noneF: Option[Int => Long] = None
scala> val someInt: Option[Int] = Some(3)
scala> val noneInt: Option[Int] = None

scala> Apply[Option].ap(someF)(someInt)
res0: Option[Long] = Some(4)

scala> Apply[Option].ap(noneF)(someInt)
res1: Option[Long] = None

scala> Apply[Option].ap(someF)(noneInt)
res2: Option[Long] = None

scala> Apply[Option].ap(noneF)(noneInt)
res3: Option[Long] = None

Attributes

Definition Classes
FlatMap -> Apply
override def coflatMap[A, B](fa: IsGiven[A])(f: IsGiven[A] => B): IsGiven[B]

coflatMap is the dual of flatMap on FlatMap. It applies a value in a context to a function that takes a value in a context and returns a normal value.

coflatMap is the dual of flatMap on FlatMap. It applies a value in a context to a function that takes a value in a context and returns a normal value.

Example:

scala> import cats.implicits._
scala> import cats.CoflatMap
scala> val fa = Some(3)
scala> def f(a: Option[Int]): Int = a match {
    | case Some(x) => 2 * x
    | case None => 0 }
scala> CoflatMap[Option].coflatMap(fa)(f)
res0: Option[Int] = Some(6)

Attributes

Definition Classes
CoflatMap
override def extract[A](x: IsGiven[A]): A

extract is the dual of pure on Monad (via Applicative) and extracts the value from its context

extract is the dual of pure on Monad (via Applicative) and extracts the value from its context

Example:

scala> import cats.Id
scala> import cats.Comonad
scala> val id: Id[Int] = 3
scala> Comonad[Id].extract(id)
res0: cats.Id[Int] = 3

Attributes

Definition Classes
Comonad
override def flatMap[A, B](fa: IsGiven[A])(f: A => IsGiven[B]): IsGiven[B]

Attributes

Definition Classes
FlatMap
override def foldLeft[A, B](fa: IsGiven[A], b: B)(f: (B, A) => B): B

Left associative fold on 'F' using the function 'f'.

Left associative fold on 'F' using the function 'f'.

Example:

scala> import cats.Foldable, cats.implicits._
scala> val fa = Option(1)

Folding by addition to zero:
scala> Foldable[Option].foldLeft(fa, Option(0))((a, n) => a.map(_ + n))
res0: Option[Int] = Some(1)

With syntax extensions, foldLeft can be used like:

Folding `Option` with addition from zero:
scala> fa.foldLeft(Option(0))((a, n) => a.map(_ + n))
res1: Option[Int] = Some(1)

There's also an alias `foldl` which is equivalent:
scala> fa.foldl(Option(0))((a, n) => a.map(_ + n))
res2: Option[Int] = Some(1)

Attributes

Definition Classes
Foldable
override def foldRight[A, B](fa: IsGiven[A], lb: Eval[B])(f: (A, Eval[B]) => Eval[B]): Eval[B]

Right associative lazy fold on F using the folding function 'f'.

Right associative lazy fold on F using the folding function 'f'.

This method evaluates lb lazily (in some cases it will not be needed), and returns a lazy value. We are using (A, Eval[B]) => Eval[B] to support laziness in a stack-safe way. Chained computation should be performed via .map and .flatMap.

For more detailed information about how this method works see the documentation for Eval[_].

Example:

scala> import cats.Foldable, cats.Eval, cats.implicits._
scala> val fa = Option(1)

Folding by addition to zero:
scala> val folded1 = Foldable[Option].foldRight(fa, Eval.now(0))((n, a) => a.map(_ + n))
Since `foldRight` yields a lazy computation, we need to force it to inspect the result:
scala> folded1.value
res0: Int = 1

With syntax extensions, we can write the same thing like this:
scala> val folded2 = fa.foldRight(Eval.now(0))((n, a) => a.map(_ + n))
scala> folded2.value
res1: Int = 1

Unfortunately, since `foldRight` is defined on many collections - this
extension clashes with the operation defined in `Foldable`.

To get past this and make sure you're getting the lazy `foldRight` defined
in `Foldable`, there's an alias `foldr`:
scala> val folded3 = fa.foldr(Eval.now(0))((n, a) => a.map(_ + n))
scala> folded3.value
res1: Int = 1

Attributes

Definition Classes
Foldable
override def map[A, B](fa: IsGiven[A])(f: A => B): IsGiven[B]

Attributes

Definition Classes
Monad -> Applicative -> Traverse -> Functor
override def nonEmptyTraverse[G[_] : Apply, A, B](fa: IsGiven[A])(f: A => G[B]): G[IsGiven[B]]

Given a function which returns a G effect, thread this effect through the running of this function on all the values in F, returning an F[B] in a G context.

Given a function which returns a G effect, thread this effect through the running of this function on all the values in F, returning an F[B] in a G context.

Example:

scala> import cats.implicits._
scala> import cats.data.NonEmptyList
scala> def countWords(words: List[String]): Map[String, Int] = words.groupBy(identity).map { case (k, v) => (k, v.length) }
scala> val expectedResult = Map("do" -> NonEmptyList.of(1, 2), "you" -> NonEmptyList.of(1, 1))
scala> val x = List("How", "do", "you", "fly")
scala> val y = List("What", "do", "you", "do")
scala> val result = NonEmptyList.of(x, y).nonEmptyTraverse(countWords)
scala> result === expectedResult
res0: Boolean = true

Attributes

Definition Classes
NonEmptyTraverse
override def product[A, B](fa: IsGiven[A], fb: IsGiven[B]): IsGiven[(A, B)]

Combine an F[A] and an F[B] into an F[(A, B)] that maintains the effects of both fa and fb.

Combine an F[A] and an F[B] into an F[(A, B)] that maintains the effects of both fa and fb.

Example:

scala> import cats.implicits._

scala> val noneInt: Option[Int] = None
scala> val some3: Option[Int] = Some(3)
scala> val noneString: Option[String] = None
scala> val someFoo: Option[String] = Some("foo")

scala> Semigroupal[Option].product(noneInt, noneString)
res0: Option[(Int, String)] = None

scala> Semigroupal[Option].product(noneInt, someFoo)
res1: Option[(Int, String)] = None

scala> Semigroupal[Option].product(some3, noneString)
res2: Option[(Int, String)] = None

scala> Semigroupal[Option].product(some3, someFoo)
res3: Option[(Int, String)] = Some((3,foo))

Attributes

Definition Classes
FlatMap -> Apply -> Semigroupal
override def pure[A](x: A): IsGiven[A]

pure lifts any value into the Applicative Functor.

pure lifts any value into the Applicative Functor.

Example:

scala> import cats.implicits._

scala> Applicative[Option].pure(10)
res0: Option[Int] = Some(10)

Attributes

Definition Classes
Applicative
override def reduceLeftTo[A, B](fa: IsGiven[A])(f: A => B)(g: (B, A) => B): B

Apply f to the "initial element" of fa and combine it with every other value using the given function g.

Apply f to the "initial element" of fa and combine it with every other value using the given function g.

Attributes

Definition Classes
Reducible
override def reduceRightTo[A, B](fa: IsGiven[A])(f: A => B)(g: (A, Eval[B]) => Eval[B]): Eval[B]

Apply f to the "initial element" of fa and lazily combine it with every other value using the given function g.

Apply f to the "initial element" of fa and lazily combine it with every other value using the given function g.

Attributes

Definition Classes
Reducible
override def tailRecM[A, B](a: A)(f: A => IsGiven[Either[A, B]]): IsGiven[B]

Keeps calling f until a scala.util.Right[B] is returned.

Keeps calling f until a scala.util.Right[B] is returned.

Based on Phil Freeman's Stack Safety for Free.

Implementations of this method should use constant stack space relative to f.

Attributes

Definition Classes
FlatMap
override def unit: IsGiven[Unit]

Returns an F[Unit] value, equivalent with pure(()).

Returns an F[Unit] value, equivalent with pure(()).

A useful shorthand, also allowing implementations to optimize the returned reference (e.g. it can be a val).

Example:

scala> import cats.implicits._

scala> Applicative[Option].unit
res0: Option[Unit] = Some(())

Attributes

Definition Classes
Applicative -> InvariantMonoidal

Inherited methods

final def *>[A, B](fa: IsGiven[A])(fb: IsGiven[B]): F[B]

Alias for productR.

Alias for productR.

Attributes

Inherited from:
Apply
final def <*[A, B](fa: IsGiven[A])(fb: IsGiven[B]): F[A]

Alias for productL.

Alias for productL.

Attributes

Inherited from:
Apply
final def <*>[A, B](ff: IsGiven[A => B])(fa: IsGiven[A]): F[B]

Alias for ap.

Alias for ap.

Attributes

Inherited from:
Apply
def ap10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
override def ap2[A, B, Z](ff: IsGiven[(A, B) => Z])(fa: IsGiven[A], fb: IsGiven[B]): F[Z]

ap2 is a binary version of ap, defined in terms of ap.

ap2 is a binary version of ap, defined in terms of ap.

Attributes

Definition Classes
FlatMap -> Apply
Inherited from:
FlatMap
def ap20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20], f21: IsGiven[A21]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap3[A0, A1, A2, Z](f: IsGiven[(A0, A1, A2) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap4[A0, A1, A2, A3, Z](f: IsGiven[(A0, A1, A2, A3) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap5[A0, A1, A2, A3, A4, Z](f: IsGiven[(A0, A1, A2, A3, A4) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap6[A0, A1, A2, A3, A4, A5, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap7[A0, A1, A2, A3, A4, A5, A6, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap8[A0, A1, A2, A3, A4, A5, A6, A7, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def ap9[A0, A1, A2, A3, A4, A5, A6, A7, A8, Z](f: IsGiven[(A0, A1, A2, A3, A4, A5, A6, A7, A8) => Z])(f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8]): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def as[A, B](fa: IsGiven[A], b: B): F[B]

Replaces the A value in F[A] with the supplied value.

Replaces the A value in F[A] with the supplied value.

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].as(List(1,2,3), "hello")
res0: List[String] = List(hello, hello, hello)

Attributes

Inherited from:
Functor
def coflatten[A](fa: IsGiven[A]): F[F[A]]

coflatten is the dual of flatten on FlatMap. Whereas flatten removes a layer of F, coflatten adds a layer of F

coflatten is the dual of flatten on FlatMap. Whereas flatten removes a layer of F, coflatten adds a layer of F

Example:

scala> import cats.implicits._
scala> import cats.CoflatMap
scala> val fa = Some(3)
fa: Option[Int] = Some(3)
scala> CoflatMap[Option].coflatten(fa)
res0: Option[Option[Int]] = Some(Some(3))

Attributes

Inherited from:
CoflatMap
def collectFirst[A, B](fa: IsGiven[A])(pf: PartialFunction[A, B]): Option[B]

Attributes

Inherited from:
Foldable
def collectFirstSome[A, B](fa: IsGiven[A])(f: A => Option[B]): Option[B]

Like collectFirst from scala.collection.Traversable but takes A => Option[B] instead of PartialFunctions.

Like collectFirst from scala.collection.Traversable but takes A => Option[B] instead of PartialFunctions.

scala> import cats.implicits._
scala> val keys = List(1, 2, 4, 5)
scala> val map = Map(4 -> "Four", 5 -> "Five")
scala> keys.collectFirstSome(map.get)
res0: Option[String] = Some(Four)
scala> val map2 = Map(6 -> "Six", 7 -> "Seven")
scala> keys.collectFirstSome(map2.get)
res1: Option[String] = None

Attributes

Inherited from:
Foldable
def collectFirstSomeM[G[_], A, B](fa: IsGiven[A])(f: A => G[Option[B]])(implicit G: Monad[G]): G[Option[B]]

Monadic version of collectFirstSome.

Monadic version of collectFirstSome.

If there are no elements, the result is None. collectFirstSomeM short-circuits, i.e. once a Some element is found, no further effects are produced.

For example:

scala> import cats.implicits._
scala> def parseInt(s: String): Either[String, Int] = Either.catchOnly[NumberFormatException](s.toInt).leftMap(_.getMessage)
scala> val keys1 = List("1", "2", "4", "5")
scala> val map1 = Map(4 -> "Four", 5 -> "Five")
scala> Foldable[List].collectFirstSomeM(keys1)(parseInt(_) map map1.get)
res0: scala.util.Either[String,Option[String]] = Right(Some(Four))

scala> val map2 = Map(6 -> "Six", 7 -> "Seven")
scala> Foldable[List].collectFirstSomeM(keys1)(parseInt(_) map map2.get)
res1: scala.util.Either[String,Option[String]] = Right(None)

scala> val keys2 = List("1", "x", "4", "5")
scala> Foldable[List].collectFirstSomeM(keys2)(parseInt(_) map map1.get)
res2: scala.util.Either[String,Option[String]] = Left(For input string: "x")

scala> val keys3 = List("1", "2", "4", "x")
scala> Foldable[List].collectFirstSomeM(keys3)(parseInt(_) map map1.get)
res3: scala.util.Either[String,Option[String]] = Right(Some(Four))

Attributes

Inherited from:
Foldable
def collectFold[A, B](fa: IsGiven[A])(f: PartialFunction[A, B])(implicit B: Monoid[B]): B

Tear down a subset of this structure using a PartialFunction.

Tear down a subset of this structure using a PartialFunction.

scala> import cats.implicits._
scala> val xs = List(1, 2, 3, 4)
scala> Foldable[List].collectFold(xs) { case n if n % 2 == 0 => n }
res0: Int = 6

Attributes

Inherited from:
Foldable
def collectFoldSome[A, B](fa: IsGiven[A])(f: A => Option[B])(implicit B: Monoid[B]): B

Tear down a subset of this structure using a A => Option[M].

Tear down a subset of this structure using a A => Option[M].

scala> import cats.implicits._
scala> val xs = List(1, 2, 3, 4)
scala> def f(n: Int): Option[Int] = if (n % 2 == 0) Some(n) else None
scala> Foldable[List].collectFoldSome(xs)(f)
res0: Int = 6

Attributes

Inherited from:
Foldable
def combineAll[A : Monoid](fa: IsGiven[A]): A

Alias for fold.

Alias for fold.

Attributes

Inherited from:
Foldable
def combineAllOption[A](fa: IsGiven[A])(implicit ev: Semigroup[A]): Option[A]

Attributes

Inherited from:
Foldable
def compose[G[_] : Apply]: Apply[[α] =>> F[G[α]]]

Compose an Apply[F] and an Apply[G] into an Apply[λ[α => F[G[α]]]].

Compose an Apply[F] and an Apply[G] into an Apply[λ[α => F[G[α]]]].

Example:

scala> import cats.implicits._

scala> val alo = Apply[List].compose[Option]

scala> alo.product(List(None, Some(true), Some(false)), List(Some(2), None))
res1: List[Option[(Boolean, Int)]] = List(None, None, Some((true,2)), None, Some((false,2)), None)

Attributes

Inherited from:
Apply
def compose[G[_] : Invariant]: Invariant[[α] =>> F[G[α]]]

Compose Invariant F[_] and G[_] then produce Invariant[F[G[_]]] using their imap.

Compose Invariant F[_] and G[_] then produce Invariant[F[G[_]]] using their imap.

Example:

scala> import cats.implicits._
scala> import scala.concurrent.duration._

scala> val durSemigroupList: Semigroup[List[FiniteDuration]] =
    | Invariant[Semigroup].compose[List].imap(Semigroup[List[Long]])(Duration.fromNanos)(_.toNanos)
scala> durSemigroupList.combine(List(2.seconds, 3.seconds), List(4.seconds))
res1: List[FiniteDuration] = List(2 seconds, 3 seconds, 4 seconds)

Attributes

Inherited from:
Invariant
def compose[G[_] : Functor]: Functor[[α] =>> F[G[α]]]

Attributes

Inherited from:
Functor
def compose[G[_] : Applicative]: Applicative[[α] =>> F[G[α]]]

Compose an Applicative[F] and an Applicative[G] into an Applicative[λ[α => F[G[α]]]].

Compose an Applicative[F] and an Applicative[G] into an Applicative[λ[α => F[G[α]]]].

Example:

scala> import cats.implicits._

scala> val alo = Applicative[List].compose[Option]

scala> alo.pure(3)
res0: List[Option[Int]] = List(Some(3))

scala> alo.product(List(None, Some(true), Some(false)), List(Some(2), None))
res1: List[Option[(Boolean, Int)]] = List(None, None, Some((true,2)), None, Some((false,2)), None)

Attributes

Inherited from:
Applicative
def compose[G[_] : NonEmptyTraverse]: NonEmptyTraverse[[α] =>> F[G[α]]]

Attributes

Inherited from:
NonEmptyTraverse
def compose[G[_] : Reducible]: Reducible[[α] =>> F[G[α]]]

Attributes

Inherited from:
Reducible
def compose[G[_] : Foldable]: Foldable[[α] =>> F[G[α]]]

Attributes

Inherited from:
Foldable
def compose[G[_] : Traverse]: Traverse[[α] =>> F[G[α]]]

Attributes

Inherited from:
Traverse
def composeApply[G[_] : Apply]: InvariantSemigroupal[[α] =>> F[G[α]]]

Attributes

Inherited from:
InvariantSemigroupal
override def composeContravariant[G[_] : Contravariant]: Contravariant[[α] =>> F[G[α]]]

Compose Invariant F[_] and Contravariant G[_] then produce Invariant[F[G[_]]] using F's imap and G's contramap.

Compose Invariant F[_] and Contravariant G[_] then produce Invariant[F[G[_]]] using F's imap and G's contramap.

Example:

scala> import cats.implicits._
scala> import scala.concurrent.duration._

scala> type ToInt[T] = T => Int
scala> val durSemigroupToInt: Semigroup[ToInt[FiniteDuration]] =
    | Invariant[Semigroup]
    |   .composeContravariant[ToInt]
    |   .imap(Semigroup[ToInt[Long]])(Duration.fromNanos)(_.toNanos)
// semantically equal to (2.seconds.toSeconds.toInt + 1) + (2.seconds.toSeconds.toInt * 2) = 7
scala> durSemigroupToInt.combine(_.toSeconds.toInt + 1, _.toSeconds.toInt * 2)(2.seconds)
res1: Int = 7

Attributes

Definition Classes
Functor -> Invariant
Inherited from:
Functor
def composeContravariantMonoidal[G[_] : ContravariantMonoidal]: ContravariantMonoidal[[α] =>> F[G[α]]]

Compose an Applicative[F] and a ContravariantMonoidal[G] into a ContravariantMonoidal[λ[α => F[G[α]]]].

Compose an Applicative[F] and a ContravariantMonoidal[G] into a ContravariantMonoidal[λ[α => F[G[α]]]].

Example:

scala> import cats.kernel.Comparison
scala> import cats.implicits._

// compares strings by alphabetical order
scala> val alpha: Order[String] = Order[String]

// compares strings by their length
scala> val strLength: Order[String] = Order.by[String, Int](_.length)

scala> val stringOrders: List[Order[String]] = List(alpha, strLength)

// first comparison is with alpha order, second is with string length
scala> stringOrders.map(o => o.comparison("abc", "de"))
res0: List[Comparison] = List(LessThan, GreaterThan)

scala> val le = Applicative[List].composeContravariantMonoidal[Order]

// create Int orders that convert ints to strings and then use the string orders
scala> val intOrders: List[Order[Int]] = le.contramap(stringOrders)(_.toString)

// first comparison is with alpha order, second is with string length
scala> intOrders.map(o => o.comparison(12, 3))
res1: List[Comparison] = List(LessThan, GreaterThan)

// create the `product` of the string order list and the int order list
// `p` contains a list of the following orders:
// 1. (alpha comparison on strings followed by alpha comparison on ints)
// 2. (alpha comparison on strings followed by length comparison on ints)
// 3. (length comparison on strings followed by alpha comparison on ints)
// 4. (length comparison on strings followed by length comparison on ints)
scala> val p: List[Order[(String, Int)]] = le.product(stringOrders, intOrders)

scala> p.map(o => o.comparison(("abc", 12), ("def", 3)))
res2: List[Comparison] = List(LessThan, LessThan, LessThan, GreaterThan)

Attributes

Inherited from:
Applicative
def composeFunctor[G[_] : Functor]: Invariant[[α] =>> F[G[α]]]

Compose Invariant F[_] and Functor G[_] then produce Invariant[F[G[_]]] using F's imap and G's map.

Compose Invariant F[_] and Functor G[_] then produce Invariant[F[G[_]]] using F's imap and G's map.

Example:

scala> import cats.implicits._
scala> import scala.concurrent.duration._

scala> val durSemigroupList: Semigroup[List[FiniteDuration]] =
    | Invariant[Semigroup]
    |   .composeFunctor[List]
    |   .imap(Semigroup[List[Long]])(Duration.fromNanos)(_.toNanos)
scala> durSemigroupList.combine(List(2.seconds, 3.seconds), List(4.seconds))
res1: List[FiniteDuration] = List(2 seconds, 3 seconds, 4 seconds)

Attributes

Inherited from:
Invariant
def contains_[A](fa: IsGiven[A], v: A)(implicit ev: Eq[A]): Boolean

Tests if fa contains v using the Eq instance for A

Tests if fa contains v using the Eq instance for A

Attributes

Inherited from:
UnorderedFoldable
def count[A](fa: IsGiven[A])(p: A => Boolean): Long

Count the number of elements in the structure that satisfy the given predicate.

Count the number of elements in the structure that satisfy the given predicate.

For example:

scala> import cats.implicits._
scala> val map1 = Map[Int, String]()
scala> val p1: String => Boolean = _.length > 0
scala> UnorderedFoldable[Map[Int, *]].count(map1)(p1)
res0: Long = 0

scala> val map2 = Map(1 -> "hello", 2 -> "world", 3 -> "!")
scala> val p2: String => Boolean = _.length > 1
scala> UnorderedFoldable[Map[Int, *]].count(map2)(p2)
res1: Long = 2

Attributes

Inherited from:
UnorderedFoldable
def dropWhile_[A](fa: IsGiven[A])(p: A => Boolean): List[A]

Convert F[A] to a List[A], dropping all initial elements which match p.

Convert F[A] to a List[A], dropping all initial elements which match p.

Attributes

Inherited from:
Foldable
override def exists[A](fa: IsGiven[A])(p: A => Boolean): Boolean

Check whether at least one element satisfies the predicate.

Check whether at least one element satisfies the predicate.

If there are no elements, the result is false.

Attributes

Definition Classes
Foldable -> UnorderedFoldable
Inherited from:
Foldable
def existsM[G[_], A](fa: IsGiven[A])(p: A => G[Boolean])(implicit G: Monad[G]): G[Boolean]

Check whether at least one element satisfies the effectful predicate.

Check whether at least one element satisfies the effectful predicate.

If there are no elements, the result is false. existsM short-circuits, i.e. once a true result is encountered, no further effects are produced.

For example:

scala> import cats.implicits._
scala> val F = Foldable[List]
scala> F.existsM(List(1,2,3,4))(n => Option(n <= 4))
res0: Option[Boolean] = Some(true)

scala> F.existsM(List(1,2,3,4))(n => Option(n > 4))
res1: Option[Boolean] = Some(false)

scala> F.existsM(List(1,2,3,4))(n => if (n <= 2) Option(true) else Option(false))
res2: Option[Boolean] = Some(true)

scala> F.existsM(List(1,2,3,4))(n => if (n <= 2) Option(true) else None)
res3: Option[Boolean] = Some(true)

scala> F.existsM(List(1,2,3,4))(n => if (n <= 2) None else Option(true))
res4: Option[Boolean] = None

Attributes

Inherited from:
Foldable
def filter_[A](fa: IsGiven[A])(p: A => Boolean): List[A]

Convert F[A] to a List[A], only including elements which match p.

Convert F[A] to a List[A], only including elements which match p.

Attributes

Inherited from:
Foldable
def find[A](fa: IsGiven[A])(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.

Attributes

Inherited from:
Foldable
def findM[G[_], A](fa: IsGiven[A])(p: A => G[Boolean])(implicit G: Monad[G]): G[Option[A]]

Find the first element matching the effectful predicate, if one exists.

Find the first element matching the effectful predicate, if one exists.

If there are no elements, the result is None. findM short-circuits, i.e. once an element is found, no further effects are produced.

For example:

scala> import cats.implicits._
scala> val list = List(1,2,3,4)
scala> Foldable[List].findM(list)(n => (n >= 2).asRight[String])
res0: Either[String,Option[Int]] = Right(Some(2))

scala> Foldable[List].findM(list)(n => (n > 4).asRight[String])
res1: Either[String,Option[Int]] = Right(None)

scala> Foldable[List].findM(list)(n => Either.cond(n < 3, n >= 2, "error"))
res2: Either[String,Option[Int]] = Right(Some(2))

scala> Foldable[List].findM(list)(n => Either.cond(n < 3, false, "error"))
res3: Either[String,Option[Int]] = Left(error)

Attributes

Inherited from:
Foldable
def flatMap10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap2[A0, A1, Z](f0: IsGiven[A0], f1: IsGiven[A1])(f: (A0, A1) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20], f21: IsGiven[A21])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap3[A0, A1, A2, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2])(f: (A0, A1, A2) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap4[A0, A1, A2, A3, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3])(f: (A0, A1, A2, A3) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap5[A0, A1, A2, A3, A4, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4])(f: (A0, A1, A2, A3, A4) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap6[A0, A1, A2, A3, A4, A5, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5])(f: (A0, A1, A2, A3, A4, A5) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap7[A0, A1, A2, A3, A4, A5, A6, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6])(f: (A0, A1, A2, A3, A4, A5, A6) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap8[A0, A1, A2, A3, A4, A5, A6, A7, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7])(f: (A0, A1, A2, A3, A4, A5, A6, A7) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatMap9[A0, A1, A2, A3, A4, A5, A6, A7, A8, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8) => IsGiven[Z]): F[Z]

Attributes

Inherited from:
FlatMapArityFunctions
def flatSequence[G[_], A](fgfa: IsGiven[G[IsGiven[A]]])(implicit G: Applicative[G], F: FlatMap[IsGiven]): G[F[A]]

Thread all the G effects through the F structure and flatten to invert the structure from F[G[F[A]]] to G[F[A]].

Thread all the G effects through the F structure and flatten to invert the structure from F[G[F[A]]] to G[F[A]].

Example:

scala> import cats.implicits._
scala> val x: List[Option[List[Int]]] = List(Some(List(1, 2)), Some(List(3)))
scala> val y: List[Option[List[Int]]] = List(None, Some(List(3)))
scala> x.flatSequence
res0: Option[List[Int]] = Some(List(1, 2, 3))
scala> y.flatSequence
res1: Option[List[Int]] = None

Attributes

Inherited from:
Traverse
def flatTap[A, B](fa: IsGiven[A])(f: A => IsGiven[B]): F[A]

Apply a monadic function and discard the result while keeping the effect.

Apply a monadic function and discard the result while keeping the effect.

scala> import cats._, implicits._
scala> Option(1).flatTap(_ => None)
res0: Option[Int] = None
scala> Option(1).flatTap(_ => Some("123"))
res1: Option[Int] = Some(1)
scala> def nCats(n: Int) = List.fill(n)("cat")
nCats: (n: Int)List[String]
scala> List[Int](0).flatTap(nCats)
res2: List[Int] = List()
scala> List[Int](4).flatTap(nCats)
res3: List[Int] = List(4, 4, 4, 4)

Attributes

Inherited from:
FlatMap
def flatTraverse[G[_], A, B](fa: IsGiven[A])(f: A => G[IsGiven[B]])(implicit G: Applicative[G], F: FlatMap[IsGiven]): G[F[B]]

A traverse followed by flattening the inner result.

A traverse followed by flattening the inner result.

Example:

scala> import cats.implicits._
scala> def parseInt(s: String): Option[Int] = Either.catchOnly[NumberFormatException](s.toInt).toOption
scala> val x = Option(List("1", "two", "3"))
scala> x.flatTraverse(_.map(parseInt))
res0: List[Option[Int]] = List(Some(1), None, Some(3))

Attributes

Inherited from:
Traverse
def flatten[A](ffa: IsGiven[IsGiven[A]]): F[A]

"flatten" a nested F of F structure into a single-layer F structure.

"flatten" a nested F of F structure into a single-layer F structure.

This is also commonly called join.

Example:

scala> import cats.Eval
scala> import cats.implicits._

scala> val nested: Eval[Eval[Int]] = Eval.now(Eval.now(3))
scala> val flattened: Eval[Int] = nested.flatten
scala> flattened.value
res0: Int = 3

Attributes

Inherited from:
FlatMap
final def fmap[A, B](fa: IsGiven[A])(f: A => B): F[B]

Alias for map, since map can't be injected as syntax if the implementing type already had a built-in .map method.

Alias for map, since map can't be injected as syntax if the implementing type already had a built-in .map method.

Example:

scala> import cats.implicits._

scala> val m: Map[Int, String] = Map(1 -> "hi", 2 -> "there", 3 -> "you")

scala> m.fmap(_ ++ "!")
res0: Map[Int,String] = Map(1 -> hi!, 2 -> there!, 3 -> you!)

Attributes

Inherited from:
Functor
def fold[A](fa: IsGiven[A])(implicit A: Monoid[A]): A

Fold implemented using the given Monoid[A] instance.

Fold implemented using the given Monoid[A] instance.

Attributes

Inherited from:
Foldable
def foldA[G[_], A](fga: IsGiven[G[A]])(implicit G: Applicative[G], A: Monoid[A]): G[A]

Fold implemented using the given Applicative[G] and Monoid[A] instance.

Fold implemented using the given Applicative[G] and Monoid[A] instance.

This method is similar to fold, but may short-circuit.

For example:

scala> import cats.implicits._
scala> val F = Foldable[List]
scala> F.foldA(List(Either.right[String, Int](1), Either.right[String, Int](2)))
res0: Either[String, Int] = Right(3)

Attributes

Inherited from:
Foldable
def foldK[G[_], A](fga: IsGiven[G[A]])(implicit G: MonoidK[G]): G[A]

Fold implemented using the given MonoidK[G] instance.

Fold implemented using the given MonoidK[G] instance.

This method is identical to fold, except that we use the universal monoid (MonoidK[G]) to get a Monoid[G[A]] instance.

For example:

scala> import cats.implicits._
scala> val F = Foldable[List]
scala> F.foldK(List(1 :: 2 :: Nil, 3 :: 4 :: 5 :: Nil))
res0: List[Int] = List(1, 2, 3, 4, 5)

Attributes

Inherited from:
Foldable
final def foldLeftM[G[_], A, B](fa: IsGiven[A], z: B)(f: (B, A) => G[B])(implicit G: Monad[G]): G[B]

Alias for foldM.

Alias for foldM.

Attributes

Inherited from:
Foldable
def foldM[G[_], A, B](fa: IsGiven[A], z: B)(f: (B, A) => G[B])(implicit G: Monad[G]): G[B]

Perform a stack-safe monadic left fold from the source context F into the target monad G.

Perform a stack-safe monadic left fold from the source context F into the target monad G.

This method can express short-circuiting semantics. Even when fa is an infinite structure, this method can potentially terminate if the foldRight implementation for F and the tailRecM implementation for G are sufficiently lazy.

Instances for concrete structures (e.g. List) will often have a more efficient implementation than the default one in terms of foldRight.

Attributes

Inherited from:
Foldable
def foldMap[A, B](fa: IsGiven[A])(f: A => B)(implicit B: Monoid[B]): B

Fold implemented by mapping A values into B and then combining them using the given Monoid[B] instance.

Fold implemented by mapping A values into B and then combining them using the given Monoid[B] instance.

Attributes

Inherited from:
Foldable
def foldMapA[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: Applicative[G], B: Monoid[B]): G[B]

Fold in an Applicative context by mapping the A values to G[B]. combining the B values using the given Monoid[B] instance.

Fold in an Applicative context by mapping the A values to G[B]. combining the B values using the given Monoid[B] instance.

Similar to foldMapM, but will typically be less efficient.

scala> import cats.Foldable
scala> import cats.implicits._
scala> val evenNumbers = List(2,4,6,8,10)
scala> val evenOpt: Int => Option[Int] =
    |   i => if (i % 2 == 0) Some(i) else None
scala> Foldable[List].foldMapA(evenNumbers)(evenOpt)
res0: Option[Int] = Some(30)
scala> Foldable[List].foldMapA(evenNumbers :+ 11)(evenOpt)
res1: Option[Int] = None

Attributes

Inherited from:
Foldable
def foldMapK[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: MonoidK[G]): G[B]

Fold implemented by mapping A values into B in a context G and then combining them using the MonoidK[G] instance.

Fold implemented by mapping A values into B in a context G and then combining them using the MonoidK[G] instance.

scala> import cats._, cats.implicits._
scala> val f: Int => Endo[String] = i => (s => s + i)
scala> val x: Endo[String] = Foldable[List].foldMapK(List(1, 2, 3))(f)
scala> val a = x("foo")
a: String = "foo321"

Attributes

Inherited from:
Foldable
def foldMapM[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: Monad[G], B: Monoid[B]): G[B]

Monadic folding on F by mapping A values to G[B], combining the B values using the given Monoid[B] instance.

Monadic folding on F by mapping A values to G[B], combining the B values using the given Monoid[B] instance.

Similar to foldM, but using a Monoid[B]. Will typically be more efficient than foldMapA.

scala> import cats.Foldable
scala> import cats.implicits._
scala> val evenNumbers = List(2,4,6,8,10)
scala> val evenOpt: Int => Option[Int] =
    |   i => if (i % 2 == 0) Some(i) else None
scala> Foldable[List].foldMapM(evenNumbers)(evenOpt)
res0: Option[Int] = Some(30)
scala> Foldable[List].foldMapM(evenNumbers :+ 11)(evenOpt)
res1: Option[Int] = None

Attributes

Inherited from:
Foldable
def foldRightDefer[G[_] : Defer, A, B](fa: IsGiven[A], gb: G[B])(fn: (A, G[B]) => G[B]): G[B]

Attributes

Inherited from:
Foldable
override def forall[A](fa: IsGiven[A])(p: A => Boolean): Boolean

Check whether all elements satisfy the predicate.

Check whether all elements satisfy the predicate.

If there are no elements, the result is true.

Attributes

Definition Classes
Foldable -> UnorderedFoldable
Inherited from:
Foldable
def forallM[G[_], A](fa: IsGiven[A])(p: A => G[Boolean])(implicit G: Monad[G]): G[Boolean]

Check whether all elements satisfy the effectful predicate.

Check whether all elements satisfy the effectful predicate.

If there are no elements, the result is true. forallM short-circuits, i.e. once a false result is encountered, no further effects are produced.

For example:

scala> import cats.implicits._
scala> val F = Foldable[List]
scala> F.forallM(List(1,2,3,4))(n => Option(n <= 4))
res0: Option[Boolean] = Some(true)

scala> F.forallM(List(1,2,3,4))(n => Option(n <= 1))
res1: Option[Boolean] = Some(false)

scala> F.forallM(List(1,2,3,4))(n => if (n <= 2) Option(true) else Option(false))
res2: Option[Boolean] = Some(false)

scala> F.forallM(List(1,2,3,4))(n => if (n <= 2) Option(false) else None)
res3: Option[Boolean] = Some(false)

scala> F.forallM(List(1,2,3,4))(n => if (n <= 2) None else Option(false))
res4: Option[Boolean] = None

Attributes

Inherited from:
Foldable
def foreverM[A, B](fa: IsGiven[A]): F[B]

Like an infinite loop of >> calls. This is most useful effect loops that you want to run forever in for instance a server.

Like an infinite loop of >> calls. This is most useful effect loops that you want to run forever in for instance a server.

This will be an infinite loop, or it will return an F[Nothing].

Be careful using this. For instance, a List of length k will produce a list of length k^n at iteration n. This means if k = 0, we return an empty list, if k = 1, we loop forever allocating single element lists, but if we have a k > 1, we will allocate exponentially increasing memory and very quickly OOM.

Attributes

Inherited from:
FlatMap
def fproduct[A, B](fa: IsGiven[A])(f: A => B): F[(A, B)]

Tuple the values in fa with the result of applying a function with the value

Tuple the values in fa with the result of applying a function with the value

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> Functor[Option].fproduct(Option(42))(_.toString)
res0: Option[(Int, String)] = Some((42,42))

Attributes

Inherited from:
Functor
def fproductLeft[A, B](fa: IsGiven[A])(f: A => B): F[(B, A)]

Pair the result of function application with A.

Pair the result of function application with A.

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> Functor[Option].fproductLeft(Option(42))(_.toString)
res0: Option[(String, Int)] = Some((42,42))

Attributes

Inherited from:
Functor
def get[A](fa: IsGiven[A])(idx: Long): Option[A]

Get the element at the index of the Foldable.

Get the element at the index of the Foldable.

Attributes

Inherited from:
Foldable
def ifElseM[A](branches: (IsGiven[Boolean], IsGiven[A])*)(els: IsGiven[A]): F[A]

Simulates an if/else-if/else in the context of an F. It evaluates conditions until one evaluates to true, and returns the associated F[A]. If no condition is true, returns els.

Simulates an if/else-if/else in the context of an F. It evaluates conditions until one evaluates to true, and returns the associated F[A]. If no condition is true, returns els.

scala> import cats._
scala> Monad[Eval].ifElseM(Eval.later(false) -> Eval.later(1), Eval.later(true) -> Eval.later(2))(Eval.later(5)).value
res0: Int = 2

Based on a gist by Daniel Spiewak with a stack-safe implementation due to P. Oscar Boykin

Attributes

See also:
Inherited from:
Monad
def ifF[A](fb: IsGiven[Boolean])(ifTrue: => A, ifFalse: => A): F[A]

Lifts if to Functor

Lifts if to Functor

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].ifF(List(true, false, false))(1, 0)
res0: List[Int] = List(1, 0, 0)

Attributes

Inherited from:
Functor
def ifM[B](fa: IsGiven[Boolean])(ifTrue: => IsGiven[B], ifFalse: => IsGiven[B]): F[B]

if lifted into monad.

if lifted into monad.

Attributes

Inherited from:
FlatMap
override def imap[A, B](fa: IsGiven[A])(f: A => B)(g: B => A): F[B]

Transform an F[A] into an F[B] by providing a transformation from A to B and one from B to A.

Transform an F[A] into an F[B] by providing a transformation from A to B and one from B to A.

Example:

scala> import cats.implicits._
scala> import scala.concurrent.duration._

scala> val durSemigroup: Semigroup[FiniteDuration] =
    | Invariant[Semigroup].imap(Semigroup[Long])(Duration.fromNanos)(_.toNanos)
scala> durSemigroup.combine(2.seconds, 3.seconds)
res1: FiniteDuration = 5 seconds

Attributes

Definition Classes
Functor -> Invariant
Inherited from:
Functor
def intercalate[A](fa: IsGiven[A], a: A)(implicit A: Monoid[A]): A

Intercalate/insert an element between the existing elements while folding.

Intercalate/insert an element between the existing elements while folding.

scala> import cats.implicits._
scala> Foldable[List].intercalate(List("a","b","c"), "-")
res0: String = a-b-c
scala> Foldable[List].intercalate(List("a"), "-")
res1: String = a
scala> Foldable[List].intercalate(List.empty[String], "-")
res2: String = ""
scala> Foldable[Vector].intercalate(Vector(1,2,3), 1)
res3: Int = 8

Attributes

Inherited from:
Foldable
override def isEmpty[A](fa: IsGiven[A]): Boolean

Returns true if there are no elements. Otherwise false.

Returns true if there are no elements. Otherwise false.

Attributes

Definition Classes
Reducible -> Foldable -> UnorderedFoldable
Inherited from:
Reducible
def iterateForeverM[A, B](a: A)(f: A => IsGiven[A]): F[B]

iterateForeverM is almost exclusively useful for effect types. For instance, A may be some state, we may take the current state, run some effect to get a new state and repeat.

iterateForeverM is almost exclusively useful for effect types. For instance, A may be some state, we may take the current state, run some effect to get a new state and repeat.

Attributes

Inherited from:
FlatMap
def iterateUntil[A](f: IsGiven[A])(p: A => Boolean): F[A]

Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.

Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.

Attributes

Inherited from:
Monad
def iterateUntilM[A](init: A)(f: A => IsGiven[A])(p: A => Boolean): F[A]

Apply a monadic function iteratively until its result satisfies the given predicate and return that result.

Apply a monadic function iteratively until its result satisfies the given predicate and return that result.

Attributes

Inherited from:
Monad
def iterateWhile[A](f: IsGiven[A])(p: A => Boolean): F[A]

Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.

Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.

Attributes

Inherited from:
Monad
def iterateWhileM[A](init: A)(f: A => IsGiven[A])(p: A => Boolean): F[A]

Apply a monadic function iteratively until its result fails to satisfy the given predicate and return that result.

Apply a monadic function iteratively until its result fails to satisfy the given predicate and return that result.

Attributes

Inherited from:
Monad
def lift[A, B](f: A => B): F[A] => F[B]

Lift a function f to operate on Functors

Lift a function f to operate on Functors

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> val o = Option(42)
scala> Functor[Option].lift((x: Int) => x + 10)(o)
res0: Option[Int] = Some(52)

Attributes

Inherited from:
Functor
def map10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
override def map2[A, B, Z](fa: IsGiven[A], fb: IsGiven[B])(f: (A, B) => Z): F[Z]

Applies the pure (binary) function f to the effectful values fa and fb.

Applies the pure (binary) function f to the effectful values fa and fb.

map2 can be seen as a binary version of cats.Functor#map.

Example:

scala> import cats.implicits._

scala> val someInt: Option[Int] = Some(3)
scala> val noneInt: Option[Int] = None
scala> val someLong: Option[Long] = Some(4L)
scala> val noneLong: Option[Long] = None

scala> Apply[Option].map2(someInt, someLong)((i, l) => i.toString + l.toString)
res0: Option[String] = Some(34)

scala> Apply[Option].map2(someInt, noneLong)((i, l) => i.toString + l.toString)
res0: Option[String] = None

scala> Apply[Option].map2(noneInt, noneLong)((i, l) => i.toString + l.toString)
res0: Option[String] = None

scala> Apply[Option].map2(noneInt, someLong)((i, l) => i.toString + l.toString)
res0: Option[String] = None

Attributes

Definition Classes
FlatMap -> Apply
Inherited from:
FlatMap
def map20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20], f21: IsGiven[A21])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
override def map2Eval[A, B, Z](fa: IsGiven[A], fb: Eval[IsGiven[B]])(f: (A, B) => Z): Eval[F[Z]]

Similar to map2 but uses Eval to allow for laziness in the F[B] argument. This can allow for "short-circuiting" of computations.

Similar to map2 but uses Eval to allow for laziness in the F[B] argument. This can allow for "short-circuiting" of computations.

NOTE: the default implementation of map2Eval does not short-circuit computations. For data structures that can benefit from laziness, Apply instances should override this method.

In the following example, x.map2(bomb)(_ + _) would result in an error, but map2Eval "short-circuits" the computation. x is None and thus the result of bomb doesn't even need to be evaluated in order to determine that the result of map2Eval should be None.

scala> import cats.{Eval, Later}
scala> import cats.implicits._
scala> val bomb: Eval[Option[Int]] = Later(sys.error("boom"))
scala> val x: Option[Int] = None
scala> x.map2Eval(bomb)(_ + _).value
res0: Option[Int] = None

Attributes

Definition Classes
FlatMap -> Apply
Inherited from:
FlatMap
def map3[A0, A1, A2, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2])(f: (A0, A1, A2) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map4[A0, A1, A2, A3, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3])(f: (A0, A1, A2, A3) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map5[A0, A1, A2, A3, A4, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4])(f: (A0, A1, A2, A3, A4) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map6[A0, A1, A2, A3, A4, A5, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5])(f: (A0, A1, A2, A3, A4, A5) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map7[A0, A1, A2, A3, A4, A5, A6, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6])(f: (A0, A1, A2, A3, A4, A5, A6) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map8[A0, A1, A2, A3, A4, A5, A6, A7, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7])(f: (A0, A1, A2, A3, A4, A5, A6, A7) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def map9[A0, A1, A2, A3, A4, A5, A6, A7, A8, Z](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
def mapAccumulate[S, A, B](init: S, fa: IsGiven[A])(f: (S, A) => (S, B)): (S, F[B])

Akin to map, but allows to keep track of a state value when calling the function.

Akin to map, but allows to keep track of a state value when calling the function.

Attributes

Inherited from:
Traverse
def mapWithIndex[A, B](fa: IsGiven[A])(f: (A, Int) => B): F[B]

Akin to map, but also provides the value's index in structure F when calling the function.

Akin to map, but also provides the value's index in structure F when calling the function.

Attributes

Inherited from:
Traverse
def mapWithLongIndex[A, B](fa: IsGiven[A])(f: (A, Long) => B): F[B]

Same as mapWithIndex but the index type is Long instead of Int.

Same as mapWithIndex but the index type is Long instead of Int.

Attributes

Inherited from:
Traverse
def maximum[A](fa: IsGiven[A])(implicit A: Order[A]): A

Attributes

Inherited from:
Reducible
def maximumBy[A, B : Order](fa: IsGiven[A])(f: A => B): A

Find the maximum A item in this structure according to an Order.by(f).

Find the maximum A item in this structure according to an Order.by(f).

Attributes

See also:

minimumBy for minimum instead of maximum.

Inherited from:
Reducible
def maximumByList[A, B : Order](fa: IsGiven[A])(f: A => B): List[A]

Find all the maximum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the maximum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

Reducible#maximumByNel for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

minimumByList for minimum instead of maximum.

Inherited from:
Foldable
def maximumByNel[A, B : Order](fa: IsGiven[A])(f: A => B): NonEmptyList[A]

Find all the maximum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the maximum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

minimumByNel for minimum instead of maximum.

Inherited from:
Reducible
def maximumByOption[A, B : Order](fa: IsGiven[A])(f: A => B): Option[A]

Find the maximum A item in this structure according to an Order.by(f).

Find the maximum A item in this structure according to an Order.by(f).

Attributes

Returns:

None if the structure is empty, otherwise the maximum element wrapped in a Some.

See also:

Reducible#maximumBy for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

minimumByOption for minimum instead of maximum.

Inherited from:
Foldable
def maximumList[A](fa: IsGiven[A])(implicit A: Order[A]): List[A]

Find all the maximum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the maximum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

Reducible#maximumNel for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

minimumList for minimum instead of maximum.

Inherited from:
Foldable
def maximumNel[A](fa: IsGiven[A])(implicit A: Order[A]): NonEmptyList[A]

Find all the maximum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the maximum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

minimumNel for minimum instead of maximum.

Inherited from:
Reducible
override def maximumOption[A](fa: IsGiven[A])(implicit A: Order[A]): Option[A]

Find the maximum A item in this structure according to the Order[A].

Find the maximum A item in this structure according to the Order[A].

Attributes

Returns:

None if the structure is empty, otherwise the maximum element wrapped in a Some.

See also:

Reducible#maximum for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

minimumOption for minimum instead of maximum.

Definition Classes
Reducible -> Foldable
Inherited from:
Reducible
def minimum[A](fa: IsGiven[A])(implicit A: Order[A]): A

Attributes

Inherited from:
Reducible
def minimumBy[A, B : Order](fa: IsGiven[A])(f: A => B): A

Find the minimum A item in this structure according to an Order.by(f).

Find the minimum A item in this structure according to an Order.by(f).

Attributes

See also:

maximumBy for maximum instead of minimum.

Inherited from:
Reducible
def minimumByList[A, B : Order](fa: IsGiven[A])(f: A => B): List[A]

Find all the minimum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the minimum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

Reducible#minimumByNel for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

maximumByList for maximum instead of minimum.

Inherited from:
Foldable
def minimumByNel[A, B : Order](fa: IsGiven[A])(f: A => B): NonEmptyList[A]

Find all the minimum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the minimum A items in this structure according to an Order.by(f). For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

maximumByNel for maximum instead of minimum.

Inherited from:
Reducible
def minimumByOption[A, B : Order](fa: IsGiven[A])(f: A => B): Option[A]

Find the minimum A item in this structure according to an Order.by(f).

Find the minimum A item in this structure according to an Order.by(f).

Attributes

Returns:

None if the structure is empty, otherwise the minimum element wrapped in a Some.

See also:

Reducible#minimumBy for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

maximumByOption for maximum instead of minimum.

Inherited from:
Foldable
def minimumList[A](fa: IsGiven[A])(implicit A: Order[A]): List[A]

Find all the minimum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the minimum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

Reducible#minimumNel for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

maximumList for maximum instead of minimum.

Inherited from:
Foldable
def minimumNel[A](fa: IsGiven[A])(implicit A: Order[A]): NonEmptyList[A]

Find all the minimum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Find all the minimum A items in this structure. For all elements in the result Order.eqv(x, y) is true. Preserves order.

Attributes

See also:

maximumNel for maximum instead of minimum.

Inherited from:
Reducible
override def minimumOption[A](fa: IsGiven[A])(implicit A: Order[A]): Option[A]

Find the minimum A item in this structure according to the Order[A].

Find the minimum A item in this structure according to the Order[A].

Attributes

Returns:

None if the structure is empty, otherwise the minimum element wrapped in a Some.

See also:

Reducible#minimum for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty.

maximumOption for maximum instead of minimum.

Definition Classes
Reducible -> Foldable
Inherited from:
Reducible
def mproduct[A, B](fa: IsGiven[A])(f: A => IsGiven[B]): F[(A, B)]

Pair A with the result of function application.

Pair A with the result of function application.

Example:

scala> import cats.implicits._
scala> List("12", "34", "56").mproduct(_.toList)
res0: List[(String, Char)] = List((12,1), (12,2), (34,3), (34,4), (56,5), (56,6))

Attributes

Inherited from:
FlatMap
override def nonEmpty[A](fa: IsGiven[A]): Boolean

Attributes

Definition Classes
Reducible -> Foldable -> UnorderedFoldable
Inherited from:
Reducible
def nonEmptyFlatSequence[G[_], A](fgfa: IsGiven[G[IsGiven[A]]])(implicit G: Apply[G], F: FlatMap[IsGiven]): G[F[A]]

Thread all the G effects through the F structure and flatten to invert the structure from F[G[F[A]]] to G[F[A]].

Thread all the G effects through the F structure and flatten to invert the structure from F[G[F[A]]] to G[F[A]].

Example:

scala> import cats.implicits._
scala> import cats.data.NonEmptyList
scala> val x = NonEmptyList.of(Map(0 ->NonEmptyList.of(1, 2)), Map(0 -> NonEmptyList.of(3)))
scala> val y: NonEmptyList[Map[Int, NonEmptyList[Int]]] = NonEmptyList.of(Map(), Map(1 -> NonEmptyList.of(3)))
scala> x.nonEmptyFlatSequence
res0: Map[Int,cats.data.NonEmptyList[Int]] = Map(0 -> NonEmptyList(1, 2, 3))
scala> y.nonEmptyFlatSequence
res1: Map[Int,cats.data.NonEmptyList[Int]] = Map()

Attributes

Inherited from:
NonEmptyTraverse
def nonEmptyFlatTraverse[G[_], A, B](fa: IsGiven[A])(f: A => G[IsGiven[B]])(implicit G: Apply[G], F: FlatMap[IsGiven]): G[F[B]]

A nonEmptyTraverse followed by flattening the inner result.

A nonEmptyTraverse followed by flattening the inner result.

Example:

scala> import cats.implicits._
scala> import cats.data.NonEmptyList
scala> val x = NonEmptyList.of(List("How", "do", "you", "fly"), List("What", "do", "you", "do"))
scala> x.nonEmptyFlatTraverse(_.groupByNel(identity) : Map[String, NonEmptyList[String]])
res0: Map[String,cats.data.NonEmptyList[String]] = Map(do -> NonEmptyList(do, do, do), you -> NonEmptyList(you, you))

Attributes

Inherited from:
NonEmptyTraverse
def nonEmptyIntercalate[A](fa: IsGiven[A], a: A)(implicit A: Semigroup[A]): A

Intercalate/insert an element between the existing elements while reducing.

Intercalate/insert an element between the existing elements while reducing.

scala> import cats.data.NonEmptyList
scala> val nel = NonEmptyList.of("a", "b", "c")
scala> Reducible[NonEmptyList].nonEmptyIntercalate(nel, "-")
res0: String = a-b-c
scala> Reducible[NonEmptyList].nonEmptyIntercalate(NonEmptyList.of("a"), "-")
res1: String = a

Attributes

Inherited from:
Reducible
def nonEmptyPartition[A, B, C](fa: IsGiven[A])(f: A => Either[B, C]): Ior[NonEmptyList[B], NonEmptyList[C]]

Partition this Reducible by a separating function A => Either[B, C]

Partition this Reducible by a separating function A => Either[B, C]

scala> import cats.data.NonEmptyList
scala> val nel = NonEmptyList.of(1,2,3,4)
scala> Reducible[NonEmptyList].nonEmptyPartition(nel)(a => if (a % 2 == 0) Left(a.toString) else Right(a))
res0: cats.data.Ior[cats.data.NonEmptyList[String],cats.data.NonEmptyList[Int]] = Both(NonEmptyList(2, 4),NonEmptyList(1, 3))
scala> Reducible[NonEmptyList].nonEmptyPartition(nel)(a => Right(a * 4))
res1: cats.data.Ior[cats.data.NonEmptyList[Nothing],cats.data.NonEmptyList[Int]] = Right(NonEmptyList(4, 8, 12, 16))

Attributes

Inherited from:
Reducible
def nonEmptySequence[G[_] : Apply, A](fga: IsGiven[G[A]]): G[F[A]]

Thread all the G effects through the F structure to invert the structure from F[G[A]] to G[F[A]].

Thread all the G effects through the F structure to invert the structure from F[G[A]] to G[F[A]].

Example:

scala> import cats.implicits._
scala> import cats.data.NonEmptyList
scala> val x = NonEmptyList.of(Map("do" -> 1, "you" -> 1), Map("do" -> 2, "you" -> 1))
scala> val y = NonEmptyList.of(Map("How" -> 3, "do" -> 1, "you" -> 1), Map[String,Int]())
scala> x.nonEmptySequence
res0: Map[String,NonEmptyList[Int]] = Map(do -> NonEmptyList(1, 2), you -> NonEmptyList(1, 1))
scala> y.nonEmptySequence
res1: Map[String,NonEmptyList[Int]] = Map()

Attributes

Inherited from:
NonEmptyTraverse
def nonEmptySequence_[G[_], A](fga: IsGiven[G[A]])(implicit G: Apply[G]): G[Unit]

Sequence F[G[A]] using Apply[G].

Sequence F[G[A]] using Apply[G].

This method is similar to Foldable.sequence_ but requires only an Apply instance for G instead of Applicative. See the nonEmptyTraverse_ documentation for a description of the differences.

Attributes

Inherited from:
Reducible
def nonEmptyTraverse_[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: Apply[G]): G[Unit]

Traverse F[A] using Apply[G].

Traverse F[A] using Apply[G].

A values will be mapped into G[B] and combined using Apply#map2.

This method is similar to Foldable.traverse_. There are two main differences:

  1. We only need an Apply instance for G here, since we don't need to call Applicative.pure for a starting value.
  2. This performs a strict left-associative traversal and thus must always traverse the entire data structure. Prefer Foldable.traverse_ if you have an Applicative instance available for G and want to take advantage of short-circuiting the traversal.

Attributes

Inherited from:
Reducible
def partitionBifold[H[_, _], A, B, C](fa: IsGiven[A])(f: A => H[B, C])(implicit A: Alternative[IsGiven], H: Bifoldable[H]): (F[B], F[C])

Separate this Foldable into a Tuple by a separating function A => H[B, C] for some Bifoldable[H] Equivalent to Functor#map and then Alternative#separate.

Separate this Foldable into a Tuple by a separating function A => H[B, C] for some Bifoldable[H] Equivalent to Functor#map and then Alternative#separate.

scala> import cats.implicits._, cats.Foldable, cats.data.Const
scala> val list = List(1,2,3,4)
scala> Foldable[List].partitionBifold(list)(a => ("value " + a.toString(), if (a % 2 == 0) -a else a))
res0: (List[String], List[Int]) = (List(value 1, value 2, value 3, value 4),List(1, -2, 3, -4))
scala> Foldable[List].partitionBifold(list)(a => Const[Int, Nothing with Any](a))
res1: (List[Int], List[Nothing with Any]) = (List(1, 2, 3, 4),List())

Attributes

Inherited from:
Foldable
def partitionBifoldM[G[_], H[_, _], A, B, C](fa: IsGiven[A])(f: A => G[H[B, C]])(implicit A: Alternative[IsGiven], M: Monad[G], H: Bifoldable[H]): G[(F[B], F[C])]

Separate this Foldable into a Tuple by an effectful separating function A => G[H[B, C]] for some Bifoldable[H] Equivalent to Traverse#traverse over Alternative#separate

Separate this Foldable into a Tuple by an effectful separating function A => G[H[B, C]] for some Bifoldable[H] Equivalent to Traverse#traverse over Alternative#separate

scala> import cats.implicits._, cats.Foldable, cats.data.Const
scala> val list = List(1,2,3,4)
`Const`'s second parameter is never instantiated, so we can use an impossible type:
scala> Foldable[List].partitionBifoldM(list)(a => Option(Const[Int, Nothing with Any](a)))
res0: Option[(List[Int], List[Nothing with Any])] = Some((List(1, 2, 3, 4),List()))

Attributes

Inherited from:
Foldable
def partitionEither[A, B, C](fa: IsGiven[A])(f: A => Either[B, C])(implicit A: Alternative[IsGiven]): (F[B], F[C])

Separate this Foldable into a Tuple by a separating function A => Either[B, C] Equivalent to Functor#map and then Alternative#separate.

Separate this Foldable into a Tuple by a separating function A => Either[B, C] Equivalent to Functor#map and then Alternative#separate.

scala> import cats.implicits._
scala> val list = List(1,2,3,4)
scala> Foldable[List].partitionEither(list)(a => if (a % 2 == 0) Left(a.toString) else Right(a))
res0: (List[String], List[Int]) = (List(2, 4),List(1, 3))
scala> Foldable[List].partitionEither(list)(a => Right(a * 4))
res1: (List[Nothing], List[Int]) = (List(),List(4, 8, 12, 16))

Attributes

Inherited from:
Foldable
def partitionEitherM[G[_], A, B, C](fa: IsGiven[A])(f: A => G[Either[B, C]])(implicit A: Alternative[IsGiven], M: Monad[G]): G[(F[B], F[C])]

Separate this Foldable into a Tuple by an effectful separating function A => G[Either[B, C]] Equivalent to Traverse#traverse over Alternative#separate

Separate this Foldable into a Tuple by an effectful separating function A => G[Either[B, C]] Equivalent to Traverse#traverse over Alternative#separate

scala> import cats.implicits._, cats.Foldable, cats.Eval
scala> val list = List(1,2,3,4)
scala> val partitioned1 = Foldable[List].partitionEitherM(list)(a => if (a % 2 == 0) Eval.now(Either.left[String, Int](a.toString)) else Eval.now(Either.right[String, Int](a)))
Since `Eval.now` yields a lazy computation, we need to force it to inspect the result:
scala> partitioned1.value
res0: (List[String], List[Int]) = (List(2, 4),List(1, 3))
scala> val partitioned2 = Foldable[List].partitionEitherM(list)(a => Eval.later(Either.right(a * 4)))
scala> partitioned2.value
res1: (List[Nothing], List[Int]) = (List(),List(4, 8, 12, 16))

Attributes

Inherited from:
Foldable
def point[A](a: A): F[A]

point lifts any value into a Monoidal Functor.

point lifts any value into a Monoidal Functor.

Example:

scala> import cats.implicits._

scala> InvariantMonoidal[Option].point(10)
res0: Option[Int] = Some(10)

Attributes

Inherited from:
InvariantMonoidal
def productAll[A](fa: IsGiven[A])(implicit A: Numeric[A]): A

Attributes

Inherited from:
Foldable
override def productL[A, B](fa: IsGiven[A])(fb: IsGiven[B]): F[A]

Compose two actions, discarding any value produced by the second.

Compose two actions, discarding any value produced by the second.

Attributes

See also:

productR to discard the value of the first instead. Example:

scala> import cats.implicits._
scala> import cats.data.Validated
scala> import Validated.{Valid, Invalid}
scala> type ErrOr[A] = Validated[String, A]
scala> val validInt: ErrOr[Int] = Valid(3)
scala> val validBool: ErrOr[Boolean] = Valid(true)
scala> val invalidInt: ErrOr[Int] = Invalid("Invalid int.")
scala> val invalidBool: ErrOr[Boolean] = Invalid("Invalid boolean.")
scala> Apply[ErrOr].productL(validInt)(validBool)
res0: ErrOr[Int] = Valid(3)
scala> Apply[ErrOr].productL(invalidInt)(validBool)
res1: ErrOr[Int] = Invalid(Invalid int.)
scala> Apply[ErrOr].productL(validInt)(invalidBool)
res2: ErrOr[Int] = Invalid(Invalid boolean.)
scala> Apply[ErrOr].productL(invalidInt)(invalidBool)
res3: ErrOr[Int] = Invalid(Invalid int.Invalid boolean.)
Definition Classes
FlatMap -> Apply
Inherited from:
FlatMap
def productLEval[A, B](fa: IsGiven[A])(fb: Eval[IsGiven[B]]): F[A]

Sequentially compose two actions, discarding any value produced by the second. This variant of productL also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

Sequentially compose two actions, discarding any value produced by the second. This variant of productL also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

scala> import cats.Eval
scala> import cats.implicits._
scala> var count = 0
scala> val fa: Option[Int] = Some(3)
scala> def fb: Option[Unit] = Some(count += 1)
scala> fa.productLEval(Eval.later(fb))
res0: Option[Int] = Some(3)
scala> assert(count == 1)
scala> none[Int].productLEval(Eval.later(fb))
res1: Option[Int] = None
scala> assert(count == 1)

Attributes

Inherited from:
FlatMap
override def productR[A, B](fa: IsGiven[A])(fb: IsGiven[B]): F[B]

Compose two actions, discarding any value produced by the first.

Compose two actions, discarding any value produced by the first.

Attributes

See also:

productL to discard the value of the second instead. Example:

scala> import cats.implicits._
scala> import cats.data.Validated
scala> import Validated.{Valid, Invalid}
scala> type ErrOr[A] = Validated[String, A]
scala> val validInt: ErrOr[Int] = Valid(3)
scala> val validBool: ErrOr[Boolean] = Valid(true)
scala> val invalidInt: ErrOr[Int] = Invalid("Invalid int.")
scala> val invalidBool: ErrOr[Boolean] = Invalid("Invalid boolean.")
scala> Apply[ErrOr].productR(validInt)(validBool)
res0: ErrOr[Boolean] = Valid(true)
scala> Apply[ErrOr].productR(invalidInt)(validBool)
res1: ErrOr[Boolean] = Invalid(Invalid int.)
scala> Apply[ErrOr].productR(validInt)(invalidBool)
res2: ErrOr[Boolean] = Invalid(Invalid boolean.)
scala> Apply[ErrOr].productR(invalidInt)(invalidBool)
res3: ErrOr[Boolean] = Invalid(Invalid int.Invalid boolean.)
Definition Classes
FlatMap -> Apply
Inherited from:
FlatMap
def productREval[A, B](fa: IsGiven[A])(fb: Eval[IsGiven[B]]): F[B]

Sequentially compose two actions, discarding any value produced by the first. This variant of productR also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

Sequentially compose two actions, discarding any value produced by the first. This variant of productR also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

scala> import cats.Eval
scala> import cats.implicits._
scala> val fa: Option[Int] = Some(3)
scala> def fb: Option[String] = Some("foo")
scala> fa.productREval(Eval.later(fb))
res0: Option[String] = Some(foo)

Attributes

Inherited from:
FlatMap
def reduce[A](fa: IsGiven[A])(implicit A: Semigroup[A]): A

Reduce a F[A] value using the given Semigroup[A].

Reduce a F[A] value using the given Semigroup[A].

Attributes

Inherited from:
Reducible
def reduceA[G[_], A](fga: IsGiven[G[A]])(implicit G: Apply[G], A: Semigroup[A]): G[A]

Reduce a F[G[A]] value using Applicative[G] and Semigroup[A], a universal semigroup for G[_].

Reduce a F[G[A]] value using Applicative[G] and Semigroup[A], a universal semigroup for G[_].

This method is similar to reduce, but may short-circuit.

Attributes

Inherited from:
Reducible
def reduceK[G[_], A](fga: IsGiven[G[A]])(implicit G: SemigroupK[G]): G[A]

Reduce a F[G[A]] value using SemigroupK[G], a universal semigroup for G[_].

Reduce a F[G[A]] value using SemigroupK[G], a universal semigroup for G[_].

This method is a generalization of reduce.

scala> import cats.Reducible
scala> import cats.data._
scala> Reducible[NonEmptyVector].reduceK(NonEmptyVector.of(NonEmptyList.of(1, 2, 3), NonEmptyList.of(4, 5, 6), NonEmptyList.of(7, 8, 9)))
res0: NonEmptyList[Int] = NonEmptyList(1, 2, 3, 4, 5, 6, 7, 8, 9)

Attributes

Inherited from:
Reducible
def reduceLeft[A](fa: IsGiven[A])(f: (A, A) => A): A

Left-associative reduction on F using the function f.

Left-associative reduction on F using the function f.

Implementations should override this method when possible.

Attributes

Inherited from:
Reducible
def reduceLeftM[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(g: (B, A) => G[B])(implicit G: FlatMap[G]): G[B]

Monadic variant of reduceLeftTo.

Monadic variant of reduceLeftTo.

Attributes

Inherited from:
Reducible
def reduceLeftOption[A](fa: IsGiven[A])(f: (A, A) => A): Option[A]

Reduce the elements of this structure down to a single value by applying the provided aggregation function in a left-associative manner.

Reduce the elements of this structure down to a single value by applying the provided aggregation function in a left-associative manner.

Attributes

Returns:

None if the structure is empty, otherwise the result of combining the cumulative left-associative result of the f operation over all of the elements.

See also:

reduceRightOption for a right-associative alternative.

Reducible#reduceLeft for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty. Example:

scala> import cats.implicits._
scala> val l = List(6, 3, 2)
This is equivalent to (6 - 3) - 2
scala> Foldable[List].reduceLeftOption(l)(_ - _)
res0: Option[Int] = Some(1)
scala> Foldable[List].reduceLeftOption(List.empty[Int])(_ - _)
res1: Option[Int] = None
Inherited from:
Foldable
override def reduceLeftToOption[A, B](fa: IsGiven[A])(f: A => B)(g: (B, A) => B): Option[B]

Overridden from Foldable for efficiency.

Overridden from Foldable for efficiency.

Attributes

Definition Classes
Reducible -> Foldable
Inherited from:
Reducible
def reduceMap[A, B](fa: IsGiven[A])(f: A => B)(implicit B: Semigroup[B]): B

Apply f to each element of fa and combine them using the given Semigroup[B].

Apply f to each element of fa and combine them using the given Semigroup[B].

scala> import cats.Reducible
scala> import cats.data.NonEmptyList
scala> Reducible[NonEmptyList].reduceMap(NonEmptyList.of(1, 2, 3))(v => v.toString * v)
res0: String = 122333

scala> val gt5: Int => Option[Int] = (num: Int) => Some(num).filter(_ > 5)
scala> Reducible[NonEmptyList].reduceMap(NonEmptyList.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10))(gt5)
res1: Option[Int] = Some(40)

Attributes

Inherited from:
Reducible
def reduceMapA[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: Apply[G], B: Semigroup[B]): G[B]

Reduce in an Apply context by mapping the A values to G[B]. combining the B values using the given Semigroup[B] instance.

Reduce in an Apply context by mapping the A values to G[B]. combining the B values using the given Semigroup[B] instance.

Similar to reduceMapM, but may be less efficient.

scala> import cats.Reducible
scala> import cats.data.NonEmptyList
scala> val evenOpt: Int => Option[Int] =
    |   i => if (i % 2 == 0) Some(i) else None
scala> val allEven = NonEmptyList.of(2,4,6,8,10)
allEven: cats.data.NonEmptyList[Int] = NonEmptyList(2, 4, 6, 8, 10)
scala> val notAllEven = allEven ++ List(11)
notAllEven: cats.data.NonEmptyList[Int] = NonEmptyList(2, 4, 6, 8, 10, 11)
scala> Reducible[NonEmptyList].reduceMapA(allEven)(evenOpt)
res0: Option[Int] = Some(30)
scala> Reducible[NonEmptyList].reduceMapA(notAllEven)(evenOpt)
res1: Option[Int] = None

Attributes

Inherited from:
Reducible
def reduceMapK[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: SemigroupK[G]): G[B]

Apply f to each element of fa and combine them using the given SemigroupK[G].

Apply f to each element of fa and combine them using the given SemigroupK[G].

scala> import cats._, cats.data._
scala> val f: Int => Endo[String] = i => (s => s + i)
scala> val x: Endo[String] = Reducible[NonEmptyList].reduceMapK(NonEmptyList.of(1, 2, 3))(f)
scala> val a = x("foo")
a: String = "foo321"

Attributes

Inherited from:
Reducible
def reduceMapM[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: FlatMap[G], B: Semigroup[B]): G[B]

Reduce in an FlatMap context by mapping the A values to G[B]. combining the B values using the given Semigroup[B] instance.

Reduce in an FlatMap context by mapping the A values to G[B]. combining the B values using the given Semigroup[B] instance.

Similar to reduceLeftM, but using a Semigroup[B]. May be more efficient than reduceMapA.

scala> import cats.Reducible
scala> import cats.data.NonEmptyList
scala> val evenOpt: Int => Option[Int] =
    |   i => if (i % 2 == 0) Some(i) else None
scala> val allEven = NonEmptyList.of(2,4,6,8,10)
allEven: cats.data.NonEmptyList[Int] = NonEmptyList(2, 4, 6, 8, 10)
scala> val notAllEven = allEven ++ List(11)
notAllEven: cats.data.NonEmptyList[Int] = NonEmptyList(2, 4, 6, 8, 10, 11)
scala> Reducible[NonEmptyList].reduceMapM(allEven)(evenOpt)
res0: Option[Int] = Some(30)
scala> Reducible[NonEmptyList].reduceMapM(notAllEven)(evenOpt)
res1: Option[Int] = None

Attributes

Inherited from:
Reducible
def reduceRight[A](fa: IsGiven[A])(f: (A, Eval[A]) => Eval[A]): Eval[A]

Right-associative reduction on F using the function f.

Right-associative reduction on F using the function f.

Attributes

Inherited from:
Reducible
def reduceRightOption[A](fa: IsGiven[A])(f: (A, Eval[A]) => Eval[A]): Eval[Option[A]]

Reduce the elements of this structure down to a single value by applying the provided aggregation function in a right-associative manner.

Reduce the elements of this structure down to a single value by applying the provided aggregation function in a right-associative manner.

Attributes

Returns:

None if the structure is empty, otherwise the result of combining the cumulative right-associative result of the f operation over the A elements.

See also:

reduceLeftOption for a left-associative alternative

Reducible#reduceRight for a version that doesn't need to return an Option for structures that are guaranteed to be non-empty. Example:

scala> import cats.implicits._
scala> val l = List(6, 3, 2)
This is equivalent to 6 - (3 - 2)
scala> Foldable[List].reduceRightOption(l)((current, rest) => rest.map(current - _)).value
res0: Option[Int] = Some(5)
scala> Foldable[List].reduceRightOption(List.empty[Int])((current, rest) => rest.map(current - _)).value
res1: Option[Int] = None
Inherited from:
Foldable
override def reduceRightToOption[A, B](fa: IsGiven[A])(f: A => B)(g: (A, Eval[B]) => Eval[B]): Eval[Option[B]]

Overridden from Foldable for efficiency.

Overridden from Foldable for efficiency.

Attributes

Definition Classes
Reducible -> Foldable
Inherited from:
Reducible
def replicateA[A](n: Int, fa: IsGiven[A]): F[List[A]]

Given fa and n, apply fa n times to construct an F[List[A]] value.

Given fa and n, apply fa n times to construct an F[List[A]] value.

Example:

scala> import cats.data.State

scala> type Counter[A] = State[Int, A]
scala> val getAndIncrement: Counter[Int] = State { i => (i + 1, i) }
scala> val getAndIncrement5: Counter[List[Int]] =
    | Applicative[Counter].replicateA(5, getAndIncrement)
scala> getAndIncrement5.run(0).value
res0: (Int, List[Int]) = (5,List(0, 1, 2, 3, 4))

Attributes

Inherited from:
Applicative
def replicateA_[A](n: Int, fa: IsGiven[A]): F[Unit]

Given fa and n, apply fa n times discarding results to return F[Unit].

Given fa and n, apply fa n times discarding results to return F[Unit].

Example:

scala> import cats.data.State

scala> type Counter[A] = State[Int, A]
scala> val getAndIncrement: Counter[Int] = State { i => (i + 1, i) }
scala> val getAndIncrement5: Counter[Unit] =
    | Applicative[Counter].replicateA_(5, getAndIncrement)
scala> getAndIncrement5.run(0).value
res0: (Int, Unit) = (5,())

Attributes

Inherited from:
Applicative
def sequence[G[_] : Applicative, A](fga: IsGiven[G[A]]): G[F[A]]

Thread all the G effects through the F structure to invert the structure from F[G[A]] to G[F[A]].

Thread all the G effects through the F structure to invert the structure from F[G[A]] to G[F[A]].

Example:

scala> import cats.implicits._
scala> val x: List[Option[Int]] = List(Some(1), Some(2))
scala> val y: List[Option[Int]] = List(None, Some(2))
scala> x.sequence
res0: Option[List[Int]] = Some(List(1, 2))
scala> y.sequence
res1: Option[List[Int]] = None

Attributes

Inherited from:
Traverse
def sequence_[G[_] : Applicative, A](fga: IsGiven[G[A]]): G[Unit]

Sequence F[G[A]] using Applicative[G].

Sequence F[G[A]] using Applicative[G].

This is similar to traverse_ except it operates on F[G[A]] values, so no additional functions are needed.

For example:

scala> import cats.implicits._
scala> val F = Foldable[List]
scala> F.sequence_(List(Option(1), Option(2), Option(3)))
res0: Option[Unit] = Some(())
scala> F.sequence_(List(Option(1), None, Option(3)))
res1: Option[Unit] = None

Attributes

Inherited from:
Foldable
def size[A](fa: IsGiven[A]): Long

The size of this UnorderedFoldable.

The size of this UnorderedFoldable.

This is overridden in structures that have more efficient size implementations (e.g. Vector, Set, Map).

Note: will not terminate for infinite-sized collections.

Attributes

Inherited from:
UnorderedFoldable
def sliding10[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding11[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding12[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding13[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding14[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding15[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding16[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding17[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding18[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding19[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding2[A](fa: IsGiven[A]): List[(A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding20[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding21[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding22[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding3[A](fa: IsGiven[A]): List[(A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding4[A](fa: IsGiven[A]): List[(A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding5[A](fa: IsGiven[A]): List[(A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding6[A](fa: IsGiven[A]): List[(A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding7[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding8[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sliding9[A](fa: IsGiven[A]): List[(A, A, A, A, A, A, A, A, A)]

Attributes

Inherited from:
FoldableNFunctions
def sumAll[A](fa: IsGiven[A])(implicit A: Numeric[A]): A

Attributes

Inherited from:
Foldable
def takeWhile_[A](fa: IsGiven[A])(p: A => Boolean): List[A]

Convert F[A] to a List[A], retaining only initial elements which match p.

Convert F[A] to a List[A], retaining only initial elements which match p.

Attributes

Inherited from:
Foldable
def toIterable[A](fa: IsGiven[A]): Iterable[A]

Convert F[A] to an Iterable[A].

Convert F[A] to an Iterable[A].

This method may be overridden for the sake of performance, but implementers should take care not to force a full materialization of the collection.

Attributes

Inherited from:
Foldable
def toList[A](fa: IsGiven[A]): List[A]

Convert F[A] to a List[A].

Convert F[A] to a List[A].

Attributes

Inherited from:
Foldable
def toNonEmptyList[A](fa: IsGiven[A]): NonEmptyList[A]

Attributes

Inherited from:
Reducible
override def traverse[G[_] : Applicative, A, B](fa: IsGiven[A])(f: A => G[B]): G[F[B]]

Given a function which returns a G effect, thread this effect through the running of this function on all the values in F, returning an F[B] in a G context.

Given a function which returns a G effect, thread this effect through the running of this function on all the values in F, returning an F[B] in a G context.

Example:

scala> import cats.implicits._
scala> def parseInt(s: String): Option[Int] = Either.catchOnly[NumberFormatException](s.toInt).toOption
scala> List("1", "2", "3").traverse(parseInt)
res0: Option[List[Int]] = Some(List(1, 2, 3))
scala> List("1", "two", "3").traverse(parseInt)
res1: Option[List[Int]] = None

Attributes

Definition Classes
NonEmptyTraverse -> Traverse
Inherited from:
NonEmptyTraverse
def traverseTap[G[_] : Applicative, A, B](fa: IsGiven[A])(f: A => G[B]): G[F[A]]

Given a function which returns a G effect, thread this effect through the running of this function on all the values in F, returning an F[A] in a G context, ignoring the values returned by provided function.

Given a function which returns a G effect, thread this effect through the running of this function on all the values in F, returning an F[A] in a G context, ignoring the values returned by provided function.

Example:

scala> import cats.implicits._
scala> import java.io.IOException
scala> type IO[A] = Either[IOException, A]
scala> def debug(msg: String): IO[Unit] = Right(())
scala> List("1", "2", "3").traverseTap(debug)
res1: IO[List[String]] = Right(List(1, 2, 3))

Attributes

Inherited from:
Traverse
def traverseWithIndexM[G[_], A, B](fa: IsGiven[A])(f: (A, Int) => G[B])(implicit G: Monad[G]): G[F[B]]

Akin to traverse, but also provides the value's index in structure F when calling the function.

Akin to traverse, but also provides the value's index in structure F when calling the function.

This performs the traversal in a single pass but requires that effect G is monadic. An applicative traversal can be performed in two passes using zipWithIndex followed by traverse.

Attributes

Inherited from:
Traverse
def traverseWithLongIndexM[G[_], A, B](fa: IsGiven[A])(f: (A, Long) => G[B])(implicit G: Monad[G]): G[F[B]]

Same as traverseWithIndexM but the index type is Long instead of Int.

Same as traverseWithIndexM but the index type is Long instead of Int.

Attributes

Inherited from:
Traverse
def traverse_[G[_], A, B](fa: IsGiven[A])(f: A => G[B])(implicit G: Applicative[G]): G[Unit]

Traverse F[A] using Applicative[G].

Traverse F[A] using Applicative[G].

A values will be mapped into G[B] and combined using Applicative#map2.

For example:

scala> import cats.implicits._
scala> def parseInt(s: String): Option[Int] = Either.catchOnly[NumberFormatException](s.toInt).toOption
scala> val F = Foldable[List]
scala> F.traverse_(List("333", "444"))(parseInt)
res0: Option[Unit] = Some(())
scala> F.traverse_(List("333", "zzz"))(parseInt)
res1: Option[Unit] = None

This method is primarily useful when G[_] represents an action or effect, and the specific A aspect of G[A] is not otherwise needed.

Attributes

Inherited from:
Foldable
def tuple10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple2[A, B](f1: IsGiven[A], f2: IsGiven[B]): F[(A, B)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8], f9: IsGiven[A9], f10: IsGiven[A10], f11: IsGiven[A11], f12: IsGiven[A12], f13: IsGiven[A13], f14: IsGiven[A14], f15: IsGiven[A15], f16: IsGiven[A16], f17: IsGiven[A17], f18: IsGiven[A18], f19: IsGiven[A19], f20: IsGiven[A20], f21: IsGiven[A21]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple3[A0, A1, A2](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2]): F[(A0, A1, A2)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple4[A0, A1, A2, A3](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3]): F[(A0, A1, A2, A3)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple5[A0, A1, A2, A3, A4](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4]): F[(A0, A1, A2, A3, A4)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple6[A0, A1, A2, A3, A4, A5](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5]): F[(A0, A1, A2, A3, A4, A5)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple7[A0, A1, A2, A3, A4, A5, A6](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6]): F[(A0, A1, A2, A3, A4, A5, A6)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple8[A0, A1, A2, A3, A4, A5, A6, A7](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7]): F[(A0, A1, A2, A3, A4, A5, A6, A7)]

Attributes

Inherited from:
ApplyArityFunctions
def tuple9[A0, A1, A2, A3, A4, A5, A6, A7, A8](f0: IsGiven[A0], f1: IsGiven[A1], f2: IsGiven[A2], f3: IsGiven[A3], f4: IsGiven[A4], f5: IsGiven[A5], f6: IsGiven[A6], f7: IsGiven[A7], f8: IsGiven[A8]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8)]

Attributes

Inherited from:
ApplyArityFunctions
def tupleLeft[A, B](fa: IsGiven[A], b: B): F[(B, A)]

Tuples the A value in F[A] with the supplied B value, with the B value on the left.

Tuples the A value in F[A] with the supplied B value, with the B value on the left.

Example:

scala> import scala.collection.immutable.Queue
scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForQueue

scala> Functor[Queue].tupleLeft(Queue("hello", "world"), 42)
res0: scala.collection.immutable.Queue[(Int, String)] = Queue((42,hello), (42,world))

Attributes

Inherited from:
Functor
def tupleRight[A, B](fa: IsGiven[A], b: B): F[(A, B)]

Tuples the A value in F[A] with the supplied B value, with the B value on the right.

Tuples the A value in F[A] with the supplied B value, with the B value on the right.

Example:

scala> import scala.collection.immutable.Queue
scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForQueue

scala> Functor[Queue].tupleRight(Queue("hello", "world"), 42)
res0: scala.collection.immutable.Queue[(String, Int)] = Queue((hello,42), (world,42))

Attributes

Inherited from:
Functor
def unlessA[A](cond: Boolean)(f: => IsGiven[A]): F[Unit]

Returns the given argument (mapped to Unit) if cond is false, otherwise, unit lifted into F.

Returns the given argument (mapped to Unit) if cond is false, otherwise, unit lifted into F.

Example:

scala> import cats.implicits._

scala> Applicative[List].unlessA(true)(List(1, 2, 3))
res0: List[Unit] = List(())

scala> Applicative[List].unlessA(false)(List(1, 2, 3))
res1: List[Unit] = List((), (), ())

scala> Applicative[List].unlessA(true)(List.empty[Int])
res2: List[Unit] = List(())

scala> Applicative[List].unlessA(false)(List.empty[Int])
res3: List[Unit] = List()

Attributes

Inherited from:
Applicative
override def unorderedFold[A : CommutativeMonoid](fa: IsGiven[A]): A

Attributes

Definition Classes
Foldable -> UnorderedFoldable
Inherited from:
Foldable
override def unorderedFoldMap[A, B : CommutativeMonoid](fa: IsGiven[A])(f: A => B): B

Attributes

Definition Classes
Foldable -> UnorderedFoldable
Inherited from:
Foldable
override def unorderedSequence[G[_] : CommutativeApplicative, A](fga: IsGiven[G[A]]): G[F[A]]

Attributes

Definition Classes
Traverse -> UnorderedTraverse
Inherited from:
Traverse
override def unorderedTraverse[G[_] : CommutativeApplicative, A, B](sa: IsGiven[A])(f: A => G[B]): G[F[B]]

Attributes

Definition Classes
Traverse -> UnorderedTraverse
Inherited from:
Traverse
def untilDefinedM[A](foa: IsGiven[Option[A]]): F[A]

This repeats an F until we get defined values. This can be useful for polling type operations on State (or RNG) Monads, or in effect monads.

This repeats an F until we get defined values. This can be useful for polling type operations on State (or RNG) Monads, or in effect monads.

Attributes

Inherited from:
FlatMap
def untilM[G[_], A](f: IsGiven[A])(cond: => IsGiven[Boolean])(implicit G: Alternative[G]): F[G[A]]

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Collects results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Collects results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Attributes

Inherited from:
Monad
def untilM_[A](f: IsGiven[A])(cond: => IsGiven[Boolean]): F[Unit]

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Discards results.

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Discards results.

Attributes

Inherited from:
Monad
def unzip[A, B](fab: IsGiven[(A, B)]): (F[A], F[B])

Un-zips an F[(A, B)] consisting of element pairs or Tuple2 into two separate F's tupled.

Un-zips an F[(A, B)] consisting of element pairs or Tuple2 into two separate F's tupled.

NOTE: Check for effect duplication, possibly memoize before

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].unzip(List((1,2), (3, 4)))
res0: (List[Int], List[Int]) = (List(1, 3),List(2, 4))

Attributes

Inherited from:
Functor
def updated_[A, B >: A](fa: IsGiven[A], idx: Long, b: B): Option[F[B]]

If fa contains the element at index idx, return the copy of fa where the element at idx is replaced with b. If there is no element with such an index, return None.

If fa contains the element at index idx, return the copy of fa where the element at idx is replaced with b. If there is no element with such an index, return None.

The behavior is consistent with the Scala collection library's updated for collections such as List.

Attributes

Inherited from:
Traverse
def void[A](fa: IsGiven[A]): F[Unit]

Empty the fa of the values, preserving the structure

Empty the fa of the values, preserving the structure

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].void(List(1,2,3))
res0: List[Unit] = List((), (), ())

Attributes

Inherited from:
Functor
def whenA[A](cond: Boolean)(f: => IsGiven[A]): F[Unit]

Returns the given argument (mapped to Unit) if cond is true, otherwise, unit lifted into F.

Returns the given argument (mapped to Unit) if cond is true, otherwise, unit lifted into F.

Example:

scala> import cats.implicits._

scala> Applicative[List].whenA(true)(List(1, 2, 3))
res0: List[Unit] = List((), (), ())

scala> Applicative[List].whenA(false)(List(1, 2, 3))
res1: List[Unit] = List(())

scala> Applicative[List].whenA(true)(List.empty[Int])
res2: List[Unit] = List()

scala> Applicative[List].whenA(false)(List.empty[Int])
res3: List[Unit] = List(())

Attributes

Inherited from:
Applicative
def whileM[G[_], A](p: IsGiven[Boolean])(body: => IsGiven[A])(implicit G: Alternative[G]): F[G[A]]

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Collects the results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Collects the results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Attributes

Inherited from:
Monad
def whileM_[A](p: IsGiven[Boolean])(body: => IsGiven[A]): F[Unit]

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Discards results.

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Discards results.

Attributes

Inherited from:
Monad
def widen[A, B >: A](fa: IsGiven[A]): F[B]

Lifts natural subtyping covariance of covariant Functors.

Lifts natural subtyping covariance of covariant Functors.

NOTE: In certain (perhaps contrived) situations that rely on universal equality this can result in a ClassCastException, because it is implemented as a type cast. It could be implemented as map(identity), but according to the functor laws, that should be equal to fa, and a type cast is often much more performant. See this example of widen creating a ClassCastException.

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> val s = Some(42)
scala> Functor[Option].widen(s)
res0: Option[Int] = Some(42)

Attributes

Inherited from:
Functor
def zipWithIndex[A](fa: IsGiven[A]): F[(A, Int)]

Traverses through the structure F, pairing the values with assigned indices.

Traverses through the structure F, pairing the values with assigned indices.

The behavior is consistent with the Scala collection library's zipWithIndex for collections such as List.

Attributes

Inherited from:
Traverse
def zipWithLongIndex[A](fa: IsGiven[A]): F[(A, Long)]

Same as zipWithIndex but the index type is Long instead of Int.

Same as zipWithIndex but the index type is Long instead of Int.

Attributes

Inherited from:
Traverse

Deprecated and Inherited methods

def ifA[A](fcond: IsGiven[Boolean])(ifTrue: IsGiven[A], ifFalse: IsGiven[A]): F[A]

Attributes

Deprecated
true
Inherited from:
Apply