rlst 0.8.0

A Rust native linear algebra library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

//! Matrix interface.
//!
//! This module defines interfaces to the Rlst dense and sparse matrix types
//! to be used as abstract operators.

#[cfg(feature = "mpi")]
use mpi::traits::{Communicator, Equivalence};

use crate::{
    Array, AsMatrixApply, BaseItem, LinearSpace, Shape, abstract_operator::OperatorBase,
    dense::array::DynArray, operator::abstract_operator::Operator, sparse::csr_mat::CsrMatrix,
};

#[cfg(feature = "mpi")]
use crate::{
    dense::{base_array::BaseArray, data_container::VectorContainer},
    operator::interface::distributed_array_vector_space::DistributedArrayVectorSpace,
    sparse::distributed_array::DistributedArray,
    sparse::distributed_csr_mat::DistributedCsrMatrix,
};

use super::array_vector_space::ArrayVectorSpace;

/// Borrowed dense matrix viewed as an abstract operator.
///
/// For an `m x n` matrix, the domain contains length-n vectors and the range
/// length-m vectors. The operator cannot outlive the matrix.
pub struct ArrayOperator<'a, ArrayImpl>
where
    ArrayImpl: BaseItem,
{
    op: &'a Array<ArrayImpl, 2>,
    domain: ArrayVectorSpace<ArrayImpl::Item>,
    range: ArrayVectorSpace<ArrayImpl::Item>,
}

impl<'a, ArrayImpl: BaseItem> ArrayOperator<'a, ArrayImpl> {
    /// Borrow a matrix and construct matching domain and range spaces.
    pub fn new(op: &'a Array<ArrayImpl, 2>) -> Self
    where
        ArrayImpl: Shape<2>,
    {
        let shape = op.shape();
        Self {
            op,
            domain: ArrayVectorSpace::new(shape[1]),
            range: ArrayVectorSpace::new(shape[0]),
        }
    }
}

impl<'a, ArrayImpl: BaseItem + Shape<2>> From<&'a Array<ArrayImpl, 2>>
    for Operator<ArrayOperator<'a, ArrayImpl>>
where
    ArrayOperator<'a, ArrayImpl>: OperatorBase,
{
    fn from(value: &'a Array<ArrayImpl, 2>) -> Self {
        Operator::new(ArrayOperator::new(value))
    }
}

impl<'a, ArrayImpl> OperatorBase for ArrayOperator<'a, ArrayImpl>
where
    ArrayImpl: BaseItem,
    ArrayVectorSpace<ArrayImpl::Item>:
        LinearSpace<F = ArrayImpl::Item, Impl = DynArray<ArrayImpl::Item, 1>>,
    Array<ArrayImpl, 2>: AsMatrixApply<DynArray<ArrayImpl::Item, 1>, DynArray<ArrayImpl::Item, 1>>
        + BaseItem<Item = ArrayImpl::Item>,
{
    type Domain = ArrayVectorSpace<ArrayImpl::Item>;

    type Range = ArrayVectorSpace<ArrayImpl::Item>;

    fn domain(&self) -> &Self::Domain {
        &self.domain
    }

    fn range(&self) -> &Self::Range {
        &self.range
    }

    #[inline(always)]
    fn apply(
        &self,
        alpha: <Self::Range as crate::LinearSpace>::F,
        x: &crate::operator::element::Element<Self::Domain>,
        beta: <Self::Range as crate::LinearSpace>::F,
        y: &mut crate::operator::element::Element<Self::Range>,
    ) {
        self.op.apply(alpha, x.imp(), beta, y.imp_mut());
    }
}

/// Borrowed CSR matrix viewed as an abstract operator.
///
/// For an `m x n` matrix, the domain contains length-n vectors and the range
/// length-m vectors.
pub struct CsrOperator<'a, Item> {
    arr: &'a CsrMatrix<Item>,
    domain: ArrayVectorSpace<Item>,
    range: ArrayVectorSpace<Item>,
}

impl<'a, Item> CsrOperator<'a, Item> {
    /// Borrow a CSR matrix and construct matching domain and range spaces.
    pub fn new(arr: &'a CsrMatrix<Item>) -> Self {
        let shape = arr.shape();
        Self {
            arr,
            domain: ArrayVectorSpace::new(shape[1]),
            range: ArrayVectorSpace::new(shape[0]),
        }
    }
}

