[mlir][sparse] add dim level type toString convenience method

[aartbik]

moved to enums

[aartbik]

semi colon ;-)

[bixia]

mlir/include/mlir/Dialect/SparseTensor/IR/Enums.h

164

Why do we want to the double quote in the string?

[wrengr]

mlir/include/mlir/Dialect/SparseTensor/IR/Enums.h

161

Rename to toMLIRString or similar? To make it clear that the string is à la MLIR surface syntax

161

Is this really worth inlining? or should the definition be moved to a cpp file instead?

mlir/lib/Dialect/SparseTensor/IR/SparseTensorDialect.cpp

163

You probably want to assert that the string is nonempty, just in case.

Also, you should keep the todo comment (unless it's been resolved by deciding that we shouldn't raise an error for undef).

[aartbik]

mlir/include/mlir/Dialect/SparseTensor/IR/Enums.h

161

This way, we don't have dependences on a cpp file, which seemed nice given the nature of the Enums.h being pretty independent

161

that makes sense, used toMLIRString

164

I am neutral, but this way it matched the print/parser values. In the long run, when those are no longer strings we can change this one too

mlir/lib/Dialect/SparseTensor/IR/SparseTensorDialect.cpp

163

It feels like having a undef value is something that should be verified elsewhere, not while printing.
But I added to TODO back for now.

The nonempty string will never be reached with your unreachable follow up, so not really worth asserting now, right?

[aartbik]

addressed comments

[aartbik]

rebased with main

mlir/include/mlir/Dialect/SparseTensor/IR/Enums.h

enum class DimLevelType : uint8_t {
   CompressedNo = 10,   // 0b010_10
   CompressedNuNo = 11, // 0b010_11
   Singleton = 16,      // 0b100_00
   SingletonNu = 17,    // 0b100_01
   SingletonNo = 18,    // 0b100_10
   SingletonNuNo = 19,  // 0b100_11
 };
 
+/// Returns string representation of the given dimension level type.
+inline std::string toMLIRString(DimLevelType dlt) {
+  switch (dlt) {
+  // TODO: should probably raise an error instead of printing it...
+  case DimLevelType::Undef:
+    return "\"undef\"";
+  case DimLevelType::Dense:
+    return "\"dense\"";
+  case DimLevelType::Compressed:
+    return "\"compressed\"";
+  case DimLevelType::CompressedNu:
+    return "\"compressed-nu\"";
+  case DimLevelType::CompressedNo:
+    return "\"compressed-no\"";
+  case DimLevelType::CompressedNuNo:
+    return "\"compressed-nu-no\"";
+  case DimLevelType::Singleton:
+    return "\"singleton\"";
+  case DimLevelType::SingletonNu:
+    return "\"singleton-nu\"";
+  case DimLevelType::SingletonNo:
+    return "\"singleton-no\"";
+  case DimLevelType::SingletonNuNo:
+    return "\"singleton-nu-no\"";
+  }
+  return "";
+}
+
 /// Check that the `DimLevelType` contains a valid (possibly undefined) value.
 constexpr bool isValidDLT(DimLevelType dlt) {
   const uint8_t formatBits = static_cast<uint8_t>(dlt) >> 2;
   const uint8_t propertyBits = static_cast<uint8_t>(dlt) & 3;
   // If undefined or dense, then must be unique and ordered.
   // Otherwise, the format must be one of the known ones.
   return (formatBits <= 1) ? (propertyBits == 0)
                            : (formatBits == 2 || formatBits == 4);

mlir/lib/Dialect/SparseTensor/IR/SparseTensorDialect.cpp

Attribute SparseTensorEncodingAttr::parse(AsmParser &parser, Type type) {
   return parser.getChecked<SparseTensorEncodingAttr>(
       parser.getContext(), dlt, dimOrd, higherOrd, ptr, ind);
 }
 
 void SparseTensorEncodingAttr::print(AsmPrinter &printer) const {
   // Print the struct-like storage in dictionary fashion.
   printer << "<{ dimLevelType = [ ";
   for (unsigned i = 0, e = getDimLevelType().size(); i < e; i++) {
-    switch (getDimLevelType()[i]) {
-    case DimLevelType::Undef:
-      // TODO: should probably raise an error instead of printing it...
-      printer << "\"undef\"";
-      break;
-    case DimLevelType::Dense:
-      printer << "\"dense\"";
-      break;
-    case DimLevelType::Compressed:
-      printer << "\"compressed\"";
-      break;
-    case DimLevelType::CompressedNu:
-      printer << "\"compressed-nu\"";
-      break;
-    case DimLevelType::CompressedNo:
-      printer << "\"compressed-no\"";
-      break;
-    case DimLevelType::CompressedNuNo:
-      printer << "\"compressed-nu-no\"";
-      break;
-    case DimLevelType::Singleton:
-      printer << "\"singleton\"";
-      break;
-    case DimLevelType::SingletonNu:
-      printer << "\"singleton-nu\"";
-      break;
-    case DimLevelType::SingletonNo:
-      printer << "\"singleton-no\"";
-      break;
-    case DimLevelType::SingletonNuNo:
-      printer << "\"singleton-nu-no\"";
-      break;
-    }
+    printer << toMLIRString(getDimLevelType()[i]);
     if (i != e - 1)
       printer << ", ";
   }
   printer << " ]";
   // Print remaining members only for non-default values.
   if (getDimOrdering() && !getDimOrdering().isIdentity())
     printer << ", dimOrdering = affine_map<" << getDimOrdering() << ">";
   if (getHigherOrdering())