Add RCF external API skeletons

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

src/api/z3_rcf.h

@@ -0,0 +1,159 @@
+/*++
+Copyright (c) 2013 Microsoft Corporation
+
+Module Name:
+
+    z3_rcf.h
+
+Abstract:
+
+    Additional APIs for handling elements of the Z3 real closed field that contains:
+       - transcendental extensions
+       - infinitesimal extensions
+       - algebraic extensions
+
+Author:
+
+    Leonardo de Moura (leonardo) 2012-01-05
+
+Notes:
+    
+--*/
+#ifndef _Z3_RCF_H_
+#define _Z3_RCF_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif // __cplusplus
+
+    /**
+       \brief Increment the reference counter of a RCF numeral.
+    
+       def_API('Z3_rcf_inc_ref', VOID, (_in(CONTEXT), _in(RCF_NUM)))
+    */
+    void Z3_API Z3_rcf_inc_ref(__in Z3_context c, __in Z3_rcf_num a);
+
+    /**
+       \brief Decrement the reference counter of a RCF numeral.
+
+       def_API('Z3_rcf_dec_ref', VOID, (_in(CONTEXT), _in(RCF_NUM)))
+    */
+    void Z3_API Z3_rcf_dec_ref(__in Z3_context c, __in Z3_rcf_num a);
+
+    /**
+       \brief Return a RCF rational using the given string.
+
+       def_API('Z3_rcf_mk_rational', RCF_NUM, (_in(CONTEXT), _in(STRING)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_mk_rational(__in Z3_context c, __in Z3_string val);
+
+    /**
+       \brief Return a RCF small integer.
+
+       def_API('Z3_rcf_mk_small_int', RCF_NUM, (_in(CONTEXT), _in(INT)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_mk_small_int(__in Z3_context c, __in int val);
+
+    /**
+       \brief Return Pi
+
+       def_API('Z3_rcf_mk_pi', RCF_NUM, (_in(CONTEXT),))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_mk_pi(__in Z3_context c);
+
+    /**
+       \brief Return e (Euler's constant)
+
+       def_API('Z3_rcf_mk_e', RCF_NUM, (_in(CONTEXT),))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_mk_e(__in Z3_context c);
+
+    /**
+       \brief Return a new infinitesimal that is smaller than all elements in the Z3 field.
+
+       def_API('Z3_rcf_mk_infinitesimal', RCF_NUM, (_in(CONTEXT), _in(STRING)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_mk_infinitesimal(__in Z3_context c, __in Z3_string name);
+
+    /**
+       \brief Return the value a + b. 
+
+       def_API('Z3_rcf_add', RCF_NUM, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_add(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Return the value a - b. 
+
+       def_API('Z3_rcf_sub', RCF_NUM, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_sub(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Return the value a * b. 
+
+       def_API('Z3_rcf_mul', RCF_NUM, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_mul(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Return the value a / b. 
+
+       def_API('Z3_rcf_div', RCF_NUM, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_div(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+    
+    /**
+       \brief Return the value -a
+
+       def_API('Z3_rcf_neg', RCF_NUM, (_in(CONTEXT), _in(RCF_NUM)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_neg(__in Z3_context c, __in Z3_rcf_num a);
+
+    /**
+       \brief Return the value 1/a
+
+       def_API('Z3_rcf_inv', RCF_NUM, (_in(CONTEXT), _in(RCF_NUM)))
+    */
+    Z3_rcf_num Z3_API Z3_rcf_inv(__in Z3_context c, __in Z3_rcf_num a);
+
+    /**
+       \brief Return Z3_TRUE if a < b
+
+       def_API('Z3_rcf_lt', BOOL, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_bool Z3_API Z3_rcf_lt(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Return Z3_TRUE if a > b
+
+       def_API('Z3_rcf_gt', BOOL, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_bool Z3_API Z3_rcf_gt(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Return Z3_TRUE if a <= b
+
+       def_API('Z3_rcf_le', BOOL, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_bool Z3_API Z3_rcf_le(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Return Z3_TRUE if a >= b
+
+       def_API('Z3_rcf_ge', BOOL, (_in(CONTEXT), _in(RCF_NUM), _in(RCF_NUM)))
+    */
+    Z3_bool Z3_API Z3_rcf_ge(__in Z3_context c, __in Z3_rcf_num a, __in Z3_rcf_num b);
+
+    /**
+       \brief Convert the RCF numeral into a string.
+
+       def_API('Z3_rcf_num_to_string', STRING, (_in(CONTEXT), _in(RCF_NUM)))
+    */
+    Z3_string Z3_API Z3_rcf_num_to_string(__in Z3_context c, __in Z3_rcf_num a);
+
+#ifdef __cplusplus
+};
+#endif // __cplusplus
+
+#endif