Struct Allocator

pub struct Allocator { /* private fields */ }

An allocator for local variables of a kernel.

A local variable is unique to a unit. That is, each unit have their own copy of a local variable. There are three types of local variables based on their capabilities. - An immutable local variable is obtained by calling Allocator::create_local. - A mutable local variable is obtained by calling Allocator::create_local_mut. The allocator will reuse previously defined mutable variables if possible. - A restricted mutable local variable is obtained by calling Allocator::create_local_restricted. This a is mutable variable that cannot be reused. This is mostly used for loop indices.

Performance tips

In order, prefer immutable local variables, then mutable, then restricted.

To enable many compiler optimizations, it is preferred to use the [static single-assignment] strategy for immutable variables. That is, each variable must be declared and used exactly once.

static single-assignment

Implementations

impl Allocator

pub fn create_local(&self, item: Item) -> ExpandElement

Create a new immutable local variable of type specified by item.

pub fn create_local_mut(&self, item: Item) -> ExpandElement

Create a new mutable local variable of type specified by item. Try to reuse a previously defined but unused mutable variable if possible. Else, this define a new variable.

pub fn create_local_restricted(&self, item: Item) -> ExpandElement

Create a new mutable restricted local variable of type specified by item.

pub fn create_local_array(&self, item: Item, array_size: u32) -> ExpandElement

pub fn create_matrix(&self, matrix: Matrix) -> ExpandElement

Create a matrix variable

pub fn create_pipeline(&self, item: Item, num_stages: u8) -> ExpandElement

pub fn create_barrier(&self, item: Item, level: BarrierLevel) -> ExpandElement

pub fn reuse_local_mut(&self, item: Item) -> Option<ExpandElement>

pub fn add_local_mut(&self, item: Item) -> Rc<Variable>

Add a new variable to the pool with type specified by item for the given scope.

pub fn new_local_index(&self) -> u32

pub fn take_variables(&self) -> Vec<Variable>

Trait Implementations

impl Clone for Allocator

fn clone(&self) -> Allocator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Allocator

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

Formats the value using the given formatter.

impl Default for Allocator

fn default() -> Allocator

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Allocator

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Allocator

fn eq(&self, other: &Self) -> 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 Allocator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeHash for Allocator

fn write_hash(hasher: &mut impl Hasher)

Write the structure of the type to the hasher

fn type_hash() -> u64

Generate a stable hash of the type structure.

impl Eq for Allocator