Reserved APIs

The APIs described in this section are reserved and may be changed or deprecated in the future. They do not need your attention.

Table 1 API list

API Definition

Function Usage

InitTensor(const int64_t *viewDims, uint64_t viewDimsNum, aclDataType dataType, const int64_t *stride, int64_t offset, aclFormat format, const int64_t *storageDims, uint64_t storageDimsNum, void *tensorDataAddr)

Resets the attributes of an aclTensor.

ToString(op::DataType dataType)

Obtains the string corresponding to the data type.

TypeSize(DataType dataType)

Obtains the bit width of the data type.

ToContiguousStrides(const op::Shape &shape, op::Strides &strides)

Infers the strides of a contiguous tensor based on the shape.

aclStorage()

Indicates the constructor of aclStorage, which is used to describe an on-chip memory space.

aclStorage(void *addr)

Indicates the constructor of aclStorage, which is used to describe an on-chip memory space.

aclStorage(bool fromWorkspace)

Indicates the constructor of aclStorage, which is used to describe an on-chip memory space.

aclStorage(void *addr, bool fromWorkspace)

Indicates the constructor of aclStorage, which is used to describe an on-chip memory space.

GetAddr()

Obtains the pointer to the on-chip memory address represented by the storage.

SetAddr(void *addr)

Sets the pointer to the on-chip memory address represented by the storage.

SetWorkspaceOffset(uint64_t offset)

Sets the offset of the valid data in the device memory when the storage represents a workspace.

GetWorkspaceOffset()

Obtains the offset of the valid data in the device memory when the storage represents a workspace.

SetFromWorkspace(bool fromWorkspace)

Sets whether the storage represents a workspace.

SetFromWorkspace(bool from_workspace)

Sets an aclTensor to represent a workspace.

IsFromWorkspace()

Checks whether the storage represents a workspace.

SetExtend(void *extend)

Sets the content of the extend member variable.

GetExtend()

Obtains the content of the extend member variable.

SetStorageOffset(int64_t offset)

Sets the offset of the valid storage data in the device memory.

GetStorageOffset()

Obtains the offset of the valid storage data in the device memory.

aclArray()

Indicates the constructor of aclArray, which is used to describe an array on the host.

Size()

Obtains the size of aclArray.

GetData()

Obtains the data area pointer of aclArray.

ToString()

Obtains the printed string of the aclArray content.

aclArray(const T *value, uint64_t size)

Indicates the constructor of aclArray, which is used to describe an array on the host.

aclTensor(aclTensor &&other)

Blocks the constructor of this class of aclTensor.

GetTensor()

Obtains the gert::Tensor stored in aclTensor.

NOTE:

For details about gert::Tensor, see gert::Tensor in Basic Data Structures and APIs.

GetStorageAddr()

Obtains the memory pointer to the aclStorage in aclTensor.

GetStorage()

Obtains the aclStorage in aclTensor.

GetViewOffset()

Obtains the ViewOffset of aclTensor.

SetStorageAddr(void *addr)

Sets the memory pointer to the aclStorage in aclTensor.

SetViewOffset(int64_t offset)

Sets the ViewOffset of aclTensor.

GetPlacement()

Obtains the type of aclTensor, either on the device or host.

aclTensor(const int64_t *viewDims, uint64_t viewDimsNum, aclDataType dataType, const int64_t *stride, int64_t offset, const aclFormat format, const int64_t *storageDims, uint64_t storageDimsNum, void *tensorDataAddr)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(op::DataType dataType, op::Format storageFormat, op::Format originFormat)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const op::Shape &shape, op::DataType dataType, op::Format format, void *tensorDataAddr)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const op::Shape &storageShape, const op::Shape &originShape, op::DataType dataType, op::Format storageFormat, op::Format originFormat, void *tensorDataAddr)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const op::Shape &shape, op::DataType dataType, op::Format format)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const op::Shape &storageShape, const op::Shape &originShape, op::DataType dataType, op::Format storageFormat, op::Format originFormat)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclTensor &other, const op::Shape &shape, int64_t offset)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclIntArray *value, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclBoolArray *value, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclFloatArray *value, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclFp16Array *value, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclBf16Array *value, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor()

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const T *value, uint64_t size, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

aclTensor(const aclScalar *value, op::DataType dataType)

