qofnumeric.h

Go to the documentation of this file.

/********************************************************************
 * qofnumeric.h - A rational number library                         *
 * This program 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 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
 *******************************************************************/

#ifndef QOF_NUMERIC_H
#define QOF_NUMERIC_H

struct _QofNumeric
{
    gint64 num;
    gint64 denom;
};

typedef struct _QofNumeric QofNumeric;

#define QOF_NUMERIC_RND_MASK     0x0000000f
#define QOF_NUMERIC_DENOM_MASK   0x000000f0
#define QOF_NUMERIC_SIGFIGS_MASK 0x0000ff00

enum
{
    QOF_HOW_RND_FLOOR = 0x01,

    QOF_HOW_RND_CEIL = 0x02,

    QOF_HOW_RND_TRUNC = 0x03,

    QOF_HOW_RND_PROMOTE = 0x04,

    QOF_HOW_RND_ROUND_HALF_DOWN = 0x05,

    QOF_HOW_RND_ROUND_HALF_UP = 0x06,

    QOF_HOW_RND_ROUND = 0x07,

    QOF_HOW_RND_NEVER = 0x08
};

enum
{
    QOF_HOW_DENOM_EXACT = 0x10,

    QOF_HOW_DENOM_REDUCE = 0x20,

    QOF_HOW_DENOM_LCD = 0x30,

    QOF_HOW_DENOM_FIXED = 0x40,

    QOF_HOW_DENOM_SIGFIG = 0x50
};

#define QOF_HOW_DENOM_SIGFIGS( n ) ( ((( n ) & 0xff) << 8) | QOF_HOW_DENOM_SIGFIG)
#define QOF_HOW_GET_SIGFIGS( a ) ( (( a ) & 0xff00 ) >> 8)

typedef enum
{
    QOF_ERROR_OK = 0,      
    QOF_ERROR_ARG = -1,    
    QOF_ERROR_OVERFLOW = -2,   
    QOF_ERROR_DENOM_DIFF = -3,

    QOF_ERROR_REMAINDER = -4
} QofNumericErrorCode;


#define QOF_DENOM_AUTO 0

#define QOF_DENOM_RECIPROCAL( a ) (- ( a ))

static inline QofNumeric
qof_numeric_create (gint64 num, gint64 denom)
{
    QofNumeric out;
    out.num = num;
    out.denom = denom;
    return out;
}

static inline QofNumeric
qof_numeric_zero (void)
{
    return qof_numeric_create (0, 1);
}

QofNumeric
qof_numeric_from_double (gdouble in, gint64 denom, gint how);

gboolean
qof_numeric_from_string (const gchar * str, QofNumeric * n);

QofNumeric
qof_numeric_error (QofNumericErrorCode error_code);
static inline gint64
qof_numeric_num (QofNumeric a)
{
    return a.num;
}

static inline gint64
qof_numeric_denom (QofNumeric a)
{
    return a.denom;
}

gdouble
qof_numeric_to_double (QofNumeric in);

gchar *
qof_numeric_to_string (QofNumeric n);

gchar *
qof_numeric_dbg_to_string (QofNumeric n);
QofNumericErrorCode
qof_numeric_check (QofNumeric a);

gint 
qof_numeric_compare (QofNumeric a, QofNumeric b);

gboolean 
qof_numeric_zero_p (QofNumeric a);

gboolean 
qof_numeric_negative_p (QofNumeric a);

gboolean 
qof_numeric_positive_p (QofNumeric a);

gboolean 
qof_numeric_eq (QofNumeric a, QofNumeric b);

gboolean 
qof_numeric_equal (QofNumeric a, QofNumeric b);

gint 
qof_numeric_same (QofNumeric a, QofNumeric b, gint64 denom, gint how);
QofNumeric 
qof_numeric_add (QofNumeric a, QofNumeric b,
                             gint64 denom, gint how);

QofNumeric 
qof_numeric_sub (QofNumeric a, QofNumeric b,
                             gint64 denom, gint how);

QofNumeric 
qof_numeric_mul (QofNumeric a, QofNumeric b,
                             gint64 denom, gint how);

QofNumeric 
qof_numeric_div (QofNumeric x, QofNumeric y,
                             gint64 denom, gint how);
QofNumeric 
qof_numeric_neg (QofNumeric a);

QofNumeric 
qof_numeric_abs (QofNumeric a);

static inline QofNumeric
qof_numeric_add_fixed (QofNumeric a, QofNumeric b)
{
    return qof_numeric_add (a, b, QOF_DENOM_AUTO,
                QOF_HOW_DENOM_FIXED | QOF_HOW_RND_NEVER);
}

static inline QofNumeric
qof_numeric_sub_fixed (QofNumeric a, QofNumeric b)
{
    return qof_numeric_sub (a, b, QOF_DENOM_AUTO,
                QOF_HOW_DENOM_FIXED | QOF_HOW_RND_NEVER);
}

QofNumeric 
qof_numeric_add_with_error (QofNumeric a, QofNumeric b,
                                        gint64 denom, gint how,
                    QofNumeric * error);

QofNumeric 
qof_numeric_sub_with_error (QofNumeric a, QofNumeric b,
                                        gint64 denom, gint how,
                    QofNumeric * error);

QofNumeric 
qof_numeric_mul_with_error (QofNumeric a, QofNumeric b,
                                        gint64 denom, gint how,
                    QofNumeric * error);

QofNumeric 
qof_numeric_div_with_error (QofNumeric a, QofNumeric b,
                                        gint64 denom, gint how,
                    QofNumeric * error);
QofNumeric 
qof_numeric_convert (QofNumeric in, gint64 denom, gint how);

QofNumeric 
qof_numeric_convert_with_error (QofNumeric in, gint64 denom,
                                gint how, QofNumeric * error);

QofNumeric qof_numeric_reduce (QofNumeric in);
#define QOF_RND_FLOOR           QOF_HOW_RND_FLOOR
#define QOF_RND_CEIL            QOF_HOW_RND_CEIL
#define QOF_RND_TRUNC           QOF_HOW_RND_TRUNC
#define QOF_RND_PROMOTE         QOF_HOW_RND_PROMOTE
#define QOF_RND_ROUND_HALF_DOWN QOF_HOW_RND_ROUND_HALF_DOWN
#define QOF_RND_ROUND_HALF_UP   QOF_HOW_RND_ROUND_HALF_UP
#define QOF_RND_ROUND           QOF_HOW_RND_ROUND
#define QOF_RND_NEVER           QOF_HOW_RND_NEVER

#define QOF_DENOM_EXACT         QOF_HOW_DENOM_EXACT
#define QOF_DENOM_REDUCE        QOF_HOW_DENOM_REDUCE
#define QOF_DENOM_LCD           QOF_HOW_DENOM_LCD
#define QOF_DENOM_FIXED         QOF_HOW_DENOM_FIXED
#define QOF_DENOM_SIGFIG        QOF_HOW_DENOM_SIGFIG

#define QOF_DENOM_SIGFIGS(X)    QOF_HOW_DENOM_SIGFIGS(X)
#define QOF_NUMERIC_GET_SIGFIGS(X) QOF_HOW_GET_SIGFIGS(X)

#endif

---