dataset_is_cross_section()

#define dataset_is_cross_section(p) (p != NULL && p->structure == CROSS_SECTION)

Attempt to determine whether a dataset contains cross-sectional data (1) or not (0).

dataset_is_time_series()

#define             dataset_is_time_series(p)

Attempt to determine whether a dataset contains time series data (1) or not (0).

dataset_is_seasonal()

#define             dataset_is_seasonal(p)

Attempt to determine whether a dataset contains seasonal time series data (1) or not (0).

custom_time_series()

#define custom_time_series(p) (p != NULL && p->structure == SPECIAL_TIME_SERIES)

Attempt to determine whether a dataset contains time series data with custom (non-standard) frequency (1) or not (0).

dataset_is_daily()

#define             dataset_is_daily(p)

Attempt to determine whether a dataset contains daily time series data (1) or not (0).

dataset_is_incomplete_daily()

#define             dataset_is_incomplete_daily(p)

Attempt to determine whether a dataset contains daily on an incomplete calendar (1) or not (0).

dataset_is_weekly()

#define             dataset_is_weekly(p)

Attempt to determine whether a dataset contains weekly time series data (1) or not (0).

dataset_is_hourly()

#define             dataset_is_hourly(p)

Attempt to determine whether a dataset contains hourly time series data (1) or not (0).

dataset_is_decennial()

#define             dataset_is_decennial(p)

Attempt to determine whether a dataset contains decennial time series data (1) or not (0).

dated_daily_data()

#define             dated_daily_data(p)

Attempt to determine whether a dataset contains dated daily time series data (1) or not (0).

dated_seven_day_data()

#define             dated_seven_day_data(p)

Attempt to determine whether a dataset contains dated daily (seven-day) time series data (1) or not (0).

dated_weekly_data()

#define             dated_weekly_data(p)

Attempt to determine whether a dataset contains dated weekly time series data (1) or not (0).

calendar_data()

#define             calendar_data(p)

Attempt to determine whether a dataset uses calendar dates for observation strings (1) or not (0).

quarterly_or_monthly()

#define             quarterly_or_monthly(p)

Attempt to determine whether a dataset is a quarterly or monthly time series (1), or something else (0).

annual_data()

#define             annual_data(p)

Attempt to determine whether a dataset is an annual time series (1), or something else (0).

decennial_data()

#define             decennial_data(p)

Attempt to determine whether a dataset is a decemmial time series (1), or something else (0).

dataset_is_panel()

#define dataset_is_panel(p) (p != NULL && p->structure == STACKED_TIME_SERIES)

Attempt to determine whether a dataset contains panel data (1) or not (0).

dataset_is_seasonal_panel()

#define             dataset_is_seasonal_panel(p)

Attempt to determine whether a dataset contains panel data with a seasonal time-series dimension (1) or not (0).

dataset_has_markers()

#define dataset_has_markers(p) (p != NULL && p->markers && p->S != NULL)

Determine whether a dataset has observation marker strings (1) or not (0).

dataset_has_panel_time()

#define             dataset_has_panel_time(p)

Determine whether a panel dataset has information on its time dimension recorded (1) or not (0).

sample_size()

#define sample_size(p) ((p == NULL)? 0 : (p->t2 - p->t1 + 1))

Retrieves the length of the current sample range.

dset_get_data()

#define dset_get_data(d,i,t) (d->Z[i][t])

Gets the value of series i at observation t .

dset_set_data()

#define dset_set_data(d,i,t,x) (d->Z[i][t]=x)

Sets the value of series i at observation t .

free_Z ()

void
free_Z (DATASET *dset);

Does a deep free on the data matrix.

datainfo_new ()

DATASET *
datainfo_new (void);

Creates a new data information struct pointer from scratch, properly initialized as empty (no variables, no observations).

datainfo_init ()

void
datainfo_init (DATASET *dset);

Zeros all members of dset and sets it as a plain cross-section. Designed for use with a DATASET structure that has not been obtained via datainfo_new().

create_new_dataset ()

DATASET *
create_new_dataset (int nvar,
                    int nobs,
                    int markers);

Allocates space in the dataset to hold the specified number of variables and observations.

create_auxiliary_dataset ()

DATASET *
create_auxiliary_dataset (int nvar,
                          int nobs,
                          gretlopt opt);

destroy_dataset ()

void
destroy_dataset (DATASET *dset);

Frees all resources associated with dset .

clear_datainfo ()

