bimm-contracts 0.20.1

Runtime shape/geometry contracts for the burn framework.
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! # Utility crate for [`ShapeArgument`] for passing shapes in a type-safe manner.

use alloc::vec::Vec;

/// A trait that provides a method to extract the shape from various types.
pub trait ShapeArgument {
    /// Extracts the shape from the implementing type as a vector.
    fn get_shape_vec(self) -> Vec<usize>;
}

impl<const D: usize> ShapeArgument for &[usize; D] {
    fn get_shape_vec(self) -> Vec<usize> {
        self.to_vec()
    }
}

impl<const D: usize> ShapeArgument for &[u32; D] {
    fn get_shape_vec(self) -> Vec<usize> {
        self.iter().map(|&d| d as usize).collect::<Vec<_>>()
    }
}

impl<const D: usize> ShapeArgument for &[i32; D] {
    fn get_shape_vec(self) -> Vec<usize> {
        self.iter().map(|&d| d as usize).collect::<Vec<_>>()
    }
}

impl ShapeArgument for &[usize] {
    fn get_shape_vec(self) -> Vec<usize> {
        self.to_vec()
    }
}

impl ShapeArgument for &[u32] {
    fn get_shape_vec(self) -> Vec<usize> {
        self.iter().map(|&d| d as usize).collect::<Vec<_>>()
    }
}

impl ShapeArgument for &[i32] {
    fn get_shape_vec(self) -> Vec<usize> {
        self.iter().map(|&d| d as usize).collect::<Vec<_>>()
    }
}

impl ShapeArgument for &Vec<usize> {
    fn get_shape_vec(self) -> Vec<usize> {
        self.to_vec()
    }
}

impl ShapeArgument for &Vec<u32> {
    fn get_shape_vec(self) -> Vec<usize> {
        self.iter().map(|&d| d as usize).collect::<Vec<_>>()
    }
}

impl ShapeArgument for &Vec<i32> {
    fn get_shape_vec(self) -> Vec<usize> {
        self.iter().map(|&d| d as usize).collect::<Vec<_>>()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::vec;
    use alloc::vec::Vec;

    #[test]
    fn test_shape_argument() {
        let expected = vec![2, 3, 4];

        {
            let arr: [usize; 3] = [2, 3, 4];
            assert_eq!(&arr.get_shape_vec(), &expected);

            let arr_ref: &[usize] = &arr;
            assert_eq!(&arr_ref.get_shape_vec(), &expected);
        }

        {
            let arr: [u32; 3] = [2, 3, 4];
            assert_eq!(&arr.get_shape_vec(), &expected);

            let arr_ref: &[u32] = &arr;
            assert_eq!(&arr_ref.get_shape_vec(), &expected);
        }

        {
            let arr: [i32; 3] = [2, 3, 4];
            assert_eq!(&arr.get_shape_vec(), &expected);

            let arr_ref: &[i32] = &arr;
            assert_eq!(&arr_ref.get_shape_vec(), &expected);
        }

        {
            let vec: Vec<usize> = vec![2, 3, 4];
            assert_eq!(&vec.get_shape_vec(), &expected);

            let vec_ref: &Vec<usize> = &vec;
            assert_eq!(&vec_ref.get_shape_vec(), &expected);
        }

        {
            let vec: Vec<u32> = vec![2, 3, 4];
            assert_eq!(&vec.get_shape_vec(), &expected);

            let vec_ref: &Vec<u32> = &vec;
            assert_eq!(&vec_ref.get_shape_vec(), &expected);
        }
    }
}