rlst 0.10.2

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

//! Implementation of operator concepts for dense arrays.

use std::{
    marker::PhantomData,
    ops::{Add, AddAssign, Mul, MulAssign, Neg, Sub, SubAssign},
    rc::Rc,
};

use mpi::traits::{Communicator, Equivalence};

use crate::{
    Inner, InnerProductSpace, LinearSpace,
    dense::{base_array::BaseArray, data_container::VectorContainer},
    dist_vec,
    distributed_tools::IndexLayout,
    operator::element::Element,
    sparse::distributed_array::DistributedArray,
};

/// Distributed vector space defined by a shared global index layout.
///
/// Elements use the layout's communicator and local index range. All ranks
/// participating in collective element operations must use compatible layouts,
/// including ranks whose local range is empty.
pub struct DistributedArrayVectorSpace<'a, C: Communicator, Item: Equivalence> {
    index_layout: Rc<IndexLayout<'a, C>>,
    _marker: PhantomData<Item>,
}

impl<'a, C: Communicator, Item: Equivalence> DistributedArrayVectorSpace<'a, C, Item> {
    /// Create a space sharing ownership of `index_layout`.
    pub fn new(index_layout: Rc<IndexLayout<'a, C>>) -> Self {
        Self {
            index_layout,
            _marker: PhantomData,
        }
    }

    /// Return the communicator owned by the index layout.
    pub fn comm(&self) -> &C {
        self.index_layout.comm()
    }

    /// Clone the reference-counted index-layout handle.
    pub fn index_layout(&self) -> Rc<IndexLayout<'a, C>> {
        self.index_layout.clone()
    }
}

impl<'a, C, Item> LinearSpace for DistributedArrayVectorSpace<'a, C, Item>
where
    C: Communicator,
    Item: Equivalence
        + Copy
        + Default
        + Add<Item, Output = Item>
        + Sub<Item, Output = Item>
        + Mul<Item, Output = Item>
        + Neg<Output = Item>
        + AddAssign<Item>
        + SubAssign<Item>
        + MulAssign<Item>,
{
    type F = Item;

    type Impl = DistributedArray<'a, C, BaseArray<VectorContainer<Item>, 1>, 1>;

    fn zero(&self) -> crate::operator::element::Element<'_, Self> {
        Element::new(self, dist_vec!(Item, self.index_layout.clone()))
    }

    /// Compute `x + y`.
    fn add(
        &self,
        x: &crate::operator::element::Element<Self>,
        y: &crate::operator::element::Element<Self>,
    ) -> crate::operator::element::Element<'_, Self> {
        Element::new(self, (x.imp().r() + y.imp().r()).eval())
    }

    /// Compute `x - y`.
    fn sub(
        &self,
        x: &crate::operator::element::Element<Self>,
        y: &crate::operator::element::Element<Self>,
    ) -> crate::operator::element::Element<'_, Self> {
        Element::new(self, (x.imp().r() - y.imp().r()).eval())
    }

    /// Compute `scalar * x`.
    fn scalar_mul(
        &self,
        scalar: &Self::F,
        x: &crate::operator::element::Element<Self>,
    ) -> crate::operator::element::Element<'_, Self> {
        Element::new(self, x.imp().r().scalar_mul(*scalar).eval())
    }

    /// Compute `-x`.
    fn neg(
        &self,
        x: &crate::operator::element::Element<Self>,
    ) -> crate::operator::element::Element<'_, Self> {
        Element::new(self, x.imp().r().neg().eval())
    }

    /// Compute `x += y`.
    fn sum_inplace(
        &self,
        x: &mut crate::operator::element::Element<Self>,
        y: &crate::operator::element::Element<Self>,
    ) {
        x.imp_mut().r_mut().add_assign(y.imp().r());
    }

    /// Compute `x -= y`.
    fn sub_inplace(
        &self,
        x: &mut crate::operator::element::Element<Self>,
        y: &crate::operator::element::Element<Self>,
    ) {
        x.imp_mut().r_mut().sub_assign(y.imp().r());
    }

    /// Compute `x *= scalar`.
    fn scale_inplace(&self, scalar: &Self::F, x: &mut crate::operator::element::Element<Self>) {
        x.imp_mut().r_mut().mul_assign(*scalar);
    }

    /// Create a new element by copying `x`.
    fn copy_from(
        &self,
        x: &crate::operator::element::Element<Self>,
    ) -> crate::operator::element::Element<'_, Self> {
        Element::new(self, x.imp().eval())
    }

    /// Compute `y += alpha * x` without forming the scaled element.
    ///
    /// The update is entirely local; no collective operation is involved.
    fn axpy_inplace(
        &self,
        alpha: &Self::F,
        x: &crate::operator::element::Element<Self>,
        y: &mut crate::operator::element::Element<Self>,
    ) {
        y.imp_mut()
            .r_mut()
            .add_assign(x.imp().r().scalar_mul(*alpha));
    }
}

impl<'a, C, Item> InnerProductSpace for DistributedArrayVectorSpace<'a, C, Item>
where
    C: Communicator,
    Item: Equivalence
        + Copy
        + Default
        + Add<Item, Output = Item>
        + Sub<Item, Output = Item>
        + Mul<Item, Output = Item>
        + Neg<Output = Item>
        + AddAssign<Item>
        + SubAssign<Item>
        + MulAssign<Item>,
    DistributedArray<'a, C, BaseArray<VectorContainer<Item>, 1>, 1>:
        Inner<DistributedArray<'a, C, BaseArray<VectorContainer<Item>, 1>, 1>, Output = Item>,
{
    fn inner_product(&self, x: &Element<Self>, other: &Element<Self>) -> Self::F {
        x.imp().inner(other.imp())
    }
}