bunsen 0.29.0

bunsen is a batteries included common library for burn
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202

//! # `TensorData` View Wrappers

use std::ops::{
    Deref,
    DerefMut,
    Index,
    IndexMut,
};

use burn::{
    prelude::TensorData,
    tensor::{
        AsIndex,
        Element,
    },
};

use crate::zspace::ravel_dims;

/// [Index] view wrapper for a [`TensorData`].
///
/// # Example
/// ```rust,no_run
/// use bunsen::burner::tensor::*;
/// use burn::prelude::*;
///
/// let data = TensorData::from([[1.0, 2.0], [3.0, 4.0]]);
/// let shape = data.shape.clone();
/// let view: TensorDataIndexView<f64> = TensorDataIndexView::view(&data);
///
/// // Deref
/// assert_eq!(&view.shape, &shape);
///
/// assert_eq!(view[&[0, 0]], 1.0);
/// assert_eq!(view[&[0, 1]], 2.0);
/// assert_eq!(view[&[1, 0]], 3.0);
/// assert_eq!(view[&[1, 1]], 4.0);
/// ```
#[derive(Debug)]
pub struct TensorDataIndexView<'a, E: Element> {
    data: &'a TensorData,
    _phantom: std::marker::PhantomData<&'a E>,
}

impl<'a, E: Element> Deref for TensorDataIndexView<'a, E> {
    type Target = TensorData;

    fn deref(&self) -> &Self::Target {
        self.data
    }
}

impl<'a, E: Element> TensorDataIndexView<'a, E> {
    /// Returns an indexed view of the data.
    pub fn view(data: &'a TensorData) -> TensorDataIndexView<'a, E> {
        TensorDataIndexView {
            data,
            _phantom: std::marker::PhantomData,
        }
    }

    /// Ravels the dims via [`ravel_dims`] and the view's shape.
    pub fn ravel_dims<I: AsIndex>(
        &self,
        dims: &[I],
    ) -> usize {
        ravel_dims(&self.data.shape, dims)
    }
}

impl<'a, I: AsIndex, E: Element> Index<&[I]> for TensorDataIndexView<'a, E> {
    type Output = E;

    fn index(
        &self,
        index: &[I],
    ) -> &Self::Output {
        let o = self.ravel_dims(index);
        &self.data.as_slice::<E>().unwrap()[o]
    }
}

/// Mutable [`IndexMut`] view wrapper for a [`TensorData`].
///
/// # Example
/// ```rust,no_run
/// use bunsen::burner::tensor::*;
/// use burn::prelude::*;
///
/// let mut data = TensorData::from([[1.0, 2.0], [3.0, 4.0]]);
/// let shape = data.shape.clone();
/// let mut view: TensorDataIndexMutView<f64> =
///     TensorDataIndexMutView::view(&mut data);
///
/// // Deref
/// assert_eq!(&view.shape, &shape);
///
/// assert_eq!(view[&[0, 0]], 1.0);
/// assert_eq!(view[&[0, 1]], 2.0);
/// assert_eq!(view[&[1, 0]], 3.0);
/// assert_eq!(view[&[1, 1]], 4.0);
///
/// view[&[0, 0]] = 10.0;
/// assert_eq!(view[&[0, 0]], 10.0);
/// ```
#[derive(Debug)]
pub struct TensorDataIndexMutView<'a, E: Element> {
    data: &'a mut TensorData,
    _phantom: std::marker::PhantomData<&'a E>,
}

impl<'a, E: Element> Deref for TensorDataIndexMutView<'a, E> {
    type Target = TensorData;

    fn deref(&self) -> &Self::Target {
        self.data
    }
}

impl<'a, E: Element> DerefMut for TensorDataIndexMutView<'a, E> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.data
    }
}

impl<'a, E: Element> TensorDataIndexMutView<'a, E> {
    /// Returns an indexed view of the data.
    pub fn view(data: &'a mut TensorData) -> TensorDataIndexMutView<'a, E> {
        TensorDataIndexMutView {
            data,
            _phantom: std::marker::PhantomData,
        }
    }

    /// Ravels the dims via [`ravel_dims`] and the view's shape.
    pub fn ravel_dims<I: AsIndex>(
        &self,
        dims: &[I],
    ) -> usize {
        ravel_dims(&self.data.shape, dims)
    }
}

impl<'a, I: AsIndex, E: Element> Index<&[I]> for TensorDataIndexMutView<'a, E> {
    type Output = E;

    fn index(
        &self,
        index: &[I],
    ) -> &Self::Output {
        let o = self.ravel_dims(index);
        &self.data.as_slice::<E>().unwrap()[o]
    }
}

impl<'a, I: AsIndex, E: Element> IndexMut<&[I]> for TensorDataIndexMutView<'a, E> {
    fn index_mut(
        &mut self,
        index: &[I],
    ) -> &mut Self::Output {
        let o = self.ravel_dims(index);
        &mut self.data.as_mut_slice::<E>().unwrap()[o]
    }
}

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

    #[test]
    fn test_tensor_data_index_view() {
        let data = TensorData::from([[1.0, 2.0], [3.0, 4.0]]);
        let view: TensorDataIndexView<f64> = TensorDataIndexView::view(&data);

        // Deref
        assert_eq!(&data.shape, &view.shape);

        assert_eq!(view[&[0, 0]], 1.0);
        assert_eq!(view[&[0, 1]], 2.0);
        assert_eq!(view[&[1, 0]], 3.0);
        assert_eq!(view[&[1, 1]], 4.0);
    }

    #[test]
    fn test_tensor_data_index_mut_view() {
        let mut data = TensorData::from([[1.0, 2.0], [3.0, 4.0]]);
        let shape = data.shape.clone();

        let mut view: TensorDataIndexMutView<f64> = TensorDataIndexMutView::view(&mut data);

        // Deref
        assert_eq!(&view.shape, &shape);

        assert_eq!(view[&[0, 0]], 1.0);
        assert_eq!(view[&[0, 1]], 2.0);
        assert_eq!(view[&[1, 0]], 3.0);
        assert_eq!(view[&[1, 1]], 4.0);

        view[&[0, 0]] = 10.0;
        assert_eq!(view[&[0, 0]], 10.0);
    }
}