aegir 2.0.0

Strongly-typed, reverse-mode autodiff library in Rust
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

//! Module containing meta operators.
use crate::buffers::{Arrays, Scalars, Tuples, Vecs};

/// Dummy type for implementing [Precedence].
pub struct Prec;

/// Trait for defining precedence relations between buffer classes.
pub trait Precedence<C1, C2> {
    /// Class with higher precedence between `C1` and `C2`.
    type Class;
}

macro_rules! impl_class_precedence {
    (($cl1:ty, $cl2:ty) => $cl3:ty) => {
        impl Precedence<$cl1, $cl2> for Prec {
            type Class = $cl3;
        }
    };
}

impl_class_precedence!((Scalars, Scalars) => Scalars);
impl_class_precedence!((Scalars, Arrays) => Arrays);
impl_class_precedence!((Scalars, Tuples) => Tuples);
impl_class_precedence!((Scalars, Vecs) => Vecs);

impl_class_precedence!((Arrays, Scalars) => Arrays);
impl_class_precedence!((Arrays, Arrays) => Arrays);
impl_class_precedence!((Arrays, Tuples) => Arrays);
impl_class_precedence!((Arrays, Vecs) => Arrays);

impl_class_precedence!((Tuples, Scalars) => Tuples);
impl_class_precedence!((Tuples, Arrays) => Arrays);
impl_class_precedence!((Tuples, Tuples) => Tuples);
impl_class_precedence!((Tuples, Vecs) => Vecs);

impl_class_precedence!((Vecs, Scalars) => Vecs);
impl_class_precedence!((Vecs, Arrays) => Vecs);
impl_class_precedence!((Vecs, Tuples) => Vecs);
impl_class_precedence!((Vecs, Vecs) => Vecs);

/// Error type for variable/source nodes.
#[derive(Copy, Clone, Debug)]
pub enum SourceError<ID> {
    /// Error case when the `ID` variable is undefined.
    Undefined(ID),
}

impl<ID: std::fmt::Debug> std::fmt::Display for SourceError<ID> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SourceError::Undefined(id) => {
                write!(f, "No variable found with identifier {:?}.", id)
            },
        }
    }
}

impl<ID: std::fmt::Debug> std::error::Error for SourceError<ID> {}

mod constant;
pub use self::constant::{Constant, ConstantAdjoint};

mod variable;
pub use self::variable::{Variable, VariableAdjoint};