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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
use burn_backend::{ElementConversion, Scalar, ops::IntTensorOps};
use burn_dispatch::Dispatch;
use crate::{
Cast, Device, Float, Int, Shape, Tensor, TensorCreationOptions, TensorData, cartesian_grid,
ops::BridgeTensor,
};
use core::ops::Range;
impl Tensor<1, Int> {
/// Returns a new integer tensor on the specified device.
///
/// # Arguments
///
/// * `range` - The range of values to generate.
/// * `device` - The device to create the tensor on.
pub fn arange(range: Range<i64>, options: impl Into<TensorCreationOptions>) -> Self {
let opt = options.into();
let dtype = opt.resolve_dtype::<Int>();
Tensor::new(arange_impl(range, opt.device, dtype))
}
/// Returns a new integer tensor on the specified device.
///
/// # Arguments
///
/// * `range` - The range of values to generate.
/// * `step` - The step between each value.
pub fn arange_step(
range: Range<i64>,
step: usize,
options: impl Into<TensorCreationOptions>,
) -> Self {
let opt = options.into();
let dtype = opt.resolve_dtype::<Int>();
Tensor::new(arange_step_impl(range, step, opt.device, dtype))
}
}
impl<const D: usize> Tensor<D, Int> {
/// Create a tensor from integers (i32), placing it on a given device.
///
/// # Example
///
/// ```rust
/// use burn_tensor::{Tensor, Int};
///
/// fn example() {
/// let device = Default::default();
/// let _x: Tensor<1, Int> = Tensor::from_ints([1, 2], &device);
/// let _y: Tensor<2, Int> = Tensor::from_ints([[1, 2], [3, 4]], &device);
/// }
/// ```
pub fn from_ints<A: Into<TensorData>>(ints: A, device: &Device) -> Self {
Self::from_data(ints.into().convert::<i32>(), device)
}
/// Returns a new tensor with the same shape and device as the current tensor and the data
/// cast to Float.
///
/// # Example
///
/// ```rust
/// use burn_tensor::{Int, Tensor};
///
/// fn example() {
/// let device = Default::default();
/// let int_tensor = Tensor::<1, Int>::arange(0..5, &device);
/// let float_tensor = int_tensor.float();
/// }
/// ```
pub fn float(self) -> Tensor<D, Float> {
let device = self.device();
Tensor::new(int_to_float_impl(self.primitive, device))
}
/// Generates a cartesian grid for the given tensor shape on the specified device.
/// The generated tensor is of dimension `D2 = D + 1`, where each element at dimension D contains the cartesian grid coordinates for that element.
///
/// # Arguments
///
/// * `shape` - The shape specifying the dimensions of the tensor.
/// * `device` - The device to create the tensor on.
///
/// # Panics
///
/// Panics if `D2` is not equal to `D+1`.
///
/// # Examples
///
/// ```rust
/// use burn_tensor::Int;
/// use burn_tensor::{Shape, Tensor};
/// fn example() {
/// let device = Default::default();
/// let result: Tensor<3, _> = Tensor::<2, Int>::cartesian_grid([2, 3], &device);
/// println!("{}", result);
/// }
/// ```
pub fn cartesian_grid<S: Into<Shape>, const D2: usize>(
shape: S,
device: &Device,
) -> Tensor<D2, Int> {
cartesian_grid::<S, D, D2>(shape, device)
}
/// Applies element wise square operation.
///
#[cfg_attr(doc, doc = r#"$y_i = x_i * x_i$"#)]
#[cfg_attr(not(doc), doc = "`y_i = x_i * x_i`")]
pub fn square(self) -> Self {
Self::new(square_impl(self.primitive))
}
/// Applies the bitwise logical and operation with each bit representing the integer.
pub fn bitwise_and(self, other: Self) -> Self {
Self::new(bitwise_and_impl(self.primitive, other.primitive))
}
/// Applies the bitwise logical or operation with another tensor.
pub fn bitwise_or(self, other: Self) -> Self {
Self::new(bitwise_or_impl(self.primitive, other.primitive))
}
/// Applies the bitwise logical xor operation with another tensor.
pub fn bitwise_xor(self, other: Self) -> Self {
Self::new(bitwise_xor_impl(self.primitive, other.primitive))
}
/// Applies the bitwise logical not operation.
pub fn bitwise_not(self) -> Self {
Self::new(bitwise_not_impl(self.primitive))
}
/// Applies the bitwise logical and operation with each bit in the scalar and the integers in the tensor.
pub fn bitwise_and_scalar(self, other: impl ElementConversion) -> Self {
let other = Scalar::new(other, &self.dtype());
Self::new(bitwise_and_scalar_impl(self.primitive, other))
}
/// Applies the bitwise logical or operation with each bit in the scalar and the integers in the tensor.
pub fn bitwise_or_scalar(self, other: impl ElementConversion) -> Self {
let other = Scalar::new(other, &self.dtype());
Self::new(bitwise_or_scalar_impl(self.primitive, other))
}
/// Applies bitwise logical xor operation with each bit in the scalar and the integers in the tensor.
pub fn bitwise_xor_scalar(self, other: impl ElementConversion) -> Self {
let other = Scalar::new(other, &self.dtype());
Self::new(bitwise_xor_scalar_impl(self.primitive, other))
}
/// Applies the bitwise left shift operation with the integers in the tensor.
pub fn bitwise_left_shift(self, other: Self) -> Self {
Self::new(bitwise_left_shift_impl(self.primitive, other.primitive))
}
/// Applies the bitwise right shift operation with the integers in the tensor.
pub fn bitwise_right_shift(self, other: Self) -> Self {
Self::new(bitwise_right_shift_impl(self.primitive, other.primitive))
}
/// Applies the bitwise left shift operation with the scalar.
pub fn bitwise_left_shift_scalar(self, other: impl ElementConversion) -> Self {
let other = Scalar::new(other, &self.dtype());
Self::new(bitwise_left_shift_scalar_impl(self.primitive, other))
}
/// Applies the bitwise right shift operation with the scalar.
pub fn bitwise_right_shift_scalar(self, other: impl ElementConversion) -> Self {
let other = Scalar::new(other, &self.dtype());
Self::new(bitwise_right_shift_scalar_impl(self.primitive, other))
}
/// Converts a tensor to the specified data type.
///
/// Supports both within-kind casting (e.g., `IntDType::I64`) and cross-kind casting
/// (e.g., `FloatDType::F32` to produce a float tensor).
///
/// This is a no-op when casting to the current dtype within the same kind.
///
/// # Example
///
/// ```rust
/// use burn_tensor::{Tensor, Int, IntDType, FloatDType};
///
/// fn example() {
/// let device = Default::default();
/// let int_tensor = Tensor::<1, Int>::arange(0..5, &device);
///
/// // Within-kind cast (int to int)
/// let i64_tensor = int_tensor.clone().cast(IntDType::I64);
///
/// // Cross-kind cast (int to float)
/// let float_tensor = int_tensor.cast(FloatDType::F32);
/// }
/// ```
#[must_use]
pub fn cast<T: Cast<D, Int>>(self, dtype: T) -> Tensor<D, T::OutputKind> {
T::cast(self, dtype)
}
}
// =========================================================================
// Non-generic implementation helpers (outlined from the generic API).
// See the crate-level docs for the rationale behind this pattern.
// =========================================================================
fn arange_impl(range: Range<i64>, device: Device, dtype: burn_std::DType) -> BridgeTensor {
BridgeTensor::int(Dispatch::int_arange(
range,
device.as_dispatch(),
dtype.into(),
))
}
fn arange_step_impl(
range: Range<i64>,
step: usize,
device: Device,
dtype: burn_std::DType,
) -> BridgeTensor {
BridgeTensor::int(Dispatch::int_arange_step(
range,
step,
device.as_dispatch(),
dtype.into(),
))
}
fn int_to_float_impl(p: BridgeTensor, device: Device) -> BridgeTensor {
let out_dtype = device.settings().float_dtype;
BridgeTensor::float(Dispatch::int_into_float(p.into(), out_dtype))
}
fn square_impl(tensor: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::int_square(tensor.into()))
}
fn bitwise_and_impl(lhs: BridgeTensor, rhs: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_and(lhs.into(), rhs.into()))
}
fn bitwise_or_impl(lhs: BridgeTensor, rhs: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_or(lhs.into(), rhs.into()))
}
fn bitwise_xor_impl(lhs: BridgeTensor, rhs: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_xor(lhs.into(), rhs.into()))
}
fn bitwise_not_impl(p: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_not(p.into()))
}
fn bitwise_and_scalar_impl(p: BridgeTensor, other: Scalar) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_and_scalar(p.into(), other))
}
fn bitwise_or_scalar_impl(p: BridgeTensor, other: Scalar) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_or_scalar(p.into(), other))
}
fn bitwise_xor_scalar_impl(p: BridgeTensor, other: Scalar) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_xor_scalar(p.into(), other))
}
fn bitwise_left_shift_impl(lhs: BridgeTensor, rhs: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_left_shift(lhs.into(), rhs.into()))
}
fn bitwise_right_shift_impl(lhs: BridgeTensor, rhs: BridgeTensor) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_right_shift(lhs.into(), rhs.into()))
}
fn bitwise_left_shift_scalar_impl(p: BridgeTensor, other: Scalar) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_left_shift_scalar(p.into(), other))
}
fn bitwise_right_shift_scalar_impl(p: BridgeTensor, other: Scalar) -> BridgeTensor {
BridgeTensor::int(Dispatch::bitwise_right_shift_scalar(p.into(), other))
}