/*
- * Project: libFIRM
- * File name: ir/tv/fltcalc.h
- * Purpose:
- * Author:
- * Modified by:
- * Created: 2003
- * CVS-ID: $Id$
- * Copyright: (c) 2003 Universität Karlsruhe
- * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
*/
-#ifndef _FLTCALC_H_
-#define _FLTCALC_H_
+/**
+ * @file
+ * @brief tarval floating point calculations
+ * @date 2003
+ * @author Mathias Heil
+ * @version $Id$
+ */
+#ifndef FIRM_TV_FLTCALC_H
+#define FIRM_TV_FLTCALC_H
#include "firm_config.h"
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_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
-#define FC_DECLARE1(code) char* fc_##code(const void *a, void *result)
-#define FC_DECLARE2(code) char* fc_##code(const void *a, const void *b, void *result)
-
/*@{*/
/** internal buffer access
* All functions that accept NULL as return buffer put their result into an
* 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);
+char *fc_val_from_str(const char *str, unsigned int len, char exp_size, char mant_size, char *result);
/** get the representation of a floating point value
* This function tries to builds a representation having the same value as the
* @return The result pointer passed to the function. If this was NULL this returns
* a pointer to the internal accumulator buffer
*/
-char* fc_val_from_float(LLDBL l, char exp_size, char mant_size, char *result);
+char *fc_val_from_float(LLDBL l, char exp_size, char mant_size, char *result);
/** retrieve the float value of an internal value
* This function casts the internal value to LLDBL and returns a LLDBL with
* @return The result pointer passed to the function. If this was NULL this returns
* a pointer to the internal accumulator buffer
*/
-char* fc_cast(const void *val, char exp_size, char mant_size, char *result);
+char *fc_cast(const void *val, char exp_size, char mant_size, char *result);
/*@{*/
/** build a special float value
* @return The result pointer passed to the function. If this was NULL this returns
* a pointer to the internal accumulator buffer
*/
-char* fc_get_min(unsigned int exponent_size, unsigned int mantissa_size, char* result);
-char* fc_get_max(unsigned int exponent_size, unsigned int mantissa_size, char* result);
-char* fc_get_snan(unsigned int exponent_size, unsigned int mantissa_size, char* result);
-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);
+char *fc_get_min(unsigned int exponent_size, unsigned int mantissa_size, char* result);
+char *fc_get_max(unsigned int exponent_size, unsigned int mantissa_size, char* result);
+char *fc_get_snan(unsigned int exponent_size, unsigned int mantissa_size, char* result);
+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_nan(const void *a);
int fc_is_subnormal(const void *a);
-FC_DECLARE2(add);
-FC_DECLARE2(sub);
-FC_DECLARE2(mul);
-FC_DECLARE2(div);
-FC_DECLARE1(neg);
-FC_DECLARE1(int);
-FC_DECLARE1(rnd);
+char *fc_add(const void *a, const void *b, void *result);
+char *fc_sub(const void *a, const void *b, void *result);
+char *fc_mul(const void *a, const void *b, void *result);
+char *fc_div(const void *a, const void *b, void *result);
+char *fc_neg(const void *a, void *result);
+char *fc_int(const void *a, void *result);
+char *fc_rnd(const void *a, void *result);
char *fc_print(const void *a, char *buf, int buflen, unsigned base);
* 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
* 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.
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.
+ * This function allows to read a value in encoded form, byte wise.
* The value will be packed corresponding to the way used by the IEEE
* encoding formats, i.e.
* One bit sign
unsigned char fc_sub_bits(const void *val, unsigned num_bit, unsigned byte_ofs);
void init_fltcalc(int precision);
-void finish_fltcalc (void);
+void finish_fltcalc(void);
-#endif /* _FLTCALC_H_ */
+#endif /* FIRM_TV_FLTCALC_H */
projects / libfirm / blobdiff