datacreatecomplex

Purpose

Creates a complex dataset.

Format

fh = datacreatecomplex(filename, vnames, col, dtyp, vtyp)
Parameters:
  • filename (string) – name of data file.
  • vnames (string or Nx1 string array) – names of variables.
  • col (scalar) – number of variables.
  • dtyp (scalar) –

    data precision, one of the following:

    2 2-byte, signed integer.
    4 4-byte, single precision.
    8 8-byte, double precision.
  • vtyp (scalar or Nx1 vector) –

    types of variables, may contain one or both of the following:

    0 character variable.
    1 numeric variable.
Returns:

fh (scalar) – file handle.

Examples

// Name variables
string vnames = { "random1", "random2" };

/*
** Create file handle
** with vnames and 2 variables
** containing double precision
** numeric data.
*/
fh = datacreatecomplex("myfilecplx.dat", vnames, 2, 8, 1);

// Generate random complex data
x = complex(rndn(1000, 2), rndn(1000, 2));

// Write file using file handle
r = writer(fh, x);
ret = close(fh);

This example creates a complex double precision data file called myfilecplx.dat, which is placed in the current directory. The file contains 2 columns with 1000 observations (rows), and the columns are given the names random1 and random2.

Remarks

The file handle returned by datacreatecomplex() is a scalar containing a positive integer value that uniquely identifies each file. This value is assigned by GAUSS when the create, datacreate(), datacreatecomplex(), open or dataopen() commands are executed. The file handle is used to reference the file in the commands readr() and writer(). If datacreatecomplex() fails, it returns a -1.

Complex data is stored a row at a time, with the real and imaginary halves interleaved, element by element. For columns containing character data, the imaginary parts are zeroed out.

If filename does not include a path, then the file is placed in the current directory. The file is given a .dat extension if no extension is specified.

If col is set to 0, then the number of columns in the dataset is controlled by the contents of vnames. If col is positive, then the file will contain col columns.

If vnames contains col elements, then each column is given the name contained in the corresponding row of vnames. If col is positive and vnames is a string, then the columns are given the names vnames1, vnames2, ..., vnamesN (or vnames01, vnames02, ..., vnamesN), where \(N = col\). The numbers appended to vnames are padded on the left with zeros to the same length as \(N\).

The dtyp argument allows you to specify the precision to use when storing your data. Keep in mind the following range restrictions when selecting a value for dtyp:

Data Type Digits Range
integer 5 \(-32768 \lt X \lt 32767\)
single 6-7 \(8.43\times10^{-37} \lt|X| \leq 3.37 \times 10^{+38}\)
double 15-16 \(4.19\times10^{-307} \lt |X| \lt 1.67\times10^{+308}\)

Source

datafile.src

See also

Functions datacreate(), create, dataopen(), writer()