Trait LaunchArg

Source

pub trait LaunchArg: CubeType + 'static {
    type RuntimeArg<R: Runtime>: Send + Sync;
    type CompilationArg: CompilationArg;

    // Required methods
    fn register<R: Runtime>(
        arg: Self::RuntimeArg<R>,
        launcher: &mut KernelLauncher<R>,
    ) -> Self::CompilationArg;
    fn expand(
        arg: &Self::CompilationArg,
        builder: &mut KernelBuilder,
    ) -> <Self as CubeType>::ExpandType;
}

Expand description

Defines how a launch argument can be expanded.

TODO Verify the accuracy of the next comment.

Normally this type should be implemented two times for an argument. Once for the reference and the other for the mutable reference. Often time, the reference should expand the argument as an input while the mutable reference should expand the argument as an output.

Required Associated Types§

Source

type RuntimeArg<R: Runtime>: Send + Sync

The runtime argument for the kernel.

Source

type CompilationArg: CompilationArg

Compilation argument.

Required Methods§

Source

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, ) -> Self::CompilationArg

Source

fn expand( arg: &Self::CompilationArg, builder: &mut KernelBuilder, ) -> <Self as CubeType>::ExpandType

Register a variable during compilation that fill the KernelBuilder.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait LaunchArg Copy item path

Required Associated Types§

type RuntimeArg<R: Runtime>: Send + Sync

type CompilationArg: CompilationArg

Required Methods§

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, ) -> Self::CompilationArg

fn expand( arg: &Self::CompilationArg, builder: &mut KernelBuilder, ) -> <Self as CubeType>::ExpandType

Dyn Compatibility§

Implementations on Foreign Types§

impl LaunchArg for ()

type RuntimeArg<R: Runtime> = ()

type CompilationArg = ()

fn register<R: Runtime>( _runtime_arg: Self::RuntimeArg<R>, _launcher: &mut KernelLauncher<R>, )

fn expand( _: &Self::CompilationArg, _builder: &mut KernelBuilder, ) -> <Self as CubeType>::ExpandType

impl LaunchArg for bf16

type RuntimeArg<R: Runtime> = bf16

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for f16

type RuntimeArg<R: Runtime> = f16

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for f32

type RuntimeArg<R: Runtime> = f32

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for f64

type RuntimeArg<R: Runtime> = f64

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for i8

type RuntimeArg<R: Runtime> = i8

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for i16

type RuntimeArg<R: Runtime> = i16

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for i32

type RuntimeArg<R: Runtime> = i32

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for i64

type RuntimeArg<R: Runtime> = i64

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for isize

type RuntimeArg<R: Runtime> = isize

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for u8

type RuntimeArg<R: Runtime> = u8

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for u16

type RuntimeArg<R: Runtime> = u16

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for u32

type RuntimeArg<R: Runtime> = u32

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for u64

type RuntimeArg<R: Runtime> = u64

type CompilationArg = ()

fn register<R: Runtime>( arg: Self::RuntimeArg<R>, launcher: &mut KernelLauncher<R>, )

fn expand(_: &(), builder: &mut KernelBuilder) -> NativeExpand<Self>

impl LaunchArg for usize

Trait LaunchArg