objstack

objstack

Functions

void set_as_last_model ()
int gretl_model_protect ()
int gretl_model_unprotect ()
void * get_last_model ()
GretlObjType get_last_model_type ()
void * get_genr_model ()
int get_genr_model_ID ()
MODEL * get_model_by_name ()
MODEL * get_model_by_ID ()
GRETL_VAR * get_VAR_by_name ()
GRETL_VAR * get_VECM_by_name ()
equation_system * get_equation_system_by_name ()
void * gretl_get_object_by_name ()
int gretl_get_object_and_type ()
GretlType saved_object_get_data_type ()
int object_is_on_stack ()
int gretl_stack_object ()
int gretl_stack_object_as ()
void gretl_object_remove_from_stack ()
void remove_model_from_stack_on_exit ()
MODEL * maybe_stack_model ()
int maybe_stack_var ()
void gretl_object_ref ()
void gretl_object_unref ()
double saved_object_get_scalar ()
int saved_object_print_scalar ()
int saved_object_get_series ()
gretl_matrix * saved_object_get_matrix ()
gretl_matrix * saved_object_build_matrix ()
gretl_matrix * last_model_get_irf_matrix ()
gretl_matrix * last_model_get_boot_ci ()
double last_model_get_boot_pval ()
void * last_model_get_data ()
char * last_model_get_vcv_type ()
int * saved_object_get_list ()
char * saved_object_get_string ()
int gretl_object_rename ()
int gretl_object_compose_name ()
int gretl_object_compose_unique_name ()
char * gretl_object_get_name ()
int parse_object_command ()
int match_object_command ()
int last_model_test_ok ()
int last_model_test_uhat ()
void set_genr_model ()
void unset_genr_model ()
int highest_numbered_var_in_saved_object ()
int check_variable_deletion_list ()
int check_models_for_subsample ()
int n_stacked_models ()
void set_gui_model_list_callback ()
void gretl_saved_objects_cleanup ()

Types and Values

Description

Functions

set_as_last_model ()

void
set_as_last_model (void *ptr,
                   GretlObjType type);

Puts ptr in place as the "last model" (which will be accessed by default via accessors such as "$uhat").

Parameters

ptr

pointer to gretl object (e.g. MODEL).

 

type

type of object.

 

gretl_model_protect ()

int
gretl_model_protect (MODEL *pmod);

gretl_model_unprotect ()

int
gretl_model_unprotect (MODEL *pmod);

get_last_model ()

void *
get_last_model (GretlObjType *type);

Parameters

type

location to receive type of last model, or NULL.

 

Returns

pointer to the last model estimated. Note that this may be NULL if no model has been estimated.


get_last_model_type ()

GretlObjType
get_last_model_type (void);

Returns

the type indentifier for the last model estimated.


get_genr_model ()

void *
get_genr_model (GretlObjType *type);

get_genr_model_ID ()

int
get_genr_model_ID (void);

get_model_by_name ()

MODEL *
get_model_by_name (const char *mname);

get_model_by_ID ()

MODEL *
get_model_by_ID (int ID);

get_VAR_by_name ()

GRETL_VAR *
get_VAR_by_name (const char *vname);

get_VECM_by_name ()

GRETL_VAR *
get_VECM_by_name (const char *vname);

get_equation_system_by_name ()

equation_system *
get_equation_system_by_name (const char *sname);

gretl_get_object_by_name ()

void *
gretl_get_object_by_name (const char *name);

gretl_get_object_and_type ()

int
gretl_get_object_and_type (const char *name,
                           void **pp,
                           GretlObjType *type);

saved_object_get_data_type ()

GretlType
saved_object_get_data_type (const char *name,
                            ModelDataIndex idx);

object_is_on_stack ()

int
object_is_on_stack (const void *ptr);

gretl_stack_object ()

int
gretl_stack_object (void *ptr,
                    GretlObjType type);

gretl_stack_object_as ()

int
gretl_stack_object_as (void *ptr,
                       GretlObjType type,
                       const char *name);

gretl_object_remove_from_stack ()

void
gretl_object_remove_from_stack (void *ptr,
                                GretlObjType type);

remove_model_from_stack_on_exit ()

void
remove_model_from_stack_on_exit (MODEL *pmod);

maybe_stack_model ()

MODEL *
maybe_stack_model (MODEL *pmod,
                   CMD *cmd,
                   PRN *prn,
                   int *err);

maybe_stack_var ()

int
maybe_stack_var (GRETL_VAR *var,
                 CMD *cmd);

gretl_object_ref ()

void
gretl_object_ref (void *ptr,
                  GretlObjType type);

Augments the reference count for the object represented by ptr , of type type .

Parameters

ptr

pointer to gretl obejct (e.g. MODEL).

 

type

type of object.

 

gretl_object_unref ()

void
gretl_object_unref (void *ptr,
                    GretlObjType type);

