cubecl-std 0.10.0-pre.3

CubeCL Standard Library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

use cubecl::prelude::*;
use cubecl_core::{self as cubecl, zspace::Shape};

use crate::tensor::layout::{Coords1d, Layout, LayoutExpand};

/// Layout for contiguous tensors, indexed in individual elements.
/// Differs from `PlainLayout` because `PlainLayout` expects vector indices, not element indices.
#[derive(CubeType, CubeLaunch, Clone)]
pub struct SimpleLayout {
    len: usize,
    #[cube(comptime)]
    vector_size: VectorSize,
}

#[cube]
impl SimpleLayout {
    /// Create a new simple layout with a length and vector size.
    ///
    /// # Note
    /// Length should be in elements, not vectors!
    pub fn new(len: usize, #[comptime] vector_size: VectorSize) -> Self {
        SimpleLayout { len, vector_size }
    }
}

impl<R: Runtime> SimpleLayoutLaunch<R> {
    pub fn from_shape(shape: &Shape, vector_size: VectorSize) -> Self {
        let len = shape.iter().product::<usize>();
        Self::new(len, vector_size)
    }

    pub fn from_handle(handle: TensorBinding<R>, vector_size: VectorSize) -> Self {
        Self::from_shape(&handle.shape, vector_size)
    }
}

#[cube]
impl Layout for SimpleLayout {
    type Coordinates = Coords1d;
    type SourceCoordinates = Coords1d;

    fn to_source_pos(&self, pos: Self::Coordinates) -> usize {
        pos / self.vector_size
    }

    fn to_source_pos_checked(&self, pos: Self::Coordinates) -> (usize, bool) {
        (self.to_source_pos(pos), self.is_in_bounds(pos))
    }

    fn shape(&self) -> Self::Coordinates {
        self.len
    }

    fn is_in_bounds(&self, pos: Self::Coordinates) -> bool {
        pos < self.len
    }
}