Add strict flag to Conv attributes alloweing to mark those Conv's

[libfirm] / ir / tv / fltcalc.h

diff --git a/ir/tv/fltcalc.h b/ir/tv/fltcalc.h
index 448ccd7..8bee8a4 100644 (file)
--- a/ir/tv/fltcalc.h
+++ b/ir/tv/fltcalc.h
@@ -13,7 +13,7 @@
 #ifndef _FLTCALC_H_
 #define _FLTCALC_H_
 
-#include <config.h>
+#include "firm_config.h"
 
 #ifdef HAVE_LONG_DOUBLE
 /* XXX Set this via autoconf */
@@ -30,22 +30,22 @@ typedef enum {
   FC_div,   /**< divide */
   FC_neg,   /**< negate */
   FC_int,   /**< truncate to integer */
-  FC_rnd,   /**< round to integer */
+  FC_rnd   /**< round to integer */
 } fc_op_t;
 
 enum {
   FC_DEC,
   FC_HEX,
   FC_BIN,
-  FC_PACKED,
+  FC_PACKED
 };
 
-/* rounding modes */
+/** IEEE-754 Rounding modes. */
 typedef enum {
-  FC_TONEAREST,
-  FC_TOPOSITIVE,
-  FC_TONEGATIVE,
-  FC_TOZERO,
+  FC_TONEAREST,   /**< if unsure, to the nearest even */
+  FC_TOPOSITIVE,  /**< to +oo */
+  FC_TONEGATIVE,  /**< to -oo */
+  FC_TOZERO       /**< to 0 */
 } fc_rounding_mode_t;
 
 #define FC_DEFAULT_PRECISION 64
@@ -61,7 +61,7 @@ typedef enum {
  * returns the size of this buffer
  */
 const void *fc_get_buffer(void);
-const int fc_get_buffer_length(void);
+int fc_get_buffer_length(void);
 /*}@*/
 
 char* fc_val_from_str(const char *str, unsigned int len, char exp_size, char mant_size, char *result);
@@ -69,7 +69,7 @@ char* fc_val_from_str(const char *str, unsigned int len, char exp_size, char man
 /** get the representation of a floating point value
  * This function tries to builds a representation having the same value as the
  * float number passed.
- * If the wished precision is less than the precicion of LLDBL the value built
+ * If the wished precision is less than the precision of LLDBL the value built
  * will be rounded. Therefore only an approximation of the passed float can be
  * expected in this case.
  *
@@ -136,7 +136,7 @@ char* fc_get_snan(unsigned int exponent_size, unsigned int mantissa_size, char*
 char* fc_get_qnan(unsigned int exponent_size, unsigned int mantissa_size, char* result);
 char* fc_get_plusinf(unsigned int exponent_size, unsigned int mantissa_size, char* result);
 char* fc_get_minusinf(unsigned int exponent_size, unsigned int mantissa_size, char* result);
-/*}@*/
+/*@}*/
 
 int fc_is_zero(const void *a);
 int fc_is_negative(const void *a);
@@ -173,8 +173,8 @@ int fc_comp(const void *a, const void *b);
  * FC_TONEAREST (default):
  *    Any unrepresentable value is rounded to the nearest representable
  *    value. If it lies in the middle the value with the least significant
- *    bit of zero is chosen.
- *    Values too big to represent will round to +-infinity.
+ *    bit of zero is chosen (the even one).
+ *    Values too big to represent will round to +/-infinity.
  * FC_TONEGATIVE
  *    Any unrepresentable value is rounded towards negative infinity.
  *    Positive values too big to represent will round to the biggest
@@ -191,7 +191,7 @@ int fc_comp(const void *a, const void *b);
  *    Values too big to represent will round to the biggest/smallest
  *    representable value.
  *
- * These modes correspond to the modes required by the ieee standard.
+ * These modes correspond to the modes required by the IEEE-754 standard.
  *
  * @param mode The new rounding mode. Any value other than the four
  *        defined values will have no effect.
@@ -212,20 +212,20 @@ fc_rounding_mode_t fc_get_rounding_mode(void);
 
 /** Get bit representation of a value
  * This function allows to read a value in encoded form, bytewise.
- * The value will be packed corresponding to the way used by the ieee
+ * The value will be packed corresponding to the way used by the IEEE
  * encoding formats, i.e.
  *        One bit   sign
  *   exp_size bits  exponent + bias
  *  mant_size bits  mantissa, without leading 1
  *
- * As in ieee, an exponent of 0 indicates a denormalized number, which
+ * As in IEEE, an exponent of 0 indicates a denormalized number, which
  * implies a most significant bit of zero instead of one; an exponent
  * of all ones (2**exp_size - 1) encodes infinity if the mantissa is
- * all zeroes, else Not A Number.
+ * all zeros, else Not A Number.
  *
  * @param val A pointer to the value. If NULL is passed a copy of the
  *        most recent value passed to this function is used, saving the
- *        packing step. This behaviour may be changed in the future.
+ *        packing step. This behavior may be changed in the future.
  * @param num_bit The maximum number of bits to return. Any bit beyond
  *        num_bit will be returned as zero.
  * @param byte_ofs The byte index to read, 0 is the least significant
@@ -235,4 +235,6 @@ fc_rounding_mode_t fc_get_rounding_mode(void);
 unsigned char fc_sub_bits(const void *val, unsigned num_bit, unsigned byte_ofs);
 
 void init_fltcalc(int precision);
+void finish_fltcalc (void);
+
 #endif /* _FLTCALC_H_ */