jlrs 0.23.0

jlrs provides bindings to the Julia C API that enable Julia code to be called from Rust and more.
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

//! Borrow data from Julia arrays as `ndarray`'s `ArrayView` and `ArrayViewMut`.

use ndarray::{ArrayView, ArrayViewMut, IntoDimension, IxDyn, Shape, ShapeBuilder};

use super::compatible::{Compatible, CompatibleCast};
use crate::data::{
    layout::{is_bits::IsBits, valid_layout::ValidField},
    managed::array::data::{
        accessor::{Accessor, BitsAccessor, BitsAccessorMut, InlineAccessor},
        copied::CopiedArray,
    },
};

fn into_shape<'scope, 'data, T, A: Accessor<'scope, 'data, T, N>, const N: isize>(
    a: &A,
) -> Shape<IxDyn> {
    let array = a.array();
    let dims = array.dimensions();
    let slice = dims.as_slice();

    let n = slice.len();
    let ptr = slice.as_ptr().cast::<usize>();
    let slice = unsafe { std::slice::from_raw_parts(ptr, n) };
    slice.into_dimension().f()
}

/// Trait to borrow Julia arrays with inline data as `ndarray`'s `ArrayView`.
pub trait NdArrayView<'view, T>: private::NdArrayPriv {
    /// Borrow the data in the array as an `ArrayView`.
    fn array_view(&'view self) -> ArrayView<'view, T, IxDyn>;

    /// Borrow the data in the array as an `ArrayView` of a compatible type `U`.
    fn compatible_array_view<U>(&'view self) -> ArrayView<'view, U, IxDyn>
    where
        T: Compatible<U>;
}

/// Trait to borrow Julia arrays with inline data as `ndarray`'s `ArrayViewMut`.
pub trait NdArrayViewMut<'view, T>: NdArrayView<'view, T> {
    /// Mutably borrow the data in the array as an `ArrayViewMut`.
    fn array_view_mut(&'view mut self) -> ArrayViewMut<'view, T, IxDyn>;

    /// Mutably borrow the data in the array as an `ArrayViewMut` of a compatible type `U`.
    fn compatible_array_view_mut<U>(&'view mut self) -> ArrayViewMut<'view, U, IxDyn>
    where
        T: Compatible<U>;
}

impl<'borrow: 'view, 'view, 'array, 'data, T, L, const N: isize> NdArrayView<'view, L>
    for BitsAccessor<'borrow, 'array, 'data, T, L, N>
where
    L: IsBits + ValidField,
{
    fn array_view(&'view self) -> ArrayView<'view, L, IxDyn> {
        // Safety: while the array is borrowed nothing can be pushed or popped from it.
        let shape = into_shape(self);
        ArrayView::from_shape(shape, self.as_slice()).unwrap()
    }

    fn compatible_array_view<U>(&'view self) -> ArrayView<'view, U, IxDyn>
    where
        L: Compatible<U>,
    {
        let shape = into_shape(self);
        ArrayView::from_shape(shape, self.as_slice().compatible_cast()).unwrap()
    }
}

impl<'borrow: 'view, 'view, 'array, 'data, T, L, const N: isize> NdArrayView<'view, L>
    for BitsAccessorMut<'borrow, 'array, 'data, T, L, N>
where
    L: IsBits + ValidField,
{
    fn array_view(&'view self) -> ArrayView<'view, L, IxDyn> {
        // Safety: while the array is borrowed nothing can be pushed or popped from it.
        let shape = into_shape(self);
        ArrayView::from_shape(shape, self.as_slice()).unwrap()
    }

    fn compatible_array_view<U>(&'view self) -> ArrayView<'view, U, IxDyn>
    where
        L: Compatible<U>,
    {
        let shape = into_shape(self);
        ArrayView::from_shape(shape, self.as_slice().compatible_cast()).unwrap()
    }
}

impl<'borrow: 'view, 'view, 'array, 'data, T, L, const N: isize> NdArrayView<'view, L>
    for InlineAccessor<'borrow, 'array, 'data, T, L, N>
where
    L: ValidField,
{
    fn array_view(&'view self) -> ArrayView<'view, L, IxDyn> {
        // Safety: while the array is borrowed nothing can be pushed or popped from it.
        let shape = into_shape(self);
        ArrayView::from_shape(shape, self.as_slice()).unwrap()
    }

    fn compatible_array_view<U>(&'view self) -> ArrayView<'view, U, IxDyn>
    where
        L: Compatible<U>,
    {
        let shape = into_shape(self);
        ArrayView::from_shape(shape, self.as_slice().compatible_cast()).unwrap()
    }
}

impl<'borrow: 'view, 'view, 'array, 'data, T, L, const N: isize> NdArrayViewMut<'view, L>
    for BitsAccessorMut<'borrow, 'array, 'data, T, L, N>
where
    L: ValidField + IsBits,
{
    fn array_view_mut(&'view mut self) -> ArrayViewMut<'view, L, IxDyn> {
        // Safety: while the array is borrowed nothing can be pushed or popped from it.
        let shape = into_shape(self);
        ArrayViewMut::from_shape(shape, self.as_mut_slice()).unwrap()
    }

    fn compatible_array_view_mut<U>(&'view mut self) -> ArrayViewMut<'view, U, IxDyn>
    where
        L: Compatible<U>,
    {
        // Safety: while the array is borrowed nothing can be pushed or popped from it.
        let shape = into_shape(self);
        ArrayViewMut::from_shape(shape, self.as_mut_slice().compatible_cast_mut()).unwrap()
    }
}

impl<'view, T> NdArrayView<'view, T> for CopiedArray<T> {
    fn array_view(&'view self) -> ArrayView<'view, T, IxDyn> {
        let shape = self.dimensions().as_slice().into_dimension().f();
        ArrayView::from_shape(shape, self.as_slice()).unwrap()
    }

    fn compatible_array_view<U>(&'view self) -> ArrayView<'view, U, IxDyn>
    where
        T: Compatible<U>,
    {
        let shape = self.dimensions().as_slice().into_dimension().f();
        ArrayView::from_shape(shape, self.as_slice().compatible_cast()).unwrap()
    }
}

impl<'view, T> NdArrayViewMut<'view, T> for CopiedArray<T> {
    fn array_view_mut(&'view mut self) -> ArrayViewMut<'view, T, IxDyn> {
        let shape = self.dimensions().as_slice().into_dimension().f();
        ArrayViewMut::from_shape(shape, self.as_mut_slice()).unwrap()
    }

    fn compatible_array_view_mut<U>(&'view mut self) -> ArrayViewMut<'view, U, IxDyn>
    where
        T: Compatible<U>,
    {
        let shape = self.dimensions().as_slice().into_dimension().f();
        ArrayViewMut::from_shape(shape, self.as_mut_slice().compatible_cast_mut()).unwrap()
    }
}

mod private {
    use crate::data::managed::array::data::{
        accessor::{BitsAccessor, BitsAccessorMut, InlineAccessor},
        copied::CopiedArray,
    };

    pub trait NdArrayPriv {}
    impl<'borrow, 'array, 'data, T, L, const N: isize> NdArrayPriv
        for InlineAccessor<'borrow, 'array, 'data, T, L, N>
    {
    }

    impl<'borrow, 'array, 'data, T, L, const N: isize> NdArrayPriv
        for BitsAccessor<'borrow, 'array, 'data, T, L, N>
    {
    }

    impl<'borrow, 'array, 'data, T, L, const N: isize> NdArrayPriv
        for BitsAccessorMut<'borrow, 'array, 'data, T, L, N>
    {
    }

    impl<T> NdArrayPriv for CopiedArray<T> {}
}