void
clear_datainfo (DATASET *dset,
                int code);

Frees the allocated content of a data information struct; note that dset itself is not freed.

allocate_Z ()

int
allocate_Z (DATASET *dset,
            gretlopt opt);

Allocates the two-dimensional data array Z, based on the v (number of variables) and n (number of observations) members of dset . The variable at position 0 is initialized to all 1s; other variables are initialized to NADBL (unless OPT_B is given).

dataset_allocate_varnames ()

int
dataset_allocate_varnames (DATASET *dset);

Given a blank dset , which should have been obtained using datainfo_new(), allocate space for the names of variables. The v member of dset (representing the number of variables, including the automatically added constant at position 0) must be set before calling this function.

dataset_allocate_obs_markers ()

int
dataset_allocate_obs_markers (DATASET *dset);

Allocates space in dset for strings indentifying the observations and initializes all of the markers to empty strings. Note that These strings have a fixed maximum length of OBSLEN - 1.

dataset_destroy_obs_markers ()

void
dataset_destroy_obs_markers (DATASET *dset);

Frees any allocated observation markers for dset .

dataset_obs_info_default ()

void
dataset_obs_info_default (DATASET *dset);

Sets the "date" or observations information in dset to a simple default of cross-sectional data, observations 1 to n, where n is the n element (number of observations) in dset .

copy_dataset_obs_info ()

void
copy_dataset_obs_info (DATASET *targ,
                       const DATASET *src);

Sets the "date" or observations information in targ to that found in src .

copy_varinfo ()

void
copy_varinfo (VARINFO *targ,
              const VARINFO *src);

Copies relevant information from src to targ .

shrink_varinfo ()

int
shrink_varinfo (DATASET *dset,
                int nv);

set_sorted_markers ()

void
set_sorted_markers (DATASET *dset,
                    int v,
                    char **S);

dataset_set_regular_markers ()

void
dataset_set_regular_markers (DATASET *dset);

start_new_Z ()

int
start_new_Z (DATASET *dset,
             gretlopt opt);

Initializes the data array within dset (adding the constant in position 0).

is_trend_variable ()

int
is_trend_variable (const double *x,
                   int n);

is_periodic_dummy ()

int
is_periodic_dummy (const double *x,
                   const DATASET *dset);

dataset_add_observations ()

int
dataset_add_observations (DATASET *dset,
                          int n,
                          gretlopt opt);

Extends all series in the dataset by the specified number of extra observations. The added values are initialized to the missing value code, NADBL, with the exception of simple deterministic variables when OPT_A is given.

dataset_drop_observations ()

int
dataset_drop_observations (DATASET *dset,
                           int n);

Deletes n observations from the end of each series in the dataset.

dataset_shrink_obs_range ()

int
dataset_shrink_obs_range (DATASET *dset);

Truncates the range of observations in the dataset, based on the current values of the t1 and t2 members of dset .

dataset_add_series ()

int
dataset_add_series (DATASET *dset,
                    int newvars);

Adds space for the specified number of additional series in the dataset. Values are initialized to zero.

dataset_add_NA_series ()

int
dataset_add_NA_series (DATASET *dset,
                       int newvars);

Adds space for the specified number of additional series in the dataset. Values are initialized to NA.

dataset_add_allocated_series ()

int
dataset_add_allocated_series (DATASET *dset,
                              double *x);

Adds x as an additional series in the dataset. The array x is not copied; it should be treated as belonging to dset after this operation.

dataset_add_series_as ()

int
dataset_add_series_as (DATASET *dset,
                       double *x,
                       const char *name);

Adds to the dataset a new series with name name and values given by x . The new variable is added at one level "deeper" (in terms of function execution) than the current level. This is for use with user-defined functions.

dataset_copy_series_as ()

int
dataset_copy_series_as (DATASET *dset,
                        int v,
                        const char *name);

Makes a copy of series v under the name name . The copy exists in a variable namespace one level "deeper" (in terms of function execution) than the variable being copied. This is for use with user-defined functions: a variable supplied to a function as an argument is copied into the function's namespace under the name it was given as a parameter.

overwrite_err ()

int
overwrite_err (const char *name);

series_is_parent ()

int
series_is_parent (const DATASET *dset,
                  int v);

dataset_replace_series ()

int
dataset_replace_series (DATASET *dset,
                        int v,
                        double *x,
                        const char *descrip,
                        DataCopyFlag flag);

Replaces the description and numerical content of series v with the information provided.

