NAG Library Routine Document

e04wbf (init)

 Contents

    1  Purpose
    7  Accuracy
    10  Example

1
Purpose

e04wbf is used to initialize routines e04dga, e04mfa, e04nca, e04nfa, e04nka, e04uca, e04ufa, e04uga and e04usa.

2
Specification

Fortran Interface
Subroutine e04wbf ( rname, cwsav, lcwsav, lwsav, llwsav, iwsav, liwsav, rwsav, lrwsav, ifail)
Integer, Intent (In):: lcwsav, llwsav, liwsav, lrwsav
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: iwsav(liwsav)
Real (Kind=nag_wp), Intent (Out):: rwsav(lrwsav)
Logical, Intent (Out):: lwsav(llwsav)
Character (*), Intent (In):: rname
Character (80), Intent (Out):: cwsav(lcwsav)
C Header Interface
#include nagmk26.h
void  e04wbf_ (const char *rname, char cwsav[], const Integer *lcwsav, logical lwsav[], const Integer *llwsav, Integer iwsav[], const Integer *liwsav, double rwsav[], const Integer *lrwsav, Integer *ifail, const Charlen length_rname, const Charlen length_cwsav)

3
Description

e04wbf initializes some or all of the arrays cwsav, lwsav, iwsav and rwsav for the routine specified by rname, and any associated option setting routines.

4
References

None.

5
Arguments

1:     rname – Character(*)Input
On entry: the name of the routine to be initialized. The name may be abbreviated to the first 5 letters of the ‘short’ name, or by omitting the nagf_ or opt_ prefixes of the ‘long’ name.
Constraint: rname must be the name of one of the routines initialized by e04wbf.
2:     cwsavlcwsav – Character(80) arrayCommunication Array
3:     lcwsav – IntegerInput
On entry: the dimension of the array cwsav as declared in the (sub)program from which e04wbf is called.
Constraints:
  • if rname='e04uf' or 'nlp1_rcomm', lcwsav5;
  • otherwise lcwsav1.
4:     lwsavllwsav – Logical arrayCommunication Array
5:     llwsav – IntegerInput
On entry: the dimension of the array lwsav as declared in the (sub)program from which e04wbf is called.
Constraints:
  • if rname='e04nk' or 'qpconvex1_sparse_solve', llwsav20;
  • if rname='e04ug' or 'nlp1_sparse_solve', llwsav20;
  • otherwise llwsav120.
6:     iwsavliwsav – Integer arrayCommunication Array
7:     liwsav – IntegerInput
On entry: the dimension of the array iwsav as declared in the (sub)program from which e04wbf is called.
Constraints:
  • if rname='e04nk' or 'qpconvex1_sparse_solve', liwsav380;
  • if rname='e04ug' or 'nlp1_sparse_solve', liwsav550;
  • otherwise liwsav610.
8:     rwsavlrwsav – Real (Kind=nag_wp) arrayCommunication Array
9:     lrwsav – IntegerInput
On entry: the dimension of the array rwsav as declared in the (sub)program from which e04wbf is called.
Constraints:
  • if rname='e04nk' or 'qpconvex1_sparse_solve', lrwsav285;
  • if rname='e04ug' or 'nlp1_sparse_solve', lrwsav550;
  • otherwise lrwsav475.
10:   ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1​ or ​1. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value -1​ or ​1 is recommended. If the output of error messages is undesirable, then the value 1 is recommended. Otherwise, if you are not familiar with this argument, the recommended value is 0. When the value -1​ or ​1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

6
Error Indicators and Warnings

If on entry ifail=0 or -1, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
ifail=1
The routine name supplied in rname is invalid
ifail=2
One or more of the workspace array lengths lcwsav, llwsav, liwsav or lrwsav is too small.
ifail=-99
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
ifail=-399
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
ifail=-999
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7
Accuracy

Not applicable.

8
Parallelism and Performance

e04wbf is not threaded in any implementation.

9
Further Comments

The time taken by e04wbf is negligible.

10
Example

The use of e04wbf is illustrated by the example programs of the routines listed in Section 1.
© The Numerical Algorithms Group Ltd, Oxford, UK. 2017