genepi.h

Go to the documentation of this file.

/*
 * genepi.h -- The GENEPI main header file
 * 
 * This file is a part of the GENEric Presburger programming Interface. 
 * 
 * Copyright (C) 2010 CNRS UMR 5800 & Université Bordeaux I (see AUTHORS 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301  USA
 */

#ifndef __GENEPI_H__
# define __GENEPI_H__

# include <genepi/genepi-common.h>
# include <genepi/genepi-plugin-config.h>
# include <genepi/genepi-loader.h>

BEGIN_C_DECLS

typedef struct genepi_solver_st genepi_solver;

typedef struct genepi_set_st genepi_set;

# define GENEPI_FLAG_SHOW_TIMERS     (0x01<<0)

# define GENEPI_FLAG_SHOW_CACHE_INFO (0x01<<1)

typedef enum {
  GENEPI_EQ,
  GENEPI_LT,
  GENEPI_GT,
  GENEPI_LEQ,
  GENEPI_GEQ
} genepi_comparator;

typedef enum {
  GENEPI_N_SOLVER = 0,
  GENEPI_Z_SOLVER,
  GENEPI_P_SOLVER,
  GENEPI_R_SOLVER
} genepi_solver_type;

typedef enum {
  GENEPI_INFO_COPYRIGHT = 0,
  GENEPI_INFO_AUTHORS,
  GENEPI_INFO_LICENSE,
  GENEPI_INFO_BRIEF_DESCRIPTION,
  GENEPI_INFO_FULL_DESCRIPTION
} genepi_info;

typedef enum {
  GENEPI_RW_ERR_IO         = -1,

  GENEPI_R_ERR_BAD_SOLVER  = -2,

  GENEPI_R_ERR_BAD_VERSION = -3,

  GENEPI_R_ERR_DATA_ERROR  = -4
} genepi_io_error;

extern genepi_solver *
genepi_solver_create (genepi_plugin *plugin, int flags, int cachesize,
                      int number_of_cache_entries);

extern void
genepi_solver_delete (genepi_solver *solver);

extern genepi_solver_type 
genepi_solver_get_solver_type (genepi_solver *solver);

extern const genepi_plugconf *
genepi_solver_get_plugin_config (genepi_solver *solver);

extern const char *
genepi_solver_get_name (genepi_solver *solver);

extern void
genepi_solver_set_trace_file (genepi_solver *solver, FILE *output);

extern FILE *
genepi_solver_get_trace_file (genepi_solver *solver);

extern int
genepi_solver_run_autotest (genepi_solver *solver);

extern genepi_set *
genepi_set_add_reference (genepi_solver *solver, genepi_set *X);

extern void
genepi_set_del_reference (genepi_solver *solver, genepi_set *X);

extern genepi_set *
genepi_set_top (genepi_solver *solver, int n);

extern genepi_set *
genepi_set_top_N (genepi_solver *solver, int n);

extern genepi_set *
genepi_set_top_Z (genepi_solver *solver, int n);

extern genepi_set *
genepi_set_top_P (genepi_solver *solver, int n);

extern genepi_set *
genepi_set_top_R (genepi_solver *solver, int n);

extern genepi_set *
genepi_set_bot (genepi_solver *solver, int n);

extern genepi_set *
genepi_set_linear_equality (genepi_solver *solver, const int *alpha, 
                            int alpha_size, int cst);

extern genepi_set *
genepi_set_linear_operation (genepi_solver *solver, const int *alpha, 
                             int alpha_size, genepi_comparator op, int c);

extern genepi_set *
genepi_set_union (genepi_solver *solver, genepi_set *X1, genepi_set *X2);

extern genepi_set *
genepi_set_intersection (genepi_solver *solver, genepi_set *X1, 
                         genepi_set *X2);

extern genepi_set *
genepi_set_complement (genepi_solver *solver, genepi_set *X);

extern genepi_set *
genepi_set_project (genepi_solver *solver, genepi_set *X, 
                    const int *selection, int size);

extern genepi_set *
genepi_set_invproject (genepi_solver *solver, genepi_set *X, const int *sel, 
                       int size);

extern genepi_set *
genepi_set_apply (genepi_solver *solver, genepi_set *R, genepi_set *A);

extern genepi_set *
genepi_set_applyinv (genepi_solver *solver, genepi_set *R, genepi_set *A);

extern int
genepi_set_compare (genepi_solver *solver, genepi_set *X1, 
                    genepi_comparator op, genepi_set *X2);

extern int
genepi_set_equal (genepi_solver *solver, genepi_set *X1, genepi_set *X2);

extern int
genepi_set_is_empty (genepi_solver *solver, genepi_set *X);

extern int 
genepi_set_is_full (genepi_solver *solver, genepi_set *X);

extern int 
genepi_set_is_finite (genepi_solver *solver, genepi_set *X);

extern int
genepi_set_depend_on (genepi_solver *solver, genepi_set *X, const int *sel, 
                      int selsize);

extern void
genepi_set_get_solutions (genepi_solver *solver, genepi_set *X, 
                          int ***psolutions, int *psize, int max);

extern void
genepi_set_display_all_solutions (genepi_solver *solver, genepi_set *X, 
                                  FILE *output, const char * const*varnames);

extern void
genepi_set_display_data_structure (genepi_solver *solver, genepi_set *X, 
                                   FILE *output);

extern int
genepi_set_get_width (genepi_solver *solver, genepi_set *X);

extern int
genepi_set_get_data_structure_size (genepi_solver *solver, genepi_set *X);

extern int
genepi_set_is_solution (genepi_solver *solver, genepi_set *X, const int *x, 
                        int x_size, int xden);

extern int
genepi_set_get_one_solution (genepi_solver *solver, genepi_set *X, int *x, 
                             int x_size);

extern int
genepi_set_write (genepi_solver *solver, FILE *output, genepi_set *set);

extern int
genepi_set_read (genepi_solver *solver, FILE *input, genepi_set **pset);

extern genepi_set *
genepi_set_transform (genepi_solver *solver, genepi_set *X, int *indices, 
                      int nb_indices, int *cst, int nb_cst);


extern int
genepi_set_preorder (genepi_solver *solver, genepi_set *X1, genepi_set *X2);

END_C_DECLS

#endif /* ! __GENEPI_H__ */