package owl-base

  1. Overview
  2. Docs
An OCaml Numerical Library

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (16)

Authors

  1. L
    Liang Wang

Maintainers

  1. L
    Liang Wang <ryanrhymes@gmail.com>

Sources

owl-base-0.3.8.tbz
sha256=7e7725e9a1a967b2af54d7f091a0aea76c54e9abeb4220947921864ef6ffe7d0
md5=247e4b6e6190df68830095441e71e69a

doc/owl-base/Owl_utils_stack/index.html

Module Owl_utils_stack

Type definition
type 'a t = {
  1. mutable used : int;
  2. mutable size : int;
  3. mutable data : 'a array;
}

Type of a stack.

Basic functions
val make : unit -> 'a t

``make ()`` creates an empty stack.

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

``push stack x`` pushes ``x`` into ``stack``.

val pop : 'a t -> 'a option

``pop stack`` pops the top element in ``stack``. It returns ``None`` if the ``stack`` is empty.

val peek : 'a t -> 'a option

``peek stack`` returns the value of top element in ``stack`` but it does not remove the element from the stack. ``None`` is returned if the stack is empty.

val is_empty : 'a t -> bool

Returns ``true`` if the stack is empty, otherwise ``false``.

val mem : 'a t -> 'a -> bool

``mem stack x`` checks whether ``x`` exist in ``stack``. The complexity is ``O(n)`` where ``n`` is the size of the ``stack``.

val memq : 'a t -> 'a -> bool

Similar to ``mem`` but physical equality is used for comparing values.

val to_array : 'a t -> 'a array

``to_array stack`` converts the elements in ``stack`` into an array.