Trait/Object

cats

FunctorFilter

Related Docs: object FunctorFilter | package cats

Permalink

trait FunctorFilter[F[_]] extends Functor[F] with Serializable

Linear Supertypes
Functor[F], Invariant[F], Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FunctorFilter
  2. Functor
  3. Invariant
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def map[A, B](fa: F[A])(f: (A) ⇒ B): F[B]

    Permalink
    Definition Classes
    Functor
  2. abstract def mapFilter[A, B](fa: F[A])(f: (A) ⇒ Option[B]): F[B]

    Permalink

    A combined map and filter.

    A combined map and filter. Filtering is handled via Option instead of Boolean such that the output type B can be different than the input type A.

    Example:

    scala> import cats.implicits._
    scala> val m: Map[Int, String] = Map(1 -> "one", 3 -> "three")
    scala> val l: List[Int] = List(1, 2, 3, 4)
    scala> def asString(i: Int): Option[String] = m.get(i)
    scala> l.mapFilter(i => m.get(i))
    res0: List[String] = List(one, three)

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def as[A, B](fa: F[A], b: B): F[B]

    Permalink

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

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

    Definition Classes
    Functor
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[A, B](fa: F[A])(f: PartialFunction[A, B]): F[B]

    Permalink

    Similar to mapFilter but uses a partial function instead of a function that returns an Option.

    Similar to mapFilter but uses a partial function instead of a function that returns an Option.

    Example:

    scala> import cats.implicits._
    scala> val l: List[Int] = List(1, 2, 3, 4)
    scala> FunctorFilter[List].collect(l){
         |   case 1 => "one"
         |   case 3 => "three"
         | }
    res0: List[String] = List(one, three)
  8. def compose[G[_]](implicit arg0: Functor[G]): Functor[[α]F[G[α]]]

    Permalink
    Definition Classes
    Functor
  9. def compose[G[_]](implicit arg0: Invariant[G]): Invariant[[α]F[G[α]]]

    Permalink
    Definition Classes
    Invariant
  10. def composeContravariant[G[_]](implicit arg0: Contravariant[G]): Contravariant[[α]F[G[α]]]

    Permalink
    Definition Classes
    FunctorInvariant
  11. def composeFilter[G[_]](implicit arg0: FunctorFilter[G]): FunctorFilter[[α]F[G[α]]]

    Permalink
    Definition Classes
    Functor
  12. def composeFunctor[G[_]](implicit arg0: Functor[G]): Invariant[[α]F[G[α]]]

    Permalink
    Definition Classes
    Invariant
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def filter[A](fa: F[A])(f: (A) ⇒ Boolean): F[A]

    Permalink

    Apply a filter to a structure such that the output structure contains all A elements in the input structure that satisfy the predicate f but none that don't.

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def flattenOption[A](fa: F[Option[A]]): F[A]

    Permalink

    "Flatten" out a structure by collapsing Options.

    "Flatten" out a structure by collapsing Options.

    Example:

    scala> import cats.implicits._
    scala> val l: List[Option[Int]] = List(Some(1), None, Some(3), None)
    scala> l.flattenOption
    res0: List[Int] = List(1, 3)
  18. def fproduct[A, B](fa: F[A])(f: (A) ⇒ B): F[(A, B)]

    Permalink

    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

    Definition Classes
    Functor
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def imap[A, B](fa: F[A])(f: (A) ⇒ B)(fi: (B) ⇒ A): F[B]

    Permalink
    Definition Classes
    FunctorInvariant
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def lift[A, B](f: (A) ⇒ B): (F[A]) ⇒ F[B]

    Permalink

    Lift a function f to operate on Functors

    Lift a function f to operate on Functors

    Definition Classes
    Functor
  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. def tupleLeft[A, B](fa: F[A], b: B): F[(B, A)]

    Permalink

    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.

    Definition Classes
    Functor
  30. def tupleRight[A, B](fa: F[A], b: B): F[(A, B)]

    Permalink

    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.

    Definition Classes
    Functor
  31. def void[A](fa: F[A]): F[Unit]

    Permalink

    Empty the fa of the values, preserving the structure

    Empty the fa of the values, preserving the structure

    Definition Classes
    Functor
  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def widen[A, B >: A](fa: F[A]): F[B]

    Permalink

    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.

    Definition Classes
    Functor

Inherited from Functor[F]

Inherited from Invariant[F]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped