numpy 0.17.2

PyO3-based Rust bindings of the NumPy C-API
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

#![allow(deprecated)]

use numpy::{pyarray, NpyMultiIterBuilder, NpySingleIterBuilder};
use pyo3::Python;

// The order of iteration is not specified, so we should restrict ourselves
// to tests that don't verify a given order.

#[test]
fn readonly_iter() {
    Python::with_gil(|py| {
        let arr = pyarray![py, [0, 1], [2, 3], [4, 5]];
        let ro_arr = arr.readonly();

        let iter = NpySingleIterBuilder::readonly(&ro_arr).build().unwrap();

        assert_eq!(iter.sum::<i32>(), 15);
    });
}

#[test]
fn mutable_iter() {
    Python::with_gil(|py| {
        let arr = pyarray![py, [0, 1], [2, 3], [4, 5]];
        let mut rw_arr = arr.readwrite();

        let iter = NpySingleIterBuilder::readwrite(&mut rw_arr)
            .build()
            .unwrap();

        for elem in iter {
            *elem *= 2;
        }

        drop(rw_arr);
        let ro_arr = arr.readonly();

        let iter = NpySingleIterBuilder::readonly(&ro_arr).build().unwrap();

        assert_eq!(iter.sum::<i32>(), 30);
    });
}

#[test]
fn multiiter_rr() {
    Python::with_gil(|py| {
        let arr1 = pyarray![py, [0, 1], [2, 3], [4, 5]];
        let ro_arr1 = arr1.readonly();
        let arr2 = pyarray![py, [6, 7], [8, 9], [10, 11]];
        let ro_arr2 = arr2.readonly();

        let iter = NpyMultiIterBuilder::new()
            .add_readonly(&ro_arr1)
            .add_readonly(&ro_arr2)
            .build()
            .unwrap();

        assert_eq!(iter.map(|(x, y)| *x * *y).sum::<i32>(), 145);
    });
}

#[test]
fn multiiter_rw() {
    Python::with_gil(|py| {
        let arr1 = pyarray![py, [0, 1], [2, 3], [4, 5]];
        let ro_arr1 = arr1.readonly();
        let arr2 = pyarray![py, [0, 0], [0, 0], [0, 0]];
        let mut rw_arr2 = arr2.readwrite();

        let iter = NpyMultiIterBuilder::new()
            .add_readonly(&ro_arr1)
            .add_readwrite(&mut rw_arr2)
            .build()
            .unwrap();

        for (x, y) in iter {
            *y = *x * 2;
        }

        drop(rw_arr2);
        let ro_arr2 = arr2.readonly();

        let iter = NpyMultiIterBuilder::new()
            .add_readonly(&ro_arr1)
            .add_readonly(&ro_arr2)
            .build()
            .unwrap();

        for (x, y) in iter {
            assert_eq!(*x * 2, *y);
        }
    });
}

#[test]
fn single_iter_size_hint_len() {
    Python::with_gil(|py| {
        let arr = pyarray![py, [0, 1], [2, 3], [4, 5]];
        let ro_arr = arr.readonly();

        let mut iter = NpySingleIterBuilder::readonly(&ro_arr).build().unwrap();

        for len in (1..=6).rev() {
            assert_eq!(iter.len(), len);
            assert_eq!(iter.size_hint(), (len, Some(len)));
            assert!(iter.next().is_some());
        }

        assert_eq!(iter.len(), 0);
        assert_eq!(iter.size_hint(), (0, Some(0)));
        assert!(iter.next().is_none());
    });
}

#[test]
fn multi_iter_size_hint_len() {
    Python::with_gil(|py| {
        let arr1 = pyarray![py, [0, 1], [2, 3], [4, 5]];
        let ro_arr1 = arr1.readonly();
        let arr2 = pyarray![py, [0, 0], [0, 0], [0, 0]];
        let ro_arr2 = arr2.readonly();

        let mut iter = NpyMultiIterBuilder::new()
            .add_readonly(&ro_arr1)
            .add_readonly(&ro_arr2)
            .build()
            .unwrap();

        for len in (1..=6).rev() {
            assert_eq!(iter.len(), len);
            assert_eq!(iter.size_hint(), (len, Some(len)));
            assert!(iter.next().is_some());
        }

        assert_eq!(iter.len(), 0);
        assert_eq!(iter.size_hint(), (0, Some(0)));
        assert!(iter.next().is_none());
    });
}