mlib_VectorMulSShift_S8C_Mod(3mlib)

1mlib_VectorMulSShift_U8_Modm(e3dMiLaILBi)b Library Fumnlcitbi_oVnesctorMulSShift_U8_Mod(3MLIB)
2
3
4

NAME

6       mlib_VectorMulSShift_U8_Mod,  mlib_VectorMulSShift_U8_Sat, mlib_Vector‐
7       MulSShift_U8C_Mod,      mlib_VectorMulSShift_U8C_Sat,      mlib_Vector‐
8       MulSShift_S8_Mod,       mlib_VectorMulSShift_S8_Sat,       mlib_Vector‐
9       MulSShift_S8C_Mod,      mlib_VectorMulSShift_S8C_Sat,      mlib_Vector‐
10       MulSShift_S16_Mod,      mlib_VectorMulSShift_S16_Sat,      mlib_Vector‐
11       MulSShift_S16C_Mod,     mlib_VectorMulSShift_S16C_Sat,     mlib_Vector‐
12       MulSShift_S32_Mod,      mlib_VectorMulSShift_S32_Sat,      mlib_Vector‐
13       MulSShift_S32C_Mod, mlib_VectorMulSShift_S32C_Sat - vector  multiplica‐
14       tion by scalar plus shifting, in place
15

SYNOPSIS

17       cc [ flag... ] file... -lmlib [ library... ]
18       #include <mlib.h>
19
20       mlib_status mlib_VectorMulSShift_U8_Mod(mlib_u8 *xz,
21            const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
22
23
24       mlib_status mlib_VectorMulSShift_U8_Sat(mlib_u8 *xz,
25            const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
26
27
28       mlib_status mlib_VectorMulSShift_U8C_Mod(mlib_u8 *xz,
29            const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
30
31
32       mlib_status mlib_VectorMulSShift_U8C_Sat(mlib_u8 *xz,
33            const mlib_u8 *c, mlib_s32 n, mlib_s32 shift);
34
35
36       mlib_status mlib_VectorMulSShift_S8_Mod(mlib_s8 *xz,
37            const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
38
39
40       mlib_status mlib_VectorMulSShift_S8_Sat(mlib_s8 *xz,
41            const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
42
43
44       mlib_status mlib_VectorMulSShift_S8C_Mod(mlib_s8 *xz,
45            const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
46
47
48       mlib_status mlib_VectorMulSShift_S8C_Sat(mlib_s8 *xz,
49            const mlib_s8 *c, mlib_s32 n, mlib_s32 shift);
50
51
52       mlib_status mlib_VectorMulSShift_S16_Mod(mlib_s16 *xz,
53            const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
54
55
56       mlib_status mlib_VectorMulSShift_S16_Sat(mlib_s16 *xz,
57            const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
58
59
60       mlib_status mlib_VectorMulSShift_S16C_Mod(mlib_s16 *xz,
61            const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
62
63
64       mlib_status mlib_VectorMulSShift_S16C_Sat(mlib_s16 *xz,
65            const mlib_s16 *c, mlib_s32 n, mlib_s32 shift);
66
67
68       mlib_status mlib_VectorMulSShift_S32_Mod(mlib_s32 *xz,
69            const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
70
71
72       mlib_status mlib_VectorMulSShift_S32_Sat(mlib_s32 *xz,
73            const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
74
75
76       mlib_status mlib_VectorMulSShift_S32C_Mod(mlib_s32 *xz,
77            const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
78
79
80       mlib_status mlib_VectorMulSShift_S32C_Sat(mlib_s32 *xz,
81            const mlib_s32 *c, mlib_s32 n, mlib_s32 shift);
82
83

DESCRIPTION

85       Each of these functions performs an in-place multiplication of a vector
86       by a scalar and shifts the result.
87
88
89       For real data, the following equation is used:
90
91         xz[i] = xz[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         tmp         = xz[2*i]
101         xz[2*i]     = (tmp*c[0] - xz[2*i + 1]*c[1]) * 2**(-shift)
102         xz[2*i + 1] = (tmp*c[1] + xz[2*i + 1]*c[0]) * 2**(-shift)
103
104
105
106       where i = 0, 1, ..., (n - 1).
107

PARAMETERS

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

RETURN VALUES

131       Each of the functions returns MLIB_SUCCESS if successful. Otherwise  it
132       returns MLIB_FAILURE.
133

ATTRIBUTES

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

NAME

SYNOPSIS

DESCRIPTION

PARAMETERS

RETURN VALUES

ATTRIBUTES

SEE ALSO