Skip to content

Overloads for scalars constructor. #9693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 108 additions & 0 deletions extension/apple/ExecuTorch/Exported/ExecuTorchTensor.h
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,114 @@ __attribute__((deprecated("This API is experimental.")))
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism
NS_SWIFT_NAME(init(_:shape:strides:dimensionOrder:dataType:shapeDynamism:));

/**
* Initializes a tensor with an array of scalar values, specifying shape, strides, dimension order, and data type,
* using a default dynamic bound shape for shape dynamism.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param shape An NSArray of NSNumber objects representing the desired tensor shape.
* @param strides An NSArray of NSNumber objects representing the tensor strides.
* @param dimensionOrder An NSArray of NSNumber objects indicating the order of dimensions.
* @param dataType An ExecuTorchDataType value specifying the element type.
* @return An initialized ExecuTorchTensor instance containing the scalar values.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
strides:(NSArray<NSNumber *> *)strides
dimensionOrder:(NSArray<NSNumber *> *)dimensionOrder
dataType:(ExecuTorchDataType)dataType
NS_SWIFT_NAME(init(_:shape:strides:dimensionOrder:dataType:));

/**
* Initializes a tensor with an array of scalar values, specifying the desired shape, data type, and explicit shape dynamism.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param shape An NSArray of NSNumber objects representing the desired tensor shape.
* @param dataType An ExecuTorchDataType value specifying the element type.
* @param shapeDynamism An ExecuTorchShapeDynamism value indicating the shape dynamism.
* @return An initialized ExecuTorchTensor instance.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
dataType:(ExecuTorchDataType)dataType
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism
NS_SWIFT_NAME(init(_:shape:dataType:shapeDynamism:));

/**
* Initializes a tensor with an array of scalar values and a specified shape,
* using a default dynamic bound shape for shape dynamism.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param shape An NSArray of NSNumber objects representing the desired tensor shape.
* @param dataType An ExecuTorchDataType value specifying the element type.
* @return An initialized ExecuTorchTensor instance.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
dataType:(ExecuTorchDataType)dataType
NS_SWIFT_NAME(init(_:shape:dataType:));

/**
* Initializes a tensor with an array of scalar values, specifying the tensor data type and explicit shape dynamism.
* The shape is deduced from the count of the scalar array.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param dataType An ExecuTorchDataType value specifying the element type.
* @param shapeDynamism An ExecuTorchShapeDynamism value indicating the shape dynamism.
* @return An initialized ExecuTorchTensor instance with the shape deduced from the scalar count.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
dataType:(ExecuTorchDataType)dataType
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism
NS_SWIFT_NAME(init(_:dataType:shapeDynamism:));

/**
* Initializes a tensor with an array of scalar values, specifying the tensor data type.
* The shape is deduced from the count of the scalar array.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param dataType An ExecuTorchDataType value specifying the element type.
* @return An initialized ExecuTorchTensor instance with the shape deduced from the scalar count.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
dataType:(ExecuTorchDataType)dataType
NS_SWIFT_NAME(init(_:dataType:));

/**
* Initializes a tensor with an array of scalar values, a specified shape and explicit shape dynamism.
* The data type is automatically deduced from the first element of the array.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param shape An NSArray of NSNumber objects representing the desired tensor shape.
* @param shapeDynamism An ExecuTorchShapeDynamism value indicating the shape dynamism.
* @return An initialized ExecuTorchTensor instance.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism
NS_SWIFT_NAME(init(_:shape:shapeDynamism:));

/**
* Initializes a tensor with an array of scalar values and a specified shape.
* The data type is automatically deduced from the first element of the array.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @param shape An NSArray of NSNumber objects representing the desired tensor shape.
* @return An initialized ExecuTorchTensor instance.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
NS_SWIFT_NAME(init(_:shape:));

/**
* Initializes a tensor with an array of scalar values, automatically deducing the tensor shape and data type.
*
* @param scalars An NSArray of NSNumber objects representing the scalar values.
* @return An initialized ExecuTorchTensor instance with shape and data type deduced.
*/
- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
NS_SWIFT_NAME(init(_:));

