NuSMV Developers Manual: NuSMV/code/nusmv/core/enc/enc.h Source File

00001 /* ---------------------------------------------------------------------------
00002 
00003 
00004   This file is part of the ``enc'' package of NuSMV version 2.
00005   Copyright (C) 2003 by FBK-irst.
00006 
00007   NuSMV version 2 is free software; you can redistribute it and/or
00008   modify it under the terms of the GNU Lesser General Public
00009   License as published by the Free Software Foundation; either
00010   version 2 of the License, or (at your option) any later version.
00011 
00012   NuSMV version 2 is distributed in the hope that it will be useful,
00013   but WITHOUT ANY WARRANTY; without even the implied warranty of
00014   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015   Lesser General Public License for more details.
00016 
00017   You should have received a copy of the GNU Lesser General Public
00018   License along with this library; if not, write to the Free Software
00019   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA.
00020 
00021   For more information on NuSMV see <http://nusmv.fbk.eu>
00022   or email to <nusmv-users@fbk.eu>.
00023   Please report bugs to <nusmv-users@fbk.eu>.
00024 
00025   To contact the NuSMV development board, email to <nusmv@fbk.eu>. 
00026 
00027 -----------------------------------------------------------------------------*/
00028 
00039 #ifndef __NUSMV_CORE_ENC_ENC_H__
00040 #define __NUSMV_CORE_ENC_ENC_H__
00041 
00042 #include "nusmv/core/utils/utils.h"
00043 
00044 #include "nusmv/core/enc/bool/BoolEnc.h"
00045 #include "nusmv/core/enc/bdd/BddEnc.h"
00046 #include "nusmv/core/enc/be/BeEnc.h"
00047 #include "nusmv/core/utils/StreamMgr.h"
00048 
00049 
00050 /*---------------------------------------------------------------------------*/
00051 /* Macro declarations                                                        */
00052 /*---------------------------------------------------------------------------*/
00053 
00054 /*---------------------------------------------------------------------------*/
00055 /* Constant declarations                                                    */
00056 /*---------------------------------------------------------------------------*/
00057 
00058 /*---------------------------------------------------------------------------*/
00059 /* Structure definitions                                                     */
00060 /*---------------------------------------------------------------------------*/
00061 /* possible Variable Ordering Types */
00062 typedef enum  {
00063   VARS_ORD_INPUTS_BEFORE,
00064   VARS_ORD_INPUTS_AFTER,
00065   VARS_ORD_TOPOLOGICAL,
00066   VARS_ORD_INPUTS_BEFORE_BI, /* default */
00067   VARS_ORD_INPUTS_AFTER_BI,
00068   VARS_ORD_TOPOLOGICAL_BI,
00069   VARS_ORD_UNKNOWN
00070 
00071 } VarsOrdType;
00072 
00073 /* possible BDD Static Ordering Heuristics */
00074 typedef enum {
00075   BDD_STATIC_ORDER_HEURISTICS_NONE,
00076   BDD_STATIC_ORDER_HEURISTICS_BASIC,
00077   BDD_STATIC_ORDER_HEURISTICS_ERROR, /* means an error has happened*/
00078 } BddSohEnum;
00079 
00080 /*---------------------------------------------------------------------------*/
00081 /* Variable declarations                                                     */
00082 /*---------------------------------------------------------------------------*/
00083 
00084 /*---------------------------------------------------------------------------*/
00085 /* Functions declarations                                                    */
00086 /*---------------------------------------------------------------------------*/
00087 
00099 void Enc_init_encodings(NuSMVEnv_ptr env);
00100 
00114 void Enc_init_bool_encoding(NuSMVEnv_ptr env);
00115 
00121 void Enc_init_bdd_encoding(NuSMVEnv_ptr env,
00122                                   const char* input_order_file_name);
00123 
00129 void Enc_init_be_encoding(NuSMVEnv_ptr env);
00130 
00137 void Enc_quit_encodings(NuSMVEnv_ptr env);
00138 
00144 const char* Enc_vars_ord_to_string(VarsOrdType);
00145 
00154 VarsOrdType Enc_string_to_vars_ord(const char*, StreamMgr_ptr);
00155 
00162 const char* Enc_get_valid_vars_ord_types(void);
00163 
00169 const char* Enc_bdd_static_order_heuristics_to_string(BddSohEnum);
00170 
00177 BddSohEnum Enc_string_to_bdd_static_order_heuristics(const char*);
00178 
00185 const char* Enc_get_valid_bdd_static_order_heuristics(void);
00186 
00193 int Enc_clean_evaluation_cache(NuSMVEnv_ptr env,
00194                                       BddEnc_ptr enc);
00195 
00196 #endif /* __NUSMV_CORE_ENC_ENC_H__ */