Previous  Up  Next

Module Nvector_serial

module Nvector_serial: sig .. end

Standard serial nvectors of Sundials.

type data = Sundials.RealArray.t

Serial nvectors are based on bigarrays of floats.

type kind = [ `Serial ]

Represents any nvector that can be treated as a serial nvector. That is, any nvector whose underlying elements can be accessed as an array locally.

type t = (data, kind) Nvector.t

The type of serial nvectors.

val make : ?context:Sundials.Context.t ->
       ?with_fused_ops:bool -> int -> float -> t

make n iv creates a new serial nvector with n elements, each initialized to iv.

The optional argument enables the fused and array operations for a given nvector (they are disabled by default).

val wrap : ?context:Sundials.Context.t ->
       ?with_fused_ops:bool -> Sundials.RealArray.t -> t

wrap a creates a new serial nvector over the elements of a.

The optional arguments permit to enable all the fused and array operations for a given nvector (they are disabled by default).

val unwrap : t -> Sundials.RealArray.t

Aliases Nvector.unwrap.

val pp : Stdlib.Format.formatter -> t -> unit

Pretty-print a serial nvector using the Format module.

val enable : ?with_fused_ops:bool ->
       ?with_linear_combination:bool ->
       ?with_scale_add_multi:bool ->
       ?with_dot_prod_multi:bool ->
       ?with_linear_sum_vector_array:bool ->
       ?with_scale_vector_array:bool ->
       ?with_const_vector_array:bool ->
       ?with_wrms_norm_vector_array:bool ->
       ?with_wrms_norm_mask_vector_array:bool ->
       ?with_scale_add_multi_vector_array:bool ->
       ?with_linear_combination_vector_array:bool -> t -> unit

Selectively enable or disable fused and array operations. The with_fused_ops argument enables or disables all such operations.

module Ops: Nvector.NVECTOR_OPS  with type t = t

Underlying nvector operations on serial nvectors.

module DataOps: Nvector.NVECTOR_OPS  with type t = RealArray.t

Nvector operations on RealArrays implemented in OCaml.

module Any: sig .. end

A generic nvector interface to serial nvectors.