Trait Context

Source

pub trait Context: Clone + Default {
    // Required method
    fn clone_with_nbatch(&self, nbatch: usize) -> Result<Self, DiffsolError>;

    // Provided methods
    fn nbatch(&self) -> usize { ... }
    fn assert_compatible_nbatch(&self, other_nbatch: usize, op: &str) { ... }
    fn vector_from_element<V: Vector<C = Self>>(
        &self,
        len: usize,
        value: V::T,
    ) -> V { ... }
    fn vector_from_vec<V: Vector<C = Self>>(&self, vec: Vec<V::T>) -> V { ... }
    fn vector_zeros<V: Vector<C = Self>>(&self, len: usize) -> V { ... }
    fn dense_mat_zeros<V: Vector<C = Self> + DefaultDenseMatrix>(
        &self,
        rows: usize,
        cols: usize,
    ) -> <V as DefaultDenseMatrix>::M { ... }
}

Expand description

defines the current execution and allocation context of an operator / vector / matrix for example:

threading model (e.g. single-threaded, multi-threaded, GPU)
custom allocators, host/device memory
etc.

It will generally be the case that all the operators / vectors / matrices for the current ode problem share the same context

Required Methods§

Source

fn clone_with_nbatch(&self, nbatch: usize) -> Result<Self, DiffsolError>

Creates a new context with the given batch count.

Other properties of the context (e.g. CUDA stream, faer parallelism) are preserved.

Returns an error if the backend does not support batching (i.e. nbatch > 1 for CPU backends such as faer and nalgebra).

Provided Methods§

Source

fn nbatch(&self) -> usize

Returns the batch count for this context.

When nbatch > 1, vectors and matrices store data for nbatch independent ODE systems simultaneously. Operations between operands with different batch counts use broadcast semantics: an operand with nbatch == 1 is applied to all batches of the other operand.

Source