condition.h

Go to the documentation of this file.

/*
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "xcsf.h"
 
#define COND_TYPE_INVALID (-1) 
#define COND_TYPE_DUMMY (0) 
#define COND_TYPE_HYPERRECTANGLE_CSR (1) 
#define COND_TYPE_HYPERRECTANGLE_UBR (2) 
#define COND_TYPE_HYPERELLIPSOID (3) 
#define COND_TYPE_NEURAL (4) 
#define COND_TYPE_GP (5) 
#define COND_TYPE_DGP (6) 
#define COND_TYPE_TERNARY (7) 
#define RULE_TYPE_DGP (11) 
#define RULE_TYPE_NEURAL (12) 
#define RULE_TYPE_NETWORK (13) 
 
#define COND_STRING_DUMMY ("dummy\0") 
#define COND_STRING_HYPERRECTANGLE_CSR ("hyperrectangle_csr\0") 
#define COND_STRING_HYPERRECTANGLE_UBR ("hyperrectangle_ubr\0") 
#define COND_STRING_HYPERELLIPSOID ("hyperellipsoid\0") 
#define COND_STRING_NEURAL ("neural\0") 
#define COND_STRING_GP ("tree_gp\0") 
#define COND_STRING_DGP ("dgp\0") 
#define COND_STRING_TERNARY ("ternary\0") 
#define COND_STRING_RULE_DGP ("rule_dgp\0") 
#define COND_STRING_RULE_NEURAL ("rule_neural\0") 
#define COND_STRING_RULE_NETWORK ("rule_network\0") 
 
#define COND_TYPE_OPTIONS                                                      \
    "dummy, hyperrectangle_csr, hyperrectangle_ubr, hyperellipsoid, neural, "  \
    "tree_gp, dgp, ternary, rule_dgp, rule_neural, rule_network"
 
struct ArgsCond {
    int type; 
    double eta; 
    double max; 
    double min; 
    double p_dontcare; 
    double spread_min; 
    double p_mu; 
    double mu; 
    bool sam; 
    int bits; 
    struct ArgsLayer *largs; 
    struct ArgsDGP *dargs; 
    struct ArgsGPTree *targs; 
};
 
void
condition_set(const struct XCSF *xcsf, struct Cl *c);
 
const char *
condition_type_as_string(const int type);
 
int
condition_type_as_int(const char *type);
 
void
cond_param_defaults(struct XCSF *xcsf);
 
void
cond_param_free(struct XCSF *xcsf);
 
char *
cond_param_json_import(struct XCSF *xcsf, cJSON *json);
 
char *
cond_param_json_export(const struct XCSF *xcsf);
 
size_t
cond_param_save(const struct XCSF *xcsf, FILE *fp);
 
size_t
cond_param_load(struct XCSF *xcsf, FILE *fp);
 
struct CondVtbl {
    bool (*cond_impl_crossover)(const struct XCSF *xcsf, const struct Cl *c1,
                                const struct Cl *c2);
    bool (*cond_impl_general)(const struct XCSF *xcsf, const struct Cl *c1,
                              const struct Cl *c2);
    bool (*cond_impl_match)(const struct XCSF *xcsf, const struct Cl *c,
                            const double *x);
    bool (*cond_impl_mutate)(const struct XCSF *xcsf, const struct Cl *c);
    void (*cond_impl_copy)(const struct XCSF *xcsf, struct Cl *dest,
                           const struct Cl *src);
    void (*cond_impl_cover)(const struct XCSF *xcsf, const struct Cl *c,
                            const double *x);
    void (*cond_impl_free)(const struct XCSF *xcsf, const struct Cl *c);
    void (*cond_impl_init)(const struct XCSF *xcsf, struct Cl *c);
    void (*cond_impl_print)(const struct XCSF *xcsf, const struct Cl *c);
    void (*cond_impl_update)(const struct XCSF *xcsf, const struct Cl *c,
                             const double *x, const double *y);
    double (*cond_impl_size)(const struct XCSF *xcsf, const struct Cl *c);
    size_t (*cond_impl_save)(const struct XCSF *xcsf, const struct Cl *c,
                             FILE *fp);
    size_t (*cond_impl_load)(const struct XCSF *xcsf, struct Cl *c, FILE *fp);
    char *(*cond_impl_json_export)(const struct XCSF *xcsf, const struct Cl *c);
    void (*cond_impl_json_import)(const struct XCSF *xcsf, struct Cl *c,
                                  const cJSON *json);
};
 
static inline size_t
cond_save(const struct XCSF *xcsf, const struct Cl *c, FILE *fp)
{
    return (*c->cond_vptr->cond_impl_save)(xcsf, c, fp);
}
 
static inline size_t
cond_load(const struct XCSF *xcsf, struct Cl *c, FILE *fp)
{
    return (*c->cond_vptr->cond_impl_load)(xcsf, c, fp);
}
 
static inline double
cond_size(const struct XCSF *xcsf, const struct Cl *c)
{
    return (*c->cond_vptr->cond_impl_size)(xcsf, c);
}
 
static inline void
cond_update(const struct XCSF *xcsf, const struct Cl *c, const double *x,
            const double *y)
{
    (*c->cond_vptr->cond_impl_update)(xcsf, c, x, y);
}
 
static inline bool
cond_crossover(const struct XCSF *xcsf, const struct Cl *c1,
               const struct Cl *c2)
{
    return (*c1->cond_vptr->cond_impl_crossover)(xcsf, c1, c2);
}
 
static inline bool
cond_general(const struct XCSF *xcsf, const struct Cl *c1, const struct Cl *c2)
{
    return (*c1->cond_vptr->cond_impl_general)(xcsf, c1, c2);
}
 
static inline bool
cond_match(const struct XCSF *xcsf, const struct Cl *c, const double *x)
{
    return (*c->cond_vptr->cond_impl_match)(xcsf, c, x);
}
 
static inline bool
cond_mutate(const struct XCSF *xcsf, const struct Cl *c)
{
    return (*c->cond_vptr->cond_impl_mutate)(xcsf, c);
}
 
static inline void
cond_copy(const struct XCSF *xcsf, struct Cl *dest, const struct Cl *src)
{
    (*src->cond_vptr->cond_impl_copy)(xcsf, dest, src);
}
 
static inline void
cond_cover(const struct XCSF *xcsf, const struct Cl *c, const double *x)
{
    (*c->cond_vptr->cond_impl_cover)(xcsf, c, x);
}
 
static inline void
cond_free(const struct XCSF *xcsf, const struct Cl *c)
{
    (*c->cond_vptr->cond_impl_free)(xcsf, c);
}
 
static inline void
cond_init(const struct XCSF *xcsf, struct Cl *c)
{
    (*c->cond_vptr->cond_impl_init)(xcsf, c);
}
 
static inline void
cond_print(const struct XCSF *xcsf, const struct Cl *c)
{
    (*c->cond_vptr->cond_impl_print)(xcsf, c);
}
 
static inline char *
cond_json_export(const struct XCSF *xcsf, const struct Cl *c)
{
    return (*c->cond_vptr->cond_impl_json_export)(xcsf, c);
}
 
static inline void
cond_json_import(const struct XCSF *xcsf, struct Cl *c, const cJSON *json)
{
    const cJSON *item = cJSON_GetObjectItem(json, "type");
    if (item == NULL || !cJSON_IsString(item)) {
        printf("cond_json_import(): missing type\n");
        exit(EXIT_FAILURE);
    }
    const char *type = item->valuestring;
    if (condition_type_as_int(type) != xcsf->cond->type) {
        printf("cond_json_import(): mismatched type\n");
        printf("XCSF type = %s, but imported type = %s\n",
               condition_type_as_string(xcsf->cond->type), type);
        exit(EXIT_FAILURE);
    }
    (*c->cond_vptr->cond_impl_json_import)(xcsf, c, json);
}
 
/* parameter setters */
 
void
cond_param_set_eta(struct XCSF *xcsf, const double a);
 
void
cond_param_set_min(struct XCSF *xcsf, const double a);
 
void
cond_param_set_max(struct XCSF *xcsf, const double a);
 
void
cond_param_set_p_dontcare(struct XCSF *xcsf, const double a);
 
void
cond_param_set_mu(struct XCSF *xcsf, const double a);
 
void
cond_param_set_p_mu(struct XCSF *xcsf, const double a);
 
void
cond_param_set_sam(struct XCSF *xcsf, const bool a);
 
void
cond_param_set_spread_min(struct XCSF *xcsf, const double a);
 
void
cond_param_set_bits(struct XCSF *xcsf, const int a);
 
int
cond_param_set_type_string(struct XCSF *xcsf, const char *a);
 
void
cond_param_set_type(struct XCSF *xcsf, const int a);