dataset_replace_series_data ()

int
dataset_replace_series_data (DATASET *dset,
                             int v,
                             const double *x,
                             int t1,
                             int t2,
                             const char *descrip);

Replaces the description and numerical content of series v over the given sample range, with the information provided.

dataset_rename_series ()

int
dataset_rename_series (DATASET *dset,
                       int v,
                       const char *name);

dataset_drop_listed_variables ()

int
dataset_drop_listed_variables (int *list,
                               DATASET *dset,
                               int *renumber,
                               PRN *prn);

Deletes the series given in list from the dataset. Remaining series may have their ID numbers changed as a consequence. If renumber is not NULL, this location receives 1 in case series have been renumbered, 0 otherwise.

dataset_drop_variable ()

int
dataset_drop_variable (int v,
                       DATASET *dset);

Deletes variable v from the dataset.

dataset_destroy_hidden_variables ()

int
dataset_destroy_hidden_variables (DATASET *dset,
                                  int vmin);

Deletes from the dataset any "hidden" variables that have been added automatically (for example, auto-generated variables used for the x-axis in graph plotting), and that have ID numbers greater than or equal to vmin . Never deletes the automatically generated constant (ID number 0).

dataset_drop_last_variables ()

int
dataset_drop_last_variables (DATASET *dset,
                             int delvars);

Deletes from the dataset the number delvars of variables that were added most recently (that have the highest ID numbers).

dataset_renumber_variable ()

int
dataset_renumber_variable (int v_old,
                           int v_new,
                           DATASET *dset);

Moves the variable that was originally at position v_old in the datset to position v_new , renumbering other variables as required.

renumber_series_with_checks ()

int
renumber_series_with_checks (const int *list,
                             const char *param,
                             int fixmax,
                             DATASET *dset,
                             PRN *prn);

maybe_prune_dataset ()

int
maybe_prune_dataset (DATASET **pdset,
                     gretl_string_table *st);

build_stacked_series ()

int
build_stacked_series (double **pstack,
                      int *list,
                      int length,
                      int offset,
                      DATASET *dset);

Really for internal use. Don't worry about it.

dataset_sort_by ()

int
dataset_sort_by (DATASET *dset,
                 const int *list,
                 gretlopt opt);

dataset_set_matrix_name ()

int
dataset_set_matrix_name (DATASET *dset,
                         const char *name);

dataset_get_matrix_name ()

const char *
dataset_get_matrix_name (const DATASET *dset);

dataset_period_label ()

const char *
dataset_period_label (const DATASET *dset);

dataset_get_mapfile ()

const char *
dataset_get_mapfile (const DATASET *dset);

dataset_set_mapfile ()

void
dataset_set_mapfile (DATASET *dset,
                     const char *fname);

series_is_log ()

int
series_is_log (const DATASET *dset,
               int i,
               char *parent);

Tries to determine if the variable with ID number i is the logarithm of some other variable.

series_set_discrete ()

void
series_set_discrete (DATASET *dset,
                     int i,
                     int s);

Mark a variable as being discrete or not.

series_record_display_name ()

int
series_record_display_name (DATASET *dset,
                            int i,
                            const char *s);

series_record_label ()

int
series_record_label (DATASET *dset,
                     int i,
                     const char *s);

series_get_graph_name ()

const char *
series_get_graph_name (const DATASET *dset,
                       int i);

get_resampling_seed ()

unsigned int
get_resampling_seed (void);

dataset_resample ()

int
dataset_resample (DATASET *dset,
                  int n,
                  unsigned int seed);

dataset_op_from_string ()

int
dataset_op_from_string (const char *s);

modify_dataset ()

int
modify_dataset (DATASET *dset,
                int op,
                const int *list,
                const char *s,
                gretlopt opt,
                PRN *prn);

dataset_get_structure ()

int
dataset_get_structure (const DATASET *dset);

panel_sample_size ()

int
panel_sample_size (const DATASET *dset);

multi_unit_panel_sample ()

int
multi_unit_panel_sample (const DATASET *dset);

dataset_purge_missing_rows ()

int
dataset_purge_missing_rows (DATASET *dset);

Removes empty rows from the dataset -- that is, observations at which there are no non-missing values. This is intended for dated daily data only.

check_dataset_is_changed ()

int
check_dataset_is_changed (DATASET *dset);

set_dataset_is_changed ()

void
set_dataset_is_changed (DATASET *dset,
                        int s);

