Enum FastDivmod 

pub enum FastDivmod<I: FastDivmodInt> {
    Fast {
        divisor: I,
        multiplier: I,
        shift_right: u32,
    },
    Fallback {
        divisor: I,
    },
}

Create a fast-divmod object if supported, or a regular fallback if not. This precalculates certain values on the host, in exchange for making division and modulo operations on the GPU much faster. Only supports u32 right now to allow for a simpler algorithm. It’s mostly used for indices regardless.

Implementation based on ONNX: https://github.com/microsoft/onnxruntime/blob/main/onnxruntime/core/providers/cuda/shared_inc/fast_divmod.h

Variants

Fast

Fields

divisor: I

multiplier: I

shift_right: u32

Fallback

Fields

divisor: I

Implementations

impl<I: FastDivmodInt> FastDivmod<I>

pub fn new_Fast(divisor: I, multiplier: I, shift_right: u32) -> Self

pub fn __expand_new_Fast( _: &mut Scope, divisor: <I as CubeType>::ExpandType, multiplier: <I as CubeType>::ExpandType, shift_right: <u32 as CubeType>::ExpandType, ) -> FastDivmodExpand<I>

pub fn new_Fallback(divisor: I) -> Self

pub fn __expand_new_Fallback( _: &mut Scope, divisor: <I as CubeType>::ExpandType, ) -> FastDivmodExpand<I>

impl<I: FastDivmodInt> FastDivmod<I>

pub fn div(&self, dividend: I) -> I

pub fn modulo(&self, dividend: I) -> I

pub fn div_mod(&self, dividend: I) -> (I, I)

pub fn __expand_div( scope: &mut Scope, this: <Self as CubeType>::ExpandType, dividend: <I as CubeType>::ExpandType, ) -> <I as CubeType>::ExpandType

pub fn __expand_modulo( scope: &mut Scope, this: <Self as CubeType>::ExpandType, dividend: <I as CubeType>::ExpandType, ) -> <I as CubeType>::ExpandType

pub fn __expand_div_mod( scope: &mut Scope, this: <Self as CubeType>::ExpandType, dividend: <I as CubeType>::ExpandType, ) -> <(I, I) as CubeType>::ExpandType

Trait Implementations

impl<I: Clone + FastDivmodInt> Clone for FastDivmod<I>

fn clone(&self) -> FastDivmod<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: FastDivmodInt> CubeDebug for FastDivmod<I>

fn set_debug_name(&self, scope: &mut Scope, name: &'static str)

Set the debug name of this type’s expansion. Should do nothing for types that don’t appear at runtime

impl<I: FastDivmodInt> CubeType for FastDivmod<I>

type ExpandType = FastDivmodExpand<I>

fn into_mut(scope: &mut Scope, expand: Self::ExpandType) -> Self::ExpandType

Wrapper around the init method, necessary to type inference.

impl<I: FastDivmodInt> LaunchArg for FastDivmod<I>

type RuntimeArg<'a, R: Runtime> = FastDivmodArgs<I>

The runtime argument for the kernel.

type CompilationArg = FastDivmodCompilationArg<I>

Compilation argument.

fn compilation_arg<'a, R: Runtime>( runtime_arg: &Self::RuntimeArg<'a, R>, ) -> Self::CompilationArg

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

Register an input variable during compilation that fill the KernelBuilder.

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

Register an output variable during compilation that fill the KernelBuilder.

impl<I: Copy + FastDivmodInt> Copy for FastDivmod<I>