Struct logic_circus::Component

pub struct Component<Rust = Infallible> { /* fields omitted */ }

A circuit

use builder() to construct

use compute to run the logic

stick inside a Gate::component to use as part of a bigger component and compose with other gates

put a gate implemented in rust (or an enum of them) in <Rust> to use it (or them)

Implementations

impl<Rust> Component<Rust>

pub fn builder() -> ComponentBuilder<Rust>

Aquire a ComponentBuilder

pub fn single_gate(gate: Gate<Rust>, num_of_outputs: usize) -> Self

Create a component out of a single gate

this is mostly useless since the gate itself can probably do whatever you need and exists mostly for tests

pub fn from_raw_parts(
    gates: Vec<Gate<Rust>>,
    sequals: Vec<Vec<Sequal>>,
    outputs: usize
) -> Self

Create a component from it’s raw parts

in sequals each Vec<Sequal> corresponds to a single gates sequals (in the same index) and the last corresponds to the components inputs outputs is the amount of outputs your component has

impl<Rust> Component<Rust> where
    Rust: GateLike, 

pub unsafe fn run(&mut self, input: Vec<Bit>) -> Vec<Bit>

Runs the component

This is an alias for compute since that function is inside a trait impl and thus way harder to find, also the name is nice

Safety

this function is only safe if:

• input is the same length as the last sequals vector
• all Sequal::Ends point to outputs that exist - guaranteed if constructed with ComponentBuilder and used outputs from 0 up to the number of outputs
• all Sequal::Gates must point to actual inputs of actual gates
• component is clean (right after construction or after a call to Component::reset())

pub fn reset(&mut self, full_reset: bool)

Resets the whole component

this must be done in between cpu ticks (calls to compute) in order for the gates to work (otherwise the code is panicks in debug and is unsound in release)

a full reset is done in between runs, this is to reset things like memory that are kept between ticks

Trait Implementations

impl<Rust: Clone> Clone for Component<Rust>

fn clone(&self) -> Component<Rust>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Rust: Debug> Debug for Component<Rust>

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

Formats the value using the given formatter.

impl<Rust> GateLike for Component<Rust> where
    Rust: GateLike, 

unsafe fn compute(&mut self, input: Vec<Bit>) -> Vec<Bit>

Safety

this function is only safe if:

• input is the same length as the last sequals vector
• all Sequal::Ends point to outputs that exist - guaranteed if constructed with ComponentBuilder and used outputs from 0 up to the number of outputs
• all Sequal::Gates must point to actual inputs of actual gates
• component is clean (right after construction or after a call to Component::reset())

fn num_of_inputs(&self) -> usize

This function counts the amount of inputs a gate has

fn reset(&mut self, full: bool)

This function resets the gate, if your gate needs to be reset between cpu tiks (I have no example) or between runs (for example memory)