NAG CL Interface
x04nbc (nag_​enum_​value_​to_​name)

Settings help

CL Name Style:

1 Purpose

x04nbc returns the name of the NAG enumeration member given the enumeration member's value.

2 Specification

#include <nag.h>
const char *  x04nbc (int enum_value)
The function may be called by the names: x04nbc or nag_enum_value_to_name.

3 Description

x04nbc takes an integer argument, which must be the value of a NAG enumeration member and returns a string which is the name of that member (e.g., "Nag_ColMajor", "Nag_LogNormal", etc.). If the input value does not correspond to a NAG enumeration member then the function returns 0.
The reverse process of converting from enumeration member name to enumeration member value is also available using x04nac.
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. x04nbc can be used to get enumeration member names for writing.

4 References


5 Arguments

1: enum_value int Input
On entry: the value of a NAG enumeration member.

6 Error Indicators and Warnings

If the value 0 is returned then the input value is not recognized as a valid NAG enumeration member value.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
x04nbc is not threaded in any implementation.

9 Further Comments


10 Example

This example takes a set of NAG enumeration members and checks that the value used has a name that matches the member name.

10.1 Program Text

Program Text (x04nbce.c)

10.2 Program Data


10.3 Program Results

Program Results (x04nbce.r)