impl<'a, Item> From<&'a CsrMatrix<Item>> for Operator<CsrOperator<'a, Item>>
where
    CsrOperator<'a, Item>: OperatorBase,
{
    fn from(value: &'a CsrMatrix<Item>) -> Self {
        Operator::new(CsrOperator::new(value))
    }
}

impl<'a, Item> OperatorBase for CsrOperator<'a, Item>
where
    ArrayVectorSpace<Item>: LinearSpace<F = Item, Impl = DynArray<Item, 1>>,
    CsrMatrix<Item>: AsMatrixApply<DynArray<Item, 1>, DynArray<Item, 1>> + BaseItem<Item = Item>,
{
    type Domain = ArrayVectorSpace<Item>;

    type Range = ArrayVectorSpace<Item>;

    fn domain(&self) -> &Self::Domain {
        &self.domain
    }

    fn range(&self) -> &Self::Range {
        &self.range
    }

    #[inline(always)]
    fn apply(
        &self,
        alpha: <Self::Range as LinearSpace>::F,
        x: &crate::operator::element::Element<Self::Domain>,
        beta: <Self::Range as LinearSpace>::F,
        y: &mut crate::operator::element::Element<Self::Range>,
    ) {
        self.arr.apply(alpha, x.imp(), beta, y.imp_mut());
    }
}

#[cfg(feature = "mpi")]
/// Borrowed distributed CSR matrix viewed as an abstract operator.
///
/// Domain and range reuse the matrix's distributed index layouts; application
/// is collective whenever the underlying distributed matrix operation is.
pub struct DistributedCsrOperator<'a, Item: Equivalence, C: Communicator> {
    op: &'a DistributedCsrMatrix<'a, Item, C>,
    domain: DistributedArrayVectorSpace<'a, C, Item>,
    range: DistributedArrayVectorSpace<'a, C, Item>,
}

#[cfg(feature = "mpi")]
impl<'a, Item: Copy + Equivalence, C: Communicator> DistributedCsrOperator<'a, Item, C> {
    /// Borrow a distributed matrix and clone its domain/range layout handles.
    pub fn new(op: &'a DistributedCsrMatrix<'a, Item, C>) -> Self {
        Self {
            op,
            domain: DistributedArrayVectorSpace::new(op.domain_layout().clone()),
            range: DistributedArrayVectorSpace::new(op.range_layout().clone()),
        }
    }
}

#[cfg(feature = "mpi")]
impl<'a, Item: Copy + Equivalence, C: Communicator> From<&'a DistributedCsrMatrix<'a, Item, C>>
    for Operator<DistributedCsrOperator<'a, Item, C>>
where
    DistributedCsrOperator<'a, Item, C>: OperatorBase,
{
    fn from(value: &'a DistributedCsrMatrix<'a, Item, C>) -> Self {
        Operator::new(DistributedCsrOperator::new(value))
    }
}

#[cfg(feature = "mpi")]
impl<'a, Item: Equivalence, C: Communicator> OperatorBase for DistributedCsrOperator<'a, Item, C>
where
    DistributedArrayVectorSpace<'a, C, Item>: LinearSpace<
            F = Item,
            Impl = DistributedArray<'a, C, BaseArray<VectorContainer<Item>, 1>, 1>,
        >,
    DistributedCsrMatrix<'a, Item, C>: AsMatrixApply<
            DistributedArray<'a, C, BaseArray<VectorContainer<Item>, 1>, 1>,
            DistributedArray<'a, C, BaseArray<VectorContainer<Item>, 1>, 1>,
        > + BaseItem<Item = Item>,
{
    type Domain = DistributedArrayVectorSpace<'a, C, Item>;

    type Range = DistributedArrayVectorSpace<'a, C, Item>;

    fn domain(&self) -> &Self::Domain {
        &self.domain
    }

    fn range(&self) -> &Self::Range {
        &self.range
    }

    #[inline(always)]
    fn apply(
        &self,
        alpha: <Self::Range as LinearSpace>::F,
        x: &crate::operator::element::Element<Self::Domain>,
        beta: <Self::Range as LinearSpace>::F,
        y: &mut crate::operator::element::Element<Self::Range>,
    ) {
        self.op.apply(alpha, x.imp(), beta, y.imp_mut());
    }
}