1 :Info: generic_math_: 2020-04-27  generic_math_
  2 
  3 
  4 The generic_math_ subroutine is used to perform basic arithmetic
  5 operations on the generic numeric data types.  The operations that can
  6 be performed are:  addition, subtraction, multiplication, division, and
  7 negation.  There are separate entrypoints for each variation of the
  8 types:  real and complex, binary and decimal.
  9 
 10 
 11 Entry points in generic_math_:
 12    (List is generated by the help command)
 13 
 14 
 15 :Entry: negate_decimal: 1985-02-20 generic_math_$negate_decimal
 16 
 17 
 18 Function:  This entrypoint negates a generic decimal number.
 19 
 20 
 21 Syntax:
 22 declare generic_math_$negate_decimal entry(bit(576), bit(576));
 23 call generic_math_$negate_decimal (num1, result);
 24 
 25 
 26 Arguments:
 27 num1
 28    is a generic decimal number.  (Input)
 29 result
 30    is the generic decimal value that is the negation of num1.  (Output)
 31 
 32 
 33 :Entry: negate_decimal_complex: 1985-02-20 generic_math_$negate_decimal_complex
 34 
 35 
 36 Function:  This entrypoint negates a generic complex decimal number.
 37 
 38 
 39 Syntax:
 40 declare generic_math_$negate_decimal_complex entry(bit(1152),
 41      bit(1152));
 42 call generic_math_$negate_decimal_complex (num1, result);
 43 
 44 
 45 Arguments:
 46 num1
 47    is a generic complex decimal number.  (Input)
 48 result
 49    is the generic complex decimal value that is the negation of num1.
 50    (Output)
 51 
 52 
 53 :Entry: add_decimal: 1985-02-20 generic_math_$add_decimal
 54 
 55 
 56 Function:  This entrypoint adds two generic decimal numbers.
 57 
 58 
 59 Syntax:
 60 declare generic_math_$add_decimal entry(bit(576), bit(576), bit(576));
 61 call generic_math_$add_decimal (num1, num2, result);
 62 
 63 
 64 Arguments:
 65 num1
 66    is a generic decimal number.  (Input)
 67 num2
 68    is a generic decimal number.  (Input)
 69 result
 70    is the generic decimal value that is the result of adding num1 and
 71    num2.  (Output)
 72 
 73 
 74 :Entry: add_decimal_complex: 1985-02-20 generic_math_$add_decimal_complex
 75 
 76 
 77 Function:  This entrypoint adds two generic complex decimal numbers.
 78 
 79 
 80 Syntax:
 81 declare generic_math_$add_decimal_complex entry(bit(1152), bit(1152),
 82      bit(1152));
 83 call generic_math_$add_decimal_complex (num1, num2, result);
 84 
 85 
 86 Arguments:
 87 num1
 88    is a generic complex decimal number.  (Input)
 89 num2
 90    is a generic complex decimal number.  (Input)
 91 result
 92    is the generic complex decimal value that is the result of adding
 93    num1 and num2.  (Output)
 94 
 95 
 96 :Entry: subtract_decimal: 1985-02-20 generic_math_$subtract_decimal
 97 
 98 
 99 Function:  This entrypoint subtracts two generic decimal numbers.
