Struct CircuitMap 

pub struct CircuitMap {
    state: CircuitMapState,
    shreds_in_layer: HashMap<LayerId, Vec<NodeId>>,
    label_to_shred_id: HashMap<String, NodeId>,
    layer_label_to_layer_id: HashMap<String, LayerId>,
    layer_visibility: HashMap<LayerId, LayerVisibility>,
    node_location: HashMap<NodeId, (CircuitLocation, usize)>,
}

Manages the relations between all different kinds of identifiers used to specify nodes during circuit building and circuit instantiation. Keeps track of [LayerId]s, NodeIds, Labels, LayerVisibilitys, [CircuitLocation]s.

Fields

state: CircuitMapState

shreds_in_layer: HashMap<LayerId, Vec<NodeId>>

label_to_shred_id: HashMap<String, NodeId>

layer_label_to_layer_id: HashMap<String, LayerId>

layer_visibility: HashMap<LayerId, LayerVisibility>

node_location: HashMap<NodeId, (CircuitLocation, usize)>

Implementations

impl CircuitMap

pub fn new() -> Self

Constructs an empty CircuitMap in a CircuitMapState::UnderConstruction state. It can receive new data until the Self::freeze method is called which will transition it to the CircuitMapState::Ready state, at which point it can only be used to answer queries.

pub fn add_node_id_and_location_num_vars( &mut self, node_id: NodeId, value: (CircuitLocation, usize), )

Associates the node with ID node_id to its corresponding circuit location as well as number of variables.

Panics

If self is not in state CircuitMapState::UnderConstruction, or if the node with ID node_id has already been assigned a location.

pub fn insert_shreds_into_input_layer( &mut self, input_layer_id: LayerId, shreds: Vec<NodeId>, )

Adds a collection of shreds to Input Layer with ID input_layer_id.

Panics

If self is not in state CircuitMapState::UnderConstruction, or if input_layer_id has already been assigned shreds.

pub fn get_location_num_vars_from_node_id( &self, node_id: &NodeId, ) -> Result<&(CircuitLocation, usize)>

Using node_id, retrieves the number of variables and location of this node in the circuit, or returns an error if node_id is missing. This method is safe to use in any CircuitMapState.

pub fn add_input_layer( &mut self, layer_id: LayerId, layer_label: &str, layer_kind: LayerVisibility, )

Adds a new Input Layer with ID layer_id, label layer_label, and visibility defined by layer_kind.

Panics

If self is not in state CircuitMapState::UnderConstruction, or if a layer already exists with either an ID equal to layer_id or a label equal to layer_label.

pub fn add_input_shred(&mut self, label: &str, shred_id: NodeId)

Adds a new Input Shred labeled label with node ID shred_id.

Panics

If self is not in a CircuitMapState::UnderConstruction, or if label is already in use.

Note

While this method does not panic if shred_id has already been given a different label, it is considered a semantic error to associate two different labels with the same node, and Self::freeze may detect it and panic .

pub fn freeze(self) -> Self

Desctructively mutates self to transition it from a CircuitMapState::UnderConstruction state to a CircuitMapState::Ready state. As part of the transition, consistency checks are performed to ensure all internal mappings have all the expected properties.

Panics

If self is already in a CircuitMapState::Ready state, or if its internal state is inconsistent.

pub fn get_node_kind(&self, shred_label: &str) -> Result<LayerVisibility>

Returns the LayerVisibility of the Input Layer that the shred with label shred_label is in, or an error if the shred_label does not correspond to any input shred.

pub fn get_node_id(&self, shred_label: &str) -> Result<NodeId>

Returns the NodeId of the Input Shred labeled shred_label, or an error if shred_label does not correspond to any input shred.

pub fn get_all_input_shred_ids(&self) -> Vec<NodeId>

Returns a vector of all NodeIds of Input Shreds.

Panics

If self is not in CircuitMapState::Ready state.

pub fn get_shred_label_from_id(&self, shred_id: NodeId) -> Result<String>

Returns the label of the input shred with ID shred_id, or an error if there is no input shred with ID shred_id.

Intended to be used only for error-reporting; current implementation is inefficient.

Panics

If self is not in state CircuitMapState::Ready.

pub fn get_all_input_layer_ids(&self) -> Vec<LayerId>

Returns a vector of all input layer IDs.

TODO: Consider returning an iterator instead of Vec.

Panics

If self is not in CircuitMapState::Ready state.

pub fn get_all_public_input_layer_ids(&self) -> Vec<LayerId>

Returns a vector of all public input layer IDs.

TODO: Consider returning an iterator instead of Vec.

Panics

If self is not in CircuitMapState::Ready state.

pub fn get_input_shreds_from_layer_id( &self, layer_id: LayerId, ) -> Result<Vec<NodeId>>

Returns a vector of all Input Shred IDs in the Input Layer with ID layer_id, or an error if there is no input layer with that ID.

Panics

If self is not in CircuitMapState::Ready.

pub fn get_shred_location( &self, shred_id: NodeId, ) -> Result<(CircuitLocation, usize)>

Returns the [CircuitLocation] and number of variables of the Input Shred with ID shred_id, or an error if no input shred with this ID exists.

Panics

If self is not in CircuitMapState::Ready state.

pub fn get_all_committed_layers(&self) -> Vec<LayerId>

Returns a vector with all [LayerId]s of the Input Layers with LayerVisibility::Committed visibility.

Panics

If self is not in CircuitMapState::Ready state.

pub fn get_layer_id_from_label(&self, layer_label: &str) -> Result<LayerId>

Returns the layer ID of the input layer with label layer_label, or error if no such layer exists.

Trait Implementations

impl Clone for CircuitMap

fn clone(&self) -> CircuitMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CircuitMap

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

Formats the value using the given formatter.

impl Default for CircuitMap

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CircuitMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CircuitMap

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CircuitMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CircuitMap