Indicates a tensor, either on the device or host. It describes the shape, dtype, and format of a tensor and records the data position.

SetFloat8E5M2Data(const op::Float8E5M2 *value, uint64_t size, op::DataType dataType)

Sets the float8_e5m2 data in an aclTensor.

SetFloat8E4M3FNData(const op::Float8E4M3FN *value, uint64_t size, op::DataType dataType)

Sets the float8_e4m3fn data in an aclTensor.

SetFloat8E8M0Data(const op::Float8E8M0 *value, uint64_t size, op::DataType dataType)

Sets the float8_e8m0 data in an aclTensor.

SetFloat6E3M2Data(const op::Float6E3M2 *value, uint64_t size, op::DataType dataType)

Sets the float6_e3m2 data in an aclTensor.

SetFloat6E2M3Data(const op::Float6E2M3 *value, uint64_t size, op::DataType dataType)

Sets the float6_e2m3 data in an aclTensor.

SetFloat4E2M1Data(const op::Float4E2M1 *value, uint64_t size, op::DataType dataType)

Sets the float4_e2m1 data in an aclTensor.

SetFloat4E1M2Data(const op::Float4E1M2 *value, uint64_t size, op::DataType dataType)

Sets the float4_e1m2 data in an aclTensor.

SetHiFloat4Data(const op::HiFloat4 *value, uint64_t size, op::DataType dataType)

Sets the hifloat4 data in an aclTensor.

SetHiFloat8Data(const op::HiFloat8 *value, uint64_t size, op::DataType dataType)

Sets the hifloat8 data in an aclTensor.

IsView()

Checks whether aclTensor is a view tensor.

IsView()

Checks whether aclTensor is a view tensor.

SetView(bool is_view)

Sets whether aclTensor is a view tensor.

aclTensorList(const aclTensor *const *tensors, uint64_t size)

Indicates an aclTensor array. This function is the constructor of aclTensorList.

aclTensorList()

Indicates an aclTensor array. This function is the constructor of aclTensorList.

aclScalar(const void *data, op::DataType dataType)

Indicates a scalar number. This function is the constructor of aclScalar.

aclScalar()

Indicates a scalar number. This function is the constructor of aclScalar.

ToFloat()

Converts the scalar stored in an aclScalar to a float value.

ToDouble()

Converts the scalar stored in an aclScalar to a double value.

ToBool()

Converts the scalar stored in an aclScalar to a bool value.

ToInt8()

Converts the scalar stored in an aclScalar to an int8 value.

ToInt16()

Converts the scalar stored in an aclScalar to an int16 value.

ToInt32()

Converts the scalar stored in an aclScalar to an int32 value.

ToInt64()

Converts the scalar stored in an aclScalar to an int64 value.

ToUint8()

Converts the scalar stored in an aclScalar to a uint8 value.

ToUint16()

Converts the scalar stored in an aclScalar to a uint16 value.

ToUint32()

Converts the scalar stored in an aclScalar to a uint32 value.

ToUint64()

Converts the scalar stored in an aclScalar to a uint64 value.

ToFp16()

Converts the scalar stored in an aclScalar to a float16 value.

ToBf16()

Converts the scalar stored in an aclScalar to a bfloat16 value.

ToFloat8E5M2()

Converts the scalar stored in an aclScalar to a float8_e5m2 value.

ToFloat8E4M3FN()

Converts the scalar stored in an aclScalar to a float8_e4m3fn value.

ToFloat8E8M0()

Converts the scalar stored in an aclScalar to a float8_e8m0 value.

ToFloat6E3M2()

Converts the scalar stored in an aclScalar to a float6_e3m2 value.

ToFloat6E2M3()

Converts the scalar stored in an aclScalar to a float6_e2m3 value.

ToFloat4E2M1()

Converts the scalar stored in an aclScalar to a float4_e2m1 value.

ToFloat4E1M2()

Converts the scalar stored in an aclScalar to a float4_e1m2 value.

ToHiFloat4()

Converts the scalar stored in an aclScalar to a hifloat4 value.

ToHiFloat8()

Converts the scalar stored in an aclScalar to a hifloat8 value.

ToComplex64()

Converts the scalar stored in an aclScalar to a complex64 value.

ToComplex128()

Converts the scalar stored in an aclScalar to a complex128 value.

