nabled 0.0.11

A linear algebra library written in Rust with an ndarray-first architecture.
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

//! Arrow adapters for PCA workflows.

use arrow_array::FixedSizeListArray;
use arrow_array::types::{Float32Type, Float64Type};
use ndarray::{ArrayView1, ArrayView2};
use num_complex::Complex64;

use super::{
    ArrowInteropError, complex64_matrix_from_owned, complex64_matrix_view,
    fixed_size_list_from_owned, fixed_size_list_view,
};

/// Compute `f32` PCA directly from Arrow dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or PCA fails.
pub fn compute_f32(
    matrix: &FixedSizeListArray,
    n_components: Option<usize>,
) -> Result<crate::ml::pca::NdarrayPCAResult<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::ml::pca::compute_pca_view(&matrix_view, n_components)?)
}

/// Compute `f64` PCA directly from Arrow dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or PCA fails.
pub fn compute_f64(
    matrix: &FixedSizeListArray,
    n_components: Option<usize>,
) -> Result<crate::ml::pca::NdarrayPCAResult<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::ml::pca::compute_pca_view(&matrix_view, n_components)?)
}

/// Project `f32` Arrow dense data into PCA score space.
///
/// # Errors
/// Returns an error when the matrix contains nulls or shape conversion fails.
pub fn transform_f32(
    matrix: &FixedSizeListArray,
    pca: &crate::ml::pca::NdarrayPCAResult<f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    transform_f32_from_components_view(matrix, &pca.components.view(), &pca.mean.view())
}

/// Project `f32` Arrow dense data into PCA score space using borrowed PCA factors.
///
/// # Errors
/// Returns an error when the matrix contains nulls or shape conversion fails.
pub fn transform_f32_from_components_view(
    matrix: &FixedSizeListArray,
    components: &ArrayView2<'_, f32>,
    mean: &ArrayView1<'_, f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let output = crate::ml::pca::transform_from_components_view(&matrix_view, components, mean)?;
    fixed_size_list_from_owned::<Float32Type>(output)
}

/// Project `f64` Arrow dense data into PCA score space.
///
/// # Errors
/// Returns an error when the matrix contains nulls or shape conversion fails.
pub fn transform_f64(
    matrix: &FixedSizeListArray,
    pca: &crate::ml::pca::NdarrayPCAResult<f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    transform_f64_from_components_view(matrix, &pca.components.view(), &pca.mean.view())
}

/// Project `f64` Arrow dense data into PCA score space using borrowed PCA factors.
///
/// # Errors
/// Returns an error when the matrix contains nulls or shape conversion fails.
pub fn transform_f64_from_components_view(
    matrix: &FixedSizeListArray,
    components: &ArrayView2<'_, f64>,
    mean: &ArrayView1<'_, f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let output = crate::ml::pca::transform_from_components_view(&matrix_view, components, mean)?;
    fixed_size_list_from_owned::<Float64Type>(output)
}

/// Reconstruct `f32` Arrow dense data from PCA scores.
///
/// # Errors
/// Returns an error when the score matrix contains nulls or shape conversion fails.
pub fn inverse_transform_f32(
    scores: &FixedSizeListArray,
    pca: &crate::ml::pca::NdarrayPCAResult<f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    inverse_transform_f32_from_components_view(scores, &pca.components.view(), &pca.mean.view())
}

/// Reconstruct `f32` Arrow dense data from PCA scores using borrowed PCA factors.
///
/// # Errors
/// Returns an error when the score matrix contains nulls or shape conversion fails.
pub fn inverse_transform_f32_from_components_view(
    scores: &FixedSizeListArray,
    components: &ArrayView2<'_, f32>,
    mean: &ArrayView1<'_, f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let score_view = fixed_size_list_view::<Float32Type>(scores)?;
    let output =
        crate::ml::pca::inverse_transform_from_components_view(&score_view, components, mean)?;
    fixed_size_list_from_owned::<Float32Type>(output)
}

/// Reconstruct `f64` Arrow dense data from PCA scores.
///
/// # Errors
/// Returns an error when the score matrix contains nulls or shape conversion fails.
pub fn inverse_transform_f64(
    scores: &FixedSizeListArray,
    pca: &crate::ml::pca::NdarrayPCAResult<f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    inverse_transform_f64_from_components_view(scores, &pca.components.view(), &pca.mean.view())
}

/// Reconstruct `f64` Arrow dense data from PCA scores using borrowed PCA factors.
///
/// # Errors
/// Returns an error when the score matrix contains nulls or shape conversion fails.
pub fn inverse_transform_f64_from_components_view(
    scores: &FixedSizeListArray,
    components: &ArrayView2<'_, f64>,
    mean: &ArrayView1<'_, f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let score_view = fixed_size_list_view::<Float64Type>(scores)?;
    let output =
        crate::ml::pca::inverse_transform_from_components_view(&score_view, components, mean)?;
    fixed_size_list_from_owned::<Float64Type>(output)
}

/// Compute complex PCA directly from Arrow complex dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or PCA fails.
pub fn compute_complex(
    matrix: &FixedSizeListArray,
    n_components: Option<usize>,
) -> Result<crate::ml::pca::NdarrayComplexPCAResult, ArrowInteropError> {
    let matrix_view = complex64_matrix_view(matrix)?;
    Ok(crate::ml::pca::compute_pca_complex_view(&matrix_view, n_components)?)
}

/// Project complex Arrow dense data into PCA score space.
///
/// # Errors
/// Returns an error when the matrix contains nulls or shape conversion fails.
pub fn transform_complex(
    matrix: &FixedSizeListArray,
    pca: &crate::ml::pca::NdarrayComplexPCAResult,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    transform_complex_from_components_view(matrix, &pca.components.view(), &pca.mean.view())
}

/// Project complex Arrow dense data into PCA score space using borrowed PCA factors.
///
/// # Errors
/// Returns an error when the matrix contains nulls or shape conversion fails.
pub fn transform_complex_from_components_view(
    matrix: &FixedSizeListArray,
    components: &ArrayView2<'_, Complex64>,
    mean: &ArrayView1<'_, Complex64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = complex64_matrix_view(matrix)?;
    complex64_matrix_from_owned(crate::ml::pca::transform_complex_from_components_view(
        &matrix_view,
        components,
        mean,
    )?)
}

/// Reconstruct complex Arrow dense data from PCA scores.
///
/// # Errors
/// Returns an error when the score matrix contains nulls or shape conversion fails.
pub fn inverse_transform_complex(
    scores: &FixedSizeListArray,
    pca: &crate::ml::pca::NdarrayComplexPCAResult,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    inverse_transform_complex_from_components_view(scores, &pca.components.view(), &pca.mean.view())
}

/// Reconstruct complex Arrow dense data from PCA scores using borrowed PCA factors.
///
/// # Errors
/// Returns an error when the score matrix contains nulls or shape conversion fails.
pub fn inverse_transform_complex_from_components_view(
    scores: &FixedSizeListArray,
    components: &ArrayView2<'_, Complex64>,
    mean: &ArrayView1<'_, Complex64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let score_view = complex64_matrix_view(scores)?;
    complex64_matrix_from_owned(crate::ml::pca::inverse_transform_complex_from_components_view(
        &score_view,
        components,
        mean,
    )?)
}