NAG C Library Function Document

nag_opt_nlp_revcomm_init (e04wbc)

1
Purpose

nag_opt_nlp_revcomm_init (e04wbc) is used to initialize the function nag_opt_nlp_revcomm (e04ufc).

2
Specification

#include <nag.h>
#include <nage04.h>
void  nag_opt_nlp_revcomm_init (const char *rname, char cwsav[], Integer lcwsav, Nag_Boolean lwsav[], Integer llwsav, Integer iwsav[], Integer liwsav, double rwsav[], Integer lrwsav, NagError *fail)

3
Description

nag_opt_nlp_revcomm_init (e04wbc) initializes some or all of the arrays cwsav, lwsav, iwsav and rwsav for the function nag_opt_nlp_revcomm (e04ufc), and any associated option setting functions.

4
References

None.

5
Arguments

1:     rname const char *Input
On entry: the name of the function to be initialized.
Constraint: rname must be called with rname=e04ufc.
2:     cwsav[lcwsav×80] char Communication Array
3:     lcwsav IntegerInput
On entry: the dimension of the array cwsav.
Constraint: lcwsav5.
4:     lwsav[llwsav] Nag_BooleanCommunication Array
5:     llwsav IntegerInput
On entry: the dimension of the array lwsav.
Constraint: llwsav120.
6:     iwsav[liwsav] IntegerCommunication Array
7:     liwsav IntegerInput
On entry: the dimension of the array iwsav.
Constraint: liwsav610.
8:     rwsav[lrwsav] doubleCommunication Array
9:     lrwsav IntegerInput
On entry: the dimension of the array rwsav.
Constraint: lrwsav475.
10:   fail NagError *Input/Output
The NAG error argument (see Section 3.7 in How to Use the NAG Library and its Documentation).

6
Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
NE_BAD_PARAM
On entry, argument value had an illegal value.
NE_CHARACTER
On entry, rname=value.
Constraint: rname must be called with rname=e04ufc.
NE_INTERNAL_ERROR
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact NAG for assistance.
NE_TOO_SMALL
One or more of the save array lengths is too small. Supplied values are: lcwsav=value, llwsav=value, liwsav=value and lrwsav=value.

7
Accuracy

Not applicable.

8
Parallelism and Performance

nag_opt_nlp_revcomm_init (e04wbc) is not threaded in any implementation.

9
Further Comments

The time taken by nag_opt_nlp_revcomm_init (e04wbc) is negligible.

10
Example

The use of nag_opt_nlp_revcomm_init (e04wbc) is illustrated by the example in Section 10 in nag_opt_nlp_revcomm (e04ufc).