[mlir[sparse] showcase custom reduction with implicit zeros

[aartbik]

rebased with main

[aartbik]

Abandoning since this is also in https://reviews.llvm.org/D152204

mlir/test/Integration/Dialect/SparseTensor/CPU/sparse_reductions_prod.mlir

#trait_reduction = {
   ],
   iterator_types = ["reduction"],
   doc = "x += PROD_CUSTOM_i a(i)"
 }
 
 // An example of vector reductions.
 module {
 
+  // Custom prod reduction: stored i32 elements only.
   func.func @prod_dreduction_i32(%arga: tensor<32xi32, #DV>,
                                  %argx: tensor<i32>) -> tensor<i32> {
     %c = tensor.extract %argx[] : tensor<i32>
     %0 = linalg.generic #trait_reduction
       ins(%arga: tensor<32xi32, #DV>)
       outs(%argx: tensor<i32>) {
         ^bb(%a: i32, %b: i32):
           %1 = sparse_tensor.reduce %a, %b, %c : i32 {
             ^bb0(%x: i32, %y: i32):
               %2 = arith.muli %x, %y : i32
               sparse_tensor.yield %2 : i32
           }
           linalg.yield %1 : i32
     } -> tensor<i32>
     return %0 : tensor<i32>
   }
 
+  // Custom prod reduction: stored f32 elements only.
   func.func @prod_dreduction_f32(%arga: tensor<32xf32, #DV>,
                                  %argx: tensor<f32>) -> tensor<f32> {
     %c = tensor.extract %argx[] : tensor<f32>
     %0 = linalg.generic #trait_reduction
       ins(%arga: tensor<32xf32, #DV>)
       outs(%argx: tensor<f32>) {
         ^bb(%a: f32, %b: f32):
           %1 = sparse_tensor.reduce %a, %b, %c : f32 {
             ^bb0(%x: f32, %y: f32):
               %2 = arith.mulf %x, %y : f32
               sparse_tensor.yield %2 : f32
           }
           linalg.yield %1 : f32
     } -> tensor<f32>
     return %0 : tensor<f32>
   }
 
+  // Custom prod reduction: stored i32 elements only.
   func.func @prod_sreduction_i32(%arga: tensor<32xi32, #SV>,
                                  %argx: tensor<i32>) -> tensor<i32> {
     %c = tensor.extract %argx[] : tensor<i32>
     %0 = linalg.generic #trait_reduction
       ins(%arga: tensor<32xi32, #SV>)
       outs(%argx: tensor<i32>) {
         ^bb(%a: i32, %b: i32):
           %1 = sparse_tensor.reduce %a, %b, %c : i32 {
             ^bb0(%x: i32, %y: i32):
               %2 = arith.muli %x, %y : i32
               sparse_tensor.yield %2 : i32
           }
           linalg.yield %1 : i32
     } -> tensor<i32>
     return %0 : tensor<i32>
   }
 
+  // Custom prod reduction: stored f32 elements only.
   func.func @prod_sreduction_f32(%arga: tensor<32xf32, #SV>,
                                  %argx: tensor<f32>) -> tensor<f32> {
     %c = tensor.extract %argx[] : tensor<f32>
     %0 = linalg.generic #trait_reduction
       ins(%arga: tensor<32xf32, #SV>)
       outs(%argx: tensor<f32>) {
         ^bb(%a: f32, %b: f32):
           %1 = sparse_tensor.reduce %a, %b, %c : f32 {
             ^bb0(%x: f32, %y: f32):
               %2 = arith.mulf %x, %y : f32
               sparse_tensor.yield %2 : f32
           }
           linalg.yield %1 : f32
     } -> tensor<f32>
     return %0 : tensor<f32>
   }
 
+  // Custom prod reduction: stored i32 elements and implicit zeros.
+  //
+  // NOTE: this is a somewhat strange operation, since for most sparse
+  //       situations the outcome would always be zero; it is added
+  //       to test full functionality and illustrate the subtle differences
+  //       between the various custom operations; it would make a bit more
+  //       sense for e.g. a min/max reductions, although it still would
+  //       "densify" the iteration space.
+  //
+  func.func @prod_xreduction_i32(%arga: tensor<32xi32, #SV>,
+                                 %argx: tensor<i32>) -> tensor<i32> {
+    %c = tensor.extract %argx[] : tensor<i32>
+    %0 = linalg.generic #trait_reduction
+      ins(%arga: tensor<32xi32, #SV>)
+      outs(%argx: tensor<i32>) {
+        ^bb(%a: i32, %b: i32):
+           %u = sparse_tensor.unary %a : i32 to i32
+           present={
+             ^bb0(%x: i32):
+             sparse_tensor.yield %x : i32
+           } absent={
+             ^bb0:
+             %c0 = arith.constant 0 : i32
+             sparse_tensor.yield %c0 : i32
+          }
+          %1 = sparse_tensor.reduce %u, %b, %c : i32 {
+            ^bb0(%x: i32, %y: i32):
+              %2 = arith.muli %x, %y : i32
+              sparse_tensor.yield %2 : i32
+          }
+          linalg.yield %1 : i32
+    } -> tensor<i32>
+    return %0 : tensor<i32>
+  }
+
+
   func.func @dump_i32(%arg0 : tensor<i32>) {
     %v = tensor.extract %arg0[] : tensor<i32>
     vector.print %v : i32
     return
   }
 
   func.func @dump_f32(%arg0 : tensor<f32>) {
     %v = tensor.extract %arg0[] : tensor<f32>
func.func @entry() {
     %1 = call @prod_dreduction_f32(%d0_f32, %rf) : (tensor<32xf32, #DV>, tensor<f32>) -> tensor<f32>
     %2 = call @prod_sreduction_i32(%s0_i32, %ri) : (tensor<32xi32, #SV>, tensor<i32>) -> tensor<i32>
     %3 = call @prod_sreduction_f32(%s0_f32, %rf) : (tensor<32xf32, #SV>, tensor<f32>) -> tensor<f32>
     %4 = call @prod_dreduction_i32(%d1_i32, %ri) : (tensor<32xi32, #DV>, tensor<i32>) -> tensor<i32>
     %5 = call @prod_dreduction_f32(%d1_f32, %rf) : (tensor<32xf32, #DV>, tensor<f32>) -> tensor<f32>
     %6 = call @prod_sreduction_i32(%s1_i32, %ri) : (tensor<32xi32, #SV>, tensor<i32>) -> tensor<i32>
     %7 = call @prod_sreduction_f32(%s1_f32, %rf) : (tensor<32xf32, #SV>, tensor<f32>) -> tensor<f32>
     %8 = call @prod_sreduction_i32(%s0,     %ri) : (tensor<32xi32, #SV>, tensor<i32>) -> tensor<i32>
+    %9 = call @prod_xreduction_i32(%s0_i32, %ri) : (tensor<32xi32, #SV>, tensor<i32>) -> tensor<i32>
 
     // Verify results. Note that the custom reduction gave permission
     // to treat an explicit vs implicit zero differently to compute the
     // full product reduction over stored elements. A "standard" product
     // reduction would have to return 0 for any implicit zero occurrence
     // too. An explicit zero nullifies the product, though, as requested.
     //
     // CHECK: 0
     // CHECK: 0
     // CHECK: 3087
     // CHECK: 14
     // CHECK: 3087
     // CHECK: 168
     // CHECK: 3087
     // CHECK: 168
     // CHECK: 0
+    // CHECK: 0
     //
     call @dump_i32(%0) : (tensor<i32>) -> ()
     call @dump_f32(%1) : (tensor<f32>) -> ()
     call @dump_i32(%2) : (tensor<i32>) -> ()
     call @dump_f32(%3) : (tensor<f32>) -> ()
     call @dump_i32(%4) : (tensor<i32>) -> ()
     call @dump_f32(%5) : (tensor<f32>) -> ()
     call @dump_i32(%6) : (tensor<i32>) -> ()
     call @dump_f32(%7) : (tensor<f32>) -> ()
     call @dump_i32(%8) : (tensor<i32>) -> ()
+    call @dump_i32(%9) : (tensor<i32>) -> ()
 
     // Release the resources.
     bufferization.dealloc_tensor %d0_i32 : tensor<32xi32, #DV>
     bufferization.dealloc_tensor %d0_f32 : tensor<32xf32, #DV>
     bufferization.dealloc_tensor %s0_i32 : tensor<32xi32, #SV>
     bufferization.dealloc_tensor %s0_f32 : tensor<32xf32, #SV>
     bufferization.dealloc_tensor %d1_i32 : tensor<32xi32, #DV>
     bufferization.dealloc_tensor %d1_f32 : tensor<32xf32, #DV>
     bufferization.dealloc_tensor %s1_i32 : tensor<32xi32, #SV>
     bufferization.dealloc_tensor %s1_f32 : tensor<32xf32, #SV>
     bufferization.dealloc_tensor %s0     : tensor<32xi32, #SV>
 
     return
   }
 }