summaryrefslogtreecommitdiff
path: root/src/Result.defs.hh
diff options
context:
space:
mode:
authorAnas Nashif <anas.nashif@intel.com>2012-11-06 07:10:54 -0800
committerAnas Nashif <anas.nashif@intel.com>2012-11-06 07:10:54 -0800
commitede95f2eabeab645352a36af072ee998c400bca1 (patch)
treefcd5dc9c73c1bdc0444deee28a9b329f62a2ed7b /src/Result.defs.hh
downloadppl-upstream.tar.gz
ppl-upstream.tar.bz2
ppl-upstream.zip
Imported Upstream version 0.11.2upstream/0.11.2upstream
Diffstat (limited to 'src/Result.defs.hh')
-rw-r--r--src/Result.defs.hh173
1 files changed, 173 insertions, 0 deletions
diff --git a/src/Result.defs.hh b/src/Result.defs.hh
new file mode 100644
index 000000000..ce915c204
--- /dev/null
+++ b/src/Result.defs.hh
@@ -0,0 +1,173 @@
+/* Result enum and supporting function declarations.
+ Copyright (C) 2001-2010 Roberto Bagnara <bagnara@cs.unipr.it>
+ Copyright (C) 2010-2011 BUGSENG srl (http://bugseng.com)
+
+This file is part of the Parma Polyhedra Library (PPL).
+
+The PPL 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.
+
+The PPL 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 02111-1307, USA.
+
+For the most up-to-date information see the Parma Polyhedra Library
+site: http://www.cs.unipr.it/ppl/ . */
+
+#ifndef PPL_Result_defs_hh
+#define PPL_Result_defs_hh 1
+
+namespace Parma_Polyhedra_Library {
+
+enum Result_Class {
+ //! \hideinitializer Representable number result class.
+ VC_NORMAL = 0 << 4,
+
+ //! \hideinitializer Negative infinity result class.
+ VC_MINUS_INFINITY = 1 << 4,
+
+ //! \hideinitializer Positive infinity result class.
+ VC_PLUS_INFINITY = 2 << 4,
+
+ //! \hideinitializer Not a number result class.
+ VC_NAN = 3 << 4,
+
+ VC_MASK = VC_NAN
+};
+
+// This must be kept in sync with Relation_Symbol
+enum Result_Relation {
+ //! \hideinitializer No values satisfies the relation.
+ VR_EMPTY = 0,
+
+ //! \hideinitializer Equal. This need to be accompanied by a value.
+ VR_EQ = 1,
+
+ //! \hideinitializer Less than. This need to be accompanied by a value.
+ VR_LT = 2,
+
+ //! \hideinitializer Greater than. This need to be accompanied by a value.
+ VR_GT = 4,
+
+ //! \hideinitializer Not equal. This need to be accompanied by a value.
+ VR_NE = VR_LT | VR_GT,
+
+ //! \hideinitializer Less or equal. This need to be accompanied by a value.
+ VR_LE = VR_EQ | VR_LT,
+
+ //! \hideinitializer Greater or equal. This need to be accompanied by a value.
+ VR_GE = VR_EQ | VR_GT,
+
+ //! \hideinitializer All values satisfy the relation.
+ VR_LGE = VR_LT | VR_EQ | VR_GT,
+
+ VR_MASK = VR_LGE
+};
+
+//! Possible outcomes of a checked arithmetic computation.
+/*! \ingroup PPL_CXX_interface */
+enum Result {
+ //! \hideinitializer The exact result is not comparable.
+ V_EMPTY = VR_EMPTY,
+
+ //! \hideinitializer The computed result is exact.
+ V_EQ = VR_EQ,
+
+ //! \hideinitializer The computed result is inexact and rounded up.
+ V_LT = VR_LT,
+
+ //! \hideinitializer The computed result is inexact and rounded down.
+ V_GT = VR_GT,
+
+ //! \hideinitializer The computed result is inexact.
+ V_NE = VR_NE,
+
+ //! \hideinitializer The computed result may be inexact and rounded up.
+ V_LE = VR_LE,
+
+ //! \hideinitializer The computed result may be inexact and rounded down.
+ V_GE = VR_GE,
+
+ //! \hideinitializer The computed result may be inexact.
+ V_LGE = VR_LGE,
+
+ //! \hideinitializer The exact result is a number out of finite bounds.
+ V_OVERFLOW = 1 << 6,
+
+ //! \hideinitializer A negative integer overflow occurred (rounding up).
+ V_LT_INF = V_LT | V_OVERFLOW,
+
+ //! \hideinitializer A positive integer overflow occurred (rounding down).
+ V_GT_SUP = V_GT | V_OVERFLOW,
+
+ //! \hideinitializer A positive integer overflow occurred (rounding up).
+ V_LT_PLUS_INFINITY = V_LT | VC_PLUS_INFINITY,
+
+ //! \hideinitializer A negative integer overflow occurred (rounding down).
+ V_GT_MINUS_INFINITY = V_GT | VC_MINUS_INFINITY,
+
+ //! \hideinitializer Negative infinity result.
+ V_EQ_MINUS_INFINITY = V_EQ | VC_MINUS_INFINITY,
+
+ //! \hideinitializer Positive infinity result.
+ V_EQ_PLUS_INFINITY = V_EQ | VC_PLUS_INFINITY,
+
+ //! \hideinitializer Not a number result.
+ V_NAN = VC_NAN,
+
+ //! \hideinitializer Converting from unknown string.
+ V_CVT_STR_UNK = V_NAN | (1 << 8),
+
+ //! \hideinitializer Dividing by zero.
+ V_DIV_ZERO = V_NAN | (2 << 8),
+
+ //! \hideinitializer Adding two infinities having opposite signs.
+ V_INF_ADD_INF = V_NAN | (3 << 8),
+
+ //! \hideinitializer Dividing two infinities.
+ V_INF_DIV_INF = V_NAN | (4 << 8),
+
+ //! \hideinitializer Taking the modulus of an infinity.
+ V_INF_MOD = V_NAN | (5 << 8),
+
+ //! \hideinitializer Multiplying an infinity by zero.
+ V_INF_MUL_ZERO = V_NAN | (6 << 8),
+
+ //! \hideinitializer Subtracting two infinities having the same sign.
+ V_INF_SUB_INF = V_NAN | (7 << 8),
+
+ //! \hideinitializer Computing a remainder modulo zero.
+ V_MOD_ZERO = V_NAN | (8 << 8),
+
+ //! \hideinitializer Taking the square root of a negative number.
+ V_SQRT_NEG = V_NAN | (9 << 8),
+
+ //! \hideinitializer Unknown result due to intermediate negative overflow.
+ V_UNKNOWN_NEG_OVERFLOW = V_NAN | (10 << 8),
+
+ //! \hideinitializer Unknown result due to intermediate positive overflow.
+ V_UNKNOWN_POS_OVERFLOW = V_NAN | (11 << 8),
+
+ //! \hideinitializer The computed result is not representable.
+ V_UNREPRESENTABLE = 1 << 7
+
+};
+
+//! Extracts the value class part of \p r (representable number, unrepresentable minus/plus infinity or nan).
+Result_Class result_class(Result r);
+
+//! Extracts the relation part of \p r.
+Result_Relation result_relation(Result r);
+
+} // namespace Parma_Polyhedra_Library
+
+#include "Result.inlines.hh"
+
+#endif // !defined(PPL_Result_defs_hh)