Need

Struct Need 

Source
pub struct Need<'a> {
    pub circuit: &'a Circuit,
    pub settings: &'a BTreeMap<String, String>,
    pub rows: u64,
    pub stored: Vec<Format>,
    pub group_of: Vec<Option<usize>>,
    pub edge_states: Vec<Option<EdgeState>>,
    pub held: BTreeMap<EdgeIdx, Format>,
    pub stated: BTreeMap<NodeIdx, BTreeMap<StepKind, Value>>,
}
Expand description

2026-10-02: Everything a requirement reads besides the node.

Fields§

§circuit: &'a Circuit

2026-10-02: The circuit.

§settings: &'a BTreeMap<String, String>

2026-10-02: The policy’s settings.

§rows: u64

2026-10-02: The row count the plan runs (the activation-quantization ladder reads it).

§stored: Vec<Format>

2026-10-02: Each edge’s stored format.

§group_of: Vec<Option<usize>>

2026-10-02: Each node’s group under the plan; all None without one.

§edge_states: Vec<Option<EdgeState>>

2026-10-02: Each edge’s state under the plan; all None without one.

§held: BTreeMap<EdgeIdx, Format>

2026-10-02: In-group hand-off formats the plan’s rules state (holds), by edge.

§stated: BTreeMap<NodeIdx, BTreeMap<StepKind, Value>>

2026-10-02: Step values the plan’s rules state (steps), by node.

Implementations§

Source§

impl<'a> Need<'a>

Source

pub fn base( circuit: &'a Circuit, settings: &'a BTreeMap<String, String>, rows: u64, ) -> Self

2026-10-02: The requirement before any plan: the circuit’s own formats.

Source

pub fn of_plan( circuit: &'a Circuit, plan: &FusionPlan, rules: &[Rule], settings: &'a BTreeMap<String, String>, ) -> Self

2026-10-02: The requirement under plan, whose groups’ rules are among rules (a group whose rule is not there, a hardware planner’s placeholder, states nothing).

Source

pub fn held_input(&self, node: NodeIdx, e: EdgeIdx) -> bool

2026-10-02: Node node reads edge e from a producer in its own group, in a format a rule states that producer holds it in.

Source

pub fn holds_in_group(&self, e: EdgeIdx) -> bool

2026-10-02: Edge e is handed on inside its group in a format a rule states.

Source

pub fn stated_steps(&self, n: NodeIdx) -> impl Iterator<Item = StepKind> + '_

2026-10-02: The steps a rule states for node n.

Trait Implementations§

Source§

impl<'a> Clone for Need<'a>

Source§

fn clone(&self) -> Need<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for Need<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Need<'a>

§

impl<'a> RefUnwindSafe for Need<'a>

§

impl<'a> Send for Need<'a>

§

impl<'a> Sync for Need<'a>

§

impl<'a> Unpin for Need<'a>

§

impl<'a> UnwindSafe for Need<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.