burn-std 0.20.1

Core types and utilities shared across the Burn ecosystem.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

//! # Common Index Coercions
//!
//! This module contains common index coercions that can be used to implement
//! various indexing operations.

use super::indexing::IndexWrap;
use core::fmt::Debug;

/// Types which can be converted to a `usize` Size.
pub trait AsSize: Debug + Copy + Sized {
    /// Convert to a `usize` Size.
    fn as_size(self) -> usize;
}

impl<T> AsSize for &T
where
    T: AsSize,
{
    fn as_size(self) -> usize {
        (*self).as_size()
    }
}

macro_rules! gen_as_size {
    ($ty:ty) => {
        impl AsSize for $ty {
            fn as_size(self) -> usize {
                self.try_into()
                    .unwrap_or_else(|_| panic!(
                        "Unable to convert value to usize: {}_{}",
                        self,
                        stringify!($ty)))
            }
        }
    };
    ($($ty:ty),*) => {$(gen_as_size!($ty);)*};
}

gen_as_size!(usize, isize, i64, u64, i32, u32, i16, u16, i8, u8);

/// Helper trait for implementing indexing with support for negative indices.
///
/// # Example
/// ```rust
/// use burn_std::AsIndex;
///
/// fn example<I: AsIndex, const D: usize>(dim: I, size: usize) -> isize {
///    let dim: usize = dim.expect_dim_index(D);
///    unimplemented!()
/// }
/// ```
pub trait AsIndex: Debug + Copy + Sized {
    /// Converts into an `isize` index.
    fn as_index(self) -> isize;

    /// Short-form [`IndexWrap::expect_index(idx, size)`].
    fn expect_elem_index(self, size: usize) -> usize {
        IndexWrap::expect_elem(self, size)
    }

    /// Short-form [`IndexWrap::expect_dim(idx, size)`].
    fn expect_dim_index(self, size: usize) -> usize {
        IndexWrap::expect_dim(self, size)
    }
}

impl<T> AsIndex for &T
where
    T: AsIndex,
{
    fn as_index(self) -> isize {
        (*self).as_index()
    }
}

macro_rules! gen_as_index {
    ($ty:ty) => {
        impl AsIndex for $ty {
            fn as_index(self) -> isize {
                self as isize
            }
        }
    };
    ($($ty:ty),*) => {$(gen_as_index!($ty);)*};
}

gen_as_index!(usize, isize, i64, u64, i32, u32, i16, u16, i8, u8);

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

    #[test]
    fn test_as_size() {
        assert_eq!(1_usize.as_size(), 1_usize);
        assert_eq!(1_isize.as_size(), 1_usize);
        assert_eq!(1_i64.as_size(), 1_usize);
        assert_eq!(1_u64.as_size(), 1_usize);
        assert_eq!(1_i32.as_size(), 1_usize);
        assert_eq!(1_u32.as_size(), 1_usize);
        assert_eq!(1_i16.as_size(), 1_usize);
        assert_eq!(1_u16.as_size(), 1_usize);
        assert_eq!(1_i8.as_size(), 1_usize);
        assert_eq!(1_u8.as_size(), 1_usize);

        assert_eq!((&1_usize).as_size(), 1_usize);
    }

    #[test]
    #[should_panic(expected = "Unable to convert value to usize: -1_isize")]
    fn test_as_size_isize_panic() {
        (-1_isize).as_size();
    }
    #[test]
    #[should_panic(expected = "Unable to convert value to usize: -1_i64")]
    fn test_as_size_i64() {
        (-1_i64).as_size();
    }

    #[test]
    #[should_panic(expected = "Unable to convert value to usize: -1_i32")]
    fn test_as_size_i32() {
        (-1_i32).as_size();
    }

    #[test]
    #[should_panic(expected = "Unable to convert value to usize: -1_i16")]
    fn test_as_size_i16() {
        (-1_i16).as_size();
    }

    #[test]
    #[should_panic(expected = "Unable to convert value to usize: -1_i8")]
    fn test_as_size_i8() {
        (-1_i8).as_size();
    }

    #[test]
    fn test_as_index() {
        assert_eq!(1_usize.as_index(), 1_isize);
        assert_eq!(1_isize.as_index(), 1_isize);
        assert_eq!(1_i64.as_index(), 1_isize);
        assert_eq!(1_u64.as_index(), 1_isize);
        assert_eq!(1_i32.as_index(), 1_isize);
        assert_eq!(1_u32.as_index(), 1_isize);
        assert_eq!(1_i16.as_index(), 1_isize);
        assert_eq!(1_u16.as_index(), 1_isize);
        assert_eq!(1_i8.as_index(), 1_isize);
        assert_eq!(1_u8.as_index(), 1_isize);

        assert_eq!((&1_usize).as_index(), 1_isize);

        assert_eq!(-1_isize.as_index(), -1_isize);
        assert_eq!(-1_i64.as_index(), -1_isize);
        assert_eq!(-1_i32.as_index(), -1_isize);
        assert_eq!(-1_i16.as_index(), -1_isize);
        assert_eq!(-1_i8.as_index(), -1_isize);
    }
}