How precog/matryoshka works
Matryoshka is a Scala library for generalized folds, unfolds, refolds, and traversals over fixed-point data structures. A user defines a one-layer algebra or coalgebra, chooses a recursive representation, and applies a recursion scheme to compute or transform a result. The graph preserves the documented fixed-point variants, pattern functors, and optional ScalaCheck support. Relationships among unsampled modules are omitted unless documented or visible in the supplied source index; dashed links mark documented capabilities whose implementation path was not sampled.
Main entry points: Birecursive.scala Combined schemes · Delay.scala Delayed instances · Recursive.scala Folds and traversals · package.scala Algebras and coalgebras
Components 27
Recursion schemes
- Algebras and coalgebras
core/shared/src/main/scala/matryoshka/package.scala - Folds and traversals
core/shared/src/main/scala/matryoshka/Recursive.scala - Unfolds
core/shared/src/main/scala/matryoshka/Corecursive.scala - Combined schemes
core/shared/src/main/scala/matryoshka/Birecursive.scala - Transformations and refolds
core/shared/src/main/scala/matryoshka/package.scala - RecursiveT
core/shared/src/main/scala/matryoshka/RecursiveT.scala - CorecursiveT
core/shared/src/main/scala/matryoshka/CorecursiveT.scala - BirecursiveT
core/shared/src/main/scala/matryoshka/BirecursiveT.scala
Fixed-point types
Patterns and utilities
- Delayed instances
core/shared/src/main/scala/matryoshka/Delay.scala - EqualT
core/shared/src/main/scala/matryoshka/EqualT.scala - ShowT
core/shared/src/main/scala/matryoshka/ShowT.scala - Merge
core/shared/src/main/scala/matryoshka/Merge.scala - AndMaybe
core/shared/src/main/scala/matryoshka/patterns/AndMaybe.scala - CoEnv
core/shared/src/main/scala/matryoshka/patterns/CoEnv.scala - Diff
core/shared/src/main/scala/matryoshka/patterns/Diff.scala - EnvT
core/shared/src/main/scala/matryoshka/patterns/EnvT.scala - ListF
core/shared/src/main/scala/matryoshka/patterns/ListF.scala
ScalaCheck support
- Arbitrary instances
scalacheck/shared/src/main/scala/matryoshka/scalacheck/arbitrary.scala - Cogen instances
scalacheck/shared/src/main/scala/matryoshka/scalacheck/cogen.scala - Shrink instances
scalacheck/shared/src/main/scala/matryoshka/scalacheck/shrink.scala
Other components
- Library user
- Computed result
Connections 28
- Library user → Algebras and coalgebras: defines operations
- Library user → Fix: chooses representation
- Algebras and coalgebras → Folds and traversals: folds with
core/shared/src/main/scala/matryoshka/package.scala - Algebras and coalgebras → Unfolds: unfolds with
core/shared/src/main/scala/matryoshka/package.scala - Folds and traversals → Computed result: computes result
- Library user → Transformations and refolds: may apply
- Library user → Combined schemes: may apply
- Combined schemes → Folds and traversals: extends
core/shared/src/main/scala/matryoshka/Birecursive.scala - Combined schemes → Unfolds: extends
core/shared/src/main/scala/matryoshka/Birecursive.scala - BirecursiveT → RecursiveT: extends
core/shared/src/main/scala/matryoshka/BirecursiveT.scala - BirecursiveT → CorecursiveT: extends
core/shared/src/main/scala/matryoshka/BirecursiveT.scala - RecursiveT → Diff: supports workaround
core/shared/src/main/scala/matryoshka/RecursiveT.scala - RecursiveT → AndMaybe: supports workaround
- Fix → Combined schemes: implements instances
core/shared/src/main/scala/matryoshka/data/Fix.scala - Mu → Combined schemes: implements instances
core/shared/src/main/scala/matryoshka/data/Mu.scala - Nu → Combined schemes: implements instances
core/shared/src/main/scala/matryoshka/data/Nu.scala - Cofree → EnvT: uses representation
core/shared/src/main/scala/matryoshka/patterns/EnvT.scala - Free → CoEnv: uses representation
core/shared/src/main/scala/matryoshka/data/free.scala - Combined schemes → Merge: uses merge
core/shared/src/main/scala/matryoshka/Birecursive.scala - Diff → Delayed instances: defers instances
core/shared/src/main/scala/matryoshka/patterns/Diff.scala - CoEnv → Delayed instances: defers instances
core/shared/src/main/scala/matryoshka/patterns/CoEnv.scala - EnvT → Delayed instances: defers instances
core/shared/src/main/scala/matryoshka/patterns/EnvT.scala - ListF → Folds and traversals: uses recursive API
core/shared/src/main/scala/matryoshka/patterns/ListF.scala - EqualT → Delayed instances: uses delayed instances
core/shared/src/main/scala/matryoshka/EqualT.scala - ShowT → Delayed instances: uses delayed instances
core/shared/src/main/scala/matryoshka/ShowT.scala - Library user → Arbitrary instances: optionally generates
- Library user → Cogen instances: optionally generates
- Library user → Shrink instances: optionally generates