Decrements the reference count for the object represented by ptr , of type type . When the count reaches zero the object is destroyed.

Parameters

ptr

pointer to gretl object (e.g. MODEL).

 

type

type of object.

 

saved_object_get_scalar ()

double
saved_object_get_scalar (const char *oname,
                         int idx,
                         DATASET *dset,
                         int *err);

saved_object_print_scalar ()

int
saved_object_print_scalar (const char *oname,
                           const char *key,
                           PRN *prn);

saved_object_get_series ()

int
saved_object_get_series (double *x,
                         const char *oname,
                         int idx,
                         const DATASET *dset);

saved_object_get_matrix ()

gretl_matrix *
saved_object_get_matrix (const char *oname,
                         int idx,
                         int *err);

saved_object_build_matrix ()

gretl_matrix *
saved_object_build_matrix (const char *oname,
                           int idx,
                           const DATASET *dset,
                           int *err);

last_model_get_irf_matrix ()

gretl_matrix *
last_model_get_irf_matrix (int targ,
                           int shock,
                           double alpha,
                           const DATASET *dset,
                           int *err);

last_model_get_boot_ci ()

gretl_matrix *
last_model_get_boot_ci (int cnum,
                        const DATASET *dset,
                        int B,
                        double alpha,
                        int method,
                        int studentize,
                        int *err);

last_model_get_boot_pval ()

double
last_model_get_boot_pval (int cnum,
                          const DATASET *dset,
                          int B,
                          int method,
                          int *err);

last_model_get_data ()

void *
last_model_get_data (const char *key,
                     GretlType *type,
                     int *size,
                     int *copied,
                     int *err);

last_model_get_vcv_type ()

char *
last_model_get_vcv_type (void);

saved_object_get_list ()

int *
saved_object_get_list (const char *oname,
                       int idx,
                       int *err);

saved_object_get_string ()

char *
saved_object_get_string (const char *oname,
                         int idx,
                         const DATASET *dset,
                         int *err);

gretl_object_rename ()

int
gretl_object_rename (void *p,
                     GretlObjType type,
                     const char *oname);

gretl_object_compose_name ()

int
gretl_object_compose_name (void *p,
                           GretlObjType type);

gretl_object_compose_unique_name ()

int
gretl_object_compose_unique_name (void *p,
                                  GretlObjType type);

gretl_object_get_name ()

char *
gretl_object_get_name (void *p,
                       GretlObjType type);

Parameters

p

pointer to gretl object (e.g. MODEL).

 

type

type of object.

 

Returns

the name of the object of type type with location p , or NULL if the object is not found. The return value may be ovewritten (up to MAXSAVENAME-1 characters), but must not be freed.


parse_object_command ()

int
parse_object_command (const char *s,
                      char *name,
                      char **cmd);

match_object_command ()

int
match_object_command (const char *s);

last_model_test_ok ()

int
last_model_test_ok (int ci,
                    gretlopt opt,
                    const DATASET *dset,
                    PRN *prn);

last_model_test_uhat ()

int
last_model_test_uhat (DATASET *dset,
                      gretlopt opt,
                      PRN *prn);

set_genr_model ()

void
set_genr_model (void *ptr,
                GretlObjType type);

unset_genr_model ()

void
unset_genr_model (void);

highest_numbered_var_in_saved_object ()

int
highest_numbered_var_in_saved_object (const DATASET *dset);

check_variable_deletion_list ()

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

check_models_for_subsample ()

int
check_models_for_subsample (char *newmask,
                            int *ndropped);

n_stacked_models ()

int
n_stacked_models (void);

set_gui_model_list_callback ()

void
set_gui_model_list_callback (GList* (*callback) ());

gretl_saved_objects_cleanup ()

void
gretl_saved_objects_cleanup (void);

Types and Values

enum GretlObjType

Members

GRETL_OBJ_NULL

   

GRETL_OBJ_EQN

   

GRETL_OBJ_SYS

   

GRETL_OBJ_VAR

   

GRETL_OBJ_DSET

   

GRETL_OBJ_INFO

   

GRETL_OBJ_STATS

   

GRETL_OBJ_CORR

   

GRETL_OBJ_SCRIPT

   

GRETL_OBJ_NOTES

   

GRETL_OBJ_MODTAB

   

GRETL_OBJ_GPAGE

   

GRETL_OBJ_GRAPH

   

GRETL_OBJ_PLOT

   

GRETL_OBJ_TEXT

   

GRETL_OBJ_MATRIX

   

GRETL_OBJ_SCALARS

   

GRETL_OBJ_BUNDLE

   

GRETL_OBJ_ANY

   

GRETL_OBJ_MAX

   

enum SavedObjectFlags

Members

IN_GUI_SESSION

   

IN_NAMED_STACK

   

IN_MODEL_TABLE

   

IS_LAST_MODEL

   

IN_GRAPH_PAGE