Menu
▾
▴
[Oorexx-svn] SF.net SVN: oorexx:[3023] docs/trunk/ootest
|
From: <mie...@us...> - 2008-08-19 22:41:30
|
Revision: 3023
http://oorexx.svn.sourceforge.net/oorexx/?rev=3023&view=rev
Author: miesfeld
Date: 2008-08-19 22:41:38 +0000 (Tue, 19 Aug 2008)
Log Message:
-----------
Going to write the Quick Start for ooTest as a PDF file
Modified Paths:
--------------
docs/trunk/ootest/Makefile
docs/trunk/ootest/ootest.sgml
Added Paths:
-----------
docs/trunk/ootest/ootestQuick.sgml
Modified: docs/trunk/ootest/Makefile
===================================================================
--- docs/trunk/ootest/Makefile 2008-08-19 20:23:31 UTC (rev 3022)
+++ docs/trunk/ootest/Makefile 2008-08-19 22:41:38 UTC (rev 3023)
@@ -44,12 +44,18 @@
../shared/oorexx.html.dsl
-SGML_FILES = ootest.sgml \
+OOTEST_SGML_FILES = ootest.sgml \
../shared/notices.sgml \
../shared/legalstuff.sgml \
../shared/gethelp.sgml \
../shared/CPLv1.0.sgml
+OOTESTQS_SGML_FILES = ootestQuick.sgml \
+ ../shared/notices.sgml \
+ ../shared/legalstuff.sgml \
+ ../shared/gethelp.sgml \
+ ../shared/CPLv1.0.sgml
+
IMAGE_FILES = oorexx.jpg \
docbook-1.png \
new_rexxla.jpg
@@ -63,14 +69,17 @@
all: pdf html
-pdf: ootest.pdf
+pdf: ootest.pdf ootestQuickStart.pdf
html: ootest-html.zip
-ootest.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) genindex.sgml svnrev.tmp
+ootest.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) ootest_index.sgml svnrev.tmp
docbook2pdf -d ../shared/oorexx.print.dsl ootest.sgml
-book1.htm: $(IMAGE_FILES) $(HTML_STYLESHEET) genindex.sgml svnrev.tmp
+ootestQuickStart.pdf: $(IMAGE_FILES) $(STYLESHEET) $(JADETEXFMT) ootestQuick_index.sgml svnrev.tmp
+ docbook2pdf -d ../shared/oorexx.print.dsl ootestQuick.sgml
+
+book1.htm: $(IMAGE_FILES) $(HTML_STYLESHEET) ootest_index.sgml svnrev.tmp
docbook2html -d ../shared/oorexx.html.dsl ootest.sgml
ootest-html.zip: book1.htm
@@ -79,12 +88,18 @@
$(JADETEXFMT): $(HYPERREFCFG)
pdftex -ini \&pdflatex pdfjadetex.ini
-genindex.sgml: $(HTML_STYLESHEET) $(SGML_FILES) svnrev.tmp
- collateindex.pl -N -o genindex.sgml
+ootest_index.sgml: $(HTML_STYLESHEET) $(OOTEST_SGML_FILES) svnrev.tmp
+ collateindex.pl -N -o ootest_index.sgml
jade -t sgml -d ../shared/oorexx.html.dsl -V html-index ootest.sgml
rm *.htm
- collateindex.pl -p -g -o genindex.sgml HTML.index
+ collateindex.pl -p -g -o ootest_index.sgml HTML.index
+ootestQuick_index.sgml: $(HTML_STYLESHEET) $(OOTESTQS_SGML_FILES) svnrev.tmp
+ collateindex.pl -N -o ootestQuick_index.sgml
+ jade -t sgml -d ../shared/oorexx.html.dsl -V html-index ootestQuick.sgml
+ rm *.htm
+ collateindex.pl -p -g -o ootestQuick_index.sgml HTML.index
+
svnrev.tmp:
svnversion > svnrev.tmp
@@ -92,6 +107,6 @@
clean:
- @rm -f *.log *.aux *.out *.fmt *.pdf genindex.sgml *.htm *.zip \
- HTML.index *.tmp
+ @rm -f *.log *.aux *.out *.fmt *.pdf ootest_index.sgml *.htm *.zip \
+ HTML.index *.tmp ootestQuick_index.sgml
Modified: docs/trunk/ootest/ootest.sgml
===================================================================
--- docs/trunk/ootest/ootest.sgml 2008-08-19 20:23:31 UTC (rev 3022)
+++ docs/trunk/ootest/ootest.sgml 2008-08-19 22:41:38 UTC (rev 3023)
@@ -5,7 +5,7 @@
<!ENTITY notices SYSTEM "../shared/notices.sgml">
<!ENTITY cpl SYSTEM "../shared/CPLv1.0.sgml">
<!ENTITY gethelp SYSTEM "../shared/gethelp.sgml">
-<!ENTITY genindex SYSTEM "genindex.sgml">
+<!ENTITY genindex SYSTEM "ootest_index.sgml">
<!ENTITY svnrev SYSTEM "svnrev.tmp">
]>
<!--#########################################################################
Added: docs/trunk/ootest/ootestQuick.sgml
===================================================================
--- docs/trunk/ootest/ootestQuick.sgml (rev 0)
+++ docs/trunk/ootest/ootestQuick.sgml 2008-08-19 22:41:38 UTC (rev 3023)
@@ -0,0 +1,880 @@
+<?xml version="1.0" standalone="no">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
+[
+<!ENTITY legalstuff SYSTEM "../shared/legalstuff.sgml">
+<!ENTITY notices SYSTEM "../shared/notices.sgml">
+<!ENTITY cpl SYSTEM "../shared/CPLv1.0.sgml">
+<!ENTITY gethelp SYSTEM "../shared/gethelp.sgml">
+<!ENTITY genindex SYSTEM "ootestQuick_index.sgml">
+<!ENTITY svnrev SYSTEM "svnrev.tmp">
+]>
+<!--#########################################################################
+ #
+ # Description: Quick Start for the ooTest Framework SGML file.
+ #
+ # Copyright (c) 2008, Rexx Language Association. 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.
+ #
+ #########################################################################
+-->
+<book>
+<bookinfo>
+<title>A Quick Start to Writing ooRexx Test Cases</title>
+<titleabbrev>Quick Start</titleabbrev>
+
+&legalstuff;
+
+</bookinfo>
+
+<preface id="preface"><title>About This Book</title>
+<para>ooTest is a testing framework that facilitates the testing of the ooRexx
+interpreter. It sits on top of the ooRexxUnit framework which is a generic
+testing framework that anyone can use to test their Rexx applications.
+</para>
+<para>This PDF attempts to give anyone, even those with only a small
+understanding of Rexx, a quick start to writing test cases to test the ooRexx
+interpreter. In particular, it is geared towards the person who says: I would
+like to help the ooRexx project by writing test cases, but I don't understand
+that object stuff.
+</para>
+<para>The Quick Start comes from a series of e-mail messages I posted on the
+ooRexx Developer's list. As such it has a rather informal tone. The basic idea
+driving this book is that by using a few mechanical techniques along with some
+boilerplate code, anyone who can write a small piece of Rexx code can write a
+working test case. Although the ooTest framework is object orientated, you do
+not need to know objects, or even understand objects to write test cases.
+</para>
+<para>It is not my intention to fully explain every detail here. My intention
+is to get some people started writing test cases. I believe that if you use the
+boilerplate code to start writing test cases, some of the object stuff will just
+seep in. Because of this, writing test cases is a good way to slowly get used
+to using objects in your own ooRexx code.
+</para>
+
+<section id="relinf"><title>Related Information</title>
+<para>See also:
+<citetitle pubwork="book">Open Object Rexx: Reference</citetitle></para>
+</section>
+
+
+&gethelp;
+
+</preface>
+
+<chapter><title>First Steps</title>
+<para>
+ Download one of the ooRexxUnit snapshots from SourceForge. Through out this
+ discussion I use the term ooRexxUnit and ooTest interchangeably. ooRexxUnit
+ is a generic testing framework and the term first used when talking about
+ testing ooRexx. Some things retain that name. What I am really concerned
+ with is ooTest which is a framework whose sole purpose is to test the ooRexx
+ interpreter.
+</para>
+<para>
+ As the ooRexx interpreter evolves, so does the ooTest framework. For that
+ reason you need to grab a snapshot that matches the version of ooRexx that
+ you will be writing and executing your tests with.
+</para>
+<para>
+ It can not be stressed enough how valuable a contribution to the ooRexx
+ project test cases are. You do not need to write and execute test cases
+ using the most current non-released version of ooRexx. Most people should
+ write and execute test cases using the most recent released version of
+ ooRexx. This provides a solid base of good test cases with known results.
+ These test cases then make it far easier for the developers to improve and
+ enhance ooRexx. After any code changes the suite of known working test
+ cases can be executed to ensure the new code did not break anything.
+</para>
+<para>
+ An ooRexxUnit X.X.X Snapshot is a package released by the ooRexx team that
+ contains both the testing framework and the set of tests used in testing the
+ ooRexx interpreter at that X.X.X level. As the version name implies, it is
+ a snapshot of ooRexxUnit at that point in time. The package contains all
+ the currently available test groups written to test the X.X.X interpreter.
+ These test groups are an excellent source of techniques for using
+ ooRexxUnit.
+</para>
+<para>
+ The primary purpose of releasing snapshot versions of ooRexxUnit is to
+ encourage individuals and organizations to contribute test cases for the
+ interpreter.
+</para>
+<para>
+ Writing test groups to test the interpreter requires nothing other than an
+ installed X.X.X interpreter and a framework package. If an individual has
+ limited knowledge of ooRexx programming, then writing test cases will be a
+ excellent way to learn the language.
+</para>
+<para>
+ Individuals wishing to contribute to ooRexx through writing test case can
+ get advice and help by joining the oorexx-devel list. The list is free and
+ open to anyone. Go to:
+
+ <ulink url="https://sourceforge.net/mail/?group_id=119701">
+ <citetitle>Subscribe oorexx-devel list</citetitle>
+ </ulink>
+
+ to join the list.
+</para>
+<para>
+ In addition the RexxLA mailing list is also a good place to seek advice or
+ help in writing test units. If not already a member of RexxLA, more
+ information on the group can be found at:
+
+ <ulink url="http://rexxla.org/"><citetitle>RexxLA Home Page</citetitle></ulink>
+</para>
+
+<section><title>Download</title>
+<para>
+ Go to the file download section of the ooRexx project on SourceForge:
+
+ <ulink url="https://sourceforge.net/project/showfiles.php?group_id=119701">
+ <citetitle>SourceForge.net Files</citetitle>
+ </ulink>
+ and download the snapshot for your version of ooRexx.
+</para>
+<para>
+ Most of the times the snapshots are packaged in both zip and tar format.
+ However, the ooTest framework and files are completely platform independent
+ so any package will work on any system that ooRexx is working on. Pick the
+ packaging type that is most convenient for your needs.
+</para>
+</section>
+<section><title>Extract the Files</title>
+<para>
+ Unzip or untar the snapshot in a convenient spot. After unpackaging you
+ will end up with a directory structure similar to this:
+
+<![CDATA[
+ooRexxUnit.X.X.X
+ |
+ *------*framework
+ | |
+ | *-----<subdirectories>
+ |
+ *------*misc
+ | |
+ | *-----<subdirectories>
+ |
+ *------*ooRexx
+ |
+ *-----<subdirectories>
+]]>
+</para>
+
+<para>
+ The framework directory and subdirectories contain additional documentation
+ and examples.
+</para>
+<para>
+ The ooRexx directory and subdirectories contain all the tests implemented
+ using the ooTest framework. These sub-directories contain the tests used in
+ testing the ooRexx interpreter.
+</para>
+<para>
+ The misc directory has, well miscellaneous stuff. The most important of
+ which for this discussion is a template file that can be used to start your
+ test group files.
+</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.</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</primary></indexterm>
+<indexterm><primary>functions</primary>
+<secondary>MathLoadFuncs</secondary></indexterm>
+<indexterm><primary>load functions</primary></indexterm>
+<indexterm><primary>register functions</primary></indexterm>
+<programlisting>
+<![CDATA[
+>>-MathLoadFuncs()---------------------------------------------><
+]]>
+</programlisting>
+<para>Loads all functions in the Rexx Mathematical Functions package.</para>
+<para>If you supply any parameters, they will be used only to deliver copyright
+information.</para>
+</section>
+
+<section><title>MathDropFuncs()</title>
+<indexterm><primary>MathDropFuncs</primary></indexterm>
+<indexterm><primary>functions</primary>
+<secondary>MathDropFuncs</secondary></indexterm>
+<indexterm><primary>unload functions</primary></indexterm>
+<indexterm><primary>deregister functions</primary></indexterm>
+<programlisting>
+<![CDATA[
+>>-MathDropFuncs()---------------------------------------------><
+]]>
+</programlisting>
+<para>Drops all functions in the Rexx Mathematical Functions package.</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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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 number, expressed in radians.</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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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 number, expressed in radians.</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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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 number, expressed in radians.</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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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. If the precision exceeds 16 digits, the call
+ will fail.
+ </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>
+
+¬ices;
+&cpl;
+
+&genindex;
+
+</book>
+
Property changes on: docs/trunk/ootest/ootestQuick.sgml
___________________________________________________________________
Added: svn:eol-style
+ native
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|