gretl_bundle_new ()

gretl_bundle *
gretl_bundle_new (void);

gretl_is_bundle ()

int
gretl_is_bundle (const char *name);

type_can_be_bundled ()

int
type_can_be_bundled (GretlType type);

get_bundle_by_name ()

gretl_bundle *
get_bundle_by_name (const char *name);

gretl_bundle_get_content ()

void *
gretl_bundle_get_content (gretl_bundle *bundle);

gretl_bundle_get_data ()

void *
gretl_bundle_get_data (gretl_bundle *bundle,
                       const char *key,
                       GretlType *type,
                       int *size,
                       int *err);

gretl_bundle_steal_data ()

void *
gretl_bundle_steal_data (gretl_bundle *bundle,
                         const char *key,
                         GretlType *type,
                         int *size,
                         int *err);

Works like gretl_bundle_get_data() except that the data pointer in question is removed from bundle before it is returned to the caller; so in effect the caller assumes ownership of the item.

gretl_bundle_get_private_data ()

void *
gretl_bundle_get_private_data (gretl_bundle *bundle);

gretl_bundle_get_member_type ()

GretlType
gretl_bundle_get_member_type (gretl_bundle *bundle,
                              const char *key,
                              int *err);

gretl_bundle_has_key ()

int
gretl_bundle_has_key (gretl_bundle *bundle,
                      const char *key);

gretl_bundle_get_matrix ()

gretl_matrix *
gretl_bundle_get_matrix (gretl_bundle *bundle,
                         const char *key,
                         int *err);

gretl_bundle_get_series ()

double *
gretl_bundle_get_series (gretl_bundle *bundle,
                         const char *key,
                         int *n,
                         int *err);

gretl_bundle_get_list ()

int *
gretl_bundle_get_list (gretl_bundle *bundle,
                       const char *key,
                       int *err);

gretl_bundle_get_scalar ()

double
gretl_bundle_get_scalar (gretl_bundle *bundle,
                         const char *key,
                         int *err);

gretl_bundle_get_int ()

int
gretl_bundle_get_int (gretl_bundle *bundle,
                      const char *key,
                      int *err);

gretl_bundle_get_string ()

const char *
gretl_bundle_get_string (gretl_bundle *bundle,
                         const char *key,
                         int *err);

gretl_bundle_get_array ()

void *
gretl_bundle_get_array (gretl_bundle *bundle,
                        const char *key,
                        int *err);

gretl_bundle_get_note ()

const char *
gretl_bundle_get_note (gretl_bundle *bundle,
                       const char *key);

gretl_bundle_get_creator ()

const char *
gretl_bundle_get_creator (gretl_bundle *bundle);

bundled_item_get_data ()

void *
bundled_item_get_data (bundled_item *item,
                       GretlType *type,
                       int *size);

bundled_item_get_note ()

const char *
bundled_item_get_note (bundled_item *item);

gretl_bundle_donate_data ()

int
gretl_bundle_donate_data (gretl_bundle *bundle,
                          const char *key,
                          void *ptr,
                          GretlType type,
                          int size);

Sets the data type and pointer to be associated with key in the bundle given by name . If key is already present in the bundle's hash table the original value is replaced and destroyed. The value of ptr is transcribed into the bundle, which therefore "takes ownership" of the data; compare gretl_bundle_set_data().

gretl_bundle_set_data ()

int
gretl_bundle_set_data (gretl_bundle *bundle,
                       const char *key,
                       void *ptr,
                       GretlType type,
                       int size);

Sets the data type and pointer to be associated with key in the bundle given by name . If key is already present in the bundle's hash table the original value is replaced and destroyed. The content of ptr is copied into the bundle; compare gretl_bundle_donate_data().

gretl_bundle_set_string ()

int
gretl_bundle_set_string (gretl_bundle *bundle,
                         const char *key,
                         const char *str);

Sets str as a member of bundle under the name key . If key is already present in the bundle the original value is replaced and destroyed.

gretl_bundle_set_scalar ()

int
gretl_bundle_set_scalar (gretl_bundle *bundle,
                         const char *key,
                         double val);

Sets val as a member of bundle under the name key . If key is already present in the bundle the original value is replaced and destroyed.

gretl_bundle_set_int ()

int
gretl_bundle_set_int (gretl_bundle *bundle,
                      const char *key,
                      int val);

Sets val as a member of bundle under the name key . If key is already present in the bundle the original value is replaced and destroyed.

gretl_bundle_set_series ()

int
gretl_bundle_set_series (gretl_bundle *bundle,
                         const char *key,
                         const double *x,
                         int n);

Sets x as a member of bundle under the name key . If key is already present in the bundle the original value is replaced and destroyed.

gretl_bundle_set_list ()

int
gretl_bundle_set_list (gretl_bundle *bundle,
                       const char *key,
                       const int *list);

Sets list as a member of bundle under the name key . If key is already present in the bundle the original value is replaced and destroyed.

gretl_bundle_set_matrix ()

int
gretl_bundle_set_matrix (gretl_bundle *bundle,
                         const char *key,
                         const gretl_matrix *m);

