Next: NDF_MTYPN - Match the types of the array components of a number of NDFs
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_MSG - Assign the name of an NDF to a message token
NDF_MTYPE
- Match the types of the array components of a pair of NDFs
- Description:
The routine matches the types of the array components of a pair
of NDFs, selecting a numeric type which an application may use to
process these components. It also returns the type which should
be used for storing the result of this processing.
- Invocation:
CALL NDF_MTYPE( TYPLST, INDF1, INDF2, COMP, ITYPE, DTYPE, STATUS )
- Arguments:
-
TYPLST = CHARACTER * ( * ) (Given)
-
A comma-separated list of the numeric types which the
application can process explicitly; e.g. '_INTEGER,_REAL'. The
first type which has sufficient precision will be selected
from this list, so they should normally be given in order of
increasing computational cost.
-
INDF1 = INTEGER (Given)
-
Identifier for the first NDF whose type is to be matched.
-
INDF2 = INTEGER (Given)
-
Identifier for the second NDF.
-
COMP = CHARACTER * ( * ) (Given)
-
Name of the NDF array component whose type is to be
considered.
-
ITYPE = CHARACTER * ( * ) (Returned)
-
Numeric type which the application should use to process the
NDF components. This value is returned as an upper case
character string of maximum length NDF__SZTYP. Its value is
the first entry in the TYPLST list to which the NDF array
components may be converted without unnecessary loss of
information.
-
DTYPE = CHARACTER * ( * ) (Returned)
-
Data type required to hold the result of processing the NDF
array components. This result is returned as an upper case
character string of maximum length NDF__SZFTP. It is intended
to be used as input to the NDF_STYPE routine to set the type
of the output NDF component into which the result will be
written.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
-
A comma-separated list of component names may also be
supplied, in which case the results returned by this routine will
take account of the types of all the specified components in both
NDFs.
-
Matching of the type of a single NDF to an application may be
performed by supplying the same identifier value for both the
INDF1 and INDF2 arguments. There is no extra cost in doing this.
-
If the TYPLST argument does not specify any type to which the
NDF components may be converted without loss of information, then
the routine will return the highest precision type which is
available. An error will be reported, however, and STATUS will be
set to NDF__TYPNI (type not implemented).
-
The constants NDF__SZTYP and NDF__SZFTP are defined in the
include file NDF_PAR. The error code NDF__TYPNI is defined in the
include file NDF_ERR.
Next: NDF_MTYPN - Match the types of the array components of a number of NDFs
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_MSG - Assign the name of an NDF to a message token
Starlink User Note 33
R.F. Warren-Smith
11th January 2000
E-mail:rfws@star.rl.ac.uk
Copyright © 2000 Council for the Central Laboratory of the Research Councils