tenflowers-core 0.1.1

Core tensor operations and execution engine for TenfloweRS
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
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
//! Shape inference functions for all built-in operations.

use super::types::OperationMetadata;
use crate::ops::shape_inference::{
    infer_binary_elementwise, infer_matmul, BroadcastableConstraint, MinRankConstraint,
    RankConstraint, ShapeConstraint, ShapeValidator,
};
use crate::shape_error_taxonomy::{ShapeErrorBuilder, ShapeErrorCategory, ShapeErrorUtils};
use crate::{Result, Shape, TensorError};

// ============================================================================
// Binary Elementwise Operations
// ============================================================================

/// Infer shape for binary elementwise operations (add, sub, mul, div, pow)
pub(super) fn infer_add(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(
            ShapeErrorBuilder::new("add", ShapeErrorCategory::ElementwiseMismatch)
                .expected("exactly 2 input tensors")
                .got(&format!("{} input tensors", inputs.len()))
                .build(),
        );
    }
    infer_binary_elementwise(&inputs[0], &inputs[1])
}

pub(super) fn infer_sub(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(
            ShapeErrorBuilder::new("sub", ShapeErrorCategory::ElementwiseMismatch)
                .expected("exactly 2 input tensors")
                .got(&format!("{} input tensors", inputs.len()))
                .build(),
        );
    }
    infer_binary_elementwise(&inputs[0], &inputs[1])
}

pub(super) fn infer_mul(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(
            ShapeErrorBuilder::new("mul", ShapeErrorCategory::ElementwiseMismatch)
                .expected("exactly 2 input tensors")
                .got(&format!("{} input tensors", inputs.len()))
                .build(),
        );
    }
    infer_binary_elementwise(&inputs[0], &inputs[1])
}

pub(super) fn infer_div(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(
            ShapeErrorBuilder::new("div", ShapeErrorCategory::ElementwiseMismatch)
                .expected("exactly 2 input tensors")
                .got(&format!("{} input tensors", inputs.len()))
                .build(),
        );
    }
    infer_binary_elementwise(&inputs[0], &inputs[1])
}

pub(super) fn infer_pow(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(
            ShapeErrorBuilder::new("pow", ShapeErrorCategory::ElementwiseMismatch)
                .expected("exactly 2 input tensors")
                .got(&format!("{} input tensors", inputs.len()))
                .build(),
        );
    }
    infer_binary_elementwise(&inputs[0], &inputs[1])
}

// ============================================================================
// Unary Operations
// ============================================================================

/// Infer shape for unary elementwise operations
pub(super) fn infer_unary(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 1 {
        return Err(TensorError::invalid_argument(format!(
            "Unary operation expects exactly 1 input, got {}",
            inputs.len()
        )));
    }
    Ok(inputs[0].clone())
}

// ============================================================================
// Matrix Operations
// ============================================================================

/// Infer shape for matrix multiplication
pub(super) fn infer_matmul_op(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(TensorError::invalid_argument(format!(
            "matmul expects exactly 2 inputs, got {}",
            inputs.len()
        )));
    }

    let transpose_a = metadata
        .get("transpose_a")
        .and_then(|v| v.as_bool())
        .unwrap_or(false);
    let transpose_b = metadata
        .get("transpose_b")
        .and_then(|v| v.as_bool())
        .unwrap_or(false);

    infer_matmul(&inputs[0], &inputs[1], transpose_a, transpose_b)
}

/// Infer shape for dot product
pub(super) fn infer_dot(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(TensorError::invalid_argument(format!(
            "dot expects exactly 2 inputs, got {}",
            inputs.len()
        )));
    }

    // Dot product typically results in a scalar for 1D vectors
    if inputs[0].rank() == 1 && inputs[1].rank() == 1 {
        if inputs[0].dims()[0] != inputs[1].dims()[0] {
            return Err(ShapeErrorUtils::matmul_incompatible(
                "dot", &inputs[0], &inputs[1], false, false,
            ));
        }
        Ok(Shape::from_slice(&[]))
    } else {
        // For higher dimensions, fall back to matmul rules
        infer_matmul(&inputs[0], &inputs[1], false, false)
    }
}

// ============================================================================
// Reduction Operations
// ============================================================================

