ndarrow 0.0.4

Zero-copy bridge between Apache Arrow and ndarray
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

//! Extension type registration and deserialization utilities.
//!
//! Arrow Rust does not provide a global extension-type registry. This module
//! provides ndarrow's explicit registry of supported extension handlers.

use arrow_schema::{
    Field,
    extension::{ExtensionType, FixedShapeTensor, VariableShapeTensor},
};

use crate::{
    complex::{Complex32Extension, Complex64Extension},
    error::NdarrowError,
    sparse::{CsrMatrixBatchExtension, CsrMatrixExtension},
    tensor::{parse_fixed_shape_extension, parse_variable_shape_extension},
};

/// A deserialized extension type supported by ndarrow.
#[derive(Debug, Clone, PartialEq)]
pub enum RegisteredExtension {
    /// `ndarrow.csr_matrix`
    CsrMatrix(CsrMatrixExtension),
    /// `ndarrow.csr_matrix_batch`
    CsrMatrixBatch(CsrMatrixBatchExtension),
    /// `arrow.fixed_shape_tensor`
    FixedShapeTensor(FixedShapeTensor),
    /// `arrow.variable_shape_tensor`
    VariableShapeTensor(VariableShapeTensor),
    /// `ndarrow.complex32`
    Complex32(Complex32Extension),
    /// `ndarrow.complex64`
    Complex64(Complex64Extension),
}

impl RegisteredExtension {
    /// Returns the extension type name.
    #[must_use]
    pub fn name(&self) -> &'static str {
        match self {
            Self::CsrMatrix(_) => CsrMatrixExtension::NAME,
            Self::CsrMatrixBatch(_) => CsrMatrixBatchExtension::NAME,
            Self::FixedShapeTensor(_) => FixedShapeTensor::NAME,
            Self::VariableShapeTensor(_) => VariableShapeTensor::NAME,
            Self::Complex32(_) => Complex32Extension::NAME,
            Self::Complex64(_) => Complex64Extension::NAME,
        }
    }
}

/// Returns the set of extension type names supported by ndarrow.
#[must_use]
pub fn registered_extension_names() -> &'static [&'static str] {
    &[
        CsrMatrixExtension::NAME,
        CsrMatrixBatchExtension::NAME,
        FixedShapeTensor::NAME,
        VariableShapeTensor::NAME,
        Complex32Extension::NAME,
        Complex64Extension::NAME,
    ]
}

