package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

v3.7.1.tar.gz
md5=d02c4f044e53edca010de46f9139ce00
sha512=99a5afa3604c4cf0c849c670111d617f7f255acb0da043b73ddffdf0e299948bce52516ee31921f269de6088156c4e0a187e0b931543c6819c6b25966b303281

doc/batteries.unthreaded/BatStack/index.html

Module BatStackSource

Last-in first-out stacks.

This module implements stacks (LIFOs), with in-place modification.

  • author Xavier Leroy (Base module)
  • author David Teller
Sourcetype 'a t = 'a Stack.t

The type of stacks containing elements of type 'a.

Sourceexception Empty

Raised when Stack.pop or Stack.top is applied to an empty stack.

Sourceval create : unit -> 'a t

Return a new stack, initially empty.

Sourceval push : 'a -> 'a t -> unit

push x s adds the element x at the top of stack s.

Sourceval pop : 'a t -> 'a

pop s removes and returns the topmost element in stack s, or

  • raises Empty

    if the stack is empty.

Sourceval top : 'a t -> 'a

top s returns the topmost element in stack s, or

  • raises Empty

    if the stack is empty.

Sourceval clear : 'a t -> unit

Discard all elements from a stack.

Sourceval copy : 'a t -> 'a t

Return a copy of the given stack.

Sourceval is_empty : 'a t -> bool

Return true if the given stack is empty, false otherwise.

Sourceval length : 'a t -> int

Return the number of elements in a stack.

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

iter f s applies f in turn to all elements of s, from the element at the top of the stack to the element at the bottom of the stack. The stack itself is unchanged.

include BatEnum.Enumerable with type 'a enumerable = 'a t
Sourcetype 'a enumerable = 'a t

The data structure, e.g. 'a List.t

Sourceval enum : 'a t -> 'a BatEnum.t

enum s returns an enumeration of the elements of stack s, from the most recently entered to the least recently entered. This enumeration is made on a copy of the input stack, and reading from it will not affect s.

Sourceval enum_destruct : 'a t -> 'a BatEnum.t

enum_destruct s returns a destructive enumeration of the elements of stack s, from the most recently entered to the least recently entered. Reading the enumeration will progressively empty s.

Sourceval of_enum : 'a BatEnum.t -> 'a t

of_enum e returns a new stack containing all the elements of e. This is equivalent to calling push with the first element of the enumeration, then with the second, etc.

Note: if s is a stack, s <> of_enum (enum s), as of_enum reverses the input order.

Boilerplate code
Printing
Sourceval print : ?first:string -> ?last:string -> ?sep:string -> ('a BatInnerIO.output -> 'b -> unit) -> 'a BatInnerIO.output -> 'b t -> unit
Sourceval compare : 'a BatOrd.comp -> 'a t BatOrd.comp
Sourceval equal : 'a BatOrd.eq -> 'a t BatOrd.eq
Sourcemodule Exceptionless : sig ... end