echidna 0.14.0

A high-performance automatic differentiation library for 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
79
80
81
82
83
84
85
86
87

use std::collections::HashMap;

use serde::ser::SerializeStruct;
use serde::{Deserialize, Deserializer, Serialize, Serializer};

use crate::float::Float;
use crate::opcode::OpCode;

use super::BytecodeTape;

impl<F: Float + Serialize> Serialize for BytecodeTape<F> {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        if !self.custom_ops.is_empty() {
            return Err(serde::ser::Error::custom(
                "cannot serialize a BytecodeTape containing custom ops; \
                 custom ops must be re-registered after deserialization",
            ));
        }
        let mut s = serializer.serialize_struct("BytecodeTape", 8)?;
        s.serialize_field("opcodes", &self.opcodes)?;
        s.serialize_field("arg_indices", &self.arg_indices)?;
        s.serialize_field("values", &self.values)?;
        s.serialize_field("num_inputs", &self.num_inputs)?;
        s.serialize_field("num_variables", &self.num_variables)?;
        s.serialize_field("output_index", &self.output_index)?;
        s.serialize_field("output_indices", &self.output_indices)?;
        s.serialize_field("custom_second_args", &self.custom_second_args)?;
        s.end()
    }
}

impl<'de, F: Float + Deserialize<'de>> Deserialize<'de> for BytecodeTape<F> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        #[derive(Deserialize)]
        struct TapeData<F> {
            opcodes: Vec<OpCode>,
            arg_indices: Vec<[u32; 2]>,
            values: Vec<F>,
            num_inputs: u32,
            num_variables: u32,
            output_index: u32,
            #[serde(default)]
            output_indices: Vec<u32>,
            #[serde(default)]
            custom_second_args: HashMap<u32, u32>,
        }

        let data = TapeData::<F>::deserialize(deserializer)?;

        // Custom ops carry Rust callbacks that cannot be serialized, so a
        // payload containing them (or their operand side table) can never
        // be restored to a working tape. These scans touch only the field
        // they inspect — nothing here may index one array by another's
        // length before `validate()` has confirmed the lengths agree.
        if let Some(i) = data.opcodes.iter().position(|&op| op == OpCode::Custom) {
            return Err(serde::de::Error::custom(format!(
                "opcodes[{i}] is Custom, which cannot be deserialized (custom ops have no serializable callback)"
            )));
        }
        if !data.custom_second_args.is_empty() {
            return Err(serde::de::Error::custom(
                "custom_second_args must be empty: custom ops cannot be deserialized",
            ));
        }

        let tape = BytecodeTape {
            opcodes: data.opcodes,
            arg_indices: data.arg_indices,
            values: data.values,
            num_inputs: data.num_inputs,
            num_variables: data.num_variables,
            output_index: data.output_index,
            output_indices: data.output_indices,
            custom_ops: Vec::new(),
            custom_second_args: data.custom_second_args,
            #[cfg(debug_assertions)]
            tape_id: crate::bytecode_tape::next_tape_id(),
        };
        // Full structural validation: buffer lengths, the Input prefix,
        // output indices, per-op operand bounds (strictly-earlier slots),
        // and side-table consistency. Rejecting here turns every corrupt
        // payload into a clean error instead of a panic (or silently wrong
        // derivatives) at evaluation time.
        tape.validate().map_err(serde::de::Error::custom)?;
        Ok(tape)
    }
}