/// Infer shape for reduction operations
pub(super) fn infer_reduction(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "Reduction operation requires at least 1 input".to_string(),
        ));
    }

    let input_shape = &inputs[0];
    let axis = metadata.get("axis").and_then(|v| v.as_int());
    let keepdims = metadata
        .get("keepdims")
        .and_then(|v| v.as_bool())
        .unwrap_or(false);

    if let Some(ax) = axis {
        // Validate axis
        let axis_usize = if ax < 0 {
            let positive_axis = (input_shape.rank() as i64 + ax) as usize;
            if positive_axis >= input_shape.rank() {
                return Err(ShapeErrorBuilder::new(
                    "reduction",
                    ShapeErrorCategory::ReductionAxisInvalid,
                )
                .expected(&format!(
                    "axis in range [-{}, {})",
                    input_shape.rank(),
                    input_shape.rank()
                ))
                .got(&format!("axis = {}", ax))
                .build());
            }
            positive_axis
        } else {
            let ax_usize = ax as usize;
            if ax_usize >= input_shape.rank() {
                return Err(ShapeErrorBuilder::new(
                    "reduction",
                    ShapeErrorCategory::ReductionAxisInvalid,
                )
                .expected(&format!("axis in range [0, {})", input_shape.rank()))
                .got(&format!("axis = {}", ax))
                .build());
            }
            ax_usize
        };

        // Compute output shape
        if keepdims {
            let mut out_dims = input_shape.dims().to_vec();
            out_dims[axis_usize] = 1;
            Ok(Shape::from_slice(&out_dims))
        } else {
            let mut out_dims = input_shape.dims().to_vec();
            out_dims.remove(axis_usize);
            if out_dims.is_empty() {
                Ok(Shape::from_slice(&[]))
            } else {
                Ok(Shape::from_slice(&out_dims))
            }
        }
    } else {
        // Reduce all dimensions
        if keepdims {
            Ok(Shape::from_slice(&vec![1; input_shape.rank()]))
        } else {
            Ok(Shape::from_slice(&[]))
        }
    }
}

// ============================================================================
// Manipulation Operations
// ============================================================================

/// Infer shape for reshape operation
pub(super) fn infer_reshape(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "reshape requires at least 1 input".to_string(),
        ));
    }

    let input_shape = &inputs[0];
    let new_shape_vec = metadata
        .get("shape")
        .and_then(|v| v.as_int_vec())
        .ok_or_else(|| {
            TensorError::invalid_argument("reshape requires 'shape' metadata".to_string())
        })?;

    // Convert i64 to usize and handle -1 (infer dimension)
    let input_numel = input_shape.elements();
    let mut new_dims: Vec<usize> = Vec::new();
    let mut infer_index: Option<usize> = None;

    for (i, &dim) in new_shape_vec.iter().enumerate() {
        if dim == -1 {
            if infer_index.is_some() {
                return Err(
                    ShapeErrorBuilder::new("reshape", ShapeErrorCategory::ReshapeInvalid)
                        .detail("Can only specify one -1 dimension in reshape")
                        .build(),
                );
            }
            infer_index = Some(i);
            new_dims.push(0); // Placeholder
        } else if dim <= 0 {
            return Err(
                ShapeErrorBuilder::new("reshape", ShapeErrorCategory::ReshapeInvalid)
                    .detail(&format!("Invalid dimension size: {}", dim))
                    .build(),
            );
        } else {
            new_dims.push(dim as usize);
        }
    }

    // Infer -1 dimension if present
    if let Some(idx) = infer_index {
        let known_numel: usize = new_dims.iter().filter(|&&d| d != 0).product();
        if known_numel == 0 || input_numel % known_numel != 0 {
            return Err(
                ShapeErrorBuilder::new("reshape", ShapeErrorCategory::ReshapeInvalid)
                    .expected(&format!(
                        "new shape compatible with {} elements",
                        input_numel
                    ))
                    .got("new shape would require non-integer dimension")
                    .build(),
            );
        }
        new_dims[idx] = input_numel / known_numel;
    }

    // Validate total number of elements
    let new_numel: usize = new_dims.iter().product();
    if new_numel != input_numel {
        return Err(
            ShapeErrorBuilder::new("reshape", ShapeErrorCategory::ReshapeInvalid)
                .expected(&format!("new shape with {} elements", input_numel))
                .got(&format!("new shape with {} elements", new_numel))
                .build(),
        );
    }

    Ok(Shape::from_slice(&new_dims))
}

