Struct Scope 

pub struct Scope {
    pub depth: u8,
    pub instructions: RefCell<Vec<Instruction>>,
    pub return_value: Option<Value>,
    pub locals: RefCell<Vec<Value>>,
    pub debug: DebugInfo,
    pub global_state: Rc<RefCell<GlobalStateInner>>,
    /* private fields */
}

The scope is the main crate::Operation and crate::Value container that simplify the process of reading inputs, creating local variables and adding new operations.

Notes:

This type isn’t responsible for creating shader bindings and figuring out which variable can be written to.

Fields

depth: u8

instructions: RefCell<Vec<Instruction>>

return_value: Option<Value>

locals: RefCell<Vec<Value>>

debug: DebugInfo

global_state: Rc<RefCell<GlobalStateInner>>

Implementations

impl Scope

pub fn device_properties(&self, properties: &DeviceProperties)

Set the device properties.

pub fn state(&self) -> Ref<'_, GlobalStateInner>

pub fn state_mut(&self) -> RefMut<'_, GlobalStateInner>

pub fn root(debug_enabled: bool) -> Scope

Create a scope that is at the root of a kernel definition.

A local scope can be created with the child method.

pub fn with_global_state( self, global_state: Rc<RefCell<GlobalStateInner>>, ) -> Scope

Use existing state.

pub fn create_value(&self, ty: Type) -> Value

Create a new immutable value of type specified by ty.

pub fn create_local_mut(&self, value_ty: impl Into<Type>) -> Value

Create a new mutable local variable of type specified by value_ty.

pub fn create_shared( &self, value_ty: impl Into<Type>, alignment: Option<usize>, ) -> Value

Create a shared variable of the given item type.

pub fn create_function(&self, explicit_params: Vec<Value>, scope: Scope) -> u32

Create a new function.

pub fn register<T>(&self, instruction: T)

where T: Into<Instruction>,

Register an Instruction into the scope.

pub fn create_kernel_ref<'a, T>(&self, value: T) -> &'a mut T

where T: 'a,

Add a value to the global arena so we can create a kernel-wide reference to it. The reference is the same as the type for simplicity, but is only valid for the duration of the root scope. Ensure the reference lifetime is shortened to the lifetime of the underlying variable being referenced.

pub fn resolve_type<T>(&self) -> Option<StorageType>

where T: 'static,

Resolve the element type of the given generic type.

pub fn resolve_size<T>(&self) -> Option<usize>

where T: 'static,

Resolve the comptime size of the given generic size.

pub fn register_type<T>(&self, elem: StorageType)

where T: 'static,

Register the element type for the given generic type.

pub fn register_size<T>(&self, size: usize)

where T: 'static,

Register the comptime size for the given generic size.

pub fn child(&self) -> Scope

Create an empty child scope.

pub fn push_error(&self, msg: impl Into<String>)

pub fn pop_errors(&self) -> Vec<String>

Returns all validation errors.

pub fn process<'a>( &self, processors: impl IntoIterator<Item = &'a dyn Processor>, ) -> ScopeProcessing

Returns the operations to be declared and executed.

Notes:

New operations can be created within the same scope without having name conflicts.

pub fn new_local_index(&self) -> u32

pub fn global(&self, id: u32, value_ty: Type) -> Value

Obtain the index-th buffer

pub fn tensor_map(&self, id: u32) -> Value

Obtain the index-th tensor map

pub fn update_source(&self, source: CubeFnSource)

pub fn register_all(&self, instructions: impl IntoIterator<Item = Instruction>)

pub fn take_instructions(&self) -> Vec<Instruction>

pub fn update_span(&self, line: u32, col: u32)

pub fn update_value_name( &self, value: Value, name: impl Into<Cow<'static, str>>, )

pub fn extract_field(&self, aggregate: Value, ty: Type, field: usize) -> Value

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scope

fn deserialize<__D>( __deserializer: __D, ) -> Result<Scope, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Scope

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

Formats the value using the given formatter.

impl Eq for Scope

where DebugInfo: Eq, Rc<RefCell<GlobalStateInner>>: Eq, RefCell<Vec<Value>>: Eq, u8: Eq, RefCell<Vec<Instruction>>: Eq, Option<Value>: Eq, ValidationErrors: Eq,

impl Hash for Scope

fn hash<H>(&self, ra_expand_state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Scope

fn eq(&self, __other: &Scope) -> bool

Equality operator ==.

fn ne(&self, __other: &Scope) -> bool

Inequality operator !=.

impl Serialize for Scope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeHash for Scope

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.