Parallel

Provides an ApplicativeError[F, E] instance for any F, that has a Parallel.Aux[M, F] and a MonadError[M, E] instance. I.e. if you have a type M[_], that supports parallel composition through type F[_], then you can get ApplicativeError[F, E] from MonadError[M, E].

A Parallel instance for any type M[_] that supports parallel composition through itself. Can also be used for giving Parallel instances to types that do not support parallel composition, but are required to have an instance of Parallel defined, in which case parallel composition will actually be sequential.

Like Applicative[F].ap, but uses the applicative instance corresponding to the Parallel instance instead.

Like Applicative[F].ap2, but uses the applicative instance corresponding to the Parallel instance instead.

Like Bitraverse[A].bisequence, but uses the applicative instance corresponding to the Parallel instance instead.

Like Bitraverse[A].bitraverse, but uses the applicative instance corresponding to the Parallel instance instead.

Like TraverseFilter#filterA, but uses the applicative instance corresponding to the Parallel instance instead.

Example:

scala> import cats.implicits._
scala> import cats.data._
scala> val list: List[Int] = List(1, 2, 3, 4)
scala> def validate(n: Int): EitherNec[String, Boolean] =
    | if (n > 100) Left(NonEmptyChain.one("Too large"))
    | else Right(n % 3 =!= 0)
scala> list.parFilterA(validate)
res0: EitherNec[String, List[Int]] = Right(List(1, 2, 4))

Like Traverse[A].flatSequence, but uses the applicative instance corresponding to the Parallel instance instead.

Like Traverse[A].flatTraverse, but uses the applicative instance corresponding to the Parallel instance instead.

Like Foldable[A].foldMapA, but uses the applicative instance corresponding to the Parallel instance instead.

Like Bitraverse[A].leftSequence, but uses the applicative instance corresponding to the Parallel instance instead.

Like Bitraverse[A].leftTraverse, but uses the applicative instance corresponding to the Parallel instance instead.

Like NonEmptyTraverse[A].nonEmptyFlatSequence, but uses the apply instance corresponding to the Parallel instance instead.

Like NonEmptyTraverse[A].nonEmptyFlatTraverse, but uses the apply instance corresponding to the Parallel instance instead.

Like NonEmptyTraverse[A].nonEmptySequence, but uses the apply instance corresponding to the Parallel instance instead.

Like Reducible[A].nonEmptySequence_, but uses the apply instance corresponding to the Parallel instance instead.

Like NonEmptyTraverse[A].nonEmptyTraverse, but uses the apply instance corresponding to the Parallel instance instead.

Like Reducible[A].nonEmptyTraverse_, but uses the apply instance corresponding to the Parallel instance instead.

Like Applicative[F].product, but uses the applicative instance corresponding to the Parallel instance instead.

Like Reducible[A].reduceMapA, but uses the apply instance corresponding to the NonEmptyParallel instance instead.

Like Applicative[F].replicateA, but uses the apply instance corresponding to the Parallel instance instead.

Like Applicative[F].replicateA_, but uses the apply instance corresponding to the Parallel instance instead.

Like Traverse[A].sequence, but uses the applicative instance corresponding to the Parallel instance instead.

Like TraverseFilter#sequenceFilter, but uses the applicative instance corresponding to the Parallel instance instead.

Example:

scala> import cats.implicits._
scala> import cats.data._
scala> val list: List[EitherNec[String, Option[Int]]] = List(Left(NonEmptyChain.one("Error")), Left(NonEmptyChain.one("Warning!")))
scala> list.parSequenceFilter
res0: EitherNec[String, List[Int]] = Left(Chain(Error, Warning!))

Like Foldable[A].sequence_, but uses the applicative instance corresponding to the Parallel instance instead.

Like Traverse[A].traverse, but uses the applicative instance corresponding to the Parallel instance instead.

Like TraverseFilter#traverseFilter, but uses the applicative instance corresponding to the Parallel instance instead.

Example:

scala> import cats.implicits._
scala> import cats.data._
scala> val list: List[Int] = List(1, 2, 3, 4)
scala> def validate(n: Int): EitherNec[String, Option[Int]] =
    | if (n > 100) Left(NonEmptyChain.one("Too large"))
    | else if (n % 3 =!= 0) Right(Some(n))
    | else Right(None)
scala> list.parTraverseFilter(validate)
res0: EitherNec[String, List[Int]] = Right(List(1, 2, 4))

Like Foldable[A].traverse_, but uses the applicative instance corresponding to the Parallel instance instead.