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

//! Arrow adapters for QR decomposition workflows.

use arrow_array::types::{Float32Type, Float64Type};
use arrow_array::{FixedSizeListArray, PrimitiveArray};
use num_complex::Complex64;

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

/// Compute `f32` QR decomposition directly from an Arrow dense matrix.
///
/// The inbound Arrow -> ndarray bridge is zero-copy. The decomposition result remains in
/// `nabled`'s ndarray-native result struct.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_f32(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::qr::QRConfig<f32>,
) -> Result<crate::linalg::qr::QRResult<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::qr::decompose_view(&matrix_view, config)?)
}

/// Compute `f64` QR decomposition directly from an Arrow dense matrix.
///
/// The inbound Arrow -> ndarray bridge is zero-copy. The decomposition result remains in
/// `nabled`'s ndarray-native result struct.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_f64(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::qr::QRConfig<f64>,
) -> Result<crate::linalg::qr::QRResult<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::qr::decompose_view(&matrix_view, config)?)
}

/// Solve `f32` least-squares directly from Arrow dense inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or dimensions mismatch.
pub fn solve_least_squares_f32(
    matrix: &FixedSizeListArray,
    rhs: &PrimitiveArray<Float32Type>,
    config: &crate::linalg::qr::QRConfig<f32>,
) -> Result<PrimitiveArray<Float32Type>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let rhs_view = primitive_array_view(rhs)?;
    let output = crate::linalg::qr::solve_least_squares_view(&matrix_view, &rhs_view, config)?;
    Ok(primitive_array_from_owned::<Float32Type>(output))
}

/// Solve `f64` least-squares directly from Arrow dense inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or dimensions mismatch.
pub fn solve_least_squares_f64(
    matrix: &FixedSizeListArray,
    rhs: &PrimitiveArray<Float64Type>,
    config: &crate::linalg::qr::QRConfig<f64>,
) -> Result<PrimitiveArray<Float64Type>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let rhs_view = primitive_array_view(rhs)?;
    let output = crate::linalg::qr::solve_least_squares_view(&matrix_view, &rhs_view, config)?;
    Ok(primitive_array_from_owned::<Float64Type>(output))
}

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

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

/// Compute reduced `f32` QR decomposition directly from Arrow dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_reduced_f32(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::qr::QRConfig<f32>,
) -> Result<crate::linalg::qr::QRResult<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::qr::decompose_reduced_view(&matrix_view, config)?)
}

/// Compute reduced `f64` QR decomposition directly from Arrow dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_reduced_f64(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::qr::QRConfig<f64>,
) -> Result<crate::linalg::qr::QRResult<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::qr::decompose_reduced_view(&matrix_view, config)?)
}

/// Compute column-pivoted `f32` QR decomposition directly from Arrow dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_with_pivoting_f32(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::qr::QRConfig<f32>,
) -> Result<crate::linalg::qr::QRResult<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::qr::decompose_with_pivoting_view(&matrix_view, config)?)
}

/// Compute column-pivoted `f64` QR decomposition directly from Arrow dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or decomposition fails.
pub fn decompose_with_pivoting_f64(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::qr::QRConfig<f64>,
) -> Result<crate::linalg::qr::QRResult<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::qr::decompose_with_pivoting_view(&matrix_view, config)?)
}

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

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

/// Compute a QR-based condition number estimate from an ndarray-native result.
pub fn condition_number<T: nabled_core::scalar::NabledReal>(
    qr: &crate::linalg::qr::QRResult<T>,
) -> T {
    crate::linalg::qr::condition_number(qr)
}