rlst 0.9.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

//! Test distributed array functionality.

/// Test three dimensional distributed arrays.
fn test_scatter_dim3<C: mpi::traits::Communicator>(comm: &C) {
    use rlst::{DynArray, assert_array_relative_eq, distributed_tools::IndexLayout};
    use std::rc::Rc;

    let rank = comm.rank() as usize;

    // The leading dofs per rank. Every rank has a different number of dofs.
    let ndofs_per_rank = 10 + 2 * rank;

    // First we create an index layout;
    let index_layout = Rc::new(IndexLayout::from_local_counts(ndofs_per_rank, comm));

    // Let's create an array on the root process and scatter it to all processes.

    // We create the array on each process from the same seed. This allows us to compare
    // the results after scatter.
    let mut arr = DynArray::<f64, 3>::from_shape([index_layout.number_of_global_indices(), 12, 13]);
    arr.fill_from_seed_normally_distributed(1);

    let dist_array = if rank == 0 {
        // Create a local array on root

        arr.scatter_from_one_root(index_layout.clone())
    } else {
        DynArray::<f64, 3>::scatter_from_one(0, index_layout.clone())
    };

    assert_array_relative_eq!(
        dist_array.local,
        arr.r()
            .into_subview([index_layout.scan()[rank], 0, 0], [ndofs_per_rank, 12, 13]),
        1E-10
    );
}

/// Test one dimensional distributed arrays.
fn test_scatter_dim1<C: mpi::traits::Communicator>(comm: &C) {
    use rlst::{DynArray, assert_array_relative_eq, distributed_tools::IndexLayout};
    use std::rc::Rc;

    let rank = comm.rank() as usize;

    // The leading dofs per rank. Every rank has a different number of dofs.
    let ndofs_per_rank = 10 + 2 * rank;

    // First we create an index layout;
    let index_layout = Rc::new(IndexLayout::from_local_counts(ndofs_per_rank, comm));

    // Let's create an array on the root process and scatter it to all processes.

    // We create the array on each process from the same seed. This allows us to compare
    // the results after scatter.
    let mut arr = DynArray::<f64, 1>::from_shape([index_layout.number_of_global_indices()]);
    arr.fill_from_seed_normally_distributed(1);

    let dist_array = if rank == 0 {
        // Create a local array on root

        arr.scatter_from_one_root(index_layout.clone())
    } else {
        DynArray::<f64, 1>::scatter_from_one(0, index_layout.clone())
    };

    assert_array_relative_eq!(
        dist_array.local,
        arr.r()
            .into_subview([index_layout.scan()[rank]], [ndofs_per_rank]),
        1E-10
    );
}

fn test_gather_dim3<C: mpi::traits::Communicator>(comm: &C) {
    use rlst::{DynArray, assert_array_relative_eq, distributed_tools::IndexLayout};
    use std::rc::Rc;

    let rank = comm.rank() as usize;

    // The leading dofs per rank. Every rank has a different number of dofs.
    let ndofs_per_rank = 10 + 2 * rank;

    // First we create an index layout;
    let index_layout = Rc::new(IndexLayout::from_local_counts(ndofs_per_rank, comm));

    // Let's create an array on the root process and scatter it to all processes.

    // We create the array on each process from the same seed. This allows us to compare
    // the results after scatter.
    let mut arr = rlst::DynArray::<f64, 1>::from_shape([index_layout.number_of_global_indices()]);
    arr.fill_from_seed_normally_distributed(1);

    let dist_array = if rank == 0 {
        // Create a local array on root

        arr.scatter_from_one_root(index_layout.clone())
    } else {
        DynArray::<f64, 1>::scatter_from_one(0, index_layout.clone())
    };

    if rank == 0 {
        let gathered_array = dist_array.gather_to_one_root();

        assert_array_relative_eq!(gathered_array, arr, 1E-10);
    } else {
        dist_array.gather_to_one(0);
    };
}

