Skip to main content

tenferro_ops/primitive_rules/
residual_spec.rs

1use super::ResidualSpec;
2use crate::std_tensor_op::StdTensorOp;
3use tenferro_core_ops::PrimitiveOpKind;
4
5/// Return the tensor retention declaration for a core primitive.
6/// Extension declarations remain owned by their context's rule set.
7///
8/// # Examples
9///
10/// ```
11/// use tenferro_ops::{ad::primitive_residual_spec, std_tensor_op::StdTensorOp};
12/// assert!(primitive_residual_spec(&StdTensorOp::Add).unwrap().is_empty());
13/// ```
14pub fn primitive_residual_spec(op: &StdTensorOp) -> Option<ResidualSpec> {
15    op.primitive_kind().map(residual_spec_for_kind)
16}
17
18// These retention declarations are shared metadata, not differentiation rules.
19pub(super) fn residual_spec_for_kind(kind: PrimitiveOpKind) -> ResidualSpec {
20    match kind {
21        PrimitiveOpKind::Add => ResidualSpec::none(),
22        PrimitiveOpKind::Sub => ResidualSpec::none(),
23        PrimitiveOpKind::Mul => ResidualSpec::all_inputs(),
24        PrimitiveOpKind::Neg => ResidualSpec::none(),
25        PrimitiveOpKind::Conj => ResidualSpec::none(),
26        PrimitiveOpKind::Div => ResidualSpec::all_inputs(),
27        PrimitiveOpKind::Rem => ResidualSpec::none(),
28        PrimitiveOpKind::Abs => ResidualSpec::input(0),
29        PrimitiveOpKind::Sign => ResidualSpec::none(),
30        PrimitiveOpKind::Maximum => ResidualSpec::all_inputs(),
31        PrimitiveOpKind::Minimum => ResidualSpec::all_inputs(),
32        PrimitiveOpKind::Compare => ResidualSpec::none(),
33        PrimitiveOpKind::Select => ResidualSpec::input(0),
34        PrimitiveOpKind::Clamp => ResidualSpec::all_inputs(),
35        PrimitiveOpKind::Exp => ResidualSpec::input(0),
36        PrimitiveOpKind::Log => ResidualSpec::input(0),
37        PrimitiveOpKind::Sin => ResidualSpec::input(0),
38        PrimitiveOpKind::Cos => ResidualSpec::input(0),
39        PrimitiveOpKind::Tanh => ResidualSpec::input(0),
40        PrimitiveOpKind::Sqrt => ResidualSpec::input(0),
41        PrimitiveOpKind::Rsqrt => ResidualSpec::input(0),
42        PrimitiveOpKind::Pow => ResidualSpec::all_inputs(),
43        PrimitiveOpKind::Expm1 => ResidualSpec::input(0),
44        PrimitiveOpKind::Log1p => ResidualSpec::input(0),
45        PrimitiveOpKind::Erf => ResidualSpec::input(0),
46        PrimitiveOpKind::DotGeneral => ResidualSpec::all_inputs(),
47        PrimitiveOpKind::ReduceSum => ResidualSpec::input(0),
48        PrimitiveOpKind::ReduceSumSquares => ResidualSpec::input(0),
49        PrimitiveOpKind::ReduceProd => ResidualSpec::input(0),
50        PrimitiveOpKind::ReduceMax => ResidualSpec::input(0),
51        PrimitiveOpKind::ReduceMin => ResidualSpec::input(0),
52        PrimitiveOpKind::Transpose => ResidualSpec::none(),
53        PrimitiveOpKind::Reshape => ResidualSpec::input(0),
54        PrimitiveOpKind::BroadcastInDim => ResidualSpec::input(0),
55        PrimitiveOpKind::Convert => ResidualSpec::none(),
56        PrimitiveOpKind::ExtractDiag => ResidualSpec::input(0),
57        PrimitiveOpKind::EmbedDiag => ResidualSpec::none(),
58        PrimitiveOpKind::Tril => ResidualSpec::none(),
59        PrimitiveOpKind::Triu => ResidualSpec::none(),
60        PrimitiveOpKind::Gather => ResidualSpec::all_inputs(),
61        PrimitiveOpKind::GatherDynamicSliceSizes => ResidualSpec::all_inputs(),
62        PrimitiveOpKind::Scatter => ResidualSpec::all_inputs(),
63        PrimitiveOpKind::Slice => ResidualSpec::input(0),
64        PrimitiveOpKind::DynamicSlice => ResidualSpec::all_inputs(),
65        PrimitiveOpKind::DynamicUpdateSlice => ResidualSpec::all_inputs(),
66        PrimitiveOpKind::Pad => ResidualSpec::input(0),
67        PrimitiveOpKind::Concatenate => ResidualSpec::all_inputs(),
68        PrimitiveOpKind::Reverse => ResidualSpec::none(),
69        PrimitiveOpKind::ShapeOf => ResidualSpec::none(),
70        PrimitiveOpKind::DynamicTruncate => ResidualSpec::all_inputs(),
71        PrimitiveOpKind::PadToMatch => ResidualSpec::all_inputs(),
72        PrimitiveOpKind::Constant => ResidualSpec::none(),
73    }
74}