Sets the internal boolean "changed" flag to s .

dataset_clear_sample_record ()

void
dataset_clear_sample_record (DATASET *dset);

dataset_set_time_series ()

int
dataset_set_time_series (DATASET *dset,
                         int pd,
                         int yr0,
                         int minor0);

Sets time-series properties on dset : frequency pd with starting observation yr0 , minor0 . If the data are annual (pd = 1) then minor0 is ignored.

series_is_discrete ()

int
series_is_discrete (const DATASET *dset,
                    int i);

series_is_hidden ()

int
series_is_hidden (const DATASET *dset,
                  int i);

series_is_generated ()

int
series_is_generated (const DATASET *dset,
                     int i);

series_is_listarg ()

int
series_is_listarg (const DATASET *dset,
                   int i,
                   const char **lname);

series_is_coded ()

int
series_is_coded (const DATASET *dset,
                 int i);

series_is_integer_valued ()

int
series_is_integer_valued (const DATASET *dset,
                          int i);

series_get_flags ()

VarFlags
series_get_flags (const DATASET *dset,
                  int i);

series_set_flag ()

void
series_set_flag (DATASET *dset,
                 int i,
                 VarFlags flag);

Sets the given flag on series i .

series_unset_flag ()

void
series_unset_flag (DATASET *dset,
                   int i,
                   VarFlags flag);

Unsets the given flag on series i .

series_zero_flags ()

void
series_zero_flags (DATASET *dset,
                   int i);

Sets flags on series i to zero.

series_get_label ()

const char *
series_get_label (const DATASET *dset,
                  int i);

series_get_display_name ()

const char *
series_get_display_name (const DATASET *dset,
                         int i);

series_get_parent_name ()

const char *
series_get_parent_name (const DATASET *dset,
                        int i);

series_get_parent_id ()

int
series_get_parent_id (const DATASET *dset,
                      int i);

series_get_compact_method ()

int
series_get_compact_method (const DATASET *dset,
                           int i);

series_get_stack_level ()

int
series_get_stack_level (const DATASET *dset,
                        int i);

series_get_transform ()

int
series_get_transform (const DATASET *dset,
                      int i);

series_get_lag ()

int
series_get_lag (const DATASET *dset,
                int i);

series_get_string_width ()

int
series_get_string_width (const DATASET *dset,
                         int i);

series_set_mtime ()

void
series_set_mtime (DATASET *dset,
                  int i);

series_get_mtime ()

gint64
series_get_mtime (const DATASET *dset,
                  int i);

series_set_label ()

void
series_set_label (DATASET *dset,
                  int i,
                  const char *s);

series_set_display_name ()

void
series_set_display_name (DATASET *dset,
                         int i,
                         const char *s);

series_set_compact_method ()

void
series_set_compact_method (DATASET *dset,
                           int i,
                           int method);

series_set_parent ()

void
series_set_parent (DATASET *dset,
                   int i,
                   const char *parent);

series_set_transform ()

void
series_set_transform (DATASET *dset,
                      int i,
                      int transform);

series_delete_metadata ()

void
series_delete_metadata (DATASET *dset,
                        int i);

series_set_lag ()

void
series_set_lag (DATASET *dset,
                int i,
                int lag);

series_set_stack_level ()

void
series_set_stack_level (DATASET *dset,
                        int i,
                        int level);

series_increment_stack_level ()

void
series_increment_stack_level (DATASET *dset,
                              int i);

series_decrement_stack_level ()

void
series_decrement_stack_level (DATASET *dset,
                              int i);

series_ensure_level_zero ()

void
series_ensure_level_zero (DATASET *dset);

series_attach_string_table ()

void
series_attach_string_table (DATASET *dset,
                            int i,
                            series_table *st);

series_destroy_string_table ()

void
series_destroy_string_table (DATASET *dset,
                             int i);

is_string_valued ()

int
is_string_valued (const DATASET *dset,
                  int i);

series_get_string_table ()

series_table *
series_get_string_table (const DATASET *dset,
                         int i);

series_get_string_for_obs ()

const char *
series_get_string_for_obs (const DATASET *dset,
                           int i,
                           int t);

series_get_string_for_value ()

const char *
series_get_string_for_value (const DATASET *dset,
                             int i,
                             double val);

series_set_string_val ()

int
series_set_string_val (DATASET *dset,
                       int i,
                       int t,
                       const char *s);

