NAG Library ManualKeyword Search:

NAG Library Routine Document

e04vnf (nlp2_sparse_option_double_set)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

1

Purpose

e04vnf may be used to supply individual real optional parameters to e04vhf. The initialization routine e04vgf must have been called before calling e04vnf.

2

Specification

Fortran Interface

Subroutine e04vnf (

string, rvalue, cw, iw, rw, ifail)

Integer, Intent (Inout)	::	iw(*), ifail
Real (Kind=nag_wp), Intent (In)	::	rvalue
Real (Kind=nag_wp), Intent (Inout)	::	rw(*)
Character (*), Intent (In)	::	string
Character (8), Intent (Inout)	::	cw(*)

C Header Interface

#include nagmk26.h

void	e04vnf_ ( const char st, const double rvalue, char cw[], Integer iw[], double rw[], Integer *ifail, const Charlen length_st, const Charlen length_cw)

3

Description

e04vnf may be used to supply values for real optional parameters to e04vhf. It is only necessary to call e04vnf for those arguments whose values are to be different from their default values. One call to e04vnf sets one argument value.

Each real optional parameter is defined by a single character string in string and the corresponding value in rvalue. For example the following illustrates how the

L U

stability tolerance could be defined:

factol = 100.0E0
If (illcon) factol = 5.0E0
Call e04vnf ('LU Factor Tolerance', factol, cw, iw, rw, ifail)

Optional parameter settings are preserved following a call to e04vhf and so the keyword Defaults is provided to allow you to reset all the optional parameters to their default values before a subsequent call to e04vhf.

A complete list of optional parameters, their abbreviations, synonyms and default values is given in Section 12 in e04vhf.

4

References

None.

5

Arguments

1: $string$ – Character(*)Input: On entry: a single valid keyword of a real optional parameter (as described in Section 12 in e04vhf).
2: $rvalue$ – Real (Kind=nag_wp)Input: On entry: the value associated with the keyword in string.
3: $cw (*)$ – Character(8) arrayCommunication Array: Note: the dimension of the array cw must be at least $lencw$ (see e04vgf).
4: $iw (*)$ – Integer arrayCommunication Array: Note: the dimension of the array iw must be at least $leniw$ (see e04vgf).
5: $rw (*)$ – Real (Kind=nag_wp) arrayCommunication Array: Note: the dimension of the array rw must be at least $lenrw$ (see e04vgf).
6: $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

- 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 initialization routine e04vgf has not been called.

$ifail = 2$: The supplied option is invalid. Check that the keywords are neither ambiguous nor misspelt.

$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

e04vnf is not threaded in any implementation.

9

Further Comments

e04vkf or e04vlf may also be used to supply real optional parameters to e04vhf.

10

Example

See Section 10 in e04vkf.

e04vnf (PDF version)

E04 (opt) Chapter Contents

E04 (opt) Chapter Introduction

NAG Library Manual

NAG Library Routine Document

e04vnf (nlp2_sparse_option_double_set)

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example