This manualfile contains a concise description of each function with at least one example demonstrating the use of each function, including sample input and results. All information pertaining to a particular function is in one place within a chaptersection.
Each chaptersection begins with an introduction followed by a table of contents listing the functions included in the chapter. Documentation of the functions consists of the following information:
• Section Name: Usually, the common root for the type float and type double versions of the function.
• Purpose: A statement of the purpose of the function.
• Synopsis: The form for referencing the subprogram with required arguments listed.
Required Arguments: A description of the required arguments in the order of their occurrence.
Input: Argument must be initialized; it is not changed by the function.
Input/Output: Argument must be initialized; the function returns output through this argument. The argument cannot be a constant or an expression.
Output: No initialization is necessary. The argument cannot be a constant or an expression; the function returns output through this argument.
• Return Value: The value returned by the function.
• Synopsis with Optional Arguments: The form for referencing the function with both required and optional arguments listed.
• Optional Arguments: A description of the optional arguments in the order of their occurrence.
• Description: A description of the algorithm and references to detailed information. In many cases, other IMSL functions with similar or complementary functions are noted.
• Examples: At least one application of this function showing input and optional arguments.
• Errors: Listing of any errors that may occur with a particular function. A discussion on error types is given in the “User Errors” section of the Reference Material. The errors are listed by their type as follows:
Informational Errors: List of informational errors that may occur with the function.
Alert Errors: List of alert errors that may occur with the function.
Warning Errors: List of warning errors that may occur with the function.
Fatal Errors: List of fatal errors that may occur with the function.
References: References are listed alphabetically by author.
|
Visual Numerics, Inc. PHONE: 713.784.3131 FAX:713.781.9260 |