1mlib_MatrixSubS_U8_Mod(3MLImBe)diaLib Library Functiomnlsib_MatrixSubS_U8_Mod(3MLIB)
2
3
4

NAME

6       mlib_MatrixSubS_U8_Mod,       mlib_MatrixSubS_U8_Sat,      mlib_Matrix‐
7       SubS_U8C_Mod,     mlib_MatrixSubS_U8C_Sat,      mlib_MatrixSubS_S8_Mod,
8       mlib_MatrixSubS_S8_Sat,      mlib_MatrixSubS_S8C_Mod,      mlib_Matrix‐
9       SubS_S8C_Sat,     mlib_MatrixSubS_S16_Mod,     mlib_MatrixSubS_S16_Sat,
10       mlib_MatrixSubS_S16C_Mod,     mlib_MatrixSubS_S16C_Sat,    mlib_Matrix‐
11       SubS_S32_Mod,    mlib_MatrixSubS_S32_Sat,     mlib_MatrixSubS_S32C_Mod,
12       mlib_MatrixSubS_S32C_Sat - matrix subtraction from scalar, in place
13

SYNOPSIS

15       cc [ flag... ] file... -lmlib [ library... ]
16       #include <mlib.h>
17
18       mlib_status mlib_MatrixSubS_U8_Mod(mlib_u8 *xz, const mlib_u8 *c,
19            mlib_s32 m, mlib_s32 n);
20
21
22       mlib_status mlib_MatrixSubS_U8_Sat(mlib_u8 *xz, const mlib_u8 *c,
23            mlib_s32 m, mlib_s32 n);
24
25
26       mlib_status mlib_MatrixSubS_U8C_Mod(mlib_u8 *xz, const mlib_u8 *c,
27            mlib_s32 m, mlib_s32 n);
28
29
30       mlib_status mlib_MatrixSubS_U8C_Sat(mlib_u8 *xz, const mlib_u8 *c,
31            mlib_s32 m, mlib_s32 n);
32
33
34       mlib_status mlib_MatrixSubS_S8_Mod(mlib_s8 *xz, const mlib_s8 *c,
35            mlib_s32 m, mlib_s32 n);
36
37
38       mlib_status mlib_MatrixSubS_S8_Sat(mlib_s8 *xz, const mlib_s8 *c,
39            mlib_s32 m, mlib_s32 n);
40
41
42       mlib_status mlib_MatrixSubS_S8C_Mod(mlib_s8 *xz, const mlib_s8 *c,
43            mlib_s32 m, mlib_s32 n);
44
45
46       mlib_status mlib_MatrixSubS_S8C_Sat(mlib_s8 *xz, const mlib_s8 *c,
47            mlib_s32 m, mlib_s32 n);
48
49
50       mlib_status mlib_MatrixSubS_S16_Mod(mlib_s16 *xz, const mlib_s16 *c,
51            mlib_s32 m, mlib_s32 n);
52
53
54       mlib_status mlib_MatrixSubS_S16_Sat(mlib_s16 *xz, const mlib_s16 *c,
55            mlib_s32 m, mlib_s32 n);
56
57
58       mlib_status mlib_MatrixSubS_S16C_Mod(mlib_s16 *xz, const mlib_s16 *c,
59            mlib_s32 m, mlib_s32 n);
60
61
62       mlib_status mlib_MatrixSubS_S16C_Sat(mlib_s16 *xz, const mlib_s16 *c,
63            mlib_s32 m, mlib_s32 n);
64
65
66       mlib_status mlib_MatrixSubS_S32_Mod(mlib_s32 *xz, const mlib_s32 *c,
67            mlib_s32 m, mlib_s32 n);
68
69
70       mlib_status mlib_MatrixSubS_S32_Sat(mlib_s32 *xz, const mlib_s32 *c,
71            mlib_s32 m, mlib_s32 n);
72
73
74       mlib_status mlib_MatrixSubS_S32C_Mod(mlib_s32 *xz, const mlib_s32 *c,
75            mlib_s32 m, mlib_s32 n);
76
77
78       mlib_status mlib_MatrixSubS_S32C_Sat(mlib_s32 *xz, const mlib_s32 *c,
79            mlib_s32 m, mlib_s32 n);
80
81

DESCRIPTION

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

PARAMETERS

106       Each of the functions takes the following arguments:
107
108       xz    Pointer to the source and destination matrix.
109
110
111       c     Pointer to the source scalar. When the function is used with com‐
112             plex  data types, c[0] contains the scalar for the real part, and
113             c[1] contains the scalar for the imaginary part.
114
115
116       m     Number of rows in the matrices.
117
118
119       n     Number of columns in the matrices.
120
121

RETURN VALUES

123       Each of the functions returns MLIB_SUCCESS if successful. Otherwise  it
124       returns MLIB_FAILURE.
125

ATTRIBUTES

127       See attributes(5) for descriptions of the following attributes:
128
129
130
131
132       ┌─────────────────────────────┬─────────────────────────────┐
133       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
134       ├─────────────────────────────┼─────────────────────────────┤
135       │Interface Stability          │Committed                    │
136       ├─────────────────────────────┼─────────────────────────────┤
137       │MT-Level                     │MT-Safe                      │
138       └─────────────────────────────┴─────────────────────────────┘
139

SEE ALSO

141       mlib_MatrixSubS_U8_U8_Mod(3MLIB), attributes(5)
142
143
144
145SunOS 5.11                        2 Mar 2007     mlib_MatrixSubS_U8_Mod(3MLIB)
Impressum