Attempts to set the string value for observation t of series i to s . This will fail if the series in question does not have an associated table of string values.

string_series_assign_value ()

int
string_series_assign_value (DATASET *dset,
                            int i,
                            int t,
                            double x);

Attempts to set the value for observation t of series i to x . This will fail if the x falls outside of the range of values supported by the string table for the series.

series_set_string_vals ()

int
series_set_string_vals (DATASET *dset,
                        int i,
                        gretl_array *a);

series_set_string_vals_direct ()

int
series_set_string_vals_direct (DATASET *dset,
                               int i,
                               char **S,
                               int ns);

series_recode_strings ()

int
series_recode_strings (DATASET *dset,
                       int v,
                       gretlopt opt,
                       int *changed);

This function "trims" the array of string values associated with series v so that it contains no redundant elements -- that is, values of which there is no instance in the current sample -- and resets the numeric codes for the strings if necessary.

By default the original "series_table" attached to series v is destroyed, but if opt contains OPT_P it is replaced but not freed; this make sense only if another pointer to the original table exists.

If it happens that the current sample contains instances of all the strings in the full dataset, this function will not actually make any changes to dset . The changed argument provides a means of determining whether any change has been made.

series_decode_string ()

double
series_decode_string (const DATASET *dset,
                      int i,
                      const char *s);

series_get_string_vals ()

char **
series_get_string_vals (const DATASET *dset,
                        int i,
                        int *n_strs,
                        int subsample);

steal_string_table ()

int
steal_string_table (DATASET *l_dset,
                    int lvar,
                    DATASET *r_dset,
                    int rvar);

Detaches the string table from rvar in r_dset and attaches it to lvar in l_dset ,

merge_string_tables ()

int
merge_string_tables (DATASET *l_dset,
                     int lvar,
                     DATASET *r_dset,
                     int rvar);

Translates the encoding of the string-values of series rvar in r_dset to that of series lvar in l_dset , adding extra strings as needed.

set_panel_groups_name ()

int
set_panel_groups_name (DATASET *dset,
                       const char *vname);

get_panel_group_name ()

const char *
get_panel_group_name (const DATASET *dset,
                      int obs);

panel_group_names_ok ()

int
panel_group_names_ok (const DATASET *dset);

panel_group_names_varname ()

const char *
panel_group_names_varname (const DATASET *dset);

is_panel_group_names_series ()

int
is_panel_group_names_series (const DATASET *dset,
                             int v);

get_panel_group_table ()

series_table *
get_panel_group_table (const DATASET *dset,
                       int maxlen,
                       int *pv);

is_dataset_series ()

int
is_dataset_series (const DATASET *dset,
                   const double *x);

postprocess_daily_data ()

int
postprocess_daily_data (DATASET *dset,
                        const int *list);

series_get_midas_period ()

int
series_get_midas_period (const DATASET *dset,
                         int i);

series_set_midas_period ()

void
series_set_midas_period (const DATASET *dset,
                         int i,
                         int period);

series_get_midas_freq ()

int
series_get_midas_freq (const DATASET *dset,
                       int i);

series_set_midas_freq ()

int
series_set_midas_freq (const DATASET *dset,
                       int i,
                       int freq);

series_is_midas_anchor ()

int
series_is_midas_anchor (const DATASET *dset,
                        int i);

series_set_midas_anchor ()

void
series_set_midas_anchor (const DATASET *dset,
                         int i);

series_get_orig_pd ()

int
series_get_orig_pd (const DATASET *dset,
                    int i);

series_set_orig_pd ()

void
series_set_orig_pd (const DATASET *dset,
                    int i,
                    int pd);

series_unset_orig_pd ()

void
series_unset_orig_pd (const DATASET *dset,
                      int i);

series_info_bundle ()

gretl_bundle *
series_info_bundle (const DATASET *dset,
                    int i,
                    int *err);

list_info_matrix ()

gretl_matrix *
list_info_matrix (const int *list,
                  const DATASET *dset,
                  gretlopt opt,
                  int *err);

get_current_map ()

gretl_bundle *
get_current_map (const DATASET *dset,
                 const int *list,
                 int *err);

enum DatasetMarkerType

enum VarFlags

enum DatasetOp

enum DataCopyFlag

enum CompactMethod

Symbolic codes for various methods of compacting data series (i.e. converting from a higher to a lower frequency). COMPACT_WDAY is applicable only when converting from daily to weekly frequency.

series_table

typedef struct series_table_ series_table;