Struct nicompiler_backend::instruction::InstrBook

pub struct InstrBook {
    pub start_pos: usize,
    pub end_pos: usize,
    pub keep_val: bool,
    pub instr: Instruction,
}

Manages an instruction along with its associated metadata during experiment editing.

The InstrBook struct captures the following metadata:

• Defined interval using start_pos and end_pos.
• A flag, keep_val, to determine whether to retain the value after the defined interval.

For the instruction interval:

• start_pos is inclusive.
• end_pos is exclusive.

InstrBook implements ordering based on start_pos to facilitate sorting. editing phase: defined interval, and whether to keep value after defined interval. For instruction interval, start_pos is inclusive while end_pos is exclusive. We implemented ordering for InstrBook to allow sorting based on start_pos.

Fields

start_pos: usize

end_pos: usize

keep_val: bool

instr: Instruction

Implementations

impl InstrBook

pub fn new( start_pos: usize, end_pos: usize, keep_val: bool, instr: Instruction ) -> Self

Constructs a new InstrBook object.

Checks that end_pos is strictly greater than start_pos.

Arguments

• start_pos: Starting position (inclusive).
• end_pos: Ending position (exclusive).
• keep_val: Flag to determine if value should be retained after the interval.
• instr: The associated instruction.

Examples

Constructing a valid InstrBook:

let instruction = Instruction::new(InstrType::CONST, [("value".to_string(), 1.0)].iter().cloned().collect());
let book = InstrBook::new(0, 5, true, instruction);

Attempting to construct an InstrBook with end_pos not greater than start_pos will panic:

let instruction = Instruction::new(InstrType::CONST, [("value".to_string(), 1.0)].iter().cloned().collect());
let book = InstrBook::new(5, 5, true, instruction);

The panic message will be: Instruction { /* ... */ } end_pos 5 should be strictly greater than start_pos 5.

Trait Implementations

impl Display for InstrBook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for InstrBook

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<InstrBook> for InstrBook

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<InstrBook> for InstrBook

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for InstrBook