air-script-core 0.2.0

Core types for the AirScript compiler
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

use super::Identifier;

// TYPES
// ================================================================================================
pub type TraceSegment = u8;

/// [IndexedTraceAccess] is used to represent accessing an element in the execution trace during
/// constraint evaluation. The trace_segment specifies
/// how many trace commitments have preceded the specified segment. `col_idx` specifies the index
/// of the column within that trace segment, and `row_offset` specifies the offset from the current
/// row. For example, an element in the "next" row of the "main" trace would be specified by
/// a trace_segment of 0 and a row_offset of 1.
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub struct IndexedTraceAccess {
    trace_segment: TraceSegment,
    col_idx: usize,
    row_offset: usize,
}

impl IndexedTraceAccess {
    pub fn new(trace_segment: TraceSegment, col_idx: usize, row_offset: usize) -> Self {
        Self {
            trace_segment,
            col_idx,
            row_offset,
        }
    }

    /// Gets the trace segment of this [IndexedTraceAccess].
    pub fn trace_segment(&self) -> TraceSegment {
        self.trace_segment
    }

    /// Gets the column index of this [IndexedTraceAccess].
    pub fn col_idx(&self) -> usize {
        self.col_idx
    }

    /// Gets the row offset of this [IndexedTraceAccess].
    pub fn row_offset(&self) -> usize {
        self.row_offset
    }
}

/// [NamedTraceAccess] is used to indicate a column in the trace by specifying its index within a
/// set of trace columns with the given identifier. If the identifier refers to a single column
/// then the index is always zero.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct NamedTraceAccess {
    name: Identifier,
    idx: usize,
    row_offset: usize,
}

impl NamedTraceAccess {
    pub fn new(name: Identifier, idx: usize, row_offset: usize) -> Self {
        Self {
            name,
            idx,
            row_offset,
        }
    }

    pub fn name(&self) -> &str {
        self.name.name()
    }

    pub fn idx(&self) -> usize {
        self.idx
    }

    /// Gets the row offset of this [NamedTraceAccess].
    pub fn row_offset(&self) -> usize {
        self.row_offset
    }
}