ClampMin

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	√
Atlas A2 training product/Atlas A2 inference product	√
Atlas 200I/500 A2 inference product	x
Atlas inference product AI Core	√
Atlas inference product Vector Core	x
Atlas training product	x

Function Usage

Replaces the number less than scalar with scalar in srcTensor and retains the number greater than or equal to scalar as the dstTensor output.

$\text{[math]}$

Prototype

Pass the temporary space through the sharedTmpBuffer input parameter.

template <typename T, bool isReuseSource = false>
__aicore__ inline void ClampMin(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const LocalTensor<uint8_t>& sharedTmpBuffer, const T scalar, const uint32_t calCount)

The API framework allocates temporary space.

template <typename T, bool isReuseSource = false>
__aicore__ inline void ClampMin(const LocalTensor<T>& dstTensor, const LocalTensor<T>& srcTensor, const T scalar, const uint32_t calCount)

Due to the complex mathematical computation involved in the internal implementation of this API, extra temporary space is required to store intermediate variables generated during computation. The temporary space can be passed by developers through the sharedTmpBuffer input parameter or allocated by the API framework.

When the sharedTmpBuffer input parameter is used for passing the temporary space, the tensor serves as the temporary space. In this case, the API framework is not required for temporary space allocation. This enables developers to manage the sharedTmpBuffer space and reuse the buffer after calling the API, so that the buffer is not repeatedly allocated or deallocated, improving the flexibility and buffer utilization.
When the API framework allocates temporary space, developers do not need to allocate the space but must reserve the required size for the temporary space.

If sharedTmpBuffer is used, developers must allocate space for the tensor. If the API framework is used, developers must reserve the temporary space. To obtain the size of the temporary space (BufferSize) to be reserved, use the API provided in GetClampMaxMinTmpSize.

Parameters

**Table 1** Template parameters
Parameter	Description
T	Operand data type. For the Atlas 350 Accelerator Card, the supported data types are half and float. For the Atlas A3 training product/Atlas A3 inference product, the supported data types are half and float. For the Atlas A2 training product/Atlas A2 inference product, the supported data types are half and float. For the Atlas inference product AI Core, the supported data types are half and float.
isReuseSource	Whether the source operand can be modified. This parameter is reserved. Pass the default value false.

**Table 2** API parameters
Parameter	Input/Output	Description
dstTensor	Output	Destination operand. The type is LocalTensor, and TPosition can be VECIN, VECCALC, or VECOUT.
srcTensor	Input	Source operand. The type is LocalTensor, and TPosition can be VECIN, VECCALC, or VECOUT. The source operand must have the same data type as the destination operand.
sharedTmpBuffer	Input	Temporary buffer. The type is LocalTensor, and TPosition can be VECIN, VECCALC, or VECOUT. This parameter is used to store intermediate variables during complex computation in ClampMin and is provided by developers. For details about how to obtain the temporary space size (BufferSize), see GetClampMaxMinTmpSize.
scalar	Input	Scalar data. The data type is the same as that of srcTensor. The supported data types are half and float.
calCount	Input	Number of elements involved in the computation.

Returns

None

Constraints

The source operand address must not overlap the destination operand address.
The address of sharedTmpBuffer cannot overlap that of the source or destination operand.
For details about the operand address alignment requirements, see General Address Alignment Restrictions.

Examples

For details about a complete example, see ClampMin operator sample.

// dstLocal: tensor for storing the computation result
// srcLocal: input tensor involved in computation
// sharedTmpBuffer: temporary buffer for storing intermediate variables during complex internal computation
// The input shape is 128, the scalar is 2, and the number of elements involved in computation is 128.
AscendC::ClampMin<half>(dstLocal, srcLocal, sharedTmpBuffer, static_cast<half>(2), 128);

Result example:

Input (srcLocal): [0 1 2 ...  126 127]
Output (dstLocal): [2 2 2 ... 126 127]

Parent topic: Clamp APIs