nag_enum_name_to_value (x04nac) (PDF version)
x04 Chapter Contents
x04 Chapter Introduction
NAG C Library Manual

NAG Library Function Document

nag_enum_name_to_value (x04nac)

+ Contents

    1  Purpose
    7  Accuracy

1  Purpose

nag_enum_name_to_value (x04nac) returns a value corresponding to the name of a NAG enumeration member.

2  Specification

#include <nag.h>
#include <nagx04.h>
int  nag_enum_name_to_value (const char *enum_string)

3  Description

nag_enum_name_to_value (x04nac) takes a string argument, which must be the name of a NAG enumeration member (e.g., "Nag_ColMajor", "Nag_LogNormal"", etc.), and returns, as an int, the corresponding NAG enumeration member value. If the input string is not the name of a valid NAG enumeration member then the value -1 is returned.
The reverse process of converting from enumeration member value to enumeration member name is also available using nag_enum_value_to_name (x04nbc).
Converting enumeration members to and from name and value may be of use when saving a set of problem arguments to file or reading problem arguments from a file for use in an application. In the case of saving problem arguments, any enumeration members to be saved should be saved using their names to be subsequently read as strings. When these strings are read back by an application, nag_enum_name_to_value (x04nac) can be used to convert the strings to values suitable for inclusion in NAG C Library function calls.
nag_enum_name_to_value (x04nac) is also useful when calling NAG C Library functions from external application interfaces that do not facilitate enumeration types. In such cases, NAG function calls that expect an enumeration member name as one of its input arguments can pass instead its corresponding integer value following a call to nag_enum_name_to_value (x04nac).

4  References

None.

5  Arguments

1:     enum_stringconst char *Input
On entry: the name of a NAG enumeration member, e.g., "Nag_GeneralMatrix".

6  Error Indicators and Warnings

If the value -1 is returned then the input string is not recognized as a valid NAG enumeration member name.

7  Accuracy

Not applicable.

8  Further Comments

None.

9  Example

This example reads problem arguments from input, converts enumeration member names to their correponding value using nag_enum_name_to_value (x04nac), and passes these values to a function for solving a system of equations.

9.1  Program Text

Program Text (x04nace.c)

9.2  Program Data

Program Data (x04nace.d)

9.3  Program Results

Program Results (x04nace.r)


nag_enum_name_to_value (x04nac) (PDF version)
x04 Chapter Contents
x04 Chapter Introduction
NAG C Library Manual

© The Numerical Algorithms Group Ltd, Oxford, UK. 2012