added module descriptions

Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>

src/ast/normal_forms/nnf_params.pyg

@@ -1,4 +1,5 @@
 def_module_params('nnf', 
+                  description='negation normal form',
                   export=True,
                   params=(max_memory_param(),
                           ('sk_hack', BOOL, False, 'hack for VCC'),

src/ast/pattern/pattern_inference_params.cpp

@@ -0,0 +1,32 @@
+/*++
+Copyright (c) 2012 Microsoft Corporation
+
+Module Name:
+
+    pattern_inference_params.h
+
+Abstract:
+
+    <abstract>
+
+Author:
+
+    Leonardo de Moura (leonardo) 2012-12-02.
+
+Revision History:
+
+--*/
+#include"pattern_inference_params.h"
+#include"pattern_inference_params_helper.hpp"
+
+void pattern_inference_params::updt_params(params_ref const & _p) {
+    pattern_inference_params_helper p(_p);
+    m_pi_max_multi_patterns      = p.max_multi_patterns();
+    m_pi_block_loop_patterns     = p.block_loop_patterns();
+    m_pi_arith                   = static_cast<arith_pattern_inference_kind>(p.arith());
+    m_pi_use_database            = p.use_database();
+    m_pi_arith_weight            = p.arith_weight();
+    m_pi_non_nested_arith_weight = p.non_nested_arith_weight();
+    m_pi_pull_quantifiers        = p.pull_quantifiers();
+    m_pi_warnings                = p.warnings();
+}

src/ast/pattern/pattern_inference_params.h

@@ -19,7 +19,7 @@ Revision History:
 #ifndef _PATTERN_INFERENCE_PARAMS_H_
 #define _PATTERN_INFERENCE_PARAMS_H_
 
-#include"pattern_inference_params_helper.hpp"
+#include"params.h"
 
 enum arith_pattern_inference_kind {
     AP_NO,           // do not infer patterns with arithmetic terms
@@ -45,17 +45,7 @@ struct pattern_inference_params {
         updt_params(p);
     }
 
-    void updt_params(params_ref const & _p) {
-        pattern_inference_params_helper p(_p);
-        m_pi_max_multi_patterns      = p.max_multi_patterns();
-        m_pi_block_loop_patterns     = p.block_loop_patterns();
-        m_pi_arith                   = static_cast<arith_pattern_inference_kind>(p.arith());
-        m_pi_use_database            = p.use_database();
-        m_pi_arith_weight            = p.arith_weight();
-        m_pi_non_nested_arith_weight = p.non_nested_arith_weight();
-        m_pi_pull_quantifiers        = p.pull_quantifiers();
-        m_pi_warnings                = p.warnings();
-    }
+    void updt_params(params_ref const & _p);
 };
 
 #endif /* _PATTERN_INFERENCE_PARAMS_H_ */

src/ast/pattern/pattern_inference_params_helper.pyg

@@ -1,5 +1,6 @@
 def_module_params(class_name='pattern_inference_params_helper',
                   module_name='pi',
+                  description='pattern inference (heuristics) for universal formulas (without annotation)',
                   export=True,
                   params=(('max_multi_patterns', UINT, 0, 'when patterns are not provided, the prover uses a heuristic to infer them, this option sets the threshold on the number of extra multi-patterns that can be created; by default, the prover creates at most one multi-pattern when there is no unary pattern'),
                           ('block_loop_patterns', BOOL, True, 'block looping patterns during pattern inference'),

src/ast/pp_params.pyg

@@ -1,5 +1,6 @@
 def_module_params('pp', 
                   export=True,
+                  description='pretty printer',
                   params=(('max_indent', UINT, UINT_MAX, 'max. indentation in pretty printer'),
                           ('max_num_lines', UINT, UINT_MAX, 'max. number of lines to be displayed in pretty printer'),
                           ('max_width', UINT, 80, 'max. width in pretty printer'),

src/ast/simplifier/arith_simplifier_params.cpp

@@ -0,0 +1,26 @@
+/*++
+Copyright (c) 2006 Microsoft Corporation
+
+Module Name:
+
+    arith_simplifier_params.cpp
+
+Abstract:
+
+    <abstract>
+
+Author:
+
+    Leonardo de Moura (leonardo) 2012-12-02.
+
+Revision History:
+
+--*/
+#include"arith_simplifier_params.h"
+#include"arith_simplifier_params_helper.hpp"
+
+void arith_simplifier_params::updt_params(params_ref const & _p) {
+    arith_simplifier_params_helper p(_p);
+    m_arith_expand_eqs      = p.arith_expand_eqs();
+    m_arith_process_all_eqs = p.arith_process_all_eqs();
+}

src/ast/simplifier/arith_simplifier_params.h

@@ -19,7 +19,7 @@ Revision History:
 #ifndef _ARITH_SIMPLIFIER_PARAMS_H_
 #define _ARITH_SIMPLIFIER_PARAMS_H_
 
-#include"arith_simplifier_params_helper.hpp"
+#include"params.h"
 
 struct arith_simplifier_params { 
     bool    m_arith_expand_eqs;
@@ -29,11 +29,7 @@ struct arith_simplifier_params {
         updt_params(p);
     }
 
-    void updt_params(params_ref const & _p) {
-        arith_simplifier_params_helper p(_p);
-        m_arith_expand_eqs      = p.arith_expand_eqs();
-        m_arith_process_all_eqs = p.arith_process_all_eqs();
-    }
+    void updt_params(params_ref const & _p);
 };
     
 #endif /* _ARITH_SIMPLIFIER_PARAMS_H_ */

src/ast/simplifier/arith_simplifier_params_helper.pyg

@@ -1,5 +1,6 @@
 def_module_params(class_name='arith_simplifier_params_helper',
                   module_name="old_simplify", # Parameters will be in the old_simplify module
+                  description="old simplification (stack) still used in the smt module",
                   export=True,
                   params=(
                           ('arith.expand_eqs', BOOL, False, 'expand equalities into two inequalities'),

src/ast/simplifier/array_simplifier_params.cpp

@@ -0,0 +1,26 @@
+/*++
+Copyright (c) 2012 Microsoft Corporation
+
+Module Name:
+
+    array_simplifier_params.cpp
+
+Abstract:
+
+    This file was created during code reorg.
+
+Author:
+
+    Leonardo de Moura (leonardo) 2012-12-02.
+
+Revision History:
+
+--*/
+#include"array_simplifier_params.h"
+#include"array_simplifier_params_helper.hpp"
+
+void array_simplifier_params::updt_params(params_ref const & _p) {
+    array_simplifier_params_helper p(_p);
+    m_array_canonize_simplify = p.array_canonize();
+    m_array_simplify          = p.array_simplify();
+}

src/ast/simplifier/array_simplifier_params.h

@@ -1,5 +1,5 @@
 /*++
-Copyright (c) 2006 Microsoft Corporation
+Copyright (c) 2012 Microsoft Corporation
 
 Module Name:
 
@@ -19,7 +19,7 @@ Revision History:
 #ifndef _ARRAY_SIMPLIFIER_PARAMS_H_
 #define _ARRAY_SIMPLIFIER_PARAMS_H_
 
-#include"array_simplifier_params_helper.hpp"
+#include"params.h"
 
 struct array_simplifier_params {
     bool            m_array_canonize_simplify;
@@ -29,11 +29,7 @@ struct array_simplifier_params {
         updt_params(p);
     }
 
-    void updt_params(params_ref const & _p) {
-        array_simplifier_params_helper p(_p);
-        m_array_canonize_simplify = p.array_canonize();
-        m_array_simplify          = p.array_simplify();
-    }
+    void updt_params(params_ref const & _p);
 };
     
 #endif /* _ARITH_SIMPLIFIER_PARAMS_H_ */

src/ast/simplifier/bv_simplifier_params.cpp

@@ -0,0 +1,26 @@
+/*++
+Copyright (c) 2006 Microsoft Corporation
+
+Module Name:
+
+    bv_simplifier_params.cpp
+
+Abstract:
+
+    <abstract>
+
+Author:
+
+    Leonardo de Moura (leonardo) 2012-12-02.
+
+Revision History:
+
+--*/
+#include"bv_simplifier_params.h"
+#include"bv_simplifier_params_helper.hpp"
+
+void bv_simplifier_params::updt_params(params_ref const & _p) {
+    bv_simplifier_params_helper p(_p);
+    m_hi_div0 = p.bv_hi_div0();
+    m_bv2int_distribute = p.bv_bv2int_distribute();
+}

src/ast/simplifier/bv_simplifier_params.h

@@ -19,7 +19,7 @@ Revision History:
 #ifndef _BV_SIMPLIFIER_PARAMS_H_
 #define _BV_SIMPLIFIER_PARAMS_H_
 
-#include"bv_simplifier_params_helper.hpp"
+#include"params.h"
 
 struct bv_simplifier_params {
     bool  m_hi_div0; //!< if true, uses the hardware interpretation for div0, mod0, ... if false, div0, mod0, ... are considered uninterpreted.
@@ -29,11 +29,7 @@ struct bv_simplifier_params {
         updt_params(p);
     }
 
-    void updt_params(params_ref const & _p) {
-        bv_simplifier_params_helper p(_p);
-        m_hi_div0 = p.bv_hi_div0();
-        m_bv2int_distribute = p.bv_bv2int_distribute();
-    }
+    void updt_params(params_ref const & _p);
 };
 
 #endif /* _BV_SIMPLIFIER_PARAMS_H_ */