Trait/Object

cats.mtl.lifting

FunctorLayer

Related Docs: object FunctorLayer | package lifting

Permalink

trait FunctorLayer[M[_], Inner[_]] extends Serializable

FunctorLayer[M, Inner] has the following functionality: - lifts values from the Functor Inner to the Functor M. - lifts Functor isomorphisms in Inner ((Inner ~> Inner, Inner ~> Inner)) into Functor homomorphisms in M (M ~> M). This allows you to "map" a natural transformation over the Inner inside M, but only if you can provide an inverse of that natural transformation.

FunctorLayer[M, Inner] has two external laws:

def mapForwardRespectsLayer[A](in: Inner[A])(forward: Inner ~> Inner, backward: Inner ~> Inner) = {
  layer(forward(in)) <-> layerImapK(layer(in))(forward, backward)
}

def layerImapRespectsId[A](in: M[A]) = {
  in <-> layerImapK(in)(FunctionK.id, FunctionK.id)
}

FunctorLayer has one free law, i.e. a law guaranteed by parametricity:

def layerRespectsMap[A, B](in: Inner[A])(f: A => B) = {
  layer(in.map(f)) <-> layer(in).map(f)
} // this is free because all `FunctionK`'s (including `layer`, despite not being an instance of the class)
  // are natural transformations (i.e., they follow this law exactly)
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FunctorLayer
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val innerInstance: Functor[Inner]

    Permalink
  2. abstract def layer[A](inner: Inner[A]): M[A]

    Permalink
  3. abstract def layerImapK[A](ma: M[A])(forward: ~>[Inner, Inner], backward: ~>[Inner, Inner]): M[A]

    Permalink
  4. abstract val outerInstance: Functor[M]

    Permalink

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped