diffsol 0.12.4

A library for solving ordinary differential equations (ODEs) in Rust.
Documentation
use crate::{
    error::{DiffsolError, MatrixError},
    matrix_error,
    scalar::IndexType,
    vector::{Vector, VectorIndex},
    ColMajBlock, VectorCommon,
};

use super::{Matrix, MatrixCommon};

pub trait MatrixSparsity<M: Matrix>: Sized + Clone {
    fn nrows(&self) -> IndexType;
    fn ncols(&self) -> IndexType;
    fn is_sparse() -> bool;
    fn try_from_indices(
        nrows: IndexType,
        ncols: IndexType,
        indices: Vec<(IndexType, IndexType)>,
    ) -> Result<Self, DiffsolError>;
    fn indices(&self) -> Vec<(IndexType, IndexType)>;
    fn union(self, other: M::SparsityRef<'_>) -> Result<M::Sparsity, DiffsolError>;
    fn new_diagonal(n: IndexType) -> Self;
    fn as_ref(&self) -> M::SparsityRef<'_>;
    fn get_index(
        &self,
        indices: &[(IndexType, IndexType)],
        ctx: <M::V as VectorCommon>::C,
    ) -> <M::V as Vector>::Index;
}

pub trait MatrixSparsityRef<'a, M: Matrix> {
    fn nrows(&self) -> IndexType;
    fn ncols(&self) -> IndexType;
    fn is_sparse() -> bool;
    fn indices(&self) -> Vec<(IndexType, IndexType)>;
    fn to_owned(&self) -> M::Sparsity;
    fn split(
        &self,
        algebraic_indices: &<M::V as Vector>::Index,
    ) -> [(M::Sparsity, <M::V as Vector>::Index); 4];
}

#[derive(Clone)]
pub struct Dense<M: Matrix> {
    nrows: IndexType,
    ncols: IndexType,
    _phantom: std::marker::PhantomData<M>,
}

pub struct DenseRef<'a, M: Matrix> {
    dense: &'a Dense<M>,
}

impl<M: Matrix> Dense<M> {
    pub fn new(nrows: IndexType, ncols: IndexType) -> Self {
        Dense {
            nrows,
            ncols,
            _phantom: std::marker::PhantomData,
        }
    }
    pub fn nrows(&self) -> IndexType {
        self.nrows
    }
    pub fn ncols(&self) -> IndexType {
        self.ncols
    }
    pub(crate) fn split(
        &self,
        algebraic_indices: &<M::V as Vector>::Index,
    ) -> [(Self, <<M as MatrixCommon>::V as Vector>::Index); 4] {
        let (ul_blk, ur_blk, ll_blk, lr_blk) =
            ColMajBlock::split(self.nrows, self.ncols, algebraic_indices);
        let ul = Dense::new(ul_blk.nrows, ul_blk.ncols);
        let ur = Dense::new(ur_blk.nrows, ur_blk.ncols);
        let ll = Dense::new(ll_blk.nrows, ll_blk.ncols);
        let lr = Dense::new(lr_blk.nrows, lr_blk.ncols);
        [
            (ul, ul_blk.src_indices),
            (ur, ur_blk.src_indices),
            (ll, ll_blk.src_indices),
            (lr, lr_blk.src_indices),
        ]
    }
}

impl<'a, M: Matrix> DenseRef<'a, M> {
    pub fn new(dense: &'a Dense<M>) -> Self {
        DenseRef { dense }
    }
}

impl<M> MatrixSparsity<M> for Dense<M>
where
    for<'a> M: Matrix<Sparsity = Dense<M>, SparsityRef<'a> = DenseRef<'a, M>>,
{
    fn union(self, other: M::SparsityRef<'_>) -> Result<M::Sparsity, DiffsolError> {
        if self.nrows() != other.nrows() || self.ncols() != other.ncols() {
            return Err(matrix_error!(UnionIncompatibleShapes));
        }
        Ok(Self::new(self.nrows(), self.ncols()))
    }

    fn as_ref(&self) -> M::SparsityRef<'_> {
        DenseRef::new(self)
    }

    fn nrows(&self) -> IndexType {
        self.nrows
    }

    fn ncols(&self) -> IndexType {
        self.ncols
    }

    fn is_sparse() -> bool {
        false
    }

    fn try_from_indices(
        nrows: IndexType,
        ncols: IndexType,
        _indices: Vec<(IndexType, IndexType)>,
    ) -> Result<Self, DiffsolError> {
        if nrows == 0 || ncols == 0 {
            return Err(matrix_error!(MatrixShapeError));
        }
        Ok(Dense::new(nrows, ncols))
    }

    fn indices(&self) -> Vec<(IndexType, IndexType)> {
        Vec::new()
    }

    fn new_diagonal(n: IndexType) -> Self {
        Dense::new(n, n)
    }
    fn get_index(
        &self,
        indices: &[(IndexType, IndexType)],
        ctx: <M::V as VectorCommon>::C,
    ) -> <M::V as Vector>::Index {
        let indices: Vec<_> = indices
            .iter()
            .map(|(i, j)| {
                if i >= &self.nrows() || j >= &self.ncols() {
                    panic!("Index out of bounds")
                }
                j * self.nrows() + i
            })
            .collect();
        <M::V as Vector>::Index::from_vec(indices, ctx)
    }
}

impl<'a, M> MatrixSparsityRef<'a, M> for DenseRef<'a, M>
where
    M: Matrix<Sparsity = Dense<M>, SparsityRef<'a> = Self>,
{
    fn to_owned(&self) -> M::Sparsity {
        Dense::new(self.nrows(), self.ncols())
    }

    fn split(
        &self,
        indices: &<M::V as Vector>::Index,
    ) -> [(M::Sparsity, <<M as MatrixCommon>::V as Vector>::Index); 4] {
        self.dense.split(indices)
    }

    fn nrows(&self) -> IndexType {
        self.dense.nrows
    }

    fn ncols(&self) -> IndexType {
        self.dense.ncols
    }

    fn is_sparse() -> bool {
        false
    }

    fn indices(&self) -> Vec<(IndexType, IndexType)> {
        Vec::new()
    }
}