@end

NS_ASSUME_NONNULL_END
87 changes: 87 additions & 0 deletions extension/apple/ExecuTorch/Exported/ExecuTorchTensor.mm
Original file line number Diff line number Diff line change
Expand Up @@ -367,4 +367,91 @@ - (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
return [self initWithNativeInstance:&tensor];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
strides:(NSArray<NSNumber *> *)strides
dimensionOrder:(NSArray<NSNumber *> *)dimensionOrder
dataType:(ExecuTorchDataType)dataType {
return [self initWithScalars:scalars
shape:shape
strides:strides
dimensionOrder:dimensionOrder
dataType:dataType
shapeDynamism:ExecuTorchShapeDynamismDynamicBound];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
dataType:(ExecuTorchDataType)dataType
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism {
return [self initWithScalars:scalars
shape:shape
strides:@[]
dimensionOrder:@[]
dataType:dataType
shapeDynamism:shapeDynamism];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
dataType:(ExecuTorchDataType)dataType {
return [self initWithScalars:scalars
shape:shape
strides:@[]
dimensionOrder:@[]
dataType:dataType
shapeDynamism:ExecuTorchShapeDynamismDynamicBound];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
dataType:(ExecuTorchDataType)dataType
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism {
return [self initWithScalars:scalars
shape:@[@(scalars.count)]
strides:@[]
dimensionOrder:@[]
dataType:dataType
shapeDynamism:shapeDynamism];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
dataType:(ExecuTorchDataType)dataType {
return [self initWithScalars:scalars
shape:@[@(scalars.count)]
strides:@[]
dimensionOrder:@[]
dataType:dataType
shapeDynamism:ExecuTorchShapeDynamismDynamicBound];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape
shapeDynamism:(ExecuTorchShapeDynamism)shapeDynamism {
return [self initWithScalars:scalars
shape:shape
strides:@[]
dimensionOrder:@[]
dataType:static_cast<ExecuTorchDataType>(utils::deduceType(scalars.firstObject))
shapeDynamism:shapeDynamism];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars
shape:(NSArray<NSNumber *> *)shape {
return [self initWithScalars:scalars
shape:shape
strides:@[]
dimensionOrder:@[]
dataType:static_cast<ExecuTorchDataType>(utils::deduceType(scalars.firstObject))
shapeDynamism:ExecuTorchShapeDynamismDynamicBound];
}

- (instancetype)initWithScalars:(NSArray<NSNumber *> *)scalars {
return [self initWithScalars:scalars
shape:@[@(scalars.count)]
strides:@[]
dimensionOrder:@[]
dataType:static_cast<ExecuTorchDataType>(utils::deduceType(scalars.firstObject))
shapeDynamism:ExecuTorchShapeDynamismDynamicBound];
}

@end
10 changes: 5 additions & 5 deletions extension/apple/ExecuTorch/__tests__/TensorTest.swift
Original file line number Diff line number Diff line change
Expand Up @@ -225,12 +225,12 @@ class TensorTest: XCTestCase {
}

func testInitScalarsFloat() {
let data: [Float] = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0]
let tensor = Tensor(data.map(NSNumber.init), shape: [2, 3], strides: [3, 1], dimensionOrder: [0, 1], dataType: .float, shapeDynamism: .dynamicBound)
let data: [Float] = [1, 2, 3, 4, 5, 6]
let tensor = Tensor(data.map(NSNumber.init))
XCTAssertEqual(tensor.dataType, .float)
XCTAssertEqual(tensor.shape, [2, 3])
XCTAssertEqual(tensor.strides, [3, 1])
XCTAssertEqual(tensor.dimensionOrder, [0, 1])
XCTAssertEqual(tensor.shape, [6])
XCTAssertEqual(tensor.strides, [1])
XCTAssertEqual(tensor.dimensionOrder, [0])
XCTAssertEqual(tensor.count, 6)
tensor.bytes { pointer, count, dataType in
XCTAssertEqual(Array(UnsafeBufferPointer(start: pointer.assumingMemoryBound(to: Float.self), count: count)), data)
Expand Down
Loading