Struct Primitive

pub struct Primitive {
    pub name: Id,
    pub params: Vec<Id>,
    pub signature: Vec<PortDef<Width>>,
    pub attributes: Attributes,
    pub is_comb: bool,
    pub latency: Option<NonZeroU64>,
    pub body: Option<String>,
}

Representation of a external primitive definition.

Example

primitive std_reg<"static"=1>[WIDTH](
  in: WIDTH, write_en: 1, clk: 1
) -> (
  out: WIDTH, done: 1
);

The signature of a port is represented using PortDef which also specify the direction of the port.

Fields

name: Id

Name of this primitive.

params: Vec<Id>

Paramters for this primitive.

signature: Vec<PortDef<Width>>

The input/output signature for this primitive.

attributes: Attributes

Key-value attributes for this primitive.

is_comb: bool

True iff this is a combinational primitive

latency: Option<NonZeroU64>

(Optional) latency; for static primitives

body: Option<String>

body of the string, if it is an inlined primitive

Implementations

impl Primitive

pub fn resolve( &self, parameters: &[u64], ) -> CalyxResult<(SmallVec<[(Id, u64); 5]>, Vec<PortDef<u64>>)>

Retuns the bindings for all the paramters, the input ports and the output ports.

pub fn find_all_with_attr<A>( &self, attr: A, ) -> impl Iterator<Item = &PortDef<Width>>

where A: Into<Attribute> + Copy,

Return all ports that have the attribute attr.

Trait Implementations

impl Clone for Primitive

fn clone(&self) -> Primitive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Primitive

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

Formats the value using the given formatter.

impl GetName for Primitive

fn name(&self) -> Id

Return a reference to the object’s name