[r9284]: docs / branches / 4.1.3 / trunk / rxmath / rxmath.xml  Maximize  Restore  History

Download this file

942 lines (885 with data), 35.1 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
<?xml version="1.0" standalone="no">
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
[
<!ENTITY legalstuff SYSTEM "../shared/legalstuff.xml">
<!ENTITY notices SYSTEM "../shared/notices.xml">
<!ENTITY cpl SYSTEM "../shared/CPLv1.0.xml">
<!ENTITY gethelp SYSTEM "../shared/gethelp.xml">
<!ENTITY genindex SYSTEM "genindex.xml">
<!ENTITY svnrev SYSTEM "svnrev.tmp">
]>
<!--#########################################################################
#
# Description: Open Object RexxMath Library Functions SGML file.
#
# Copyright (c) 2005-2010, Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Author(s):
# W. David Ashley <dashley@us.ibm.com>
#
#########################################################################
-->
<book>
<bookinfo>
<title>Open Object Rexx&trade;</title>
<subtitle>RxMath Math Functions Reference</subtitle>
<titleabbrev>ooRexx RxMath Reference</titleabbrev>
&legalstuff;
</bookinfo>
<preface id="preface"><title>About This Book</title>
<para>This book describes the Open Object Rexx Math Function Library.
</para>
<para>This book is intended for people who plan to develop applications using
Rexx. Its users range from the novice, who might have experience in some programming
language but no Rexx experience, to the experienced application developer,
who might have had some experience with Object Rexx.</para>
<para>This book is a reference rather than a tutorial. It assumes you are already
familiar with object-oriented programming concepts.</para>
<para>Descriptions include the use and syntax of the language and explain how
the language processor &quot;interprets&quot; the language as a program is running.</para>
<section id="relinf"><title>Related Information</title>
<para>See also:
<citetitle pubwork="book">Open Object Rexx: Reference</citetitle></para>
</section>
<section id="readsy"><title>How to Read the Syntax Diagrams</title>
<para>Throughout this book, syntax is described using the structure defined below. </para>
<itemizedlist>
<listitem><para>Read the syntax diagrams from left to right, from top to bottom, following
the path of the line. </para>
<para>The <computeroutput>&gt;&gt;---</computeroutput> symbol
indicates the beginning of a statement.</para>
<para>The <computeroutput>---&gt;</computeroutput> symbol indicates that the statement syntax is continued on the
next line.</para>
<para>The <computeroutput>&gt;---</computeroutput> symbol indicates
that a statement is continued from the previous line.</para>
<para>The <computeroutput>---&gt;&lt;</computeroutput> symbol indicates the end of a statement.</para>
<para>Diagrams of syntactical units other than complete statements start
with the <computeroutput>&gt;---</computeroutput> symbol and end with
the <computeroutput>---&gt;</computeroutput> symbol.</para></listitem>
<listitem><para>Required items appear on the horizontal line (the main path).
<programlisting>
<![CDATA[
>>-STATEMENT--required_item------------------------------------><
]]>
</programlisting>
</para></listitem>
<listitem><para>Optional items appear below the main path. </para>
<programlisting>
<![CDATA[
>>-STATEMENT--+---------------+--------------------------------><
+-optional_item-+
]]>
</programlisting>
</listitem>
<listitem><para>If you can choose from two or more items, they appear vertically, in a
stack. If you must choose one of the items, one
item of the stack appears on the main path.</para>
<programlisting>
<![CDATA[
>>-STATEMENT--+-required_choice1-+-----------------------------><
+-required_choice2-+
]]>
</programlisting>
</listitem>
<listitem><para>If choosing one of the items is optional, the entire stack appears below
the main path.</para>
<programlisting>
<![CDATA[
>>-STATEMENT--+------------------+-----------------------------><
+-optional_choice1-+
+-optional_choice2-+
]]>
</programlisting>
</listitem>
<listitem><para>If one of the items is the default, it appears above the main path and
the remaining choices are shown below. </para>
<programlisting>
<![CDATA[
+-default_choice--+
>>-STATEMENT--+-----------------+------------------------------><
+-optional_choice-+
+-optional_choice-+
]]>
</programlisting>
</listitem>
<listitem><para>An arrow returning to the left above the main line indicates an item that
can be repeated.</para>
<programlisting>
<![CDATA[
+-----------------+
V |
>>-STATEMENT----repeatable_item-+------------------------------><
]]>
</programlisting>
<para>A repeat arrow above a stack indicates that you can repeat the
items in the stack.</para></listitem>
<listitem><para>A set of vertical bars around an item indicates that the item is a fragment, a part of the syntax diagram that appears in
greater detail below the main diagram.</para>
<programlisting>
<![CDATA[
>>-STATEMENT--| fragment |-------------------------------------><
]]>
</programlisting>
<para><emphasis role="italic">fragment:</emphasis></para>
<programlisting>
|--expansion_provides_greater_detail----------------------------|
</programlisting>
</listitem>
<listitem><para>Keywords appear in uppercase (for example, <computeroutput>PARM1</computeroutput>). They must
be spelled exactly as shown but you can type them in upper, lower, or mixed
case. Variables appear in all lowercase letters (for example, <computeroutput>parmx</computeroutput>). They represent user-supplied names or values.</para></listitem>
<listitem><para>If punctuation marks, parentheses, arithmetic operators, or such symbols
are shown, you must enter them as part of the syntax.</para></listitem></itemizedlist>
<para>The following example shows how the syntax is described:</para>
<programlisting>
<![CDATA[
+-,------+
V |
>>-MAX(----number-+--)-----------------------------------------><
]]>
</programlisting>
</section>
<section><title>A Note About Program Examples in this Document</title>
<para>The program examples in this document are rendered in a mono-spaced
font that is not completely compatible for cut-and-paste functionality.
Pasting text into an editor could result in some characters outside of
the standard ASCII character set. Specifically, single-quote and
double-quote characters are sometimes converted incorrectly when
pasted into an editor.</para>
</section>
&gethelp;
</preface>
<chapter><title>Introduction</title>
<para>RxMath is a Rexx utility package that enables you to use enhanced mathematical
functions.</para>
<para>The function names in the Rexx Mathematical Functions package are similar to
the names of their corresponding mathematical functions.</para>
<para>The precision of calculation depends on:</para>
<itemizedlist>
<listitem><para>The value specified when the command is issued</para></listitem>
<listitem><para>The numeric digits settings of the calling Rexx activity</para></listitem>
</itemizedlist>
<note><para>Precision is limited to 16 digits.</para></note>
<section><title>Using the RxMath package</title>
<para>
The Rexx Mathematical Functions package is contained in the library <emphasis
role="italic">rxmath</emphasis>, with the appropriate file name for the operating system. This library
must be loadable by the operating system using the normal procedure for the system. For instance, on Windows
the file must be placed in a directory listed in your PATH. When installing ooRexx from any of the
installation packages, the details of where the file is placed are handled automatically.
</para>
<para>
Beginning with ooRexx 4.0.0, a more robust process is used to load external functions. To get access to
the functions in the Rexx Mathematical Functions package, use a ::requires directive. For example:
</para>
<programlisting>
say 'The square root of 3 is:' RxCalcSqrt(3)
::requires 'rxmath' LIBRARY
</programlisting>
<para>
Existing code that used the previous process to load external functions:
</para>
<programlisting>
call rxfuncadd "MathLoadFuncs", "rxmath", "MathLoadFuncs"
</programlisting>
<para>
does not need to be changed. However, both <computeroutput>MathLoadFuncs()</computeroutput> and
<computeroutput>MathDropFuncs()</computeroutput> are nops in ooRexx 4.0.0 and later.
</para>
</section>
<section><title>Error Handling and Function Returns</title>
<para>
Error 40 (Incorrect call to routine) is raised if either the wrong number of arguments or incorrect
data is passed to a function.
</para>
<para>
If a mathematical function fails, the function will return <emphasis role="italic">nan</emphasis>,
<emphasis role="italic">+infinity</emphasis>, and <emphasis role="italic">-infinity</emphasis> as
appropriate. These returns are consistent on all operating systems.
</para>
</section>
<section><title>Package Limitations</title>
<para>
The RxMath package internally uses the corresponding C library math functions to perform the
actual calculations. These C functions are limited to values of the C numeric type of
<emphasis role="bold">double</emphasis>. All numeric arguments passed to the RxMath package
functions are truncated (if needed) in order to convert them to the C
<emphasis role="bold">double</emphasis> type.
</para>
</section>
</chapter>
<chapter><title>Functions</title>
<para>
Most function names in the Rexx Mathematical Functions package are similar to the names of their
corresponding mathematical functions. Note that in ooRexx 4.0.0 and later, the
<computeroutput>MathLoadFuncs()</computeroutput> and <computeroutput>MathDropFuncs()</computeroutput>
are nops.
</para>
<itemizedlist>
<listitem><para>MathLoadFuncs()</para></listitem>
<listitem><para>MathDropFuncs()</para></listitem>
<listitem><para>RxCalcSqrt() </para></listitem>
<listitem><para>RxCalcExp() </para></listitem>
<listitem><para>RxCalcLog() </para></listitem>
<listitem><para>RxCalcLog10() </para></listitem>
<listitem><para>RxCalcSinH() </para></listitem>
<listitem><para>RxCalcCosH() </para></listitem>
<listitem><para>RxCalcTanH() </para></listitem>
<listitem><para>RxCalcPower() </para></listitem>
<listitem><para>RxCalcSin() </para></listitem>
<listitem><para>RxCalcCos() </para></listitem>
<listitem><para>RxCalcTan() </para></listitem>
<listitem><para>RxCalcCotan() </para></listitem>
<listitem><para>RxCalcPi() </para></listitem>
<listitem><para>RxCalcArcSin() </para></listitem>
<listitem><para>RxCalcArcCos() </para></listitem>
<listitem><para>RxCalcArcTan() </para></listitem>
</itemizedlist>
<section><title>MathLoadFuncs()</title>
<indexterm><primary>MathLoadFuncs (nop)</primary></indexterm>
<programlisting>
<![CDATA[
>>-MathLoadFuncs()---------------------------------------------><
]]>
</programlisting>
<para>
Beginning with ooRexx 4.0.0 this function is basically a nop. Use:
<programlisting>
::requires 'rxmath' LIBRARY
</programlisting>
to gain access to the functions in the package.
</para>
<para>
However, if this function is called with a single, string, parameter, the copyright information is
printed.
</para>
</section>
<section><title>MathDropFuncs()</title>
<indexterm><primary>MathDropFuncs (nop)</primary></indexterm>
<programlisting>
<![CDATA[
>>-MathDropFuncs()---------------------------------------------><
]]>
</programlisting>
<para>
This function is a nop in ooRexx 4.0.0 and later. It does nothing.
</para>
</section>
<section><title>RxCalcSqrt()</title>
<indexterm><primary>RxCalcSqrt</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcSqrt</secondary></indexterm>
<indexterm><primary>square root of a number</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcSqrt(number--+---------------+--)---------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the absolute value of the square root of number.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number whose square root you wish to calculate.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcExp()</title>
<indexterm><primary>RxCalcExp</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcExp</secondary></indexterm>
<indexterm><primary>exponential</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcExp(number--+---------------+--)----------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the exponential function of number.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which you wish to calculate the exponential function.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcLog()</title>
<indexterm><primary>RxCalcLog</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcLog</secondary></indexterm>
<indexterm><primary>natural logarithm</primary></indexterm>
<indexterm><primary>logarithm, natural</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcLog(number--+---------------+--)----------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the natural logarithm (base e) of number.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which you wish to calculate the natural logarithm.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcLog10()</title>
<indexterm><primary>RxCalcLog10</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcLog10</secondary></indexterm>
<indexterm><primary>base 10 logarithm</primary></indexterm>
<indexterm><primary>logarithm, base 10</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcLog10(number--+---------------+--)--------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the base 10 logarithm of number.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which you wish to calculate the base 10 logarithm.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcSinH()</title>
<indexterm><primary>RxCalcSinH</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcSinH</secondary></indexterm>
<indexterm><primary>hyperbolic sine of a number</primary></indexterm>
<indexterm><primary>number, hyperbolic sine of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcSinH(number--+---------------+--)---------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the hyperbolic sine of <emphasis role="italic">number</emphasis>.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which you wish to calculate the hyperbolic sine.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcCosH()</title>
<indexterm><primary>RxCalcCosH</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcCosH</secondary></indexterm>
<indexterm><primary>hyperbolic cosine of a number</primary></indexterm>
<indexterm><primary>number, hyperbolic cosine of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcCosH(number--+---------------+--)---------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the hyperbolic cosine of <emphasis role="italic">number</emphasis>.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which you wish to calculate the hyperbolic cosine.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcTanH()</title>
<indexterm><primary>RxCalcTanH</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcTanH</secondary></indexterm>
<indexterm><primary>hyperbolic tangent of a number</primary></indexterm>
<indexterm><primary>number, hyperbolic tangent of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcTanH(number--+---------------+--)---------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the hyperbolic tangent of <emphasis role="italic">number</emphasis>.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which you wish to calculate the hyperbolic tangent.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcPower()</title>
<indexterm><primary>RxCalcPower</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcPower</secondary></indexterm>
<indexterm><primary>raise a number to a power</primary></indexterm>
<indexterm><primary>number to a power, raise a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcPower(number1, number2--+---------------+--)----------><
+--, precision--+
]]>
</programlisting>
<para> Returns the value of mathematical expression number1 raised to the power of
exponent number2.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number1</term>
<listitem><para>The mathematical expression to be raised to the power of exponent
number2.
</para></listitem>
</varlistentry>
<varlistentry>
<term>number2</term>
<listitem><para>The exponent to which number1 is to be raised.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcSin()</title>
<indexterm><primary>RxCalcSin</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcSin</secondary></indexterm>
<indexterm><primary>sine value of a number</primary></indexterm>
<indexterm><primary>number, sine value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcSin(number--+--------------------------+--)-----------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para>Returns the sine value for number, where number is the angle size, expressed in
degree [D], radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The angle size, expressed in degree [D], radian [R], or grade [G] units.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the angle size is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the angle size is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the angle size is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcCos()</title>
<indexterm><primary>RxCalcCos</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcCos</secondary></indexterm>
<indexterm><primary>cosine value of a number</primary></indexterm>
<indexterm><primary>number, cosine value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcCos(number--+--------------------------+--)-----------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para>Returns the cosine value for number, where number is the angle size, expressed in
degree [D], radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The angle size, expressed in degree [D], radian [R], or grade [G] units.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the angle size is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the angle size is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the angle size is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcTan()</title>
<indexterm><primary>RxCalcTan</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcTan</secondary></indexterm>
<indexterm><primary>tangent value of a number</primary></indexterm>
<indexterm><primary>number, tangent value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcTan(number--+--------------------------+--)-----------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para>Returns the tangent value for number, where number is the angle size, expressed in
degree [D], radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The angle size, expressed in degree [D], radian [R], or grade [G] units.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the angle size is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the angle size is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the angle size is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcCotan()</title>
<indexterm><primary>RxCalcCotan</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcCotan</secondary></indexterm>
<indexterm><primary>cotangent value of a number</primary></indexterm>
<indexterm><primary>number, cotangent value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcCotan(number--+--------------------------+--)---------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para>Returns the cotangent value for number, where number is the angle size, expressed
in degree [D], radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The angle size, expressed in degree [D], radian [R], or grade [G] units.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the angle size is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the angle size is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the angle size is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcPi()</title>
<indexterm><primary>RxCalcPi</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcPi</secondary></indexterm>
<indexterm><primary>value of pi</primary></indexterm>
<indexterm><primary>pi, value of</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcPi(--+---------------+--)-----------------------------><
+--, precision--+
]]>
</programlisting>
<para>Returns the value of pi.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcArcSin()</title>
<indexterm><primary>RxCalcArcSin</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcArcSin</secondary></indexterm>
<indexterm><primary>arcsine value of a number</primary></indexterm>
<indexterm><primary>number, arcsine value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcArcSin(number--+--------------------------+--)--------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para> Returns the arcsine of number, where the result can be expressed in degree [D],
radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which the arcsine is to be calculated.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the result is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the result is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the result is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcArcCos()</title>
<indexterm><primary>RxCalcArcCos</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcArcCos</secondary></indexterm>
<indexterm><primary>arccosine value of a number</primary></indexterm>
<indexterm><primary>number, arccosine value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcArcCos(number--+--------------------------+--)--------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para>Returns the arccosine of number, where the result can be expressed in degree [D],
radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which the arccosine is to be calculated.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the result is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the result is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the result is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
<section><title>RxCalcArcTan()</title>
<indexterm><primary>RxCalcArcTan</primary></indexterm>
<indexterm><primary>functions</primary>
<secondary>RxCalcArcTan</secondary></indexterm>
<indexterm><primary>arctangent value of a number</primary></indexterm>
<indexterm><primary>number, arctangent value of a</primary></indexterm>
<programlisting>
<![CDATA[
>>-RxCalcArcTan(number--+--------------------------+--)--------><
| +--D--+ |
+--, precision, --+-----+--+
+--R--+
+--G--+
]]>
</programlisting>
<para>Returns the arctangent of number, where the result can be expressed in degree [D],
radian [R], or grade [G] units.</para>
<para>Parameters:</para>
<variablelist>
<varlistentry>
<term>number</term>
<listitem><para>The number for which the arctangent is to be calculated.
</para></listitem>
</varlistentry>
<varlistentry>
<term>precision</term>
<listitem><para>The precision of the calculation. If a value is not specified, the precision of
the calling Rexx activity is used. Precision is limited to 16 digits.
</para></listitem>
</varlistentry>
<varlistentry>
<term>D</term>
<listitem><para>Indicates that the result is expressed in degrees. This is the default.
</para></listitem>
</varlistentry>
<varlistentry>
<term>R</term>
<listitem><para>Indicates that the result is expressed in radians.
</para></listitem>
</varlistentry>
<varlistentry>
<term>G</term>
<listitem><para>Indicates that the result is expressed in grades.
</para></listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
&notices;
&cpl;
&genindex;
</book>

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks