File: fring.mli

package info (click to toggle)
xen-api-libs 0.5.2-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 1,940 kB
  • sloc: ml: 13,925; sh: 2,930; ansic: 1,699; makefile: 1,240; python: 83
file content (51 lines) | stat: -rw-r--r-- 1,534 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
(*
 * Copyright (C) 2006-2009 Citrix Systems Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; version 2.1 only. with the special
 * exception on linking described in file LICENSE.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *)
(** Ring structures *)
 
type t = {
  size : int;
  mutable current : int;
  data : (float, Bigarray.float32_elt, Bigarray.c_layout) Bigarray.Array1.t;
}

(** create a ring structure with [size] record; records initialised to [init] *)
val make : int -> float -> t

(** create a duplicate ring structure *)
val copy : t -> t

(** length of the ring *)
val length : t -> int

(** push into the ring one element *)
val push : t -> float -> unit

(** get the i{^th} old element from the ring *)
val peek : t -> int -> float

(** get the top element of the ring *)
val top : t -> float

(** iterate over nb element of the ring, starting from the top *)
val iter_nb : t -> (float -> 'a) -> int -> unit

val raw_iter : t -> (float -> 'a) -> unit

(** iterate over all elements of the ring, starting from the top *)
val iter : t -> (float -> 'a) -> unit

(** get array of latest [nb] value *)
val get_nb : t -> int -> float array

val get : t -> float array