Struct CalyxComponent

pub struct CalyxComponent<'a, ComponentData: Default> { /* private fields */ }

A wrapper for a calyx component that can only be created through [CalyxBuilder::build_component], where it must live no longer than the builder that created it.

The wrapper maintains cell and control manipulation. Cells can be created through methods such as [CalyxComponent::named_reg] or CalyxComponent::component_cell. It also contains unique per-component data initialized via ComponentData::default which can be accessed through appropriate getters.

Implementations

impl<'a, ComponentData: Default> CalyxComponent<'a, ComponentData>

pub fn user_data_ref(&self) -> &ComponentData

The user data associated with the component.

pub fn user_data_mut(&mut self) -> &mut ComponentData

See CalyxComponent::user_data_ref.

pub fn signature(&mut self) -> CalyxCell

The input/output signature of this component as a cell.

pub fn control(&mut self) -> &mut CalyxControl<Sequential>

The control of this component.

pub fn with_calyx_builder<F, T>(&mut self, f: F) -> T

where F: FnOnce(&mut Builder<'_>) -> T,

Enables direct access to a calyx_ir::Builder for this component.

pub fn new_reg(&mut self, name: String, width: usize) -> CalyxCell

A register cell bound to name.

Requires: name has not been bound.

pub fn named_mem( &mut self, name: String, cell_size: usize, length: usize, address_bits: usize, ) -> CalyxCell

A memory cell bound to name.

Requires: name has not been bound.

pub fn new_prim( &mut self, name: &str, prim: &str, params: Vec<u64>, ) -> CalyxCell

Creates a cell named name for a primitive prim with parameters params. Before using this function, see if [CalyxComponent::named_reg] or CalyxComponent::named_mem are more appropriate.

Requires: name has not been bound.

pub fn component_cell( &mut self, prefix: String, component: String, instantiate_new: bool, ) -> (String, CalyxCell)

A cell for a component component whose name is guaranteed to begin with prefix. If instantiate_new, then a unique cell will be created. Both the cell and the actual cell name are returned.

pub fn new_unnamed_cell(&mut self, kind: CalyxCellKind) -> CalyxCell

An unnamed cell of a given kind.

pub fn constant(&mut self, value: i64, width: usize) -> CalyxCell

A constant cell, that is, a primitive "std_const".

pub fn signal_out(&mut self) -> CalyxCell

Equivlane to constant(1, 1).

pub fn alias_cell(&mut self, name: String, cell: CalyxCell)

Adds name as a named alias to refer to cell.

Requires: name has not been previously bound.

pub fn find(&mut self, name: String) -> CalyxCell

Looks up a named cell previously bound to name.

Requires: name has been bound.

pub fn begin_scope(&mut self)

See Environment::push.

pub fn end_scope(&mut self) -> bool

See Environment::pop.

pub fn add_group(&mut self, prefix: &str) -> CalyxGroup

Creates a new group guaranteed to start with prefix.

pub fn add_comb_group(&mut self, prefix: &str) -> CalyxCombGroup

Creates a new combinational group guaranteed to start with prefix.

pub fn finalize(self) -> Component

Yields a calyx_ir::Component.