/// Test one dimensional distributed arrays.
fn test_gather_dim1<C: mpi::traits::Communicator>(comm: &C) {
    use rlst::{DynArray, assert_array_relative_eq, distributed_tools::IndexLayout};
    use std::rc::Rc;

    let rank = comm.rank() as usize;

    // The leading dofs per rank. Every rank has a different number of dofs.
    let ndofs_per_rank = 10 + 2 * rank;

    // First we create an index layout;
    let index_layout = Rc::new(IndexLayout::from_local_counts(ndofs_per_rank, comm));

    // Let's create an array on the root process and scatter it to all processes.

    // We create the array on each process from the same seed. This allows us to compare
    // the results after scatter.
    let mut arr = DynArray::<f64, 1>::from_shape([index_layout.number_of_global_indices()]);
    arr.fill_from_seed_normally_distributed(1);

    let dist_array = if rank == 0 {
        // Create a local array on root

        arr.scatter_from_one_root(index_layout.clone())
    } else {
        DynArray::<f64, 1>::scatter_from_one(0, index_layout.clone())
    };

    if rank == 0 {
        let gathered_array = dist_array.gather_to_one_root();

        assert_array_relative_eq!(gathered_array, arr, 1E-10);
    } else {
        dist_array.gather_to_one(0);
    };
}

fn test_gather_to_all_dim3<C: mpi::traits::Communicator>(comm: &C) {
    use rlst::{DynArray, assert_array_relative_eq, distributed_tools::IndexLayout};
    use std::rc::Rc;

    let rank = comm.rank() as usize;

    // The leading dofs per rank. Every rank has a different number of dofs.
    let ndofs_per_rank = 10 + 2 * rank;

    // First we create an index layout;
    let index_layout = Rc::new(IndexLayout::from_local_counts(ndofs_per_rank, comm));

    // Let's create an array on the root process and scatter it to all processes.

    // We create the array on each process from the same seed. This allows us to compare
    // the results after scatter.
    let mut arr = DynArray::<f64, 1>::from_shape([index_layout.number_of_global_indices()]);
    arr.fill_from_seed_normally_distributed(1);

    let dist_array = if rank == 0 {
        // Create a local array on root

        arr.scatter_from_one_root(index_layout.clone())
    } else {
        DynArray::<f64, 1>::scatter_from_one(0, index_layout.clone())
    };

    let gathered_array = dist_array.gather_to_all();

    assert_array_relative_eq!(gathered_array, arr, 1E-10);
}

/// Test one dimensional distributed arrays.
fn test_gather_to_all_dim1<C: mpi::traits::Communicator>(comm: &C) {
    use rlst::{DynArray, assert_array_relative_eq, distributed_tools::IndexLayout};
    use std::rc::Rc;

    let rank = comm.rank() as usize;

    // The leading dofs per rank. Every rank has a different number of dofs.
    let ndofs_per_rank = 10 + 2 * rank;

    // First we create an index layout;
    let index_layout = Rc::new(IndexLayout::from_local_counts(ndofs_per_rank, comm));

    // Let's create an array on the root process and scatter it to all processes.

    // We create the array on each process from the same seed. This allows us to compare
    // the results after scatter.
    let mut arr = DynArray::<f64, 1>::from_shape([index_layout.number_of_global_indices()]);
    arr.fill_from_seed_normally_distributed(1);

    let dist_array = if rank == 0 {
        // Create a local array on root

        arr.scatter_from_one_root(index_layout.clone())
    } else {
        DynArray::<f64, 1>::scatter_from_one(0, index_layout.clone())
    };

    let gathered_array = dist_array.gather_to_all();

    assert_array_relative_eq!(gathered_array, arr, 1E-10);
}

pub fn main() {
    let universe = mpi::initialize().unwrap();
    let world = universe.world();
    test_scatter_dim1(&world);
    test_scatter_dim3(&world);
    test_gather_dim1(&world);
    test_gather_dim3(&world);
    test_gather_to_all_dim1(&world);
    test_gather_to_all_dim3(&world);
}