package slap

  1. Overview
  2. Docs

Module Slap_io

Slap.Io provides pretty printers for vectors and matrices.

module Context : sig ... end

General pretty printers

type index =
  1. | Head
  2. | Foot
  3. | Ellipsis
  4. | Cell of int
val pp_table : ?pp_open:(Format.formatter -> unit) -> ?pp_close:(Format.formatter -> unit) -> ?pp_head:(Format.formatter -> int -> unit) -> ?pp_foot:(Format.formatter -> int -> unit) -> ?pp_end_row:(Format.formatter -> index -> unit) -> ?pp_end_col:(Format.formatter -> row:index -> col:index -> unit) -> ?pp_left:(Format.formatter -> int -> unit) -> ?pp_right:(Format.formatter -> int -> unit) -> ?pad:char -> ?ellipsis:string -> ?vertical_context:Context.t option -> ?horizontal_context:Context.t option -> (Format.formatter -> 'el -> unit) -> Format.formatter -> int -> int -> (int -> int -> 'el) -> unit

pp_table ?pp_open ?pp_close ?pp_head ?pp_foot ?pp_end_row ?pp_end_col ?pp_left ?pp_right ?pad ?ellipsis ?vertical_context ?horizontal_context pp_el ppf n_rows n_cols get_el

Generic printing of tables.

  • pp_open ppf is called when a table is started. (default = pp_open_box ppf 0)
  • pp_close ppf is called when a table is complete. (default = pp_close_box ppf ())
  • pp_head other_ppf j is used to print a header for column j in a table. The first argument other_ppf is not ppf! (default = no header, 1 <= j <= n_cols)
  • pp_foot other_ppf j is used to print a footer for column j in a table. The first argument other_ppf is not ppf! (default = no footer, 1 <= j <= n_cols)
  • pp_end_row ~row is called at the end of each row. (default = pp_force_newline ppf ())
  • pp_end_col ~col is called at the end of each column (element). (default = pp_print_string ppf " ")
  • pp_left other_ppf i is used to print left labels for row i in a table. The first argument other_ppf is not ppf! (default = no left labels, 1 <= i <= n_rows)
  • pp_right other_ppf i is used to print right labels for row i in a table. The first argument other_ppf is not ppf! (default = no right labels)
  • pad is a padding character for each column. (default = ' ')
  • ellipsis is used as a filler when elements need to be skipped. (default = !default_ellipsis)
  • If vertical_context is Some n, the first n rows and the last n rows of a table are printed. When the number of rows is smaller than 2 * n, all rows are shown. If None, all rows of a table are output. (default = !Context.vertical_default)
  • If horizontal_context is Some n, the first n columns and the last n columns of a table are printed. When the number of columns is smaller than 2 * n, all columns are shown. If None, all columns of a table are output. (default = !Context.horizontal_default)
  • pp_el is a pretty printer to used to output elements.
  • ppf is the formatter to which all output is finally printed.
  • n_rows is the number of all rows of a table.
  • n_cols is the number of all columns of a table.
  • get_el i j returns the (i,j) element of a table. (1 <= i <= n_rows and 1 <= j <= n_cols)
val pp_vec_gen : ?pp_open:(Format.formatter -> unit) -> ?pp_close:(Format.formatter -> unit) -> ?pp_head:(Format.formatter -> int -> unit) -> ?pp_foot:(Format.formatter -> int -> unit) -> ?pp_end_row:(Format.formatter -> index -> unit) -> ?pp_end_col:(Format.formatter -> row:index -> col:index -> unit) -> ?pp_left:(Format.formatter -> int -> unit) -> ?pp_right:(Format.formatter -> int -> unit) -> ?pad:char -> ?ellipsis:string -> ?vertical_context:Context.t option -> ?horizontal_context:Context.t option -> (Format.formatter -> 'num -> unit) -> Format.formatter -> ('n, 'num, 'prec, 'cnt_or_dsc) Slap_vec.t -> unit

A generator of pretty printers for (column) vectors.

val pp_rvec_gen : ?pp_open:(Format.formatter -> unit) -> ?pp_close:(Format.formatter -> unit) -> ?pp_head:(Format.formatter -> int -> unit) -> ?pp_foot:(Format.formatter -> int -> unit) -> ?pp_end_row:(Format.formatter -> index -> unit) -> ?pp_end_col:(Format.formatter -> row:index -> col:index -> unit) -> ?pp_left:(Format.formatter -> int -> unit) -> ?pp_right:(Format.formatter -> int -> unit) -> ?pad:char -> ?ellipsis:string -> ?vertical_context:int option -> ?horizontal_context:int option -> (Format.formatter -> 'num -> unit) -> Format.formatter -> ('n, 'num, 'prec, 'cnt_or_dsc) Slap_vec.t -> unit

A generator of pretty printers for row vectors.

val pp_mat_gen : ?pp_open:(Format.formatter -> unit) -> ?pp_close:(Format.formatter -> unit) -> ?pp_head:(Format.formatter -> int -> unit) -> ?pp_foot:(Format.formatter -> int -> unit) -> ?pp_end_row:(Format.formatter -> index -> unit) -> ?pp_end_col:(Format.formatter -> row:index -> col:index -> unit) -> ?pp_left:(Format.formatter -> int -> unit) -> ?pp_right:(Format.formatter -> int -> unit) -> ?pad:char -> ?ellipsis:string -> ?vertical_context:Context.t option -> ?horizontal_context:Context.t option -> (Format.formatter -> 'num -> unit) -> Format.formatter -> ('m, 'n, 'num, 'prec, 'cnt_or_dsc) Slap_mat.t -> unit

A generator of pretty printers for matrices.

Default pretty printers for elements of vectors or matrices

type 'el pp_el_default = (Format.formatter -> 'el -> unit) ref
val pp_float_el_default : float pp_el_default

fprintf ppf "%G" el

val pp_complex_el_default : Complex.t pp_el_default

fprintf ppf "(%G, %Gi)" x.re x.im

val pp_int32_el_default : int32 pp_el_default

fprintf ppf "%ld" x

Pretty-printing in standard style

type ('n, 'num, 'prec, 'cnt_or_dsc) pp_vec = Format.formatter -> ('n, 'num, 'prec, 'cnt_or_dsc) Slap_vec.t -> unit

A type of standard pretty printers for vectors.

val pp_fvec : ('n, float, 'prec, 'cnt_or_dsc) pp_vec
val pp_cvec : ('n, Complex.t, 'prec, 'cnt_or_dsc) pp_vec
val pp_ivec : ('n, int32, 'prec, Slap_misc.cnt) pp_vec
val pp_rfvec : ('n, float, 'prec, 'cnt_or_dsc) pp_vec
val pp_rcvec : ('n, Complex.t, 'prec, 'cnt_or_dsc) pp_vec
val pp_rivec : ('n, int32, 'prec, 'cnt_or_dsc) pp_vec
type ('m, 'n, 'num, 'prec, 'cnt_or_dsc) pp_mat = Format.formatter -> ('m, 'n, 'num, 'prec, 'cnt_or_dsc) Slap_mat.t -> unit

A type of standard pretty printers for matrices.

val pp_fmat : ('m, 'n, float, 'prec, 'cnt_or_dsc) pp_mat
val pp_cmat : ('m, 'n, Complex.t, 'prec, 'cnt_or_dsc) pp_mat
val pp_imat : ('m, 'n, int32, 'prec, 'cnt_or_dsc) pp_mat

Toplevel pretty-printers

module Toplevel : sig ... end