Trait/Object

cats

Representable

Related Docs: object Representable | package cats

Permalink

trait Representable[F[_]] extends Serializable

Representable.

Is a witness to the isomorphism forall A. F[A] <-> Representation => A

Must obey the laws defined in cats.laws.RepresentableLaws i.e. tabulate andThen index = identity index andThen tabulate = identity

Inspired by the Haskell representable package http://hackage.haskell.org/package/representable-functors-3.2.0.2/docs/Data-Functor-Representable.html

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Representable
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Representation

    Permalink

Abstract Value Members

  1. abstract def F: Functor[F]

    Permalink
  2. abstract def index[A](f: F[A]): (Representation) ⇒ A

    Permalink

    Create a function that "indexes" into the F structure using Representation

    Create a function that "indexes" into the F structure using Representation

    Example:

    scala> import cats.implicits._
    
    scala> type Pair[A] = (A, A)
    
    scala> val indexed: Boolean => String = Representable[Pair].index(("foo", "bar"))
    
    scala> indexed(true)
    res0: String = foo
    
    scala> indexed(false)
    res1: String = bar
  3. abstract def tabulate[A](f: (Representation) ⇒ A): F[A]

    Permalink

    Reconstructs the F structure using the index function

    Reconstructs the F structure using the index function

    Example:

    scala> import cats.implicits._
    
    scala> type Pair[A] = (A, A)
    
    scala> val f: Boolean => String = {
         | case true => "foo"
         | case false => "bar"
         | }
    
    scala> f.tabulate[Pair]
    res0: Pair[String] = (foo,bar)

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