package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Lazy Tree Structure

containers
- CCArray
  - S
  - Sub
- CCBool
- CCError
  - MONAD
  - Traverse
    
    M
- CCFloat
- CCFormat
- CCFun
  - Monad
    
    X
- CCHash
- CCHashtbl
  - COUNTER
  - DEFAULT
  - Make
    
    X
  - MakeCounter
    
    X
  - MakeDefault
    
    X
  - S
- CCHeap
  - Make
    
    E
  - PARTIAL_ORD
  - S
- CCInt
- CCList
  - Assoc
  - Idx
  - MONAD
  - Ref
  - Set
  - Traverse
    
    M
  - Zipper
- CCMap
  - Make
    
    O
  - S
- CCOpt
- CCOrd
- CCPair
- CCPrint
  - MONAD_IO
  - MakeIO
    
    M
- CCRandom
- CCRef
- CCSet
  - Make
    
    O
  - S
- CCString
  - S
  - Split
  - Sub
- CCVector
containers.bigarray
- CCBigstring
containers.data
- CCBV
- CCCache
- CCDeque
- CCFQueue
- CCFlatHashtbl
  - HASHABLE
  - Make
    
    X
  - S
- CCMixmap
  - Make
    
    X
  - ORD
  - S
- CCMixtbl
- CCMultiMap
  - BIDIR
  - Make
    
    K
    
    V
  - MakeBidir
    
    L
    
    R
  - OrderedType
  - S
- CCMultiSet
  - Make
    
    O
  - S
- CCPersistentHashtbl
  - HashedType
  - Make
    
    H
  - S
- CCRingBuffer
  - Array
    
    Byte
    
    Make
    
    Elt
    
    S
  - Byte
  - Make
    
    Array
    
    X
  - MakeFromArray
    
    A
  - S
    
    Array
- CCTrie
  - Make
    
    W
  - MakeArray
    
    X
  - MakeList
    
    X
  - ORDERED
  - S
  - String
  - WORD
containers.io
- CCIO
  - File
containers.iter
- CCKList
  - MONAD
  - Traverse
    
    M
- CCKTree
  - Dot
  - pset
containers.misc
- Containers_misc
containers.pervasives
- CCPervasives
  - Array
  - Format
  - List
  - Random
  - String
containers.sexp
- CCSexp
  - Traverse
- CCSexpM
  - MONAD
  - MakeDecode
    
    M
- CCSexpStream
  - L
  - Lexer
  - ParseGen
  - Source
    
    Manual
containers.string
- Containers_string
containers.thread
- CCFuture
  - Infix
  - Timer
- CCLock

Legend:
Library
Module
Module type
Parameter
Class
Class type

Lazy Tree Structure

This structure can be used to represent trees and directed graphs (as infinite trees) in a lazy fashion. Like CCKList, it is a structural type.

type 'a sequence = ('a -> unit) -> unit

type 'a gen = unit -> 'a option

type 'a klist = unit -> [ `Nil | `Cons of 'a * 'a klist ]

type 'a printer = Buffer.t -> 'a -> unit

type 'a formatter = Format.formatter -> 'a -> unit

Basics

type +'a t = unit -> [ `Nil | `Node of 'a * 'a t list ]

val empty : 'a t

val is_empty : _ t -> bool

val singleton : 'a -> 'a t

Tree with only one label

val node : 'a -> 'a t list -> 'a t

Build a node from a label and a list of children

val node1 : 'a -> 'a t -> 'a t

Node with one child

val node2 : 'a -> 'a t -> 'a t -> 'a t

Node with two children

val fold : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a

Fold on values in no specified order. May not terminate if the tree is infinite.

val iter : ('a -> unit) -> 'a t -> unit

val size : _ t -> int

Number of elements

val height : _ t -> int

Length of the longest path to empty leaves

val map : ('a -> 'b) -> 'a t -> 'b t

val (>|=) : 'a t -> ('a -> 'b) -> 'b t

val cut_depth : int -> 'a t -> 'a t

Cut the tree at the given depth, so it becomes finite.

Graph Traversals

class type 'a pset = object ... end

Abstract Set structure

val set_of_cmp : ?cmp:('a -> 'a -> int) -> unit -> 'a pset

Build a set structure given a total ordering

val dfs : ?pset:'a pset -> 'a t -> [ `Enter of 'a | `Exit of 'a ] klist

Depth-first traversal of the tree

val bfs : ?pset:'a pset -> 'a t -> 'a klist

Breadth first traversal of the tree

val find : ?pset:'a pset -> ('a -> 'b option) -> 'a t -> 'b option

Look for an element that maps to Some _

Pretty-printing

Example (tree of calls for naive Fibonacci function):

let mk_fib n =
  let rec fib' l r i =
    if i=n then r else fib' r (l+r) (i+1)
  in fib' 1 1 1;;

let rec fib n = match n with
  | 0 | 1 -> CCKTree.singleton (`Cst n)
  | _ -> CCKTree.node2 (`Plus (mk_fib n)) (fib (n-1)) (fib (n-2));;

let pp_node fmt = function
  | `Cst n -> Format.fprintf fmt "%d" n
  | `Plus n -> Format.fprintf fmt "%d" n;;

Format.printf "%a@." (CCKTree.print pp_node) (fib 8);;

val print : 'a formatter -> 'a t formatter

A pretty-printer using S-expressions and boxes to render the tree. Empty nodes are not rendered; sharing is ignored.

since 0.9

Pretty printing in the DOT (graphviz) format

module Dot : sig ... end