ferray-core 0.2.8

N-dimensional array type and foundational primitives for ferray
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

// ferray-core: AsRawBuffer trait for zero-copy interop (REQ-29)

use crate::dimension::Dimension;
use crate::dtype::{DType, Element};

use crate::array::arc::ArcArray;
use crate::array::owned::Array;
use crate::array::view::ArrayView;

/// Trait exposing the raw memory layout of an array for zero-copy interop.
///
/// Implementors provide enough information for foreign code (C, Python/NumPy,
/// Arrow, etc.) to read the array data without copying.
pub trait AsRawBuffer {
    /// Raw pointer to the first element.
    fn raw_ptr(&self) -> *const u8;

    /// Shape as a slice of dimension sizes.
    fn raw_shape(&self) -> &[usize];

    /// Strides in bytes (not elements).
    fn raw_strides_bytes(&self) -> Vec<isize>;

    /// Runtime dtype descriptor.
    fn raw_dtype(&self) -> DType;

    /// Whether the data is C-contiguous.
    fn is_c_contiguous(&self) -> bool;

    /// Whether the data is Fortran-contiguous.
    fn is_f_contiguous(&self) -> bool;
}

impl<T: Element, D: Dimension> AsRawBuffer for Array<T, D> {
    fn raw_ptr(&self) -> *const u8 {
        self.as_ptr() as *const u8
    }

    fn raw_shape(&self) -> &[usize] {
        self.shape()
    }

    fn raw_strides_bytes(&self) -> Vec<isize> {
        let itemsize = std::mem::size_of::<T>() as isize;
        self.strides().iter().map(|&s| s * itemsize).collect()
    }

    fn raw_dtype(&self) -> DType {
        T::dtype()
    }

    fn is_c_contiguous(&self) -> bool {
        self.layout().is_c_contiguous()
    }

    fn is_f_contiguous(&self) -> bool {
        self.layout().is_f_contiguous()
    }
}

impl<T: Element, D: Dimension> AsRawBuffer for ArrayView<'_, T, D> {
    fn raw_ptr(&self) -> *const u8 {
        self.as_ptr() as *const u8
    }

    fn raw_shape(&self) -> &[usize] {
        self.shape()
    }

    fn raw_strides_bytes(&self) -> Vec<isize> {
        let itemsize = std::mem::size_of::<T>() as isize;
        self.strides().iter().map(|&s| s * itemsize).collect()
    }

    fn raw_dtype(&self) -> DType {
        T::dtype()
    }

    fn is_c_contiguous(&self) -> bool {
        self.layout().is_c_contiguous()
    }

    fn is_f_contiguous(&self) -> bool {
        self.layout().is_f_contiguous()
    }
}

impl<T: Element, D: Dimension> AsRawBuffer for ArcArray<T, D> {
    fn raw_ptr(&self) -> *const u8 {
        self.as_ptr() as *const u8
    }

    fn raw_shape(&self) -> &[usize] {
        self.shape()
    }

    fn raw_strides_bytes(&self) -> Vec<isize> {
        let itemsize = std::mem::size_of::<T>() as isize;
        self.strides().iter().map(|&s| s * itemsize).collect()
    }

    fn raw_dtype(&self) -> DType {
        T::dtype()
    }

    fn is_c_contiguous(&self) -> bool {
        self.layout().is_c_contiguous()
    }

    fn is_f_contiguous(&self) -> bool {
        self.layout().is_f_contiguous()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::dimension::Ix2;

    #[test]
    fn raw_buffer_array() {
        let arr = Array::<f64, Ix2>::from_vec(Ix2::new([2, 3]), vec![1.0, 2.0, 3.0, 4.0, 5.0, 6.0])
            .unwrap();

        assert_eq!(arr.raw_shape(), &[2, 3]);
        assert_eq!(arr.raw_dtype(), DType::F64);
        assert!(arr.is_c_contiguous());
        assert!(!arr.raw_ptr().is_null());

        // Strides in bytes: row stride = 3*8=24, col stride = 8
        let strides = arr.raw_strides_bytes();
        assert_eq!(strides, vec![24, 8]);
    }

    #[test]
    fn raw_buffer_view() {
        let arr = Array::<f32, Ix2>::from_vec(Ix2::new([2, 2]), vec![1.0, 2.0, 3.0, 4.0]).unwrap();
        let v = arr.view();

        assert_eq!(v.raw_dtype(), DType::F32);
        assert_eq!(v.raw_shape(), &[2, 2]);
        assert!(v.is_c_contiguous());
    }

    #[test]
    fn raw_buffer_arc() {
        let arr = Array::<i32, Ix2>::from_vec(Ix2::new([2, 2]), vec![1, 2, 3, 4]).unwrap();
        let arc = ArcArray::from_owned(arr);

        assert_eq!(arc.raw_dtype(), DType::I32);
        assert_eq!(arc.raw_shape(), &[2, 2]);
    }
}