topos 0.12.0

An autodiff compiler stack 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! The entry card: the declared reading.

use malevich::Theme;

use super::html;
use crate::{BoundEntry, Element, Entry, Numerics};

impl Entry {
    /// Renders the declared reading: roots, observes, memory
    /// posture, numerics.
    pub fn to_html(&self, theme: Theme) -> String {
        html::card(
            theme,
            &html::escape(&self.summary()),
            &html::dump_pre(&self.body_text()),
        )
    }

    /// Displays the entry when it is the last expression in an
    /// Evcxr cell.
    pub fn evcxr_display(&self) {
        html::show(
            &self.to_html(Theme::detect()),
            &format!("{}\n{}", self.summary(), self.body_text()),
        );
    }

    fn summary(&self) -> String {
        let roots = self.roots.len();
        let observes = self.observe.len();
        let numerics = match self.numerics {
            Numerics::Fast => "Fast",
            Numerics::Exact => "Exact",
        };
        format!("entry  \u{b7}  {roots} roots  \u{b7}  {observes} observes  \u{b7}  {numerics}")
    }

    fn body_text(&self) -> String {
        let roots = list_symbols(&self.roots);
        let observes = if self.observe.is_empty() {
            "(none)".to_string()
        } else {
            list_symbols(&self.observe)
        };
        let memory = if self.backward {
            "retain for backward"
        } else {
            "forward-only"
        };
        format!("roots     {roots}\nobserves  {observes}\nmemory    {memory}")
    }
}

fn list_symbols(symbols: &[crate::Symbol]) -> String {
    symbols
        .iter()
        .map(|symbol| format!("#{}", symbol.id.index()))
        .collect::<Vec<_>>()
        .join("  ")
}

impl<E: Element> BoundEntry<'_, E> {
    /// Renders the bound entry the same way as its detached
    /// signature.
    pub fn to_html(&self, theme: Theme) -> String {
        self.entry.to_html(theme)
    }

    /// Displays the bound entry when it is the last expression in
    /// an Evcxr cell.
    pub fn evcxr_display(&self) {
        self.entry.evcxr_display();
    }
}

#[cfg(test)]
#[path = "tests/entry_tests.rs"]
mod tests;