aclScalar(int32_t value)

Initializes an aclScalar object with the specified int32 type.

aclScalar(int64_t value)

Initializes an aclScalar object with the specified int64 type.

aclScalar(int16_t value)

Initializes an aclScalar object with the specified int16 type.

aclScalar(int8_t value)

Initializes an aclScalar object with the specified int8 type.

aclScalar(uint32_t value)

Initializes an aclScalar object with the specified uint32 type.

aclScalar(uint64_t value)

Initializes an aclScalar object with the specified uint64 type.

aclScalar(uint16_t value)

Initializes an aclScalar object with the specified uint16 type.

aclScalar(uint8_t value)

Initializes an aclScalar object with the specified uint8 type.

aclScalar(float value)

Initializes an aclScalar object with the specified float32 type.

aclScalar(double value)

Initializes an aclScalar object with the specified double type.

aclScalar(op::fp16_t value)

Initializes an aclScalar object with the specified float16 type.

aclScalar(op::bfloat16 value)

Initializes an aclScalar object with the specified bfloat16 type.

aclScalar(bool value)

Initializes an aclScalar object with the specified bool type.

aclScalar(op::Float8E5M2 value)

Initializes an aclScalar object with the specified float8_e5m2 type.

aclScalar(op::Float8E4M3FN value)

Initializes an aclScalar object with the specified float8_e4m3fn type.

aclScalar(op::Float8E8M0 value)

Initializes an aclScalar object with the specified float8_e8m0 type.

aclScalar(op::Float6E3M2 value)

Initializes an aclScalar object with the specified float6_e3m2 type.

aclScalar(op::Float6E2M3 value)

Initializes an aclScalar object with the specified float6_e2m3 type.

aclScalar(op::Float4E2M1 value)

Initializes an aclScalar object with the specified float4_e2m1 type.

aclScalar(op::Float4E1M2 value)

Initializes an aclScalar object with the specified float4_e1m2 type.

aclScalar(op::HiFloat4 value)

Initializes an aclScalar object with the specified hifloat4 type.

aclScalar(op::HiFloat8 value)

Initializes an aclScalar object with the specified hifloat8 type.

To()

Converts the scalar stored in aclScalar to the T type.

ToStr()

Generates a string describing aclScalar.

BFloat16()

Converts the scalar stored in aclScalar to bfloat16.

v_t()

Indicates the default constructor of the internal union v_t of an aclScalar.

aclScalarList(const aclScalar *const *scalars, uint64_t size)

Indicates an aclScalar array. This function is the constructor of aclScalarList.

aclScalarList()

ToString(const aclTensor* t)

A printing function that generates a string describing an aclTensor.

ToString(const aclTensorList* t)

A printing function that generates a string describing an aclTensorList.

ToString(const aclIntArray* t)

A printing function that generates a string describing an aclIntArray.

ToString(const aclBoolArray* t)

A printing function that generates a string describing an aclBoolArray.

ToString(const aclFloatArray* t)

A printing function that generates a string describing an aclFloatArray.

ToString(const aclFp16Array* t)

A printing function that generates a string describing an aclFp16Array.

ToString(const aclBf16Array* t)

A printing function that generates a string describing an aclBf16Array.

ToString(const aclScalar* t)

A printing function that generates a string describing an aclScalar.

ToString(const aclScalarList* t)

A printing function that generates a string describing an aclScalarList.

ToString(const aclTensor& t)

A printing function that generates a string describing an aclTensor&.

ToString(const aclTensorList& t)

A printing function that generates a string describing an aclTensorList&.

ToString(const aclIntArray& t)

A printing function that generates a string describing an aclIntArray&.

ToString(const aclBoolArray& t)

A printing function that generates a string describing an aclBoolArray&.

ToString(const aclFloatArray& t)

A printing function that generates a string describing an aclFloatArray&.

ToString(const aclFp16Array& t)

A printing function that generates a string describing an aclFp16Array&.

ToString(const aclBf16Array& t)

A printing function that generates a string describing an aclBf16Array&.

ToString(const aclScalar& t)

A printing function that generates a string describing an aclScalar&.

ToString(const aclScalarList& t)

A printing function that generates a string describing an aclScalarList&.

ToString(aclDataType dataType)

A printing function that generates a string describing an aclDataType.