/// Infer shape for transpose operation
pub(super) fn infer_transpose(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "transpose requires at least 1 input".to_string(),
        ));
    }

    let input_shape = &inputs[0];
    if input_shape.rank() < 2 {
        return Err(
            ShapeErrorBuilder::new("transpose", ShapeErrorCategory::TransposeInvalid)
                .expected("tensor with rank >= 2")
                .got(&format!("tensor with rank {}", input_shape.rank()))
                .build(),
        );
    }

    // Default transpose swaps last two dimensions
    let mut out_dims = input_shape.dims().to_vec();
    let rank = out_dims.len();
    out_dims.swap(rank - 2, rank - 1);

    Ok(Shape::from_slice(&out_dims))
}

/// Infer shape for permute operation
pub(super) fn infer_permute(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "permute requires at least 1 input".to_string(),
        ));
    }

    let input_shape = &inputs[0];
    let axes = metadata
        .get("axes")
        .and_then(|v| v.as_uint_vec())
        .ok_or_else(|| {
            TensorError::invalid_argument("permute requires 'axes' metadata".to_string())
        })?;

    if axes.len() != input_shape.rank() {
        return Err(
            ShapeErrorBuilder::new("permute", ShapeErrorCategory::TransposeInvalid)
                .expected(&format!("permutation with {} axes", input_shape.rank()))
                .got(&format!("permutation with {} axes", axes.len()))
                .build(),
        );
    }

    // Validate permutation
    let mut seen = vec![false; input_shape.rank()];
    for &ax in axes {
        if ax >= input_shape.rank() {
            return Err(
                ShapeErrorBuilder::new("permute", ShapeErrorCategory::TransposeInvalid)
                    .detail(&format!(
                        "Invalid axis {} (must be < {})",
                        ax,
                        input_shape.rank()
                    ))
                    .build(),
            );
        }
        if seen[ax] {
            return Err(
                ShapeErrorBuilder::new("permute", ShapeErrorCategory::TransposeInvalid)
                    .detail(&format!("Duplicate axis {} in permutation", ax))
                    .build(),
            );
        }
        seen[ax] = true;
    }

    // Apply permutation
    let in_dims = input_shape.dims();
    let out_dims: Vec<usize> = axes.iter().map(|&i| in_dims[i]).collect();

    Ok(Shape::from_slice(&out_dims))
}

/// Infer shape for squeeze operation
pub(super) fn infer_squeeze(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "squeeze requires at least 1 input".to_string(),
        ));
    }

    let input_shape = &inputs[0];
    let axis = metadata.get("axis").and_then(|v| v.as_int());

    if let Some(ax) = axis {
        // Squeeze specific axis
        let ax_usize = if ax < 0 {
            (input_shape.rank() as i64 + ax) as usize
        } else {
            ax as usize
        };

        if ax_usize >= input_shape.rank() {
            return Err(TensorError::invalid_argument(format!(
                "squeeze axis {} out of bounds for shape {:?}",
                ax,
                input_shape.dims()
            )));
        }

        if input_shape.dims()[ax_usize] != 1 {
            return Err(TensorError::invalid_argument(format!(
                "Cannot squeeze axis {} with size {}",
                ax,
                input_shape.dims()[ax_usize]
            )));
        }

        let mut out_dims = input_shape.dims().to_vec();
        out_dims.remove(ax_usize);

        if out_dims.is_empty() {
            Ok(Shape::from_slice(&[]))
        } else {
            Ok(Shape::from_slice(&out_dims))
        }
    } else {
        // Squeeze all dimensions of size 1
        let out_dims: Vec<usize> = input_shape
            .dims()
            .iter()
            .filter(|&&d| d != 1)
            .copied()
            .collect();

        if out_dims.is_empty() {
            Ok(Shape::from_slice(&[]))
        } else {
            Ok(Shape::from_slice(&out_dims))
        }
    }
}

/// Infer shape for unsqueeze operation
pub(super) fn infer_unsqueeze(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "unsqueeze requires at least 1 input".to_string(),
        ));
    }

    let input_shape = &inputs[0];
    let axis = metadata
        .get("axis")
        .and_then(|v| v.as_int())
        .ok_or_else(|| {
            TensorError::invalid_argument("unsqueeze requires 'axis' metadata".to_string())
        })?;

    let new_rank = input_shape.rank() + 1;
    let ax_usize = if axis < 0 {
        (new_rank as i64 + axis) as usize
    } else {
        axis as usize
    };

    if ax_usize > input_shape.rank() {
        return Err(TensorError::invalid_argument(format!(
            "unsqueeze axis {} out of bounds for new rank {}",
            axis, new_rank
        )));
    }

    let mut out_dims = input_shape.dims().to_vec();
    out_dims.insert(ax_usize, 1);

    Ok(Shape::from_slice(&out_dims))
}

