nabled 0.0.8

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

//! Arrow adapters for singular value decomposition workflows.

use arrow_array::FixedSizeListArray;
use arrow_array::types::{Float32Type, Float64Type};

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

/// Compute `f32` SVD directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_f32(
    matrix: &FixedSizeListArray,
) -> Result<crate::linalg::svd::NdarraySVD<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::svd::decompose_view(&matrix_view)?)
}

/// Compute `f64` SVD directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_f64(
    matrix: &FixedSizeListArray,
) -> Result<crate::linalg::svd::NdarraySVD<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::svd::decompose_view(&matrix_view)?)
}

/// Compute truncated `f32` SVD directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_truncated_f32(
    matrix: &FixedSizeListArray,
    k: usize,
) -> Result<crate::linalg::svd::NdarraySVD<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::svd::decompose_truncated_view(&matrix_view, k)?)
}

/// Compute truncated `f64` SVD directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_truncated_f64(
    matrix: &FixedSizeListArray,
    k: usize,
) -> Result<crate::linalg::svd::NdarraySVD<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::svd::decompose_truncated_view(&matrix_view, k)?)
}

/// Compute `f32` SVD with tolerance directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_with_tolerance_f32(
    matrix: &FixedSizeListArray,
    tolerance: f32,
) -> Result<crate::linalg::svd::NdarraySVD<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::svd::decompose_with_tolerance_view(&matrix_view, tolerance)?)
}

/// Compute `f64` SVD with tolerance directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_with_tolerance_f64(
    matrix: &FixedSizeListArray,
    tolerance: f64,
) -> Result<crate::linalg::svd::NdarraySVD<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::svd::decompose_with_tolerance_view(&matrix_view, tolerance)?)
}

/// Compute the `f32` pseudo-inverse directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn pseudo_inverse_f32(
    matrix: &FixedSizeListArray,
    config: crate::linalg::svd::PseudoInverseConfig<f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let output = crate::linalg::svd::pseudo_inverse_view(&matrix_view, &config)?;
    fixed_size_list_from_owned::<Float32Type>(output)
}

/// Compute the `f64` pseudo-inverse directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn pseudo_inverse_f64(
    matrix: &FixedSizeListArray,
    config: crate::linalg::svd::PseudoInverseConfig<f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let output = crate::linalg::svd::pseudo_inverse_view(&matrix_view, &config)?;
    fixed_size_list_from_owned::<Float64Type>(output)
}

/// Compute the `f32` null space directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn null_space_f32(
    matrix: &FixedSizeListArray,
    tolerance: Option<f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let output = crate::linalg::svd::null_space_view(&matrix_view, tolerance)?;
    fixed_size_list_from_owned::<Float32Type>(output)
}

/// Compute the `f64` null space directly from an Arrow dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn null_space_f64(
    matrix: &FixedSizeListArray,
    tolerance: Option<f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let output = crate::linalg::svd::null_space_view(&matrix_view, tolerance)?;
    fixed_size_list_from_owned::<Float64Type>(output)
}

/// Compute complex SVD directly from an Arrow complex dense matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_complex(
    matrix: &FixedSizeListArray,
) -> Result<crate::linalg::svd::NdarrayComplexSVD, ArrowInteropError> {
    let matrix_view = complex64_matrix_view(matrix)?;
    Ok(crate::linalg::svd::decompose_complex_view(&matrix_view)?)
}

/// Reconstruct a dense `f32` matrix from an ndarray-native SVD result into Arrow form.
///
/// # Errors
/// Returns an error when the reconstructed matrix cannot be represented as Arrow dense data.
pub fn reconstruct_f32(
    svd: &crate::linalg::svd::NdarraySVD<f32>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    fixed_size_list_from_owned::<Float32Type>(crate::linalg::svd::reconstruct_matrix(svd))
}

/// Reconstruct a dense `f64` matrix from an ndarray-native SVD result into Arrow form.
///
/// # Errors
/// Returns an error when the reconstructed matrix cannot be represented as Arrow dense data.
pub fn reconstruct_f64(
    svd: &crate::linalg::svd::NdarraySVD<f64>,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    fixed_size_list_from_owned::<Float64Type>(crate::linalg::svd::reconstruct_matrix(svd))
}

/// Reconstruct a dense complex matrix from an ndarray-native SVD result into Arrow form.
///
/// # Errors
/// Returns an error when the reconstructed matrix cannot be represented as Arrow dense data.
pub fn reconstruct_complex(
    svd: &crate::linalg::svd::NdarrayComplexSVD,
) -> Result<FixedSizeListArray, ArrowInteropError> {
    complex64_matrix_from_owned(crate::linalg::svd::reconstruct_matrix_complex(svd))
}

/// Compute the condition number from an ndarray-native real SVD result.
pub fn condition_number<T: nabled_core::scalar::NabledReal>(
    svd: &crate::linalg::svd::NdarraySVD<T>,
) -> T {
    crate::linalg::svd::condition_number(svd)
}

/// Compute the numerical rank from an ndarray-native real SVD result.
pub fn rank<T: nabled_core::scalar::NabledReal>(
    svd: &crate::linalg::svd::NdarraySVD<T>,
    tolerance: Option<T>,
) -> usize {
    crate::linalg::svd::rank(svd, tolerance)
}