improved doxygen comments

[libfirm] / include / libfirm / tv.h

diff --git a/include/libfirm/tv.h b/include/libfirm/tv.h
index f1ddb0d..a92175d 100644 (file)
--- a/include/libfirm/tv.h
+++ b/include/libfirm/tv.h
@@ -250,6 +250,18 @@ int tarval_is_null(tarval *a);
  */
 int tarval_is_one(tarval *a);
 
+/**
+ * Returns 1 if tv is the "minus one"
+ *
+ * @param a the tarval
+ */
+int tarval_is_minus_one(tarval *a);
+
+/*
+ * returns non-zero if all bits in the tarval are set
+ */
+int tarval_is_all_one(tarval *tv);
+
 /** The 'bad' tarval. */
 extern tarval *tarval_bad;
 /** Returns the 'bad tarval. */
@@ -294,6 +306,10 @@ tarval *get_tarval_one(ir_mode *mode);
  *  Returns tarval bad for unsigned modes */
 tarval *get_tarval_minus_one(ir_mode *mode);
 
+/** returns the value where all bits are 1 of a given mode.
+ * returns tarval_bad for float modes */
+tarval *get_tarval_all_one(ir_mode *mode);
+
 /** Return quite nan for float_number modes. */
 tarval *get_tarval_nan(ir_mode *mode);
 
@@ -552,29 +568,6 @@ char *get_tarval_bitpattern(tarval *tv);
  */
 unsigned char get_tarval_sub_bits(tarval *tv, unsigned byte_ofs);
 
-/**
- * Return values of tarval classify
- */
-typedef enum _tarval_classification_t {
-  TV_CLASSIFY_NULL    =  0, /**< the tarval represents the additive neutral element */
-  TV_CLASSIFY_ONE     = +1, /**< the tarval represents the multiplicative neutral element */
-  TV_CLASSIFY_ALL_ONE = -1, /**< the tarval represents the bitwise-and neutral element */
-  TV_CLASSIFY_OTHER   =  2  /**< all other tarvals */
-} tarval_classification_t;
-
-/**
- * Identifying tarvals values for algebraic simplifications.
- *
- * @param tv        the tarval
- *
- * @return
- *   - TV_CLASSIFY_NULL    for additive neutral or the NULL tarval for reference modes,
- *   - TV_CLASSIFY_ONE     for multiplicative neutral,
- *   - TV_CLASSIFY_ALL_ONE for bitwise-and neutral
- *   - TV_CLASSIFY_OTHER   else
- */
-tarval_classification_t classify_tarval(tarval *tv);
-
 /**
  * Returns non-zero if a given (integer) tarval has only one single bit
  * set.
@@ -622,4 +615,24 @@ unsigned tarval_ieee754_get_exact(void);
  */
 int tarval_enable_fp_ops(int enable);
 
+/**
+ * Check if its the a floating point NaN.
+ */
+int tarval_is_NaN(tarval *tv);
+
+/**
+ * Check if its the a floating point +inf.
+ */
+int tarval_is_plus_inf(tarval *tv);
+
+/**
+ * Check if its the a floating point -inf.
+ */
+int tarval_is_minus_inf(tarval *tv);
+
+/**
+ * Check if the tarval represents a finite value, ie neither NaN nor inf.
+ */
+int tarval_is_finite(tarval *tv);
+
 #endif  /* FIRM_TV_TV_H */