Module Slap_C.Mat

module Mat: sig .. end

module type CNTMAT = sig .. end

The signature of modules containing dynamically-sized contiguous matrices.

module type DSCMAT = sig .. end

The signature of modules containing dynamically-sized discrete matrices.

val cnt : ('m, 'n, Slap_misc.cnt) Slap_C.mat -> ('m, 'n, 'cnt) Slap_C.mat

Recover polymorphism of the fifth type parameter.

Creation of matrices

val empty : (Slap_size.z, Slap_size.z, 'cnt) Slap_C.mat

An empty matrix.

val create : 'm Slap_size.t -> 'n Slap_size.t -> ('m, 'n, 'cnt) Slap_C.mat

create m n
Returns a fresh m-by-n matrix (not initialized).

val make : 'm Slap_size.t ->
       'n Slap_size.t -> Slap_C.num_type -> ('m, 'n, 'cnt) Slap_C.mat

make m n x
Returns a fresh m-by-n matrix initialized with x.

val make0 : 'm Slap_size.t -> 'n Slap_size.t -> ('m, 'n, 'cnt) Slap_C.mat

make0 m n
Returns a fresh m-by-n matrix initialized with 0.

val make1 : 'm Slap_size.t -> 'n Slap_size.t -> ('m, 'n, 'cnt) Slap_C.mat

make1 m n
Returns a fresh m-by-n matrix initialized with 1.

val identity : 'n Slap_size.t -> ('n, 'n, 'cnt) Slap_C.mat

identity n
Returns a fresh n-by-n identity matrix.

val init : 'm Slap_size.t ->
       'n Slap_size.t ->
       (int -> int -> Slap_C.num_type) -> ('m, 'n, 'cnt) Slap_C.mat

An alias of init_cols.

val init_cols : 'm Slap_size.t ->
       'n Slap_size.t ->
       (int -> int -> Slap_C.num_type) -> ('m, 'n, 'cnt) Slap_C.mat

init_cols m n f returns a fresh m-by-n matrix whose the (i,j) element is initialized by the result of calling f i j. The elements are passed column-wise.

val init_rows : 'm Slap_size.t ->
       'n Slap_size.t ->
       (int -> int -> Slap_C.num_type) -> ('m, 'n, 'cnt) Slap_C.mat

init_rows m n f returns a fresh m-by-n matrix whose the (i,j) element is initialized by the result of calling f i j. The elements are passed row-wise.

Accessors

val dim : ('m, 'n, 'cd) Slap_C.mat -> 'm Slap_size.t * 'n Slap_size.t

dim a is (dim1 a, dim2 a).

val dim1 : ('m, 'n, 'cd) Slap_C.mat -> 'm Slap_size.t

dim1 a
Returns the number of rows in a.

val dim2 : ('m, 'n, 'cd) Slap_C.mat -> 'n Slap_size.t

dim1 a
Returns the number of columns in a.

val get_dyn : ('m, 'n, 'cd) Slap_C.mat -> int -> int -> Slap_C.num_type

get_dyn a i j
Returns the (i,j) element of the matrix a.

val set_dyn : ('m, 'n, 'cd) Slap_C.mat -> int -> int -> Slap_C.num_type -> unit

set_dyn a i j x assigns x to the (i,j) element of the matrix a.

val unsafe_get : ('m, 'n, 'cd) Slap_C.mat -> int -> int -> Slap_C.num_type

Like get_dyn, but size checking is not always performed.

val unsafe_set : ('m, 'n, 'cd) Slap_C.mat -> int -> int -> Slap_C.num_type -> unit

Like set_dyn, but size checking is not always performed.

val col_dyn : ('m, 'n, 'cd) Slap_C.mat -> int -> ('m, 'cnt) Slap_C.vec

col_dyn a i
Returns the i-th column of the matrix a. The data are shared.

val row_dyn : ('m, 'n, 'cd) Slap_C.mat -> int -> ('n, Slap_misc.dsc) Slap_C.vec

row_dyn a i
Returns the i-th row of the matrix a. The data are shared.

val copy_row_dyn : ('m, 'n, 'cd) Slap_C.mat -> int -> ('n, 'cnt) Slap_C.vec

copy_row_dyn a i is Vec.copy (Mat.row_dyn a i).

val diag : ('n, 'n, 'cd) Slap_C.mat -> ('n, Slap_misc.dsc) Slap_C.vec

diag a
Returns the diagonal elements of the matrix a. The data are shared.

val diag_rect : ('m, 'n, 'cd) Slap_C.mat ->
       (('m, 'n) Slap_size.min, Slap_misc.dsc) Slap_C.vec

diag_rect a
Since 1.0.0
Returns the diagonal elements of the rectangular matrix a. The data are shared.

val copy_diag : ('n, 'n, 'cd) Slap_C.mat -> ('n, 'cnt) Slap_C.vec

copy_diag a is Vec.copy (Mat.diag a).

val copy_diag_rect : ('m, 'n, 'cd) Slap_C.mat -> (('m, 'n) Slap_size.min, 'cnt) Slap_C.vec

copy_diag_rect a is Vec.copy (Mat.diag_rect a).
Since 1.0.0

val as_vec : ('m, 'n, Slap_misc.cnt) Slap_C.mat ->
       (('m, 'n) Slap_size.mul, 'cnt) Slap_C.vec

as_vec a
Returns the vector containing all elements of the matrix in column-major order. The data are shared.

Basic operations

val fill : ('m, 'n, 'cd) Slap_C.mat -> Slap_C.num_type -> unit

Fill the given matrix with the given value.
Since 0.1.0

val copy : ?uplo:[ `L | `U ] ->
       ?b:('m, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat -> ('m, 'n, 'b_cd) Slap_C.mat

copy ?uplo ?b a copies the matrix a into the matrix b with the LAPACK function lacpy.

If uplo is omitted, all elements in a is copied.
If uplo is `U, the upper trapezoidal part of a is copied.
If uplo is `L, the lower trapezoidal part of a is copied.

Returns b, which is overwritten.

uplo : default = all elements in a is copied.

b : default = a fresh matrix.

val of_col_vecs_dyn : 'm Slap_size.t ->
       'n Slap_size.t ->
       ('m, Slap_misc.cnt) Slap_C.vec array -> ('m, 'n, 'cnt) Slap_C.mat

Type conversion

val to_array : ('m, 'n, 'cd) Slap_C.mat -> Slap_C.num_type array array

to_array a
Returns the array of arrays of all the elements of a.

val of_array_dyn : 'm Slap_size.t ->
       'n Slap_size.t -> Slap_C.num_type array array -> ('m, 'n, 'cnt) Slap_C.mat

Build a matrix initialized from the given array of arrays.
Raises Invalid_argument the given array of arrays is not rectangular or its size is not m-by-n.

val of_array : Slap_C.num_type array array -> (module Slap_C.Mat.CNTMAT)

module M = (val of_array aa : CNTMAT)
Raises Invalid_argument the given array of arrays is not rectangular.
Returns module M containing the matrix M.value that has the type (M.m, M.n, 'cnt) mat with a generative phantom types M.m and M.n as a package of an existential quantified sized type like exists m, n. (m, n, 'cnt) mat.

module Of_array: functor (X : sig
val value : Slap_C.num_type array array
end) -> CNTMAT

A functor vesion of of_array.

val unsafe_of_array : 'm Slap_size.t ->
       'n Slap_size.t -> Slap_C.num_type array array -> ('m, 'n, 'cnt) Slap_C.mat

Like of_array_dyn, but size checking is not always performed.
Since 1.0.0

val to_list : ('m, 'n, 'cd) Slap_C.mat -> Slap_C.num_type list list

to_list a
Returns the list of lists of all the elements of a.

val of_list_dyn : 'm Slap_size.t ->
       'n Slap_size.t -> Slap_C.num_type list list -> ('m, 'n, 'cnt) Slap_C.mat

Build a matrix initialized from the given list of lists.
Raises Invalid_argument the given list of lists is not rectangular or its size is not m-by-n.

val of_list : Slap_C.num_type list list -> (module Slap_C.Mat.CNTMAT)

module M = (val of_list ll : CNTMAT)
Raises Invalid_argument the given list of lists is not rectangular.
Returns module M containing the matrix M.value that has the type (M.m, M.n, 'cnt) mat with a generative phantom types M.m and M.n as a package of an existential quantified sized type like exists m, n. (m, n, 'cnt) mat.

module Of_list: functor (X : sig
val value : Slap_C.num_type list list
end) -> CNTMAT

A functor vesion of of_list.

val unsafe_of_list : 'm Slap_size.t ->
       'n Slap_size.t -> Slap_C.num_type list list -> ('m, 'n, 'cnt) Slap_C.mat

Like of_list_dyn, but size checking is not always performed.
Since 1.0.0

val to_bigarray : ('m, 'n, 'cd) Slap_C.mat ->
       (Slap_C.num_type, Slap_C.prec, Bigarray.fortran_layout) Bigarray.Array2.t

to_bigarray a
Since 1.0.0
Returns the big array of all the elements of the matrix a.

val of_bigarray_dyn : ?share:bool ->
       'm Slap_size.t ->
       'n Slap_size.t ->
       (Slap_C.num_type, Slap_C.prec, Bigarray.fortran_layout) Bigarray.Array2.t ->
       ('m, 'n, 'cnt) Slap_C.mat

of_bigarray_dyn ?share m n ba
Since 1.0.0
Raises Invalid_argument the size of the given big array is not equal to m-by-n.
Returns a fresh matrix of all the elements of big array ba.

share : true if data are shared. (default = false)

val of_bigarray : (Slap_C.num_type, Slap_C.prec, Bigarray.fortran_layout) Bigarray.Array2.t ->
       (module Slap_C.Mat.CNTMAT)

module M = (val of_bigarray ba : CNTMAT)
Since 1.0.0
Raises Invalid_argument the given big array is not rectangular.
Returns module M containing the matrix M.value that has the type (M.m, M.n, 'cnt) mat with a generative phantom types M.m and M.n as a package of an existential quantified sized type like exists m, n. (m, n, 'cnt) mat.

module Of_bigarray: functor (X : sig
val value : (Slap_C.num_type, Slap_C.prec, Bigarray.fortran_layout) Bigarray.Array2.t
end) -> CNTMAT

A functor vesion of of_bigarray.

val unsafe_of_bigarray : ?share:bool ->
       'm Slap_size.t ->
       'n Slap_size.t ->
       (Slap_C.num_type, Slap_C.prec, Bigarray.fortran_layout) Bigarray.Array2.t ->
       ('m, 'n, 'cnt) Slap_C.mat

Like of_bigarray_dyn, but size checking is not always performed.
Since 1.0.0

val of_array_c : Slap_C.num_type array array ->
       (Slap_C.num_type, Slap_C.prec, 'cnt) Slap_mat.dyn

let Slap.Mat.MAT n = of_array_c arr
Since 4.0.0
Returns a constructor MAT that has a matrix (initialized from the given array of arrays) that has the existential quantified sized type exists m, n. (n, 'num, 'prec, 'cnt_or_dsc) Mat.t. "c" of of_array_c means a "c"onstructor of GADT. This function is available in OCaml 4.00 or above.

val of_list_c : Slap_C.num_type list list ->
       (Slap_C.num_type, Slap_C.prec, 'cnt) Slap_mat.dyn

let Slap.Mat.MAT n = of_list_c kind lst
Since 4.0.0
Returns a constructor MAT that has a matrix (initialized from the given list of lists) that has the existential quantified sized type exists m, n. (n, 'num, 'prec, 'cnt_or_dsc) Mat.t. "c" of of_list_c means a "c"onstructor of GADT. This function is available in OCaml 4.00 or above.

val of_bigarray_c : ?share:bool ->
       (Slap_C.num_type, Slap_C.prec, Bigarray.fortran_layout) Bigarray.Array2.t ->
       (Slap_C.num_type, Slap_C.prec, 'cnt) Slap_mat.dyn

let Slap.Mat.MAT n = of_bigarray_c ?share ba
Since 4.0.0
Returns a constructor MAT that has a matrix (initialized from the given big array) that has the existential quantified sized type exists m, n. (n, 'num, 'prec, 'cnt_or_dsc) Mat.t. "c" of of_bigarray_c means a "c"onstructor of GADT. This function is available in OCaml 4.00 or above.

share : true if data are shared. (default = false)

Iterators

val map : (Slap_C.num_type -> Slap_C.num_type) ->
       ?b:('m, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat -> ('m, 'n, 'b_cd) Slap_C.mat

val mapi : (int -> int -> Slap_C.num_type -> Slap_C.num_type) ->
       ?b:('m, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat -> ('m, 'n, 'b_cd) Slap_C.mat

val fold_left : ('accum -> ('m, 'x_cd) Slap_C.vec -> 'accum) ->
       'accum -> ('m, 'n, 'a_cd) Slap_C.mat -> 'accum

fold_left f init a folds column vectors of matrix a by f in the order left to right.

val fold_lefti : (int -> 'accum -> ('m, 'x_cd) Slap_C.vec -> 'accum) ->
       'accum -> ('m, 'n, 'a_cd) Slap_C.mat -> 'accum

fold_lefti f init a folds column vectors of matrix a by f in the order left to right.

val fold_right : (('m, 'x_cd) Slap_C.vec -> 'accum -> 'accum) ->
       ('m, 'n, 'a_cd) Slap_C.mat -> 'accum -> 'accum

fold_right f a init folds column vectors of matrix a by f in the order right to left.

val fold_righti : (int -> ('m, 'x_cd) Slap_C.vec -> 'accum -> 'accum) ->
       ('m, 'n, 'a_cd) Slap_C.mat -> 'accum -> 'accum

fold_righti f a init folds column vectors of matrix a by f in the order right to left.

val fold_top : ('accum -> ('n, Slap_misc.dsc) Slap_C.vec -> 'accum) ->
       'accum -> ('m, 'n, 'a_cd) Slap_C.mat -> 'accum

fold_top f init a folds row vectors of matrix a by f in the order top to bottom.

val fold_topi : (int -> 'accum -> ('n, Slap_misc.dsc) Slap_C.vec -> 'accum) ->
       'accum -> ('m, 'n, 'a_cd) Slap_C.mat -> 'accum

fold_topi f init a folds row vectors of matrix a by f in the order top to bottom.

val fold_bottom : (('n, Slap_misc.dsc) Slap_C.vec -> 'accum -> 'accum) ->
       ('m, 'n, 'a_cd) Slap_C.mat -> 'accum -> 'accum

fold_bottom f a init folds row vectors of matrix a by f in the order bottom to top.

val fold_bottomi : (int -> ('n, Slap_misc.dsc) Slap_C.vec -> 'accum -> 'accum) ->
       ('m, 'n, 'a_cd) Slap_C.mat -> 'accum -> 'accum

fold_bottomi f a init folds row vectors of matrix a by f in the order bottom to top.

val replace_all : ('m, 'n, 'cd) Slap_C.mat -> (Slap_C.num_type -> Slap_C.num_type) -> unit

replace_all a f modifies the matrix a in place -- the (i,j)-element aij of a will be set to f aij.

val replace_alli : ('m, 'n, 'cd) Slap_C.mat ->
       (int -> int -> Slap_C.num_type -> Slap_C.num_type) -> unit

replace_all a f modifies the matrix a in place -- the (i,j)-element aij of a will be set to f i j aij.

Matrix transformations

val transpose_copy : ?b:('n, 'm, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat -> ('n, 'm, 'b_cd) Slap_C.mat

transpose_copy ?b a copies the transpose of a into b.
Since 0.1.0
Returns the matrix b, which is overwritten.

val detri : ?up:bool -> ('n, 'n, 'cd) Slap_C.mat -> unit

detri ?up a converts triangular matrix a to a symmetric matrix, i.e., copies the upper or lower triangular part of a into another part.
Since 0.1.0

up : default = true

val packed : ?up:bool ->
       ?x:('n Slap_size.packed, Slap_misc.cnt) Slap_C.vec ->
       ('n, 'n, 'cd) Slap_C.mat -> ('n Slap_size.packed, 'cnt) Slap_C.vec

packed ?up ?x a transforms matrix a into packed storage format.
Since 0.2.0
Returns vector x, which is overwritten.

up : default = true

If up = true, then the upper triangular part of a is packed;
If up = false, then the lower triangular part of a is packed.

val unpacked : ?up:bool ->
       ?fill_num:Slap_C.num_type option ->
       ?a:('n, 'n, 'cd) Slap_C.mat ->
       ('n Slap_size.packed, Slap_misc.cnt) Slap_C.vec -> ('n, 'n, 'cd) Slap_C.mat

unpacked ?up ?fill_num ?a x generates an upper or lower triangular matrix from packed-storage-format vector x.
Since 0.2.0
Returns matrix a, which is overwritten.

up : default = true

If up = true, then the upper triangular matrix is generated;
If up = false, then the lower triangular matrix is generated.

fill_num : default = Some 0

If fill_num is None, the elements in the generated matrix are not initialized;
If fill_num is Some c, the elements in the generated matrix are initialized by c.

val geband_dyn : 'kl Slap_size.t ->
       'ku Slap_size.t ->
       ?b:(('m, 'n, 'kl, 'ku) Slap_size.geband, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat ->
       (('m, 'n, 'kl, 'ku) Slap_size.geband, 'n, 'b_cd) Slap_C.mat

geband_dyn kl ku ?b a converts matrix a into a matrix stored in band storage.
Since 0.2.0
Raises Invalid_arg if kl >= dim1 a or ku >= dim2 a.
Returns matrix b, which is overwritten.

val ungeband : 'm Slap_size.t ->
       'kl Slap_size.t ->
       'ku Slap_size.t ->
       ?fill_num:Slap_C.num_type option ->
       ?a:('m, 'n, 'a_cd) Slap_C.mat ->
       (('m, 'n, 'kl, 'ku) Slap_size.geband, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat

ungeband m kl ku ?a b converts matrix b stored in band storage into a matrix stored in the normal order.
Since 0.2.0
Returns matrix a, which is overwritten.

fill_num : default = Some 0

If fill_num = None, the elements in the generated matrix are not initialized;
If fill_num = Some c, the elements in the generated matrix are initialized by c.

val syband_dyn : 'kd Slap_size.t ->
       ?up:bool ->
       ?b:(('n, 'kd) Slap_size.syband, 'n, 'b_cd) Slap_C.mat ->
       ('n, 'n, 'a_cd) Slap_C.mat ->
       (('n, 'kd) Slap_size.syband, 'n, 'b_cd) Slap_C.mat

syband_dyn kd ?b a converts matrix a into a matrix stored in symmetric or Hermitian band storage.
Since 0.2.0
Raises Invalid_arg if kd >= dim1 a.
Returns matrix b, which is overwritten.

up : default = true

If up = true, then the upper triangular part of a is used;
If up = false, then the lower triangular part of a is used.

val unsyband : 'kd Slap_size.t ->
       ?up:bool ->
       ?fill_num:Slap_C.num_type option ->
       ?a:('n, 'n, 'a_cd) Slap_C.mat ->
       (('n, 'kd) Slap_size.syband, 'n, 'b_cd) Slap_C.mat ->
       ('n, 'n, 'a_cd) Slap_C.mat

unsyband kd ?a b converts matrix b stored in symmetric or Hermitian band storage into a matrix stored in the normal order.
Since 0.2.0
Returns matrix a, which is overwritten.

up : default = true

If up = true, then b is treated as the upper triangular part of symmetric or Hermitian matrix a;
If up = false, then b is treated as the lower triangular part of symmetric or Hermitian matrix a;

fill_num : default = Some 0

If fill_num = None, the elements in the generated matrix are not initialized;
If fill_num = Some c, the elements in the generated matrix are initialized by c.

val luband_dyn : 'kl Slap_size.t ->
       'ku Slap_size.t ->
       ?ab:(('m, 'n, 'kl, 'ku) Slap_size.luband, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat ->
       (('m, 'n, 'kl, 'ku) Slap_size.luband, 'n, 'b_cd) Slap_C.mat

luband_dyn kl ku ?ab a converts matrix a into a matrix stored in band storage for LU factorization.
Since 0.2.0
Raises Invalid_arg if kl >= dim1 a or ku >= dim2 a.
Returns matrix ab, which is overwritten.

val unluband : 'm Slap_size.t ->
       'kl Slap_size.t ->
       'ku Slap_size.t ->
       ?fill_num:Slap_C.num_type option ->
       ?a:('m, 'n, 'a_cd) Slap_C.mat ->
       (('m, 'n, 'kl, 'ku) Slap_size.luband, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat

unluband m kl ku ?a ab converts matrix ab stored in band storage for LU factorization into a matrix stored in the normal order.
Since 0.2.0
Returns matrix a, which is overwritten.

fill_num : default = Some 0

If fill_num = None, the elements in the generated matrix are not initialized;
If fill_num = Some c, the elements in the generated matrix are initialized by c.

Arithmetic operations

val add_const : Slap_C.num_type ->
       ?b:('m, 'n, 'b_cd) Slap_C.mat ->
       ('m, 'n, 'a_cd) Slap_C.mat -> ('m, 'n, 'b_cd) Slap_C.mat

add_const c ?b a adds constant value c to all elements in a.
Since 0.1.0
Returns the matrix b, which is overwritten.

val sum : ('m, 'n, 'cd) Slap_C.mat -> Slap_C.num_type

sum a returns the sum of all elements in a.
Since 0.1.0

val trace : ('m, 'n, 'cd) Slap_C.mat -> Slap_C.num_type

trace a
Returns the sum of diagonal elements of the matrix a.

val scal : Slap_C.num_type -> ('m, 'n, 'cd) Slap_C.mat -> unit

scal alpha a computes a := alpha * a with the scalar value alpha and the matrix a.

val scal_cols : ('m, 'n, 'cd) Slap_C.mat -> ('n, Slap_misc.cnt) Slap_C.vec -> unit

A column-wise scal function for matrices.

val scal_rows : ('m, Slap_misc.cnt) Slap_C.vec -> ('m, 'n, 'cd) Slap_C.mat -> unit

A row-wise scal function for matrices.

val axpy : ?alpha:Slap_C.num_type ->
       ('m, 'n, 'x_cd) Slap_C.mat -> ('m, 'n, 'y_cd) Slap_C.mat -> unit

axpy ?alpha x y computes y := alpha * x + y.

val gemm_diag : ?beta:Slap_C.num_type ->
       ?y:('n, Slap_misc.cnt) Slap_C.vec ->
       transa:('a_n * 'a_k, 'n * 'k, [< `C | `N | `T ]) Slap_C.trans3 ->
       ?alpha:Slap_C.num_type ->
       ('a_n, 'a_k, 'a_cd) Slap_C.mat ->
       transb:('b_k * 'b_n, 'k * 'n, [< `C | `N | `T ]) Slap_C.trans3 ->
       ('b_k, 'b_n, 'b_cd) Slap_C.mat -> ('n, 'cnt) Slap_C.vec

gemm_diag ?beta ?y ~transa ?alpha a ~transb b executes y := DIAG(alpha * OP(a) * OP(b)) + beta * y where DIAG(x) is the vector of the diagonal elements in matrix x, and OP(x) is one of OP(x) = x, OP(x) = x^T, or OP(x) = x^H (the conjugate transpose of x).
Since 0.1.0
Returns the vector y, which is overwritten.

beta : default = 0.0

transa : the transpose flag for a:

if Slap_common.normal, then OP(a) = a;
if Slap_common.trans, then OP(a) = a^T;
if Slap_common.conjtr, then OP(a) = a^H.

alpha : default = 1.0

transb : the transpose flag for b:

if Slap_common.normal, then OP(b) = b;
if Slap_common.trans, then OP(b) = b^T;
if Slap_common.conjtr, then OP(b) = b^H.

val syrk_diag : ?beta:Slap_C.num_type ->
       ?y:('n, Slap_misc.cnt) Slap_C.vec ->
       trans:('a_n * 'a_k, 'n * 'k, [< `N | `T ]) Slap_common.trans2 ->
       ?alpha:Slap_C.num_type ->
       ('a_n, 'a_k, 'a_cd) Slap_C.mat -> ('n, 'cnt) Slap_C.vec

syrk_diag ?beta ?y ~transa ?alpha a executes

y := alpha * DIAG(a * a^T) + beta * y (if trans = Slap_common.normal) or
y := alpha * DIAG(a^T * a) + beta * y (if trans = Slap_common.trans)

where DIAG(x) is the vector of the diagonal elements in matrix x.
Returns the vector y, which is overwritten.

beta : default = 0.0

alpha : default = 1.0

val gemm_trace : transa:('a_n * 'a_k, 'n * 'k, [< `C | `N | `T ]) Slap_C.trans3 ->
       ('a_n, 'a_k, 'a_cd) Slap_C.mat ->
       transb:('b_k * 'b_n, 'k * 'n, [< `C | `N | `T ]) Slap_C.trans3 ->
       ('b_k, 'b_n, 'b_cd) Slap_C.mat -> Slap_C.num_type

gemm_trace ~transa a ~transb b
Returns the trace of OP(a) * OP(b).

transa : the transpose flag for a:

if Slap_common.normal, then OP(a) = a;
if Slap_common.trans, then OP(a) = a^T;
if Slap_common.conjtr, then OP(a) = a^H.

transb : the transpose flag for b:

if Slap_common.normal, then OP(b) = b;
if Slap_common.trans, then OP(b) = b^T;
if Slap_common.conjtr, then OP(b) = b^H.

val syrk_trace : ('n, 'k, 'cd) Slap_C.mat -> Slap_C.num_type

syrk_trace a computes the trace of a * a^T or a^T * a.
Since 0.1.0

val symm2_trace : ?upa:bool ->
       ('n, 'n, 'a_cd) Slap_C.mat ->
       ?upb:bool -> ('n, 'n, 'b_cd) Slap_C.mat -> Slap_C.num_type

symm2_trace ?upa a ?upb b computes the trace of a * b with symmetric matrices a and b.

upa : default = true

If upa = true, then the upper triangular part of a is used;
If upa = false, then the lower triangular part of a is used.

upb : default = true

If upb = true, then the upper triangular part of b is used;
If upb = false, then the lower triangular part of b is used.

Submatrices

val submat_dyn : 'm Slap_size.t ->
       'n Slap_size.t ->
       ?ar:int ->
       ?ac:int -> ('a, 'b, 'cd) Slap_C.mat -> ('m, 'n, Slap_misc.dsc) Slap_C.mat

submat_dyn m n ?ar ?ac a
Returns a m-by-n submatrix of the matrix a. The (i,j) element of the returned matrix refers the (ar+i-1,ac+j-1) element of a. The data are shared.

ar : default = 1

ac : default = 1

Creation of vectors

val random : ?rnd_state:Random.State.t ->
       ?re_from:float ->
       ?re_range:float ->
       ?im_from:float ->
       ?im_range:float ->
       'm Slap_size.t -> 'n Slap_size.t -> ('m, 'n, 'cnt) Slap_C.mat

random ?rnd_state ?from ?range m n creates a m-by-n matrix randomly initialized with the uniform distribution between re_from/im_from and re_from+re_range/im_from+im_range for real and imaginary parts, respectively.
Since 0.2.0

rnd_state : default = Random.get_state ().

re_from : default = -1.0.

re_range : default = 2.0.

im_from : default = -1.0.

im_range : default = 2.0.