NAG Library ManualKeyword Search:

NAG Library Routine Document

e04vkf (nlp2_sparse_option_file)

▸▿ 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

10.1 Program Text

10.2 Program Data

10.3 Program Results

1

Purpose

e04vkf may be used to supply optional parameters to e04vhf from an external file. The initialization routine e04vgf must have been called before calling e04vkf.

2

Specification

Fortran Interface

Subroutine e04vkf (

ispecs, cw, iw, rw, ifail)

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

C Header Interface

#include nagmk26.h

void	e04vkf_ ( const Integer ispecs, char cw[], Integer iw[], double rw[], Integer ifail, const Charlen length_cw)

3

Description

e04vkf may be used to supply values for optional parameters to e04vhf. e04vkf reads an external file and each line of the file defines a single optional parameter. It is only necessary to supply values for those arguments whose values are to be different from their default values.

Each optional parameter is defined by a single character string consisting of one or more items. The items associated with a given option must be separated by spaces, or equals signs

[=]

. Alphabetic characters may be upper or lower case. The string

Print Level = 1

is an example of a string used to set an optional parameter. For each option the string contains one or more of the following items:

–	a mandatory keyword.
–	a phrase that qualifies the keyword.
–	a number that specifies an integer or real value. Such numbers may be up to $16$ contiguous characters in Fortran's I, F, E or D formats, terminated by a space if this is not the last item on the line.

Blank strings and comments are ignored. A comment begins with an asterisk (*) and all subsequent characters in the string are regarded as part of the comment.

The file containing the options must start with Begin and must finish with End. An example of a valid options file is:

Begin * Example options file 
   Print level = 5 
End

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: $ispecs$ – IntegerInput: On entry: the unit number of the option file to be read.

Constraint: ispecs is a valid unit open for reading.
2: $cw (*)$ – Character(8) arrayCommunication Array: Note: the dimension of the array cw must be at least $lencw$ (see e04vgf).
3: $iw (*)$ – Integer arrayCommunication Array: Note: the dimension of the array iw must be at least $leniw$ (see e04vgf).
4: $rw (*)$ – Real (Kind=nag_wp) arrayCommunication Array: Note: the dimension of the array rw must be at least $lenrw$ (see e04vgf).
5: $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$

At least one line of the options file is invalid.

Could not read options file on unit

ispecs = 〈value〉

Could not read options file on unit ispecs. This may be due to:

(a)	ispecs is not a valid unit number;
(b)	a file is not associated with unit ispecs, or if it is, is unavailable for read access;
(c)	one or more lines of the options file is invalid. Check that all keywords are neither ambiguous nor misspelt;
(d)	Begin was found, but end-of-file was found before End was found;
(e)	end-of-file was found before Begin was found.

$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

e04vkf is not threaded in any implementation.

9

Further Comments

e04vlf, e04vmf or e04vnf may also be used to supply optional parameters to e04vhf.

10

Example

This example solves the same problem as the example in the document for e04vhf, but sets and reads some optional parameters first. See Section 10 in e04vhf for further details.

The example in the document for e04vjf also solves the same problem (see Section 10 in e04vjf), but it first calls e04vjf to determine the sparsity pattern before calling e04vkf.

NAG Library Routine Document

e04vkf (nlp2_sparse_option_file)

▸▿ 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

10.1 Program Text

10.2 Program Data

10.3 Program Results