DUMP directive

Prints information about data structures, and internal system information.

Options

PRINT = string tokens What information to print about structures (attributes, values, identifiers, space); default attr
CHANNEL = identifier Channel number of file, or identifier of a text to store output; default current output file
INFORMATION = string tokens What information to print for each structure (brief, full, extended); default brie
TYPE = string tokens Which types of structure to include in addition to those in the parameter list (all, ASAVE, diagonalmatrix, dummy, expression, factor, formula, LRV, matrix, pointer, RSAVE, scalar, SSPM, symmetricmatrix, table, text, tree, TSAVE, TSM, variate, VSAVE); default * i.e. none
SYSTEM = string token Whether to display Genstat system structures (yes, no); default no
UNNAMED = string token Whether to display unnamed structures (yes, no); default no

Parameter

    identifiers or numbers Identifier or reference number of a structure whose information is to be printed

Description

The structures for which the information is to be displayed are specified by the parameter of DUMP. The PRINT option indicates what is to be presented: you can ask for just the identifiers, or values and identifiers, or attributes (the identifier is itself an attribute), or for all three. For example, to get all three for the structures A and B you would put:

DUMP [PRINT=attributes,values] A,B

There is also a setting, space, which provides information about the current use of workspace within Genstat.

If the CHANNEL option is set to a scalar, this specifies the output channel to which the information is sent. Alternatively, if you specify the identifier of a text structure, the lines of information will be stored in the text instead of being printed; likewise if you specify the identifier of a structure that has not yet been declared, it will be defined automatically as a text to store the information. If CHANNEL is not specified, the information is displayed on the current output channel.

The INFORMATION option selects which attributes are presented. The default setting brief selects only the most important ones. The setting full causes all the attributes to be presented, and the setting extended also gives details of the structures associated with listed structures.

Some of the attributes may be set to unnamed structures. You can obtain further information about these by setting option UNNAMED=yes. Alternatively, you can dump a specific unnamed structure by giving its (negative) reference number (as displayed by DUMP when indicating its association with another structure) in the parameter list. This is likely to be useful mainly to advanced users.

The TYPE option lets you display, in addition, lists of all structures of a particular type, or of several types. For example, if you had forgotten the identifier of a factor, you could give the statement

DUMP [TYPE=factor; PRINT=identifiers]

This lists all the current factors. When PRINT=attributes or values (or both), the setting TYPE=all provides a list of all named and unnamed structures, except system structures. Setting PRINT=identifiers with TYPE=all lists only named structures.

The SYSTEM option allows all the system structures to be dumped: there are many of these, so it is not a good idea to set this option frivolously.

Options: PRINT, CHANNEL, INFORMATION, TYPE, SYSTEM, UNNAMED.

Parameter: unnamed.

See also

Directives: GETATTRIBUTE, LIST.

Commands for: Data structures.

Example

" Examples 1:2.11.2a-c "
VARIATE [VALUES=1...8,*] A
FACTOR [NVALUES=9; LEVELS=!(0,1.2,2.4)] B
DUMP [PRINT=attributes,values] A,B
DUMP [INFORMATION=extended; PRINT=attributes,values] B
FACTOR [NVALUES=9; LEVELS=3; VALUES=3(1...3)] F1
& [LEVELS=2; VALUES=(1,2)4,1] F2
DUMP [TYPE=factor; PRINT=identifiers]
Updated on March 8, 2019

Was this article helpful?