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

//! Arrow adapters for eigenvalue decomposition workflows.

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

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

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

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

/// Compute generalized `f32` eigen decomposition directly from Arrow dense matrices.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or eigendecomposition fails.
pub fn generalized_f32(
    matrix_a: &FixedSizeListArray,
    matrix_b: &FixedSizeListArray,
) -> Result<crate::linalg::eigen::NdarrayGeneralizedEigenResult<f32>, ArrowInteropError> {
    let left_view = fixed_size_list_view::<Float32Type>(matrix_a)?;
    let right_view = fixed_size_list_view::<Float32Type>(matrix_b)?;
    Ok(crate::linalg::eigen::generalized_view(&left_view, &right_view)?)
}

/// Compute generalized `f64` eigen decomposition directly from Arrow dense matrices.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or eigendecomposition fails.
pub fn generalized_f64(
    matrix_a: &FixedSizeListArray,
    matrix_b: &FixedSizeListArray,
) -> Result<crate::linalg::eigen::NdarrayGeneralizedEigenResult<f64>, ArrowInteropError> {
    let left_view = fixed_size_list_view::<Float64Type>(matrix_a)?;
    let right_view = fixed_size_list_view::<Float64Type>(matrix_b)?;
    Ok(crate::linalg::eigen::generalized_view(&left_view, &right_view)?)
}

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

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

/// Balance a non-symmetric `f32` matrix directly from Arrow dense storage.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or balancing fails.
pub fn balance_nonsymmetric_f32(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::eigen::NonsymmetricEigenConfig<f32>,
) -> Result<(FixedSizeListArray, PrimitiveArray<Float32Type>), ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let (balanced, diagonal) =
        crate::linalg::eigen::balance_nonsymmetric_view(&matrix_view, config)?;
    Ok((
        fixed_size_list_from_owned::<Float32Type>(balanced)?,
        primitive_array_from_owned::<Float32Type>(diagonal),
    ))
}

/// Balance a non-symmetric `f64` matrix directly from Arrow dense storage.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or balancing fails.
pub fn balance_nonsymmetric_f64(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::eigen::NonsymmetricEigenConfig<f64>,
) -> Result<(FixedSizeListArray, PrimitiveArray<Float64Type>), ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let (balanced, diagonal) =
        crate::linalg::eigen::balance_nonsymmetric_view(&matrix_view, config)?;
    Ok((
        fixed_size_list_from_owned::<Float64Type>(balanced)?,
        primitive_array_from_owned::<Float64Type>(diagonal),
    ))
}

/// Compute matched left/right non-symmetric `f32` eigenvectors directly from an Arrow matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or eigendecomposition fails.
pub fn nonsymmetric_bi_f32(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::eigen::NonsymmetricEigenConfig<f32>,
) -> Result<crate::linalg::eigen::NdarrayNonsymmetricBiEigenResult<f32>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    Ok(crate::linalg::eigen::nonsymmetric_bi_view(&matrix_view, config)?)
}

/// Compute matched left/right non-symmetric `f64` eigenvectors directly from an Arrow matrix.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or eigendecomposition fails.
pub fn nonsymmetric_bi_f64(
    matrix: &FixedSizeListArray,
    config: &crate::linalg::eigen::NonsymmetricEigenConfig<f64>,
) -> Result<crate::linalg::eigen::NdarrayNonsymmetricBiEigenResult<f64>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    Ok(crate::linalg::eigen::nonsymmetric_bi_view(&matrix_view, config)?)
}

/// Compute complex non-symmetric eigen decomposition directly from Arrow complex dense input.
///
/// # Errors
/// Returns an error when the matrix contains nulls, is empty, or eigendecomposition fails.
pub fn nonsymmetric_complex(
    matrix: &FixedSizeListArray,
) -> Result<crate::linalg::eigen::NdarrayNonsymmetricEigenResult<f64>, ArrowInteropError> {
    let matrix_view = complex64_matrix_view(matrix)?;
    Ok(crate::linalg::eigen::nonsymmetric_complex_view(&matrix_view)?)
}