D Routine Descriptions

 D.1 Routine List
 D.2 Full Routine Specifications

D.1 Routine List

The following is a complete list of user-level TRANSFORM routines with a brief description of their purpose. Full specifications are given in the next Section.

TRN_ANNUL( ID, STATUS )
    Annul compiled mapping

TRN_APND( LOCTR1, LOCTR2, STATUS )
    Append transformation

TRN_CLOSE( STATUS )
    Close the TRANSFORM facility

TRN_COMP( LOCTR, FORWD, ID, STATUS )
    Compile transformation

TRN_GTCL( LOCTR, FORWD, CLASS, STATUS )
    Get classification

TRN_GTCLC( ID, CLASS, STATUS )
    Get compiled classification

TRN_GTNV( LOCTR, NVIN, NVOUT, STATUS )
    Get numbers of variables

TRN_GTNVC( ID, NVIN, NVOUT, STATUS )
    Get numbers of compiled variables

TRN_INV( LOCTR, STATUS )
    Invert transformation

TRN_JOIN( LOCTR1, LOCTR2, ELOC, NAME, LOCTR, STATUS )
    Concatenate transformations

TRN_NEW( NVIN, NVOUT, FOR, INV, PREC, COMM, ELOC, NAME, LOCTR, STATUS )
    Create new transformation

TRN_PRFX( LOCTR1, LOCTR2, STATUS )
    Prefix transformation

TRN_PTCL( CLASS, LOCTR, STATUS )
    Put classification

??TRN_STOK[x]( TOKEN, VALUE, TEXT, NSUBS, STATUS )
    Substitute token

TRN_TR1x( BAD, NX, XIN, ID, XOUT, STATUS )
    Transform 1-dimensional data

TRN_TR2x( BAD, NXY, XIN, YIN, ID, XOUT, YOUT, STATUS )
    Transform 2-dimensional data

TRN_TRNx( BAD, ND1, NCIN, NDAT, DATA, ID, NR1, NCOUT, RESULT, STATUS )
    Transform general data

D.2 Full Routine Specifications

This Section gives full specifications for the user-level TRANSFORM routines. The following notation is used to specify the types of routine arguments:

Notation :

Fortran type




L :

LOGICAL

I :

INTEGER

R :

REAL

C :

CHARACTER()

? :

Unspecified, dependent on the data type being processed.

() :

A 1-dimensional array of one of the above types.

(,) :

A 2-dimensional array of one of the above types.

LCLS :

A 1-dimensional LOGICAL array, with TRN__MXCLS9 elements, to contain classification information.

CPRC :

A CHARACTER argument to contain a precision specification of maximum length TRN__SZPRC.9

CLOC :

A CHARACTER(DAT__SZLOC)10 argument containing an HDS locator. In some routines where this is an input argument, a blank string (of any length) may be substituted to specify different routine behaviour; the individual routine descriptions give details.

CNAM :

A CHARACTER argument specifying an HDS name string of maximum length DAT__SZNAM.10




9The symbolic constants TRN__MXCLS and TRN__SZPRC are defined in the include file TRN_PAR.

10The symbolic constants DAT__SZLOC and DAT__SZNAM are defined by HDS.