/// Deserializes any supported extension type from a field.
///
/// This is ndarrow's explicit extension-handler registry for field-level
/// deserialization.
///
/// # Errors
///
/// Returns an error when:
/// - the field has no extension type name;
/// - the extension name is unknown to ndarrow;
/// - extension metadata/storage validation fails.
pub fn deserialize_registered_extension(
    field: &Field,
) -> Result<RegisteredExtension, NdarrowError> {
    let name = field.extension_type_name().ok_or_else(|| NdarrowError::InvalidMetadata {
        message: "field extension type name missing".to_owned(),
    })?;

    match name {
        CsrMatrixExtension::NAME => field
            .try_extension_type::<CsrMatrixExtension>()
            .map(RegisteredExtension::CsrMatrix)
            .map_err(NdarrowError::from),
        CsrMatrixBatchExtension::NAME => field
            .try_extension_type::<CsrMatrixBatchExtension>()
            .map(RegisteredExtension::CsrMatrixBatch)
            .map_err(NdarrowError::from),
        FixedShapeTensor::NAME => {
            parse_fixed_shape_extension(field).map(RegisteredExtension::FixedShapeTensor)
        }
        VariableShapeTensor::NAME => {
            parse_variable_shape_extension(field).map(RegisteredExtension::VariableShapeTensor)
        }
        Complex32Extension::NAME => field
            .try_extension_type::<Complex32Extension>()
            .map(RegisteredExtension::Complex32)
            .map_err(NdarrowError::from),
        Complex64Extension::NAME => field
            .try_extension_type::<Complex64Extension>()
            .map(RegisteredExtension::Complex64)
            .map_err(NdarrowError::from),
        other => Err(NdarrowError::InvalidMetadata {
            message: format!("unsupported extension type: {other}"),
        }),
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use arrow_schema::DataType;
    use ndarray::{ArrayD, IxDyn};

    use super::*;
    use crate::{
        sparse::{csr_batch_to_extension_array, csr_to_extension_array},
        tensor::arrays_to_variable_shape_tensor,
    };

    fn field_with_extension_name(name: &str, data_type: DataType) -> Field {
        let mut metadata = HashMap::new();
        metadata.insert("ARROW:extension:name".to_owned(), name.to_owned());
        Field::new("manual", data_type, false).with_metadata(metadata)
    }

    #[test]
    fn registered_extension_names_include_expected_entries() {
        let names = registered_extension_names();
        assert!(names.contains(&CsrMatrixExtension::NAME));
        assert!(names.contains(&CsrMatrixBatchExtension::NAME));
        assert!(names.contains(&FixedShapeTensor::NAME));
        assert!(names.contains(&VariableShapeTensor::NAME));
        assert!(names.contains(&Complex32Extension::NAME));
        assert!(names.contains(&Complex64Extension::NAME));
    }

    #[test]
    fn deserialize_registered_extension_rejects_missing_name() {
        let field = Field::new("no_ext", DataType::Float32, false);
        let err =
            deserialize_registered_extension(&field).expect_err("missing extension should fail");
        assert!(matches!(err, NdarrowError::InvalidMetadata { .. }));
    }

    #[test]
    fn deserialize_registered_extension_parses_complex32() {
        let data_type = DataType::new_fixed_size_list(DataType::Float32, 2, false);
        let mut field = Field::new("c32", data_type, false);
        field
            .try_with_extension_type(Complex32Extension)
            .expect("attaching complex32 extension should succeed");

        let extension = deserialize_registered_extension(&field)
            .expect("registered extension parsing should succeed");
        assert!(matches!(extension, RegisteredExtension::Complex32(_)));
        assert_eq!(extension.name(), Complex32Extension::NAME);
    }

    #[test]
    fn deserialize_registered_extension_parses_complex64() {
        let data_type = DataType::new_fixed_size_list(DataType::Float64, 2, false);
        let mut field = Field::new("c64", data_type, false);
        field
            .try_with_extension_type(Complex64Extension)
            .expect("attaching complex64 extension should succeed");

        let extension = deserialize_registered_extension(&field)
            .expect("registered extension parsing should succeed");
        assert!(matches!(extension, RegisteredExtension::Complex64(_)));
        assert_eq!(extension.name(), Complex64Extension::NAME);
    }

    #[test]
    fn deserialize_registered_extension_parses_fixed_shape_tensor() {
        let data_type = DataType::new_fixed_size_list(DataType::Float32, 2, false);
        let extension = FixedShapeTensor::try_new(DataType::Float32, vec![2], None, None)
            .expect("fixed-shape tensor extension creation should succeed");
        let field = Field::new("tensor", data_type, false).with_extension_type(extension);

        let parsed = deserialize_registered_extension(&field)
            .expect("registered extension parsing should succeed");
        assert!(matches!(parsed, RegisteredExtension::FixedShapeTensor(_)));
        assert_eq!(parsed.name(), FixedShapeTensor::NAME);
    }

    #[test]
    fn deserialize_registered_extension_parses_variable_shape_tensor() {
        let input = ArrayD::from_shape_vec(IxDyn(&[1, 2]), vec![1.0_f32, 2.0])
            .expect("array construction should succeed");
        let (field, _array) = arrays_to_variable_shape_tensor("ragged", vec![input], None)
            .expect("variable-shape tensor construction should succeed");

        let parsed = deserialize_registered_extension(&field)
            .expect("registered extension parsing should succeed");
        assert!(matches!(parsed, RegisteredExtension::VariableShapeTensor(_)));
        assert_eq!(parsed.name(), VariableShapeTensor::NAME);
    }

    #[test]
    fn deserialize_registered_extension_parses_csr_matrix() {
        let row_ptrs = vec![0_i32, 1_i32];
        let col_indices = vec![0_u32];
        let values = vec![1.0_f32];
        let (field, _array) = csr_to_extension_array("csr", 4, row_ptrs, col_indices, values)
            .expect("csr extension construction should succeed");

        let parsed = deserialize_registered_extension(&field)
            .expect("registered extension parsing should succeed");
        assert!(matches!(parsed, RegisteredExtension::CsrMatrix(_)));
        assert_eq!(parsed.name(), CsrMatrixExtension::NAME);
    }

    #[test]
    fn deserialize_registered_extension_parses_csr_matrix_batch() {
        let shapes = vec![[2_usize, 4_usize], [1_usize, 3_usize]];
        let row_ptrs = vec![vec![0_i32, 1_i32, 2_i32], vec![0_i32, 1_i32]];
        let col_indices = vec![vec![0_u32, 3_u32], vec![1_u32]];
        let values = vec![vec![1.0_f32, 2.0_f32], vec![3.0_f32]];
        let (field, _array) =
            csr_batch_to_extension_array("csr_batch", shapes, row_ptrs, col_indices, values)
                .expect("csr matrix batch construction should succeed");

        let parsed = deserialize_registered_extension(&field)
            .expect("registered extension parsing should succeed");
        assert!(matches!(parsed, RegisteredExtension::CsrMatrixBatch(_)));
        assert_eq!(parsed.name(), CsrMatrixBatchExtension::NAME);
    }

    #[test]
    fn deserialize_registered_extension_rejects_unknown_name() {
        let field = field_with_extension_name("ndarrow.unknown", DataType::Float32);
        let err =
            deserialize_registered_extension(&field).expect_err("unknown extension name must fail");
        assert!(matches!(err, NdarrowError::InvalidMetadata { .. }));
    }
}