mlib_MatrixScale_S16C_Sat(3mlib)

1mlib_MatrixScale_U8_Mod(3MLmIeBd)iaLib Library Functimolnisb_MatrixScale_U8_Mod(3MLIB)
2
3
4

NAME

6       mlib_MatrixScale_U8_Mod,     mlib_MatrixScale_U8_Sat,     mlib_MatrixS‐
7       cale_U8C_Mod,    mlib_MatrixScale_U8C_Sat,     mlib_MatrixScale_S8_Mod,
8       mlib_MatrixScale_S8_Sat,     mlib_MatrixScale_S8C_Mod,    mlib_MatrixS‐
9       cale_S8C_Sat,    mlib_MatrixScale_S16_Mod,    mlib_MatrixScale_S16_Sat,
10       mlib_MatrixScale_S16C_Mod,   mlib_MatrixScale_S16C_Sat,   mlib_MatrixS‐
11       cale_S32_Mod,   mlib_MatrixScale_S32_Sat,    mlib_MatrixScale_S32C_Mod,
12       mlib_MatrixScale_S32C_Sat - matrix linear scaling, in place
13

SYNOPSIS

15       cc [ flag... ] file... -lmlib [ library... ]
16       #include <mlib.h>
17
18       mlib_status mlib_MatrixScale_U8_Mod(mlib_u8 *xz, const mlib_u8 *a,
19            const mlib_u8 *b, mlib_s32 m, mlib_s32 n);
20
21
22       mlib_status mlib_MatrixScale_U8_Sat(mlib_u8 *xz, const mlib_u8 *a,
23            const mlib_u8 *b, mlib_s32 m, mlib_s32 n);
24
25
26       mlib_status mlib_MatrixScale_U8C_Mod(mlib_u8 *xz, const mlib_u8 *a,
27            const mlib_u8 *b, mlib_s32 m, mlib_s32 n);
28
29
30       mlib_status mlib_MatrixScale_U8C_Sat(mlib_u8 *xz, const mlib_u8 *a,
31            const mlib_u8 *b, mlib_s32 m, mlib_s32 n);
32
33
34       mlib_status mlib_MatrixScale_S8_Mod(mlib_s8 *xz, const mlib_s8 *a,
35            const mlib_s8 *b, mlib_s32 m, mlib_s32 n);
36
37
38       mlib_status mlib_MatrixScale_S8_Sat(mlib_s8 *xz, const mlib_s8 *a,
39            const mlib_s8 *b, mlib_s32 m, mlib_s32 n);
40
41
42       mlib_status mlib_MatrixScale_S8C_Mod(mlib_s8 *xz, const mlib_s8 *a,
43            const mlib_s8 *b, mlib_s32 m, mlib_s32 n);
44
45
46       mlib_status mlib_MatrixScale_S8C_Sat(mlib_s8 *xz, const mlib_s8 *a,
47            const mlib_s8 *b, mlib_s32 m, mlib_s32 n);
48
49
50       mlib_status mlib_MatrixScale_S16_Mod(mlib_s16 *xz, const mlib_s16 *a,
51            const mlib_s16 *b, mlib_s32 m, mlib_s32 n);
52
53
54       mlib_status mlib_MatrixScale_S16_Sat(mlib_s16 *xz, const mlib_s16 *a,
55            const mlib_s16 *b, mlib_s32 m, mlib_s32 n);
56
57
58       mlib_status mlib_MatrixScale_S16C_Mod(mlib_s16 *xz, const mlib_s16 *a,
59            const mlib_s16 *b, mlib_s32 m, mlib_s32 n);
60
61
62       mlib_status mlib_MatrixScale_S16C_Sat(mlib_s16 *xz, const mlib_s16 *a,
63            const mlib_s16 *b, mlib_s32 m, mlib_s32 n);
64
65
66       mlib_status mlib_MatrixScale_S32_Mod(mlib_s32 *xz, const mlib_s32 *a,
67            const mlib_s32 *b, mlib_s32 m, mlib_s32 n);
68
69
70       mlib_status mlib_MatrixScale_S32_Sat(mlib_s32 *xz, const mlib_s32 *a,
71            const mlib_s32 *b, mlib_s32 m, mlib_s32 n);
72
73
74       mlib_status mlib_MatrixScale_S32C_Mod(mlib_s32 *xz, const mlib_s32 *a,
75            const mlib_s32 *b, mlib_s32 m, mlib_s32 n);
76
77
78       mlib_status mlib_MatrixScale_S32C_Sat(mlib_s32 *xz, const mlib_s32 *a,
79            const mlib_s32 *b, mlib_s32 m, mlib_s32 n);
80
81

DESCRIPTION

83       Each of these functions performs an in-place multiplication of a matrix
84       by a scalar and then adds an offset.
85
86
87       For real data, the following equation is used:
88
89         xz[i] = a[0]*xz[i] + b[0]
90
91
92
93       where i = 0, 1, ..., (m*n - 1).
94
95
96       For complex data, the following equation is used:
97
98         tmp         = xz[2*i]
99         xz[2*i]     = a[0]*tmp - a[1]*xz[2*i + 1] + b[0]
100         xz[2*i + 1] = a[1]*tmp + a[0]*xz[2*i + 1] + b[1]
101
102
103
104       where i = 0, 1, ..., (m*n - 1).
105

PARAMETERS

107       Each of the functions takes the following arguments:
108
109       xz    Pointer to the source and destination matrix.
110
111
112       a     Pointer to the source scaling factor. When the function  is  used
113             with  complex  data  types, a[0] contains the scalar for the real
114             part, and a[1] contains the scalar for the imaginary part.
115
116
117       b     Pointer to the source offset. When the function is used with com‐
118             plex  data types, b[0] contains the offset for the real part, and
119             b[1] contains the offset for the imaginary part.
120
121
122       m     Number of rows in the matrix.
123
124
125       n     Number of columns in the matrix.
126
127

RETURN VALUES

129       Each of the functions returns MLIB_SUCCESS if successful. Otherwise  it
130       returns MLIB_FAILURE.
131

ATTRIBUTES

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

NAME

SYNOPSIS

DESCRIPTION

PARAMETERS

RETURN VALUES

ATTRIBUTES

SEE ALSO