Модуль Bigarray.Genarray

module Genarray: sig .. end

type (!'a, !'b, !'c) t

Тип Genarray.t — это тип Bigarray с переменным числом измерений. Поддерживается любое количество измерений от 0 до 16.

Три параметра типа Genarray.t идентифицируют вид элементов массива и его расположение следующим образом:

первый параметр, 'a, — это тип OCaml для доступа к элементам массива (float, int, int32, int64, nativeint);
второй параметр, 'b, — это фактический вид элементов массива (float32_elt, float64_elt, int8_signed_elt, int8_unsigned_elt, и т. д.);
третий параметр, 'c, идентифицирует расположение массива (c_layout или fortran_layout).

Например, (float, float32_elt, fortran_layout) Genarray.t — это тип универсальных Bigarray, содержащих 32-битные числа с плавающей точкой в формате Fortran; чтение и запись в этом массиве используют тип OCaml float.

val create : ('a, 'b) Bigarray.kind ->       'c Bigarray.layout -> int array -> ('a, 'b, 'c) t

Genarray.create kind layout dimensions возвращает новый Bigarray, вид элементов которого определяется параметром kind (один из float32, float64, int8_signed, и т. д.), а расположение — параметром layout (один из c_layout или fortran_layout). Параметр dimensions — это массив целых чисел, указывающих размер Bigarray в каждом измерении. Длина параметра dimensions определяет количество измерений Bigarray.

Например, Genarray.create int32 c_layout [|4;6;8|] возвращает новый Bigarray 32-битных целых чисел в расположении C с тремя измерениями, размерами 4, 6 и 8 соответственно.

Bigarray, возвращаемые Genarray.create не инициализируются: начальные значения элементов массива не определены.

Genarray.create вызывает Invalid_argument, если количество измерений не находится в диапазоне от 0 до 16 включительно или если одно из измерений отрицательно.

