VEQUATE procedure

Equates across numerical structures (P.W. Goedhart).

No options

Parameters

OLDSTRUCTURES = pointers

Structures whose values are to be transferred; pointers should point to structures of the same type (scalar, variate, matrix or table) and length

NEWSTRUCTURES = pointers

Pointer to variates to take each set of transferred values; if necessary structures are redefined to be variates of correct length

Description

This procedure allows the values in a set of structures to be copied into a set of variates, one for each element of the original structures. The original structures are input in a pointer, using the OLDSTRUCTURES parameter. The variates to take the values are returned in a pointer whose identifier is specified by the NEWSTRUCTURES parameter. If this is already declared, it should be to a pointer of the correct length; if necessary, the structures to which it points will be redefined to be variates of correct length.

The procedure copies the values in the first element of each of the original structures into the first variate in the NEWSTRUCTURES pointer, then those in the second element to the second variate, and so on. The structures in the OLDSTRUCTURES pointer should be of the same type (scalar, variate, matrix, diagonal matrix, symmetric matrix or table) and length.

Options: none. Parameters: OLDSTRUCTURES, NEWSTRUCTURES.

Method

EQUATE is used to transfer values. If OLDSTRUCTURES points to restricted variates, the values included in the subset are first copied to dummy structures.

Action with RESTRICT

If the OLDSTRUCTURES pointer consists of variates, any restrictions will be taken into account and, if the NEWSTRUCTURES pointer is not declared in advance, its suffixes will be set to the units in the restricted set.