Add more types to create a Value from. (#9698)

Summary: #8364

Reviewed By: bsoyluoglu

Differential Revision: D71936422

Co-authored-by: Anthony Shoumikhin <[email protected]>

Author: kirklandsign

extension/apple/ExecuTorch/Exported/ExecuTorchValue.h

@@ -30,6 +30,17 @@ typedef NS_ENUM(uint32_t, ExecuTorchValueTag) {
   ExecuTorchValueTagOptionalTensorList,
 } NS_SWIFT_NAME(ValueTag);
 
+typedef NSNumber *ExecuTorchScalarValue
+    NS_SWIFT_BRIDGED_TYPEDEF NS_SWIFT_NAME(ScalarValue);
+typedef NSString *ExecuTorchStringValue
+    NS_SWIFT_BRIDGED_TYPEDEF NS_SWIFT_NAME(StringValue);
+typedef BOOL ExecuTorchBooleanValue
+    NS_SWIFT_BRIDGED_TYPEDEF NS_SWIFT_NAME(BoolValue);
+typedef NSInteger ExecuTorchIntegerValue
+    NS_SWIFT_BRIDGED_TYPEDEF NS_SWIFT_NAME(IntegerValue);
+typedef double ExecuTorchDoubleValue
+    NS_SWIFT_BRIDGED_TYPEDEF NS_SWIFT_NAME(DoubleValue);
+
 /**
  * A dynamic value type used by ExecuTorch.
  *
@@ -54,6 +65,41 @@ __attribute__((deprecated("This API is experimental.")))
  */
 @property(nullable, nonatomic, readonly) ExecuTorchTensor *tensorValue NS_SWIFT_NAME(tensor);
 
+/**
+ * The string value if the tag is ExecuTorchValueTagString.
+ *
+ * @return An NSString instance or nil.
+ */
+@property(nullable, nonatomic, readonly) ExecuTorchStringValue stringValue NS_SWIFT_NAME(string);
+
+/**
+ * The scalar value if the tag is boolean, integer or double.
+ *
+ * @return A scalar value or nil.
+ */
+@property(nullable, nonatomic, readonly) ExecuTorchScalarValue scalarValue NS_SWIFT_NAME(scalar);
+
+/**
+ * The boolean value if the tag is ExecuTorchValueTagBoolean.
+ *
+ * @return A BOOL representing the boolean value.
+ */
+@property(nonatomic, readonly) ExecuTorchBooleanValue boolValue NS_SWIFT_NAME(boolean);
+
+/**
+ * The integer value if the tag is ExecuTorchValueTagInteger.
+ *
+ * @return An NSInteger representing the integer value.
+ */
+@property(nonatomic, readonly) ExecuTorchIntegerValue intValue NS_SWIFT_NAME(integer);
+
+/**
+ * The double value if the tag is ExecuTorchValueTagDouble.
+ *
+ * @return A double representing the double value.
+ */
+@property(nonatomic, readonly) ExecuTorchDoubleValue doubleValue NS_SWIFT_NAME(double);
+
 /**
  * Returns YES if the value is of type None.
  *
@@ -68,6 +114,41 @@ __attribute__((deprecated("This API is experimental.")))
  */
 @property(nonatomic, readonly) BOOL isTensor;
 
+/**
+ * Returns YES if the value is a string.
+ *
+ * @return A BOOL indicating whether the value is a string.
+ */
+@property(nonatomic, readonly) BOOL isString;
+
+/**
+ * Returns YES if the value is a scalar (boolean, integer or double).
+ *
+ * @return A BOOL indicating whether the value is a scalar.
+ */
+@property(nonatomic, readonly) BOOL isScalar;
+
+/**
+ * Returns YES if the value is a boolean.
+ *
+ * @return A BOOL indicating whether the value is a boolean.
+ */
+@property(nonatomic, readonly) BOOL isBoolean;
+
+/**
+ * Returns YES if the value is an integer.
+ *
+ * @return A BOOL indicating whether the value is an integer.
+ */
+@property(nonatomic, readonly) BOOL isInteger;
+
+/**
+ * Returns YES if the value is a double.
+ *
+ * @return A BOOL indicating whether the value is a double.
+ */
+@property(nonatomic, readonly) BOOL isDouble;
+
 /**
  * Creates an instance encapsulating a Tensor.
  *
@@ -76,6 +157,42 @@ __attribute__((deprecated("This API is experimental.")))
  */
 + (instancetype)valueWithTensor:(ExecuTorchTensor *)value NS_SWIFT_NAME(init(_:));
 
+/**
+ * Creates an instance encapsulating a string.
+ *
+ * @param value A string.
+ * @return A new ExecuTorchValue instance with a tag of ExecuTorchValueTagString.
+ */
++ (instancetype)valueWithString:(ExecuTorchStringValue)value
+    NS_SWIFT_NAME(init(_:));
+
+/**
+ * Creates an instance encapsulating a boolean.
+ *
+ * @param value A boolean.
+ * @return A new ExecuTorchValue instance with a tag of ExecuTorchValueTagBoolean.
+ */
++ (instancetype)valueWithBoolean:(ExecuTorchBooleanValue)value
+    NS_SWIFT_NAME(init(_:));
+
+/**
+ * Creates an instance encapsulating an integer.
+ *
+ * @param value An integer.
+ * @return A new ExecuTorchValue instance with a tag of ExecuTorchValueTagInteger.
+ */
++ (instancetype)valueWithInteger:(ExecuTorchIntegerValue)value
+    NS_SWIFT_NAME(init(_:));
+
+/**
+ * Creates an instance encapsulating a double value.
+ *
+ * @param value A double value.
+ * @return A new ExecuTorchValue instance with a tag of ExecuTorchValueTagDouble.
+ */
++ (instancetype)valueWithDouble:(ExecuTorchDoubleValue)value
+    NS_SWIFT_NAME(init(_:));
+
 @end
 
 NS_ASSUME_NONNULL_END

extension/apple/ExecuTorch/Exported/ExecuTorchValue.mm

@@ -27,6 +27,23 @@ + (instancetype)valueWithTensor:(ExecuTorchTensor *)value {
   return [[ExecuTorchValue alloc] initWithTag:ExecuTorchValueTagTensor value:value];
 }
 
++ (instancetype)valueWithString:(ExecuTorchStringValue)value {
+  ET_CHECK(value);
+  return [[ExecuTorchValue alloc] initWithTag:ExecuTorchValueTagString value:value];
+}
+
++ (instancetype)valueWithBoolean:(ExecuTorchBooleanValue)value {
+  return [[ExecuTorchValue alloc] initWithTag:ExecuTorchValueTagBoolean value:@(value)];
+}
+
++ (instancetype)valueWithInteger:(ExecuTorchIntegerValue)value {
+  return [[ExecuTorchValue alloc] initWithTag:ExecuTorchValueTagInteger value:@(value)];
+}
+
++ (instancetype)valueWithDouble:(ExecuTorchDoubleValue)value {
+  return [[ExecuTorchValue alloc] initWithTag:ExecuTorchValueTagDouble value:@(value)];
+}
+
 - (instancetype)init {
   return [self initWithTag:ExecuTorchValueTagNone value:nil];
 }
@@ -48,6 +65,29 @@ - (nullable ExecuTorchTensor *)tensorValue {
   return self.isTensor ? _value : nil;
 }
 
+- (nullable ExecuTorchScalarValue)scalarValue {
+  return self.isScalar ? _value : nil;
+}
+
+- (nullable ExecuTorchStringValue)stringValue {
+    return self.isString ? _value : nil;
+}
+
+- (ExecuTorchBooleanValue)boolValue {
+  ET_CHECK(self.isBoolean);
+  return [(ExecuTorchScalarValue)_value boolValue];
+}
+
+- (ExecuTorchIntegerValue)intValue {
+  ET_CHECK(self.isInteger);
+  return [(ExecuTorchScalarValue)_value integerValue];
+}
+
+- (ExecuTorchDoubleValue)doubleValue {
+  ET_CHECK(self.isDouble);
+  return [(ExecuTorchScalarValue)_value doubleValue];
+}
+
 - (BOOL)isNone {
   return _tag == ExecuTorchValueTagNone;
 }
@@ -56,4 +96,26 @@ - (BOOL)isTensor {
   return _tag == ExecuTorchValueTagTensor;
 }
 
+- (BOOL)isScalar {
+  return _tag == ExecuTorchValueTagBoolean ||
+         _tag == ExecuTorchValueTagInteger ||
+         _tag == ExecuTorchValueTagDouble;
+}
+
+- (BOOL)isString {
+  return _tag == ExecuTorchValueTagString;
+}
+
+- (BOOL)isBoolean {
+  return _tag == ExecuTorchValueTagBoolean;
+}
+
+- (BOOL)isInteger {
+  return _tag == ExecuTorchValueTagInteger;
+}
+
+- (BOOL)isDouble {
+  return _tag == ExecuTorchValueTagDouble;
+}
+
 @end

extension/apple/ExecuTorch/__tests__/ValueTest.swift

@@ -22,4 +22,28 @@ class ValueTest: XCTestCase {
     XCTAssertTrue(value.isTensor)
     XCTAssertEqual(value.tensor, tensor)
   }
+
+  func testString() {
+    let value = Value("hello")
+    XCTAssertTrue(value.isString)
+    XCTAssertEqual(value.string, "hello")
+  }
+
+  func testBoolean() {
+    let value = Value(true)
+    XCTAssertTrue(value.isBoolean)
+    XCTAssertEqual(value.boolean, true)
+  }
+
+  func testInteger() {
+    let value = Value(42)
+    XCTAssertTrue(value.isInteger)
+    XCTAssertEqual(value.integer, 42)
+  }
+
+  func testDouble() {
+    let value = Value(3.14)
+    XCTAssertTrue(value.isDouble)
+    XCTAssertEqual(value.double, 3.14)
+  }
 }