val init : ('a, 'b) Bigarray.kind ->       'c Bigarray.layout ->       int array -> (int array -> 'a) -> ('a, 'b, 'c) t

Genarray.init kind layout dimensions f возвращает новый Bigarray b, вид элементов которого определяется параметром kind (один из float32, float64, int8_signed, и т. д.), а расположение — параметром layout (один из c_layout или fortran_layout). Параметр dimensions — это массив целых чисел, указывающих размер Bigarray в каждом измерении. Длина параметра dimensions определяет количество измерений Bigarray.

Каждый элемент Genarray.get b i инициализируется результатом f i. Другими словами, Genarray.init kind layout dimensions f табулирует результаты применения f к индексам нового Bigarray, расположение которого описывается kind, layout и dimensions. Массив индексов i может быть совместно использован и изменён между вызовами f.

Например, Genarray.init int c_layout [|2; 1; 3|] (Array.fold_left (+) 0) возвращает новый Bigarray целых чисел в расположении C с тремя измерениями (2, 1, 3 соответственно), значениями элементов 0, 1, 2, 1, 2, 3.

Genarray.init вызывает Invalid_argument, если количество измерений не находится в диапазоне от 0 до 16 включительно или если одно из измерений отрицательно.

Since 4.12

val num_dims : ('a, 'b, 'c) t -> int

Возвращает количество измерений данного Bigarray.

val dims : ('a, 'b, 'c) t -> int array

Genarray.dims a возвращает все размеры Bigarray a, как массив целых чисел длиной Genarray.num_dims a.

val nth_dim : ('a, 'b, 'c) t -> int -> int

Genarray.nth_dim a n возвращает n-ое измерение Bigarray a. Первое измерение соответствует n = 0; второе — n = 1; последнее — n = Genarray.num_dims a - 1.

Raises Invalid_argument если n меньше 0 или больше или равно Genarray.num_dims a.

val kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kind

Возвращает вид данного Bigarray.

val layout : ('a, 'b, 'c) t -> 'c Bigarray.layout

Возвращает расположение данного Bigarray.

val change_layout : ('a, 'b, 'c) t ->       'd Bigarray.layout -> ('a, 'b, 'd) t

Genarray.change_layout a layout возвращает Bigarray со указанным layout, совместно использующим данные с a (и, следовательно, имеющим те же измерения, что и a). Копирование элементов не происходит: новый массив и исходный массив делят одно и то же хранилище. Измерения инвертированы, таким образом get v [| a; b |] в расположении C становится get v [| b+1; a+1 |] в расположении Fortran.

Since 4.04

val size_in_bytes : ('a, 'b, 'c) t -> int

size_in_bytes a — это количество элементов в a, умноженное на Bigarray.kind_size_in_bytes a.

Since 4.03

val get : ('a, 'b, 'c) t -> int array -> 'a

Чтение элемента универсального Bigarray. Genarray.get a [|i1; ...; iN|] возвращает элемент a с координатами i1 в первом измерении, i2 во втором измерении, ..., iN в N-м измерении.

Если a имеет расположение C, координаты должны быть больше или равны 0 и строго меньше соответствующих размеров a. Если a имеет расположение Fortran, координаты должны быть больше или равны 1 и меньше или равны соответствующим размерам a.

Если N > 3, предоставляется альтернативный синтаксис: вы можете написать a.{i1, i2, ..., iN} вместо Genarray.get a [|i1; ...; iN|]. (Синтаксис a.{...} с одной, двумя или тремя координатами предназначен для доступа к одномерным, двумерным и трехмерным массивам, как описано ниже.)

Raises Invalid_argument если массив a не имеет ровно N измерений, или если координаты выходят за пределы массива.

val set : ('a, 'b, 'c) t -> int array -> 'a -> unit

Присваивание элемента универсальному Bigarray. Genarray.set a [|i1; ...; iN|] v сохраняет значение v в элементе a с координатами i1 в первом измерении, i2 во втором измерении, ..., iN в N-м измерении.

Массив a должен иметь ровно N измерений, и все координаты должны лежать внутри границ массива, как описано для Genarray.get; в противном случае, возникает Invalid_argument.

Если N > 3, предоставляется альтернативный синтаксис: вы можете написать a.{i1, i2, ..., iN} <- v вместо Genarray.set a [|i1; ...; iN|] v. (Синтаксис a.{...} <- v с одной, двумя или тремя координатами предназначен для обновления одномерных, двумерных и трехмерных массивов, как описано ниже.)

val sub_left : ('a, 'b, Bigarray.c_layout) t ->       int -> int -> ('a, 'b, Bigarray.c_layout) t

Извлечение подмассива данного Bigarray, ограничивая первое (левое) измерение. Genarray.sub_left a ofs len возвращает Bigarray с тем же количеством измерений, что и a, и теми же размерами, что и a, за исключением первого измерения, которое соответствует интервалу [ofs ... ofs + len - 1] первого измерения a. Копирование элементов не происходит: подмассив и исходный массив делят одно и то же хранилище. Другими словами, элемент с координатами [|i1; ...; iN|] в подмассиве идентичен элементу с координатами [|i1+ofs; ...; iN|] в исходном массиве a.

Genarray.sub_left применяется только к Bigarray в расположении C.

Raises Invalid_argument если ofs и len не обозначают действительный подмассив a, то есть если ofs < 0, или len < 0, или ofs + len > Genarray.nth_dim a 0.

val sub_right : ('a, 'b, Bigarray.fortran_layout) t ->       int -> int -> ('a, 'b, Bigarray.fortran_layout) t

Извлечение подмассива данного Bigarray, ограничивая последнее (правое) измерение. Genarray.sub_right a ofs len возвращает Bigarray с тем же количеством измерений, что и a, и теми же размерами, что и a, за исключением последнего измерения, которое соответствует интервалу [ofs ... ofs + len - 1] последнего измерения a. Копирование элементов не происходит: подмассив и исходный массив делят одно и то же хранилище. Другими словами, элемент с координатами [|i1; ...; iN|] в подмассиве идентичен элементу с координатами [|i1; ...; iN+ofs|] в исходном массиве a.

Genarray.sub_right применяется только к Bigarray в расположении Fortran.

Raises Invalid_argument если ofs и len не обозначают действительный подмассив a, то есть если ofs < 1, или len < 0, или ofs + len > Genarray.nth_dim a (Genarray.num_dims a - 1).

val slice_left : ('a, 'b, Bigarray.c_layout) t ->       int array -> ('a, 'b, Bigarray.c_layout) t

Извлечение подмассива меньшей размерности из данного Bigarray, фиксируя одну или несколько первых (левых) координат. Genarray.slice_left a [|i1; ... ; iM|] возвращает «срез» a, полученный путём установки первых M координат в i1, ..., iM. Если a имеет N измерений, срез имеет размерность N - M, и элемент с координатами [|j1; ...; j(N-M)|] в срезе идентичен элементу с координатами [|i1; ...; iM; j1; ...; j(N-M)|] в исходном массиве a. Копирование элементов не происходит: срез и исходный массив делят одно и то же хранилище.

Genarray.slice_left применяется только к Bigarray в расположении C.

Raises Invalid_argument если M >= N, или если [|i1; ... ; iM|] выходит за пределы a.

val slice_right : ('a, 'b, Bigarray.fortran_layout) t ->       int array -> ('a, 'b, Bigarray.fortran_layout) t

Извлечь подмассив меньшей размерности из данного Bigarray, зафиксировав одну или несколько последних (правых) координат. Genarray.slice_right a [|i1; ... ; iM|] возвращает 'срез' a, полученный путем установки последних M координат в i1, ..., iM. Если a имеет N размерностей, то срез имеет размерность N - M, и элемент с координатами [|j1; ...; j(N-M)|] в срезе идентичен элементу с координатами [|j1; ...; j(N-M); i1; ...; iM|] в исходном массиве a. Копирование элементов не происходит: срез и исходный массив используют одно и то же хранилище.

Genarray.slice_right применяется только к Bigarray с фортран-расположением.

Возможные исключения Invalid_argument если M >= N, или если [|i1; ... ; iM|] выходит за пределы a.

val blit : ('a, 'b, 'c) t -> ('a, 'b, 'c) t -> unit

Скопировать все элементы Bigarray в другой Bigarray. Genarray.blit src dst копирует все элементы src в dst. Оба массива src и dst должны иметь одинаковое количество измерений и равные размеры. Копирование подмассива src в подмассив dst можно выполнить, применяя Genarray.blit к подмассиву или срезам src и dst.

val fill : ('a, 'b, 'c) t -> 'a -> unit

Установить все элементы Bigarray в заданное значение. Genarray.fill a v сохраняет значение v во всех элементах Bigarray a. Установка только некоторых элементов a в v может быть достигнута путем применения Genarray.fill к подмассиву или срезу a.