fixmath.h

Go to the documentation of this file.

/*  Copyright (C) 2005-2011, Axis Communications AB, LUND, SWEDEN
 *
 *  This file is part of Fixmath.
 *
 *  Fixmath is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *  You can use the comments under either the terms of the GNU Lesser General
 *  Public License version 3 as published by the Free Software Foundation,
 *  either version 3 of the License or (at your option) any later version, or
 *  the GNU Free Documentation License version 1.3 or any later version
 *  published by the Free Software Foundation; with no Invariant Sections, no
 *  Front-Cover Texts, and no Back-Cover Texts.
 *  A copy of the license is included in the documentation section entitled
 *  "GNU Free Documentation License".
 *
 *  Fixmath 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License and a copy of the GNU Free Documentation License along
 *  with Fixmath. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef FIXMATH_H
#define FIXMATH_H

#include <stdint.h>         /* Fixed-size integers           */
#include "fixmath_arch.h"   /* Platform-specific definitions */
#include "fixmath_export.h" /* Win32 DLL function visibility */

#ifdef __cplusplus
extern "C" {
#endif

/*
 * -------------------------------------------------------------
 *  Type definitions
 * -------------------------------------------------------------
 */

typedef int32_t fixed_t;

typedef struct {
    int32_t mant;
    int     expn;
} fx_rdiv_t;


/*
 * -------------------------------------------------------------
 *  Bit manipulation functions
 * -------------------------------------------------------------
 */

#ifndef fx_clz
FX_EXPORT int
fx_clz(uint32_t word);
#endif /* !fx_clz */

#ifndef fx_ctz
FX_EXPORT int
fx_ctz(uint32_t word);
#endif /* !fx_ctz */

#ifndef fx_bitcount
FX_EXPORT int
fx_bitcount(uint32_t word);
#endif /* !fx_bitcount */


/*
 * -------------------------------------------------------------
 *  Fixed-point arithmetic and conversions
 * -------------------------------------------------------------
 */

FX_EXPORT fixed_t
fx_itox(int32_t ival, unsigned frac);

FX_EXPORT fixed_t
fx_ftox(float fval, unsigned frac);

FX_EXPORT fixed_t
fx_dtox(double dval, unsigned frac);

FX_EXPORT fixed_t
fx_xtox(fixed_t xval, unsigned frac1, unsigned frac2);

FX_EXPORT int32_t
fx_xtoi(fixed_t xval, unsigned frac);

FX_EXPORT float
fx_xtof(fixed_t xval, unsigned frac);

FX_EXPORT double
fx_xtod(fixed_t xval, unsigned frac);

FX_EXPORT int32_t
fx_roundx(fixed_t xval, unsigned frac);

FX_EXPORT int32_t
fx_ceilx(fixed_t xval, unsigned frac);

FX_EXPORT int32_t
fx_floorx(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_addx(fixed_t x1, fixed_t x2);

FX_EXPORT fixed_t
fx_subx(fixed_t x1, fixed_t x2);

FX_EXPORT fixed_t
fx_mulx(fixed_t x1, fixed_t x2, unsigned frac);

FX_EXPORT fixed_t
fx_divx(fixed_t x1, fixed_t x2, unsigned frac);

FX_EXPORT fixed_t
fx_rdivx(fixed_t xval, const fx_rdiv_t *rdiv);


/*
 * -------------------------------------------------------------
 *  String conversion functions
 * -------------------------------------------------------------
 */

FX_EXPORT int
fx_itoa(char *str, int32_t val);

FX_EXPORT int
fx_xtoa(char *str, fixed_t xval, unsigned frac, unsigned digits);


/*
 * -------------------------------------------------------------
 *  Algebraic functions
 * -------------------------------------------------------------
 */

FX_EXPORT fixed_t
fx_invx(fixed_t xval, unsigned frac, fx_rdiv_t *rdiv);

FX_EXPORT fixed_t
fx_sqrtx(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_isqrtx(fixed_t xval, unsigned frac, fx_rdiv_t *rdiv);


/*
 * -------------------------------------------------------------
 *  Transcendental functions
 * -------------------------------------------------------------
 */

FX_EXPORT fixed_t
fx_expx(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_exp2x(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_exp10x(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_logx(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_log2x(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_log10x(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_powx(fixed_t xval, unsigned xfrac, fixed_t yval, unsigned yfrac);

FX_EXPORT fixed_t
fx_sinx(fixed_t xval, unsigned frac);

FX_EXPORT fixed_t
fx_cosx(fixed_t xval, unsigned frac);


#include "fixmath_impl.h"  /* Internal implementations */
#include "fixmath_macro.h" /* Macro overrides          */

#ifdef __cplusplus
};
#endif

#endif /* FIXMATH_H */