fundamentals-bio
API
Generated with
fundamentals-bio/izumi.functional.bio/CatsConversions/BIOCatsApplicative

BIOCatsApplicative

izumi.functional.bio.CatsConversions$.BIOCatsApplicative
trait BIOCatsApplicative[F[_, _], E] extends Applicative[[_] =>> F[E, _$46]] with BIOCatsFunctor[F, E]

Attributes

Graph
Supertypes
trait BIOCatsFunctor[F, E]
trait Applicative[[_] =>> F[E, _$46]]
trait InvariantMonoidal[[_] =>> F[E, _$46]]
trait Apply[[_] =>> F[E, _$46]]
trait ApplyArityFunctions[[_] =>> F[E, _$46]]
trait InvariantSemigroupal[[_] =>> F[E, _$46]]
trait Semigroupal[[_] =>> F[E, _$46]]
trait Functor[[_] =>> F[E, _$41]]
trait Invariant[[_] =>> F[E, _$41]]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class BIOCatsClockImpl[F, E]
class BIOCatsMonad[F, E]
class BIOCatsMonadError[F, E]
class BIOCatsSync[F]
class BIOCatsAsync[F]

Members list

Concise view

Value members

Abstract methods

override def F: Applicative2[F]

Attributes

Definition Classes

Concrete methods

final override def ap[A, B](ff: F[E, A => B])(fa: F[E, A]): F[E, 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
Apply
final override def map2[A, B, Z](fa: F[E, A], fb: F[E, B])(f: (A, B) => Z): F[E, 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
Apply
final override def map2Eval[A, B, Z](fa: F[E, A], fb: Eval[F[E, B]])(f: (A, B) => Z): Eval[F[E, 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
Apply
final override def point[A](x: A): F[E, 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

Definition Classes
InvariantMonoidal
final override def productL[A, B](fa: F[E, A])(fb: F[E, B]): F[E, 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
Apply
final override def productR[A, B](fa: F[E, A])(fb: F[E, B]): F[E, 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
Apply
final override def pure[A](x: A): F[E, 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
final override def unit: F[E, 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
final override def unlessA[A](cond: Boolean)(f: => F[E, A]): F[E, 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

Definition Classes
Applicative
final override def whenA[A](cond: Boolean)(f: => F[E, A]): F[E, 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

Definition Classes
Applicative

Inherited methods

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

Alias for productR.

Alias for productR.

Attributes

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

Alias for productL.

Alias for productL.

Attributes

Inherited from:
Apply
final def <*>[A, B](ff: F[E, A => B])(fa: F[E, 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: F[E, (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) => Z])(f0: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9]): F[Z]

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
ApplyArityFunctions
def ap2[A, B, Z](ff: F[E, (A, B) => Z])(fa: F[E, A], fb: F[E, 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

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
ApplyArityFunctions
final override def as[A, B](fa: F[E, A], b: B): F[E, 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

Definition Classes
BIOCatsFunctor -> Functor
Inherited from:
BIOCatsFunctor
def compose[G[_] : Functor]: Functor[[α] =>> F[G[α]]]

Attributes

Inherited from:
Functor
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[_] : 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[_] : 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 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
final def fmap[A, B](fa: F[E, 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 fproduct[A, B](fa: F[E, 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: F[E, 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 ifF[A](fb: F[E, 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
override def imap[A, B](fa: F[E, 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 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
final override def map[A, B](fa: F[E, A])(f: A => B): F[E, B]

Attributes

Definition Classes
BIOCatsFunctor -> Functor
Inherited from:
BIOCatsFunctor
def map10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f0: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, 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
def map20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f0: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, A18], f19: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, A18], f19: F[E, A19], f20: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, A18], f19: F[E, A19], f20: F[E, A20], f21: F[E, 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
def map3[A0, A1, A2, Z](f0: F[E, A0], f1: F[E, A1], f2: F[E, A2])(f: (A0, A1, A2) => Z): F[Z]

Attributes

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

Attributes

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

Attributes

Inherited from:
ApplyArityFunctions
def map6[A0, A1, A2, A3, A4, A5, Z](f0: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8) => Z): F[Z]

Attributes

Inherited from:
ApplyArityFunctions
override def product[A, B](fa: F[E, A], fb: F[E, B]): F[(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
Apply -> Semigroupal
Inherited from:
Apply
def replicateA[A](n: Int, fa: F[E, 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: F[E, 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 tuple10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9](f0: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, 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: F[E, A], f2: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, A18], f19: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, A18], f19: F[E, A19], f20: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8], f9: F[E, A9], f10: F[E, A10], f11: F[E, A11], f12: F[E, A12], f13: F[E, A13], f14: F[E, A14], f15: F[E, A15], f16: F[E, A16], f17: F[E, A17], f18: F[E, A18], f19: F[E, A19], f20: F[E, A20], f21: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2]): F[(A0, A1, A2)]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
ApplyArityFunctions
def tuple8[A0, A1, A2, A3, A4, A5, A6, A7](f0: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, 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: F[E, A0], f1: F[E, A1], f2: F[E, A2], f3: F[E, A3], f4: F[E, A4], f5: F[E, A5], f6: F[E, A6], f7: F[E, A7], f8: F[E, A8]): F[(A0, A1, A2, A3, A4, A5, A6, A7, A8)]

Attributes

Inherited from:
ApplyArityFunctions
def tupleLeft[A, B](fa: F[E, 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: F[E, 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 unzip[A, B](fab: F[E, (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
final override def void[A](fa: F[E, A]): F[E, 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

Definition Classes
BIOCatsFunctor -> Functor
Inherited from:
BIOCatsFunctor
final override def widen[A, B >: A](fa: F[E, A]): F[E, 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

Definition Classes
BIOCatsFunctor -> Functor
Inherited from:
BIOCatsFunctor

Deprecated and Inherited methods

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

Attributes

Deprecated
true
Inherited from:
Apply
Generated with