tenferro-linalg 0.3.0

Linear algebra traced APIs, eager helpers, extension runtime, and optional AD rules for tenferro.
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

use tenferro_tensor::DType;

use crate::extension::{EighGauge, QrGauge, SvdGauge, DEFAULT_DECOMPOSITION_DERIVATIVE_EPS};

use super::*;

#[test]
fn manifest_internal_mapping_covers_linalg_op_variants() {
    let samples = [
        (LinalgOp::Cholesky, LinalgAdOpKind::Cholesky),
        (LinalgOp::Lu, LinalgAdOpKind::Lu),
        (LinalgOp::LuFactor, LinalgAdOpKind::LuFactor),
        (
            LinalgOp::LuSolvePrepared {
                transpose_a: false,
                conjugate_a: false,
            },
            LinalgAdOpKind::LuSolvePrepared,
        ),
        (LinalgOp::FullPivLu, LinalgAdOpKind::FullPivLu),
        (
            LinalgOp::FullPivLuSolve { transpose_a: false },
            LinalgAdOpKind::FullPivLuSolve,
        ),
        (
            LinalgOp::Svd {
                derivative_eps: DEFAULT_DECOMPOSITION_DERIVATIVE_EPS,
                gauge: SvdGauge::Raw,
            },
            LinalgAdOpKind::Svd,
        ),
        (
            LinalgOp::SvdVals {
                derivative_eps: DEFAULT_DECOMPOSITION_DERIVATIVE_EPS,
            },
            LinalgAdOpKind::SvdVals,
        ),
        (LinalgOp::SvdFull, LinalgAdOpKind::SvdFull),
        (
            LinalgOp::Qr {
                gauge: QrGauge::Raw,
            },
            LinalgAdOpKind::Qr,
        ),
        (
            LinalgOp::Eigh {
                derivative_eps: DEFAULT_DECOMPOSITION_DERIVATIVE_EPS,
                gauge: EighGauge::Raw,
            },
            LinalgAdOpKind::Eigh,
        ),
        (
            LinalgOp::EighVals {
                derivative_eps: DEFAULT_DECOMPOSITION_DERIVATIVE_EPS,
            },
            LinalgAdOpKind::EighVals,
        ),
        (
            LinalgOp::Eig {
                input_dtype: DType::F64,
            },
            LinalgAdOpKind::Eig,
        ),
        (
            LinalgOp::EigVals {
                input_dtype: DType::F64,
            },
            LinalgAdOpKind::EigVals,
        ),
        (
            LinalgOp::TriangularSolve {
                left_side: true,
                lower: true,
                transpose_a: false,
                unit_diagonal: false,
            },
            LinalgAdOpKind::TriangularSolve,
        ),
    ];

    for (op, kind) in samples {
        assert_eq!(linalg_ad_support_for_op(op).kind, kind);
    }
}

#[test]
fn helper_routes_cover_all_rule_statuses() {
    let supported_statuses = [
        LinalgAdRuleSupport::Supported,
        LinalgAdRuleSupport::SupportedViaLinearize,
        LinalgAdRuleSupport::PartiallySupported,
    ];
    for status in supported_statuses {
        assert_eq!(jvp_route(status), LinalgAdRoute::Linearize);
        assert_eq!(mode(status, jvp_route(status)).status, status);
    }

    let inactive_statuses = [
        LinalgAdRuleSupport::Unsupported,
        LinalgAdRuleSupport::NonDifferentiable,
        LinalgAdRuleSupport::PendingOracle,
    ];
    for status in inactive_statuses {
        assert_eq!(jvp_route(status), LinalgAdRoute::Unsupported);
        assert_eq!(
            mode(status, jvp_route(status)).route,
            LinalgAdRoute::Unsupported
        );
    }
}

#[test]
fn support_entry_helper_preserves_manifest_fields() {
    static OUTPUTS: [LinalgAdOutputSupport; 1] = [output(
        0,
        "solution",
        LinalgAdRuleSupport::SupportedViaLinearize,
    )];
    static CAVEATS: [&str; 1] = ["test caveat"];

    let vjp = mode(
        LinalgAdRuleSupport::SupportedViaLinearize,
        LinalgAdRoute::LinearizeThenCustomLinearTranspose,
    );
    let entry = support_entry(
        LinalgAdOpKind::TriangularSolve,
        LinalgAdRuleSupport::SupportedViaLinearize,
        LinalgAdRuleSupport::Supported,
        vjp,
        LinalgAdRuleSupport::Supported,
        &OUTPUTS,
        &CAVEATS,
    );

    assert_eq!(entry.kind, LinalgAdOpKind::TriangularSolve);
    assert_eq!(entry.jvp.status, LinalgAdRuleSupport::SupportedViaLinearize);
    assert_eq!(entry.jvp.route, LinalgAdRoute::Linearize);
    assert_eq!(entry.vjp, vjp);
    assert_eq!(
        entry.linearize_rule,
        LinalgAdRuleSupport::SupportedViaLinearize
    );
    assert_eq!(entry.custom_vjp_rule, LinalgAdRuleSupport::Unsupported);
    assert_eq!(
        entry.custom_linear_transpose_rule,
        LinalgAdRuleSupport::Supported
    );
    assert_eq!(entry.linearize, LinalgAdRuleSupport::SupportedViaLinearize);
    assert_eq!(entry.transpose, LinalgAdRuleSupport::Supported);
    assert_eq!(entry.outputs, &OUTPUTS);
    assert_eq!(entry.caveats, &CAVEATS);
}