mlib_VectorMulSShift_U8_U8_Mod(3mlib)

1mlib_VectorMulSShift_U8_U8_mMeoddi(a3LMiLbIBL)ibrarymlFiubn_cVteicotnosrMulSShift_U8_U8_Mod(3MLIB)
2
3
4

NAME

6       mlib_VectorMulSShift_U8_U8_Mod,         mlib_VectorMulSShift_U8_U8_Sat,
7       mlib_VectorMulSShift_U8C_U8C_Mod,     mlib_VectorMulSShift_U8C_U8C_Sat,
8       mlib_VectorMulSShift_S8_S8_Mod,         mlib_VectorMulSShift_S8_S8_Sat,
9       mlib_VectorMulSShift_S8C_S8C_Mod,     mlib_VectorMulSShift_S8C_S8C_Sat,
10       mlib_VectorMulSShift_S16_S16_Mod,     mlib_VectorMulSShift_S16_S16_Sat,
11       mlib_VectorMulSShift_S16C_S16C_Mod, mlib_VectorMulSShift_S16C_S16C_Sat,
12       mlib_VectorMulSShift_S32_S32_Mod,     mlib_VectorMulSShift_S32_S32_Sat,
13       mlib_VectorMulSShift_S32C_S32C_Mod,  mlib_VectorMulSShift_S32C_S32C_Sat
14       - vector multiplication by scalar plus shifting
15

SYNOPSIS

17       cc [ flag... ] file... -lmlib [ library... ]
18       #include <mlib.h>
19
20       mlib_status mlib_VectorMulSShift_U8_U8_Mod(mlib_u8 *z,
21            const mlib_u8 *x, const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
22
23
24       mlib_status mlib_VectorMulSShift_U8_U8_Sat(mlib_u8 *z,
25            const mlib_u8 *x, const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
26
27
28       mlib_status mlib_VectorMulSShift_U8C_U8C_Mod(mlib_u8 *z,
29            const mlib_u8 *x, const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
30
31
32       mlib_status mlib_VectorMulSShift_U8C_U8C_Sat(mlib_u8 *z,
33            const mlib_u8 *x, const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
34
35
36       mlib_status mlib_VectorMulSShift_S8_S8_Mod(mlib_s8 *z,
37            const mlib_s8 *x, const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
38
39
40       mlib_status mlib_VectorMulSShift_S8_S8_Sat(mlib_s8 *z,
41            const mlib_s8 *x,const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
42
43
44       mlib_status mlib_VectorMulSShift_S8C_S8C_Mod(mlib_s8 *z,
45            const mlib_s8 *x, const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
46
47
48       mlib_status mlib_VectorMulSShift_S8C_S8C_Sat(mlib_s8 *z,
49            const mlib_s8 *x, const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
50
51
52       mlib_status mlib_VectorMulSShift_S16_S16_Mod(mlib_s16 *z,
53            const mlib_s16 *x, const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
54
55
56       mlib_status mlib_VectorMulSShift_S16_S16_Sat(mlib_s16 *z,
57            const mlib_s16 *x, const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
58
59
60       mlib_status mlib_VectorMulSShift_S16C_S16C_Mod(mlib_s16 *z,
61            const mlib_s16 *x, const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
62
63
64       mlib_status mlib_VectorMulSShift_S16C_S16C_Sat(mlib_s16 *z,
65            const mlib_s16 *x, const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
66
67
68       mlib_status mlib_VectorMulSShift_S32_S32_Mod(mlib_s32 *z,
69            const mlib_s32 *x, const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
70
71
72       mlib_status mlib_VectorMulSShift_S32_S32_Sat(mlib_s32 *z,
73            const mlib_s32 *x, const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
74
75
76       mlib_status mlib_VectorMulSShift_S32C_S32C_Mod(mlib_s32 *z,
77            const mlib_s32 *x, const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
78
79
80       mlib_status mlib_VectorMulSShift_S32C_S32C_Sat(mlib_s32 *z,
81            const mlib_s32 *x, const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
82
83

DESCRIPTION

85       Each  of  these  functions  performs  a multiplication of a vector by a
86       scalar and shifts the result.
87
88
89       For real data, the following equation is used:
90
91         z[i] = x[i] * c[0] * 2**(-shift)
92
93
94
95       where i = 0, 1, ..., (n - 1).
96
97
98       For complex data, the following equation is used:
99
100         z[2*i]     = (x[2*i]*c[0] - x[2*i + 1]*c[1]) * 2**(-shift)
101         z[2*i + 1] = (x[2*i]*c[1] + x[2*i + 1]*c[0]) * 2**(-shift)
102
103
104
105       where i = 0, 1, ..., (n - 1).
106

PARAMETERS

108       Each of the functions takes the following arguments:
109
110       z        Pointer to the first element of the result vector.
111
112
113       x        Pointer to the first element of the source vector.
114
115
116       c        Pointer to the source scalar. When the function is  used  with
117                complex data types, c[0] contains the real part of the scalar,
118                and c[1] contains the imaginary part of the scalar.
119
120
121       n        Number of elements in each vector.
122
123
124       shift    Right shifting factor. The ranges of valid shift are:
125
126                  1 ≤ shift ≤ 8   for U8, S8, U8C, S8C types
127                  1 ≤ shift ≤ 16  for S16, S16C types
128                  1 ≤ shift ≤ 31  for S32, S32C types
129
130
131

RETURN VALUES

133       Each of the functions returns MLIB_SUCCESS if successful. Otherwise  it
134       returns MLIB_FAILURE.
135

ATTRIBUTES

137       See attributes(5) for descriptions of the following attributes:
138
139
140
141
142       ┌─────────────────────────────┬─────────────────────────────┐
143       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
144       ├─────────────────────────────┼─────────────────────────────┤
145       │Interface Stability          │Committed                    │
146       ├─────────────────────────────┼─────────────────────────────┤
147       │MT-Level                     │MT-Safe                      │
148       └─────────────────────────────┴─────────────────────────────┘
149

NAME

SYNOPSIS

DESCRIPTION

PARAMETERS

RETURN VALUES

ATTRIBUTES

SEE ALSO