val check_vec_inc : loc:string ->vec_name:string ->int -> unit
check_vec_inc ~loc ~vec_name inc checks whether vector increment inc for vector of name vec_name is invalid (i.e. 0).
raises
Invalid_argument in that case.
val calc_vec_max_n : dim:int ->ofs:int ->inc:int -> int
calc_vec_max_n ~dim ~ofs ~inc
returns
maximum operation length n for a vector given the dimension dim of the vector, the offset ofs, and increment inc. Assumes that the offset has already been validated to not exceed dim, i.e. the returned max_n is at least 1.
val calc_vec_opt_max_n : ?ofs:int ->?inc:int ->int -> int
calc_vec_opt_max_n ?ofs ?inc dim
returns
maximum operation length n for a vector given the dimension dim of the vector, the optional offset ofs, and optional increment inc. Assumes that the offset has already been validated to not exceed dim, i.e. the returned max_n is at least 1.
val raise_max_len :
loc:string ->len_name:string ->len:int ->max_len:int ->'a
that the maximum operation size (e.g. m or n for vectors and matrices) has been exceeded.
val check_vec_dim :
loc:string ->vec_name:string ->dim:int ->ofs:int ->inc:int ->n_name:string ->n:int ->
unit
check_vec_dim ~loc ~vec_name ~dim ~ofs ~inc ~n_name ~n checks the vector operation length in parameter n with name n_name at location loc for vector with name vec_name and dimension dim given the operation offset ofs and increment inc.
val get_vec_n :
loc:string ->vec_name:string ->dim:int ->ofs:int ->inc:int ->n_name:string ->int option->
int
get_vec_n ~loc ~vec_name ~dim ~ofs ~inc ~n_name n checks or infers the vector operation length in the option parameter n with name n_name at location loc for vector with name vec_name and dimension dim given the operation offset ofs and increment inc.
maximum row operation length m for a matrix given the dimension dim1 of the matrix and the start row r.
val calc_mat_opt_max_rows : ?r:int ->int -> int
calc_mat_opt_max_rows ?r dim1
returns
maximum row operation length m for a matrix given the dimension dim1 of the matrix and the optional start row r. Assumes that the offset has already been validated to not exceed dim1, i.e. the returned max_m is at least 1.
val calc_mat_max_cols : dim2:int ->c:int -> int
calc_mat_max_cols ~dim2 ~c
returns
maximum column operation length n for a matrix given the dimension dim1 of the matrix and the start column c.
val calc_mat_opt_max_cols : ?c:int ->int -> int
calc_mat_opt_max_cols ?c dim1
returns
maximum column operation length m for a matrix given the dimension dim2 of the matrix and the optional start column c. Assumes that the offset has already been validated to not exceed dim2, i.e. the returned max_n is at least 1.
val check_mat_rows :
loc:string ->mat_name:string ->dim1:int ->r:int ->p:int ->param_name:string ->
unit
check_mat_rows ~loc ~mat_name ~dim1 ~r ~p ~param_name checks the matrix row operation length in parameter p with name param_name at location loc for matrix with name mat_name and dimension dim1 given the operation row r.
val check_mat_m :
loc:string ->mat_name:string ->dim1:int ->r:int ->m:int ->
unit
check_mat_m ~loc ~mat_name ~dim1 ~r ~m checks the matrix row operation length in parameter m at location loc for matrix with name mat_name and dimension dim1 given the operation row r.
val check_mat_cols :
loc:string ->mat_name:string ->dim2:int ->c:int ->p:int ->param_name:string ->
unit
check_mat_cols ~loc ~mat_name ~dim2 ~c ~p ~param_name checks the matrix column operation length in parameter p with name param_name at location loc for matrix with name mat_name and dimension dim2 given the operation column c.
val check_mat_n :
loc:string ->mat_name:string ->dim2:int ->c:int ->n:int ->
unit
check_mat_n ~loc ~mat_name ~dim2 ~c ~n checks the matrix column operation length in parameter n at location loc for matrix with name mat_name and dimension dim2 given the operation column c.
val check_mat_mn :
loc:string ->mat_name:string ->dim1:int ->dim2:int ->r:int ->c:int ->m:int ->n:int ->
unit
check_mat_mn ~loc ~mat_name ~dim1 ~dim2 ~r ~c ~m ~n checks the matrix operation lengths in parameters m and n at location loc for matrix with name mat_name and dimensions dim1 and dim2 given the operation row r and column c.
val get_mat_rows :
loc:string ->mat_name:string ->dim1:int ->r:int ->p:int option->param_name:string ->
int
get_mat_rows ~loc ~mat_name ~dim1 ~r p ~param_name checks or infers the matrix row operation length in the option parameter p with name param_name at location loc for matrix with name mat_name and dimension dim1 given the row operation offset r.
raises
Invalid_argument if any arguments are invalid.
val get_mat_dim1 :
loc:string ->mat_name:string ->dim1:int ->r:int ->m:int option->m_name:string ->
int
get_mat_dim1 ~loc ~mat_name ~dim1 ~r ~m ~m_name checks or infers the matrix row operation length in the option parameter m with name m_name at location loc for matrix with name mat_name and dimension dim1 given the row operation offset r.
val get_mat_m :
loc:string ->mat_name:string ->dim1:int ->r:int ->m:int option->
int
get_mat_m ~loc ~mat_name ~dim1 ~r ~m checks or infers the matrix row operation length in the option parameter m at location loc for matrix with name mat_name and dimension dim1 given the row operation offset r.
val get_mat_cols :
loc:string ->mat_name:string ->dim2:int ->c:int ->p:int option->param_name:string ->
int
get_mat_cols ~loc ~mat_name ~dim2 ~c ~param_name p checks or infers the matrix column operation length in the option parameter p with name param_name at location loc for matrix with name mat_name and dimension dim2 given the column operation offset c.
raises
Invalid_argument if any arguments are invalid.
val get_mat_dim2 :
loc:string ->mat_name:string ->dim2:int ->c:int ->n:int option->n_name:string ->
int
get_mat_dim2 ~loc ~mat_name ~dim2 ~c ~n ~n_name checks or infers the matrix column operation length in the option parameter n with name n_name at location loc for matrix with name mat_name and dimension dim2 given the column operation offset c.
val get_mat_n :
loc:string ->mat_name:string ->dim2:int ->c:int ->n:int option->
int
get_mat_n ~loc ~mat_name ~dim2 ~c ~n checks or infers the matrix column operation length in the option parameter n at location loc for matrix with name mat_name and dimension dim2 given the column operation offset c.
val get_mat_min_dim1 : loc:string ->mat_name:string ->r:int ->m:int -> int
get_mat_min_dim1 ~loc ~mat_name ~r ~m
returns
the minimum row dimension of a matrix with name mat_name at location loc given row r and row operation length m.
@raise Invalid_argument
if any arguments are invalid.
val get_mat_min_dim2 : loc:string ->mat_name:string ->c:int ->n:int -> int
get_mat_min_dim2 ~loc ~mat_name ~c ~n
returns
the minimum column dimension of a matrix with name mat_name at location loc given column c and row operation length n.
@raise Invalid_argument
if any arguments are invalid.
val check_mat_min_dim1 :
loc:string ->mat_name:string ->dim1:int ->min_dim1:int ->
unit
check_mat_min_dim1 ~loc ~mat_name ~dim1 ~min_dim1 checks the minimum row dimension min_dim1 of a matrix with name mat_name at location loc given its row dimension dim1.
val check_mat_min_dim2 :
loc:string ->mat_name:string ->dim2:int ->min_dim2:int ->
unit
check_mat_min_dim2 ~loc ~mat_name ~dim2 ~min_dim2 checks the minimum column dimension min_dim2 of a matrix with name mat_name at location loc given its column dimension dim2.
val check_mat_min_dims :
loc:string ->mat_name:string ->dim1:int ->dim2:int ->min_dim1:int ->min_dim2:int ->
unit
check_mat_min_dim2 ~loc ~mat_name ~dim2 ~min_dim2 checks the minimum column dimension min_dim2 of a matrix with name mat_name at location loc given its column dimension dim2.
val get_dim_vec :
string ->string ->int ->int ->('a, 'b, 'c)Bigarray.Array1.t->string ->int option->
int
get_dim_vec loc vec_name ofs inc vec n_name n if the dimension n is given, check that the vector vec is big enough, otherwise return the maximal n for the given vector vec.
val check_vec_empty : loc:string ->vec_name:string ->dim:int -> unit
val orgqr_get_params :
string ->?m:int ->?n:int ->?k:int ->tau:('a, 'b, 'c)Bigarray.Array1.t->ar:int ->ac:int ->('d, 'e, 'f)Bigarray.Array2.t->
int * int * int