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

//! Arrow adapters for dense iterative-solver workflows.

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

use super::{
    ArrowInteropError, complex64_vector_from_owned, complex64_vector_view, fixed_size_list_view,
    primitive_array_from_owned, primitive_array_view,
};

/// Solve an SPD `f32` system with conjugate gradient directly from Arrow dense inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or the solver fails.
pub fn conjugate_gradient_f32(
    matrix: &FixedSizeListArray,
    rhs: &PrimitiveArray<Float32Type>,
    config: &crate::ml::iterative::IterativeConfig<f32>,
) -> Result<PrimitiveArray<Float32Type>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let rhs_view = primitive_array_view(rhs)?;
    let output = crate::ml::iterative::conjugate_gradient_view(&matrix_view, &rhs_view, config)?;
    Ok(primitive_array_from_owned::<Float32Type>(output))
}

/// Solve an SPD `f64` system with conjugate gradient directly from Arrow dense inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or the solver fails.
pub fn conjugate_gradient_f64(
    matrix: &FixedSizeListArray,
    rhs: &PrimitiveArray<Float64Type>,
    config: &crate::ml::iterative::IterativeConfig<f64>,
) -> Result<PrimitiveArray<Float64Type>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let rhs_view = primitive_array_view(rhs)?;
    let output = crate::ml::iterative::conjugate_gradient_view(&matrix_view, &rhs_view, config)?;
    Ok(primitive_array_from_owned::<Float64Type>(output))
}

/// Solve a general `f32` system with GMRES directly from Arrow dense inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or the solver fails.
pub fn gmres_f32(
    matrix: &FixedSizeListArray,
    rhs: &PrimitiveArray<Float32Type>,
    config: &crate::ml::iterative::IterativeConfig<f32>,
) -> Result<PrimitiveArray<Float32Type>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float32Type>(matrix)?;
    let rhs_view = primitive_array_view(rhs)?;
    let output = crate::ml::iterative::gmres_view(&matrix_view, &rhs_view, config)?;
    Ok(primitive_array_from_owned::<Float32Type>(output))
}

/// Solve a general `f64` system with GMRES directly from Arrow dense inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or the solver fails.
pub fn gmres_f64(
    matrix: &FixedSizeListArray,
    rhs: &PrimitiveArray<Float64Type>,
    config: &crate::ml::iterative::IterativeConfig<f64>,
) -> Result<PrimitiveArray<Float64Type>, ArrowInteropError> {
    let matrix_view = fixed_size_list_view::<Float64Type>(matrix)?;
    let rhs_view = primitive_array_view(rhs)?;
    let output = crate::ml::iterative::gmres_view(&matrix_view, &rhs_view, config)?;
    Ok(primitive_array_from_owned::<Float64Type>(output))
}

/// Solve a complex SPD system with conjugate gradient directly from Arrow complex inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or the solver fails.
pub fn conjugate_gradient_complex(
    matrix: &FixedSizeListArray,
    rhs_field: &Field,
    rhs: &FixedSizeListArray,
    config: &crate::ml::iterative::IterativeConfig<f64>,
) -> Result<(Field, FixedSizeListArray), ArrowInteropError> {
    let matrix_view = super::complex64_matrix_view(matrix)?;
    let rhs_view = complex64_vector_view(rhs_field, rhs)?;
    let output =
        crate::ml::iterative::conjugate_gradient_complex_view(&matrix_view, &rhs_view, config)?;
    complex64_vector_from_owned("cg_complex", output)
}

/// Solve a general complex system with GMRES directly from Arrow complex inputs.
///
/// # Errors
/// Returns an error when inputs contain nulls, are empty, or the solver fails.
pub fn gmres_complex(
    matrix: &FixedSizeListArray,
    rhs_field: &Field,
    rhs: &FixedSizeListArray,
    config: &crate::ml::iterative::IterativeConfig<f64>,
) -> Result<(Field, FixedSizeListArray), ArrowInteropError> {
    let matrix_view = super::complex64_matrix_view(matrix)?;
    let rhs_view = complex64_vector_view(rhs_field, rhs)?;
    let output = crate::ml::iterative::gmres_complex_view(&matrix_view, &rhs_view, config)?;
    complex64_vector_from_owned("gmres_complex", output)
}