100 
101 
102 Syntax:
103 declare generic_math_$subtract_decimal entry(bit(576), bit(576),
104      bit(576));
105 call generic_math_$subtract_decimal (num1, num2, result);
106 
107 
108 Arguments:
109 num1
110    is a generic decimal number.  (Input)
111 num2
112    is a generic decimal number.  (Input)
113 result
114    is the generic decimal value that is the result of subtracting num1
115    and num2.  (Output)
116 
117 
118 :Entry: subtract_decimal_complex: 1985-02-20 generic_math_$subtract_decimal_complex
119 
120 
121 Function:  This entrypoint subtracts two generic complex decimal
122 numbers.
123 
124 
125 Syntax:
126 declare generic_math_$subtract_decimal_complex entry(bit(1152),
127      bit(1152), bit(1152));
128 call generic_math_$subtract_decimal_complex (num1, num2, result);
129 
130 
131 Arguments:
132 num1
133    is a generic complex decimal number.  (Input)
134 num2
135    is a generic complex decimal number.  (Input)
136 result
137    is the generic complex decimal value that is the result of
138    subtracting num2 from num1.  (Output)
139 
140 
141 :Entry: multiply_decimal: 1985-02-20 generic_math_$multiply_decimal
142 
143 
144 Function:  This entrypoint multiplies two generic decimal numbers.
145 
146 
147 Syntax:
148 declare generic_math_$multiply_decimal entry(bit(576), bit(576),
149      bit(576));
150 call generic_math_$multiply_decimal (num1, num2, result);
151 
152 
153 Arguments:
154 num1
155    is a generic decimal number.  (Input)
156 num2
157    is a generic decimal number.  (Input)
158 result
159    is the generic decimal value that is the result of multiplying num1
160    and num2.  (Output)
161 
162 
163 :Entry: multiply_decimal_complex: 1985-02-20 generic_math_$multiply_decimal_complex
164 
165 
166 Function:  This entrypoint multiplies two generic complex decimal
167 numbers.
168 
169 
170 Syntax:
171 declare generic_math_$multiply_decimal_complex entry(bit(1152),
172      bit(1152), bit(1152));
173 call generic_math_$multiply_decimal_complex (num1, num2, result);
174 
175 
176 Arguments:
177 num1
178    is a generic complex decimal number.  (Input)
179 num2
180    is a generic complex decimal number.  (Input)
181 result
182    is the generic complex decimal value that is the result of
183    multiplying num1 by num2.  (Output)
184 
185 
186 :Entry: divide_decimal: 1985-02-20 generic_math_$divide_decimal
187 
188 
189 Function:  This entrypoint divides two generic decimal numbers.
190 
191 
192 Syntax:
193 declare generic_math_$divide_decimal entry(bit(576), bit(576),
194      bit(576));
195 call generic_math_$divide_decimal (num1, num2, result);
196 
197 
198 Arguments:
199 num1
200    is a generic decimal number.  (Input)
201 num2
202    is a generic decimal number.  (Input)
203 result
204    is the generic decimal value that is the result of dividing num1 by
205    num2.  (Output)
206 
207 
208 :Entry: divide_decimal_complex: 1985-02-20 generic_math_$divide_decimal_complex
209 
210 
211 Function:  This entrypoint divides two generic complex decimal numbers.
212 
213 
214 Syntax:
215 declare generic_math_$divide_decimal_complex entry(bit(1152),
216      bit(1152), bit(1152));
217 call generic_math_$divide_decimal_complex (num1, num2, result);
218 
219 
220 Arguments:
221 num1
222    is a generic complex decimal number.  (Input)
223 num2
224    is a generic complex decimal number.  (Input)
225 result
226    is the generic complex decimal value that is the result of dividing
227    num1 by num2.  (Output)
228 
229 
230 :Entry: negate_binary: 1985-02-20 generic_math_$negate_binary
231 
232 
233 Function:  This entrypoint negates a generic binary number.
234 
235 
236 Syntax:
237 declare generic_math_$negate_binary entry(bit(108), bit(108));
238 call generic_math_$negate_binary (num1, result);
239 
240 
241 Arguments:
242 num1
243    is a generic binary number.  (Input)
244 result
245    is the generic binary value that is the negation of num1.  (Output)
246 
247 
248 :Entry: negate_binary_complex: 1985-02-20 generic_math_$negate_binary_complex
249 
250 
251 Function:  This entrypoint negates a generic complex binary number.
252 
253 
254 Syntax:
255 declare generic_math_$negate_binary_complex entry(bit(252), bit(252));
256 call generic_math_$negate_binary_complex (num1, result);
257 
258 
259 Arguments:
260 num1
261    is a generic complex binary number.  (Input)
262 result
263    is the generic complex binary value that is the negation of num1.
264    (Output)
265 
266 
267 :Entry: add_binary: 1985-02-20 generic_math_$add_binary
268 
269 
270 Function:  This entrypoint adds two generic binary numbers.
271 
272 
273 Syntax:
274 declare generic_math_$add_binary entry(bit(108), bit(108), bit(108));
275 call generic_math_$add_binary (num1, num2, result);
276 
277 
278 Arguments:
279 num1
280    is a generic binary number.  (Input)
281 num2
282    is a generic binary number.  (Input)
283 result
284    is the generic binary value that is the result of adding num1 and
285    num2.  (Output)
286 
287 
288 :Entry: add_binary_complex: 1985-02-20 generic_math_$add_binary_complex
289 
290 
291 Function:  This entrypoint adds two generic complex binary numbers.
292 
293 
294 Syntax:
295 declare generic_math_$add_binary_complex entry(bit(252), bit(252),
296      bit(252));
297 call generic_math_$add_binary_complex (num1, num2, result);
298 
299 
300 Arguments:
301 num1
302    is a generic complex binary number.  (Input)
303 num2
304    is a generic complex binary number.  (Input)
305 result
306    is the generic complex binary value that is the result of adding
307    num1 and num2.  (Output)
308 
309 
310 :Entry: subtract_binary: 1985-02-20 generic_math_$subtract_binary
311 
312 
313 Function:  This entrypoint subtracts two generic binary numbers.
314 
315 
316 Syntax:
317 declare generic_math_$subtract_binary entry(bit(108), bit(108),
318      bit(108));
319 call generic_math_$subtract_binary (num1, num2, result);
320 
321 
322 Arguments:
323 num1
324    is a generic binary number.  (Input)
325 num2
326    is a generic binary number.  (Input)
327 result
328    is the generic binary value that is the result of subtracting num2
329    from num1.  (Output)
330 
331 
332 :Entry: subtract_binary_complex: 1985-02-20 generic_math_$subtract_binary_complex
333 
334 
335 Function:  This entrypoint subtracts two generic complex binary
336 numbers.
337 
338 
339 Syntax:
340 declare generic_math_$subtract_binary_complex entry(bit(252), bit(252),
341      bit(252));
342 call generic_math_$subtract_binary_complex (num1, num2, result);
343 
344 
345 Arguments:
346 num1
347    is a generic complex binary number.  (Input)
348 num2
349    is a generic complex binary number.  (Input)
350 result
351    is the generic complex binary value that is the result of
352    subtracting num2 from num1.  (Output)
353 
354 
355 :Entry: multiply_binary: 1985-02-20 generic_math_$multiply_binary
356 
357 
358 Function:  This entrypoint multiplies two generic binary numbers.
359 
360 
361 Syntax:
362 declare generic_math_$multiply_binary entry(bit(108), bit(108),
363      bit(108));
364 call generic_math_$multiply_binary (num1, num2, result);
365 
366 
367 Arguments:
368 num1
369    is a generic binary number.  (Input)
370 num2
371    is a generic binary number.  (Input)
372 result
373    is the generic binary value that is the result of multiplying num1
374    by num2.  (Output)
375 
376 
377 :Entry: multiply_binary_complex: 1985-02-20
378 generic_math_$multiply_binary_complex
379 
380 
381 Function:  This entrypoint multiplies two generic complex binary
382 numbers.
383 
384 
385 Syntax:
386 declare generic_math_$multiply_binary_complex entry(bit(252), bit(252),
387      bit(252));
388 call generic_math_$multiply_binary_complex (num1, num2, result);
389 
390 
391 Arguments:
392 num1
393    is a generic complex binary number.  (Input)
394 num2
395    is a generic complex binary number.  (Input)
396 result
397    is the generic complex binary value that is the result of
398    multiplying num1 by num2.  (Output)
399 
400 
401 :Entry: divide_binary: 1985-02-20 generic_math_$divide_binary
402 
403 
404 Function:  This entrypoint divides two generic binary numbers.
405 
406 
407 Syntax:
408 declare generic_math_$divide_binary entry(bit(108), bit(108),
409      bit(108));
410 call generic_math_$divide_binary (num1, num2, result);
411 
412 
413 Arguments:
414 num1
415    is a generic binary number.  (Input)
416 num2
417    is a generic binary number.  (Input)
418 result
419    is the generic binary value that is the result of dividing num1 by
420    num2.  (Output)
421 
422 
423 :Entry: divide_binary_complex: 1985-02-20 generic_math_$divide_binary_complex
424 
425 
426 Function:  This entrypoint divides two generic complex binary numbers.
427 
428 
429 Syntax:
430 declare generic_math_$divide_binary_complex entry(bit(252), bit(252),
431      bit(252));
432 call generic_math_$divide_binary_complex (num1, num2, result);
433 
434 
435 Arguments:
436 num1
437    is a generic complex binary number.  (Input)
438 num2
439    is a generic complex binary number.  (Input)
440 result
441    is the generic complex binary value that is the result of dividing
442    num1 by num2.  (Output)
443 
444 
445 :hcom:
446 
447 
448 
449 /****^  HISTORY COMMENTS:
450   1) change(2020-04-24,GDixon), approve(2021-02-22,MCR10088),
451      audit(2021-05-27,Swenson), install(2021-05-27,MR12.6g-0056):
452       A) Fix heading in generic_math_$add_decimal.
453                                                    END HISTORY COMMENTS */
454 
455 
456