package gg

  1. Overview
  2. Docs

Module Gg.BaSource

Linear bigarrays and bigarray buffers.

WARNING. This interface is subject to change in the future.

This module has a few convenience functions for linear (1D) bigarrays.

The purpose of buffer is to allow to specify a few more data types than bigarrays are able to express and facilitate the generic handling of linear bigarrays.

Scalar types

The type for bigarray scalar types.

Sourceval ba_kind_of_ba_scalar_type : ('a, 'b) ba_scalar_type -> ('a, 'b) Bigarray.kind

ba_kind_of_ba_scalar_type st is the bigarray kind corresponding to st.

Sourcetype scalar_type = [
  1. | `Int8
  2. | `Int16
  3. | `Int32
  4. | `Int64
  5. | `UInt8
  6. | `UInt16
  7. | `UInt32
  8. | `UInt64
  9. | `Float16
  10. | `Float32
  11. | `Float64
]

The type for buffer scalar types.

Sourceval scalar_type_of_ba_scalar_type : ('a, 'b) ba_scalar_type -> scalar_type

scalar_type_of_ba_scalar_type st is the scalar type corresponding to st.

Sourceval scalar_type_byte_count : scalar_type -> int

scalar_type_byte_count st is the number of bytes used by a scalar of type st.

Sourceval pp_scalar_type : Format.formatter -> scalar_type -> unit

pp_scalar_type ppf st prints a textual representation of st on ppf.

Bigarray buffers

Sourcemodule Buffer : sig ... end

Bigarrays

Sourceval create : ('a, 'b) ba_scalar_type -> int -> ('a, 'b) bigarray

create k count is a bigarray of kind k with count scalars.

Sourceval length : ('a, 'b) bigarray -> int

length ba is the length of ba.

Sourceval sub : ('a, 'b) bigarray -> int -> int -> ('a, 'b) bigarray

sub ba i len are the ith to ith + n scalars of ba as a bigarray. Note, this is not a copy.

Sourceval blit : ('a, 'b) bigarray -> int -> ('a, 'b) bigarray -> int -> int -> unit

blit src si dst di len copies len scalar values starting at si in src to dst starting at di.

Sourceval fill : ('a, 'b) bigarray -> 'a -> unit

fill ba v sets each scalar value of ba to v.

Sourceval of_array : ('a, 'b) ba_scalar_type -> 'a array -> ('a, 'b) bigarray

of_array st a is a bigarray from array a.

Sourceval of_list : ('a, 'b) ba_scalar_type -> 'a list -> ('a, 'b) bigarray

of_list st l is a bigarray from list l.

Sourceval of_bytes : ?be:bool -> ('a, 'b) ba_scalar_type -> string -> ('a, 'b) bigarray

of_bytes be s k is a bigarray of kind k from s. if be is true data is assumed to be in big endian order (defaults to false).

TODO For now only Int8 and UInt8 are supported.

Raises Invalid_argument if given an unsupported kind or if the data length is not a multiple of the requested scalar type.

Sourceval pp : ?count:int -> ?stride:int -> ?first:int -> ?dim:int -> pp_scalar:(Format.formatter -> 'a -> unit) -> Format.formatter -> ('a, 'b) bigarray -> unit

pp count stride first dim pp_scalar ppf b prints on ppf, count groups of size dim of scalars of b, starting at first using pp_scalar, and striding stride scalars to go from group to group. If count is unspecified prints as much as possible. stride defaults to dim, first defaults to 0 and dim to 1.

Getting

Sourceval get_v2 : (float, 'b) bigarray -> int -> v2

get_v2 b i is the ith to i+1th scalars of b as a vector.

Sourceval get_v3 : (float, 'b) bigarray -> int -> v3

get_v3 b i is the ith to i+2th scalars of b as a vector.

Sourceval get_v4 : (float, 'b) bigarray -> int -> v4

get_v4 b i is the ith to i+3th scalars of b as a vector.

Sourceval get_2d : ('a, 'b) bigarray -> int -> 'a * 'a

get_v2 b i is the ith to i+1th scalars of b.

Sourceval get_3d : ('a, 'b) bigarray -> int -> 'a * 'a * 'a

get_v3 b i is the ith to i+2th scalars of b.

Sourceval get_4d : ('a, 'b) bigarray -> int -> 'a * 'a * 'a * 'a

get_v4 b i is the ith to i+3th scalars of b.

int32 Bigarray

Sourceval geti_2d : (int32, 'b) bigarray -> int -> int * int

get_v2 b i is the ith to i+1th scalars of b. The integers are converted with Int32.to_int.

Sourceval geti_3d : (int32, 'b) bigarray -> int -> int * int * int

get_v3 b i is the ith to i+2th scalars of b. The integers are converted with Int32.to_int

Setting

Sourceval set_v2 : (float, 'b) bigarray -> int -> v2 -> unit

set_v2 b i v sets the ith to i+1th scalars of b with v.

Sourceval set_v3 : (float, 'b) bigarray -> int -> v3 -> unit

set_v3 b i v sets the ith to i+2th scalars of b with v.

Sourceval set_v4 : (float, 'b) bigarray -> int -> v4 -> unit

set_v4 b i v sets the ith to i+3th scalars of b with v.

Sourceval set_2d : ('a, 'b) bigarray -> int -> 'a -> 'a -> unit

set_2d b i s1 s2 sets the ith to i+1th scalar of b to s1, s2.

Sourceval set_3d : ('a, 'b) bigarray -> int -> 'a -> 'a -> 'a -> unit

set_3d b i s1 s2 s3 sets the ith to i+2th scalar of b to s1, s2, s3.

Sourceval set_4d : ('a, 'b) bigarray -> int -> 'a -> 'a -> 'a -> 'a -> unit

set_4d b i s1 s2 s3 s4 sets the ith to i+3th scalar of b to s1, s2, s3, s4.

int32 Bigarray

Sourceval seti_2d : (int32, 'b) bigarray -> int -> int -> int -> unit

set_2d b i s1 s2 sets the ith to i+1th scalar of b to s1, s2.

Sourceval seti_3d : (int32, 'b) bigarray -> int -> int -> int -> int -> unit

set_3d b i s1 s2 s3 sets the ith to i+2th scalar of b to s1, s2, s3.