Sets m as a member of bundle under the name key . If key is already present in the bundle the original value is replaced and destroyed.

gretl_bundle_set_note ()

int
gretl_bundle_set_note (gretl_bundle *bundle,
                       const char *key,
                       const char *note);

Adds a descriptive note to the item under key in bundle . If a note is already present it is replaced by the new one.

gretl_bundle_delete_data ()

int
gretl_bundle_delete_data (gretl_bundle *bundle,
                          const char *key);

Deletes the data item under key from bundle , if such an item is present.

gretl_bundle_add_or_replace ()

int
gretl_bundle_add_or_replace (gretl_bundle *bundle,
                             const char *name);

gretl_bundle_copy_as ()

int
gretl_bundle_copy_as (const char *name,
                      const char *copyname);

Look for a saved bundle specified by name , and if found, make a full copy and save it under copyname . This is called from geneval.c on completion of assignment to a bundle named copyname , where the returned value on the right-hand side is a pre-existing saved bundle.

gretl_bundle_copy ()

gretl_bundle *
gretl_bundle_copy (const gretl_bundle *bundle,
                   int *err);

gretl_bundle_set_creator ()

int
gretl_bundle_set_creator (gretl_bundle *b,
                          const char *name);

Sets the "creator" attribute of bundle . This is called automatically when a bundle is returned to top-level userspace by a packaged function.

gretl_bundle_print ()

int
gretl_bundle_print (gretl_bundle *bundle,
                    PRN *prn);

Prints to prn a list of the keys defined in bundle , along with descriptive notes, if any.

gretl_bundle_is_stacked ()

int
gretl_bundle_is_stacked (gretl_bundle *b);

gretl_bundle_get_n_keys ()

int
gretl_bundle_get_n_keys (gretl_bundle *b);

gretl_bundle_get_n_members ()

int
gretl_bundle_get_n_members (gretl_bundle *b);

gretl_bundle_has_content ()

int
gretl_bundle_has_content (gretl_bundle *b);

gretl_bundle_pull_from_stack ()

gretl_bundle *
gretl_bundle_pull_from_stack (const char *name,
                              int *err);

gretl_bundle_union ()

gretl_bundle *
gretl_bundle_union (const gretl_bundle *bundle1,
                    const gretl_bundle *bundle2,
                    int *err);

gretl_bundle_destroy ()

void
gretl_bundle_destroy (gretl_bundle *bundle);

Frees all contents of bundle as well as the pointer itself.

gretl_bundle_void_content ()

void
gretl_bundle_void_content (gretl_bundle *bundle);

Frees all contents of bundle .

gretl_bundle_serialize ()

void
gretl_bundle_serialize (gretl_bundle *b,
                        const char *name,
                        FILE *fp);

gretl_bundle_deserialize ()

gretl_bundle *
gretl_bundle_deserialize (void *p1,
                          void *p2,
                          int *err);

gretl_bundle_write_to_file ()

int
gretl_bundle_write_to_file (gretl_bundle *b,
                            const char *fname,
                            int to_dotdir);

gretl_bundle_write_to_buffer ()

char *
gretl_bundle_write_to_buffer (gretl_bundle *b,
                              int *bytes,
                              int *err);

gretl_bundle_read_from_file ()

gretl_bundle *
gretl_bundle_read_from_file (const char *fname,
                             int from_dotdir,
                             int *err);

gretl_bundle_read_from_buffer ()

gretl_bundle *
gretl_bundle_read_from_buffer (const char *buf,
                               int len,
                               int *err);

get_sysinfo_bundle ()

gretl_bundle *
get_sysinfo_bundle (int *err);

sysinfo_bundle_get_data ()

void *
sysinfo_bundle_get_data (const char *key,
                         GretlType *type,
                         int *err);

bundle_from_model ()

gretl_bundle *
bundle_from_model (MODEL *pmod,
                   DATASET *dset,
                   int *err);

kalman_bundle_new ()

gretl_bundle *
kalman_bundle_new (gretl_matrix *M[],
                   int copy[],
                   int nmat,
                   int *err);

gretl_bundle_cleanup ()

void
gretl_bundle_cleanup (void);

BUNDLE_PRINT

#define BUNDLE_PRINT "bundle-print"

BUNDLE_PLOT

#define BUNDLE_PLOT  "bundle-plot"

BUNDLE_TEST

#define BUNDLE_TEST  "bundle-test"

BUNDLE_FCAST

#define BUNDLE_FCAST "bundle-fcast"

BUNDLE_EXTRA

#define BUNDLE_EXTRA "bundle-extra"

GUI_MAIN

#define GUI_MAIN     "gui-main"

GUI_PRECHECK

#define GUI_PRECHECK "gui-precheck"

LIST_MAKER

#define LIST_MAKER   "list-maker"

enum BundleType

gretl_bundle

typedef struct gretl_bundle_ gretl_bundle;

An opaque type; use the relevant accessor functions.

bundled_item

typedef struct bundled_item_ bundled_item;

An item of data within a gretl_bundle. This is an opaque type; use the relevant accessor functions.