// ============================================================================
// Concatenation Operations
// ============================================================================

/// Infer shape for concatenation operation
pub(super) fn infer_concat(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "concat requires at least 1 input".to_string(),
        ));
    }

    let axis = metadata.get("axis").and_then(|v| v.as_int()).unwrap_or(0);

    let first_shape = &inputs[0];
    let ax_usize = if axis < 0 {
        (first_shape.rank() as i64 + axis) as usize
    } else {
        axis as usize
    };

    if ax_usize >= first_shape.rank() {
        return Err(
            ShapeErrorBuilder::new("concat", ShapeErrorCategory::ConcatenationInvalid)
                .expected(&format!("axis in range [0, {})", first_shape.rank()))
                .got(&format!("axis = {}", axis))
                .build(),
        );
    }

    // Validate all shapes match except on concat axis
    let mut concat_size = first_shape.dims()[ax_usize];
    for (i, shape) in inputs.iter().enumerate().skip(1) {
        if shape.rank() != first_shape.rank() {
            return Err(
                ShapeErrorBuilder::new("concat", ShapeErrorCategory::ConcatenationInvalid)
                    .expected(&format!("all tensors to have rank {}", first_shape.rank()))
                    .got(&format!("tensor {} has rank {}", i, shape.rank()))
                    .build(),
            );
        }

        for (dim_idx, (&dim1, &dim2)) in first_shape
            .dims()
            .iter()
            .zip(shape.dims().iter())
            .enumerate()
        {
            if dim_idx != ax_usize && dim1 != dim2 {
                return Err(ShapeErrorBuilder::new(
                    "concat",
                    ShapeErrorCategory::ConcatenationInvalid,
                )
                .expected(&format!(
                    "dimension {} to match: {} == {}",
                    dim_idx, dim1, dim2
                ))
                .got(&format!(
                    "dimension {} mismatch: {} != {}",
                    dim_idx, dim1, dim2
                ))
                .build());
            }
        }

        concat_size += shape.dims()[ax_usize];
    }

    // Build output shape
    let mut out_dims = first_shape.dims().to_vec();
    out_dims[ax_usize] = concat_size;

    Ok(Shape::from_slice(&out_dims))
}

/// Infer shape for stack operation
pub(super) fn infer_stack(inputs: &[Shape], metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.is_empty() {
        return Err(TensorError::invalid_argument(
            "stack requires at least 1 input".to_string(),
        ));
    }

    let axis = metadata.get("axis").and_then(|v| v.as_int()).unwrap_or(0);

    let first_shape = &inputs[0];

    // All shapes must be identical for stack
    for (i, shape) in inputs.iter().enumerate().skip(1) {
        if shape.dims() != first_shape.dims() {
            return Err(
                ShapeErrorBuilder::new("stack", ShapeErrorCategory::ConcatenationInvalid)
                    .expected(&format!(
                        "all tensors to have shape {:?}",
                        first_shape.dims()
                    ))
                    .got(&format!("tensor {} has shape {:?}", i, shape.dims()))
                    .build(),
            );
        }
    }

    let new_rank = first_shape.rank() + 1;
    let ax_usize = if axis < 0 {
        (new_rank as i64 + axis) as usize
    } else {
        axis as usize
    };

    if ax_usize > first_shape.rank() {
        return Err(TensorError::invalid_argument(format!(
            "stack axis {} out of bounds for new rank {}",
            axis, new_rank
        )));
    }

    // Insert new dimension at stack axis
    let mut out_dims = first_shape.dims().to_vec();
    out_dims.insert(ax_usize, inputs.len());

    Ok(Shape::from_slice(&out_dims))
}

// ============================================================================
// Comparison and Logical Operations
// ============================================================================

/// Infer shape for comparison operations
pub(super) fn infer_comparison(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(TensorError::invalid_argument(format!(
            "Comparison operation expects exactly 2 inputs, got {}",
            inputs.len()
        )));
    }
    // Comparison operations broadcast like binary elementwise
    infer_binary_elementwise(&inputs[0], &inputs[1])
}

/// Infer shape for logical operations
pub(super) fn infer_logical(inputs: &[Shape], _metadata: &OperationMetadata) -> Result<Shape> {
    if inputs.len() != 2 {
        return Err(TensorError::invalid_argument(format!(
            "Logical operation expects exactly 2 inputs, got {}",
            inputs.len()
        )));
    }
    // Logical operations broadcast like binary elementwise
    infer_binary_elementwise(&inputs[0], &inputs[1])
}