SubC

Subtracts a constant from a vector.

The function interface is declared as follows:

Operations on floating-point numbers:
HmppResult HMPPS_SubC_32f(const float *src, float val, float *dst, int32_t len);

HmppResult HMPPS_SubC_64f(const double *src, double val, double *dst, int32_t len);

HmppResult HMPPS_SubC_32fc(const Hmpp32fc *src, Hmpp32fc val, Hmpp32fc *dst, int32_t len);

HmppResult HMPPS_SubC_64fc(const Hmpp64fc *src, Hmpp64fc val, Hmpp64fc *dst, int32_t len);
Scaling of integers:
HmppResult HMPPS_SubC_16s_S(const int16_t *src, int16_t val, int16_t *dst, int32_t len, double scale);

HmppResult HMPPS_SubC_32s_S(const int32_t *src, int32_t val, int32_t *dst, int32_t len, double scale);

HmppResult HMPPS_SubC_8u_S(const uint8_t *src, uint8_t val, uint8_t *dst, int32_t len, double scale);

HmppResult HMPPS_SubC_16u_S(const uint16_t *src, uint16_t val, uint16_t *dst, int32_t len, double scale);

HmppResult HMPPS_SubC_16sc_S(const Hmpp16sc *src, Hmpp16sc val, Hmpp16sc *dst, int32_t len, double scale);

HmppResult HMPPS_SubC_32sc_S(const Hmpp32sc *src, Hmpp32sc val, Hmpp32sc *dst, int32_t len, double scale);
In-place operations on integers:
HmppResult HMPPS_SubC_16s_I(int16_t val, int16_t *srcDst, int32_t len);
In-place operations on floating-point numbers:
HmppResult HMPPS_SubC_32f_I(float val, float *srcDst, int32_t len);

HmppResult HMPPS_SubC_64f_I(double val, double *srcDst, int32_t len);

HmppResult HMPPS_SubC_32fc_I(Hmpp32fc val, Hmpp32fc *srcDst, int32_t len);

HmppResult HMPPS_SubC_64fc_I(Hmpp64fc val, Hmpp64fc *srcDst, int32_t len);
In-place scaling on integers:
HmppResult HMPPS_SubC_16s_IS(int16_t val, int16_t *srcDst, int32_t len, double scale);

HmppResult HMPPS_SubC_32s_IS(int32_t val, int32_t *srcDst, int32_t len, double scale);

HmppResult HMPPS_SubC_8u_IS(uint8_t val, uint8_t *srcDst, int32_t len, double scale)

HmppResult HMPPS_SubC_16u_IS(uint16_t val, uint16_t *srcDst, int32_t len, double scale);

HmppResult HMPPS_SubC_16sc_IS(Hmpp16sc val, Hmpp16sc *srcDst, int32_t len, double scale);

HmppResult HMPPS_SubC_32sc_IS(Hmpp32sc val, Hmpp32sc *srcDst, int32_t len, double scale);

Parameters

Parameter	Description	Value Range	Input/Output
src	Pointer to the minuend	The value cannot be NULL.	Input
val	Given constant	Not limited, depending on the type	Input
dst	Pointer to the destination vector	The value cannot be NULL.	Output
srcDst	Pointer to the source vector for in-place operations	The value cannot be NULL.	Input/Output
len	Vector length	(0, INT_MAX]	Input
scale	Scale factor	scale = 2ⁿ, where n is an integer. The value is within (0, INF).	Input

Return Value

Success: HMPP_STS_NO_ERR
Failure: An error code is returned.

Error Codes

Error Code	Description
HMPP_STS_NULL_PTR_ERR	The value of src, dst, or srcDst is NULL.
HMPP_STS_SIZE_ERR	The value of len is less than or equal to 0.
HMPP_STS_SCALE_ERR	The value of scale is not within the range (0, INF) or is NaN.

Example

#define BUFFER_SIZE_T 10
void SubCExample(void)
{
    float src[BUFFER_SIZE_T] = {10.29, 2.46, 10.88, 3.51, 10.72, 10.46, 2.85, 5.44, 7.68, 11.25};
    float valTest = 8.51;
    float dst[BUFFER_SIZE_T] = {0.00};
    (void)HMPPS_Zero_32f(dst, BUFFER_SIZE_T);
    HmppResult result = HMPPS_SubC_32f(src, valTest, dst, BUFFER_SIZE_T);
    printf("result = %d\n", result);
    if (result != HMPP_STS_NO_ERR) {
        return;
    }
    printf("dst =");
    for (int i = 0; i < BUFFER_SIZE_T; i++) {
        printf(" %.2f", dst[i]);
    }
    printf("\n");
}

Output:

subC: result = 0.
dst = 1.78    -6.05    2.37    -5.00    2.21    1.95    -5.66    -3.07    -0.83    2.74

Parent topic: Basic and Common Calculations