Packages

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

Self Type
Representable[F]
Source
Representable.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Type Hierarchy
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

Abstract Value Members

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

    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]

    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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def compose[G[_]](implicit G: Representable[G]): Aux[[α]F[G[α]], (Representation, Representation)]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped