numeric.h File Reference

#include "fmgr.h"

Include dependency graph for numeric.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	NUMERIC_MAX_PRECISION   1000
#define	NUMERIC_MAX_DISPLAY_SCALE   NUMERIC_MAX_PRECISION
#define	NUMERIC_MIN_DISPLAY_SCALE   0
#define	NUMERIC_MAX_RESULT_SCALE   (NUMERIC_MAX_PRECISION * 2)
#define	NUMERIC_MIN_SIG_DIGITS   16
#define	DatumGetNumeric(X)   ((Numeric) PG_DETOAST_DATUM(X))
#define	DatumGetNumericCopy(X)   ((Numeric) PG_DETOAST_DATUM_COPY(X))
#define	NumericGetDatum(X)   PointerGetDatum(X)
#define	PG_GETARG_NUMERIC(n)   DatumGetNumeric(PG_GETARG_DATUM(n))
#define	PG_GETARG_NUMERIC_COPY(n)   DatumGetNumericCopy(PG_GETARG_DATUM(n))
#define	PG_RETURN_NUMERIC(x)   return NumericGetDatum(x)

Typedefs
typedef struct NumericData *	Numeric

Functions
bool	numeric_is_nan (Numeric num)
int32	numeric_maximum_size (int32 typmod)
char *	numeric_out_sci (Numeric num, int scale)
char *	numeric_normalize (Numeric num)
Numeric	numeric_add_opt_error (Numeric num1, Numeric num2, bool *have_error)
Numeric	numeric_sub_opt_error (Numeric num1, Numeric num2, bool *have_error)
Numeric	numeric_mul_opt_error (Numeric num1, Numeric num2, bool *have_error)
Numeric	numeric_div_opt_error (Numeric num1, Numeric num2, bool *have_error)
Numeric	numeric_mod_opt_error (Numeric num1, Numeric num2, bool *have_error)
int32	numeric_int4_opt_error (Numeric num, bool *error)

Macro Definition Documentation

DatumGetNumeric

#define DatumGetNumeric

(

X

)

((Numeric) PG_DETOAST_DATUM(X))

Definition at line 49 of file numeric.h.

Referenced by datum_to_jsonb(), executeItemOptUnwrapTarget(), executeKeyValueMethod(), executeNumericItemMethod(), executeUnaryArithmExpr(), gbt_numeric_consistent(), gbt_numeric_penalty(), getArrayIndex(), hstore_to_jsonb_loose(), int2_accum(), int2_accum_inv(), int4_accum(), int4_accum_inv(), int64_to_numeric(), int8_accum(), int8_accum_inv(), int8_avg_accum(), int8_avg_accum_inv(), int8_avg_deserialize(), int8_to_char(), jsonb_agg_transfn(), jsonb_in_scalar(), jsonb_object_agg_transfn(), numeric_absolute(), numeric_avg_deserialize(), numeric_deserialize(), numeric_fast_cmp(), numeric_half_rounded(), numeric_poly_deserialize(), numeric_shift_right(), numeric_to_char(), numeric_to_number(), pg_size_bytes(), PLyNumber_ToJsonbValue(), and SV_to_JsonbValue().

DatumGetNumericCopy

#define DatumGetNumericCopy

(

X

)

((Numeric) PG_DETOAST_DATUM_COPY(X))

Definition at line 50 of file numeric.h.

Referenced by jsonb_numeric().

NUMERIC_MAX_DISPLAY_SCALE

#define NUMERIC_MAX_DISPLAY_SCALE   NUMERIC_MAX_PRECISION

Definition at line 29 of file numeric.h.

Referenced by log_var(), numeric_exp(), numeric_ln(), numeric_sqrt(), power_var(), power_var_int(), and select_div_scale().

NUMERIC_MAX_PRECISION

#define NUMERIC_MAX_PRECISION   1000

Definition at line 24 of file numeric.h.

Referenced by numerictypmodin().

NUMERIC_MAX_RESULT_SCALE

#define NUMERIC_MAX_RESULT_SCALE   (NUMERIC_MAX_PRECISION * 2)

Definition at line 32 of file numeric.h.

Referenced by exp_var(), numeric_exp(), numeric_round(), numeric_trunc(), and power_var().

NUMERIC_MIN_DISPLAY_SCALE

#define NUMERIC_MIN_DISPLAY_SCALE   0

Definition at line 30 of file numeric.h.

Referenced by exp_var(), ln_var(), log_var(), numeric_exp(), numeric_ln(), numeric_sqrt(), power_var(), power_var_int(), and select_div_scale().

NUMERIC_MIN_SIG_DIGITS

#define NUMERIC_MIN_SIG_DIGITS   16

Definition at line 39 of file numeric.h.

Referenced by log_var(), numeric_exp(), numeric_ln(), numeric_sqrt(), power_var(), and select_div_scale().

NumericGetDatum

#define NumericGetDatum

(

X

)

PointerGetDatum(X)

Definition at line 51 of file numeric.h.

Referenced by compareNumeric(), executeItemOptUnwrapTarget(), executeNumericItemMethod(), executeUnaryArithmExpr(), gbt_numeric_penalty(), generate_series_step_numeric(), getArrayIndex(), gin_numeric_cmp(), int8_avg_serialize(), int8_sum(), iterate_jsonb_values(), jsonb_agg_transfn(), jsonb_float4(), jsonb_float8(), jsonb_int2(), jsonb_int4(), jsonb_int8(), jsonb_numeric(), jsonb_object_agg_transfn(), JsonbHashScalarValue(), JsonbHashScalarValueExtended(), JsonbValue_to_SV(), numeric_absolute(), numeric_avg(), numeric_avg_serialize(), numeric_float4(), numeric_float8(), numeric_half_rounded(), numeric_is_less(), numeric_poly_avg(), numeric_poly_serialize(), numeric_serialize(), numeric_shift_right(), numeric_to_char(), numeric_to_cstring(), numeric_to_double_no_overflow(), numeric_to_number(), pg_size_bytes(), PLyObject_FromJsonbValue(), and printJsonPathItem().

PG_GETARG_NUMERIC

#define PG_GETARG_NUMERIC

(

n

)

DatumGetNumeric(PG_GETARG_DATUM(n))

Definition at line 52 of file numeric.h.

Referenced by generate_series_step_numeric(), hash_numeric(), hash_numeric_extended(), in_range_numeric_numeric(), int8_sum(), numeric(), numeric_abs(), numeric_accum(), numeric_accum_inv(), numeric_add(), numeric_avg_accum(), numeric_ceil(), numeric_cmp(), numeric_div(), numeric_div_trunc(), numeric_eq(), numeric_exp(), numeric_float4(), numeric_float8(), numeric_float8_no_overflow(), numeric_floor(), numeric_gcd(), numeric_ge(), numeric_gt(), numeric_inc(), numeric_int2(), numeric_int4(), numeric_int8(), numeric_larger(), numeric_lcm(), numeric_le(), numeric_ln(), numeric_log(), numeric_lt(), numeric_min_scale(), numeric_mod(), numeric_mul(), numeric_ne(), numeric_out(), numeric_power(), numeric_round(), numeric_scale(), numeric_send(), numeric_sign(), numeric_smaller(), numeric_sqrt(), numeric_sub(), numeric_to_char(), numeric_trim_scale(), numeric_trunc(), numeric_uminus(), numeric_uplus(), pg_size_pretty_numeric(), and width_bucket_numeric().

PG_GETARG_NUMERIC_COPY

#define PG_GETARG_NUMERIC_COPY

(

n

)

DatumGetNumericCopy(PG_GETARG_DATUM(n))

Definition at line 53 of file numeric.h.

PG_RETURN_NUMERIC

#define PG_RETURN_NUMERIC

(

x

)

return NumericGetDatum(x)

Definition at line 54 of file numeric.h.

Referenced by float4_numeric(), float8_numeric(), int2_numeric(), int4_numeric(), int8_numeric(), int8_sum(), jsonb_numeric(), numeric(), numeric_abs(), numeric_add(), numeric_avg(), numeric_ceil(), numeric_div(), numeric_div_trunc(), numeric_exp(), numeric_fac(), numeric_floor(), numeric_gcd(), numeric_in(), numeric_inc(), numeric_larger(), numeric_lcm(), numeric_ln(), numeric_log(), numeric_mod(), numeric_mul(), numeric_poly_stddev_pop(), numeric_poly_stddev_samp(), numeric_poly_sum(), numeric_poly_var_pop(), numeric_poly_var_samp(), numeric_power(), numeric_recv(), numeric_round(), numeric_sign(), numeric_smaller(), numeric_sqrt(), numeric_stddev_pop(), numeric_stddev_samp(), numeric_sub(), numeric_sum(), numeric_trim_scale(), numeric_trunc(), numeric_uminus(), numeric_uplus(), numeric_var_pop(), numeric_var_samp(), and pg_wal_lsn_diff().

Typedef Documentation

Numeric

typedef struct NumericData* Numeric

Definition at line 43 of file numeric.h.

Function Documentation

numeric_add_opt_error()

Numeric numeric_add_opt_error	(	Numeric	num1,
		Numeric	num2,
		bool *	have_error
	)

Definition at line 2430 of file numeric.c.

References add_var(), free_var(), init_var, init_var_from_num(), make_result(), make_result_opt_error(), and NUMERIC_IS_NAN.

Referenced by executeItemOptUnwrapTarget(), and numeric_add().

{
    NumericVar  arg1;
    NumericVar  arg2;
    NumericVar  result;
    Numeric     res;

    /*
     * Handle NaN
     */
    if (NUMERIC_IS_NAN(num1) || NUMERIC_IS_NAN(num2))
        return make_result(&const_nan);

    /*
     * Unpack the values, let add_var() compute the result and return it.
     */
    init_var_from_num(num1, &arg1);
    init_var_from_num(num2, &arg2);

    init_var(&result);
    add_var(&arg1, &arg2, &result);

    res = make_result_opt_error(&result, have_error);

    free_var(&result);

    return res;
}

numeric_div_opt_error()

Numeric numeric_div_opt_error	(	Numeric	num1,
		Numeric	num2,
		bool *	have_error
	)

Definition at line 2602 of file numeric.c.

References NumericVar::digits, div_var(), free_var(), init_var, init_var_from_num(), make_result(), make_result_opt_error(), NumericVar::ndigits, NUMERIC_IS_NAN, and select_div_scale().

Referenced by executeItemOptUnwrapTarget(), and numeric_div().

{
    NumericVar  arg1;
    NumericVar  arg2;
    NumericVar  result;
    Numeric     res;
    int         rscale;

    if (have_error)
        *have_error = false;

    /*
     * Handle NaN
     */
    if (NUMERIC_IS_NAN(num1) || NUMERIC_IS_NAN(num2))
        return make_result(&const_nan);

    /*
     * Unpack the arguments
     */
    init_var_from_num(num1, &arg1);
    init_var_from_num(num2, &arg2);

    init_var(&result);

    /*
     * Select scale for division result
     */
    rscale = select_div_scale(&arg1, &arg2);

    /*
     * If "have_error" is provided, check for division by zero here
     */
    if (have_error && (arg2.ndigits == 0 || arg2.digits[0] == 0))
    {
        *have_error = true;
        return NULL;
    }

    /*
     * Do the divide and return the result
     */
    div_var(&arg1, &arg2, &result, rscale, true);

    res = make_result_opt_error(&result, have_error);

    free_var(&result);

    return res;
}

numeric_int4_opt_error()

int32 numeric_int4_opt_error	(	Numeric	num,
		bool *	error
	)

Definition at line 3405 of file numeric.c.

References ereport, errcode(), errmsg(), ERROR, init_var_from_num(), NUMERIC_IS_NAN, and numericvar_to_int32().

Referenced by getArrayIndex(), and numeric_int4().

{
    NumericVar  x;
    int32       result;

    if (have_error)
        *have_error = false;

    /* XXX would it be better to return NULL? */
    if (NUMERIC_IS_NAN(num))
    {
        if (have_error)
        {
            *have_error = true;
            return 0;
        }
        else
        {
            ereport(ERROR,
                    (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
                     errmsg("cannot convert NaN to integer")));
        }
    }

    /* Convert to variable format, then convert to int4 */
    init_var_from_num(num, &x);

    if (!numericvar_to_int32(&x, &result))
    {
        if (have_error)
        {
            *have_error = true;
            return 0;
        }
        else
        {
            ereport(ERROR,
                    (errcode(ERRCODE_NUMERIC_VALUE_OUT_OF_RANGE),
                     errmsg("integer out of range")));
        }
    }

    return result;
}

numeric_is_nan()

bool numeric_is_nan

(

Numeric

num

)

Definition at line 685 of file numeric.c.

References NUMERIC_IS_NAN.

Referenced by convertJsonbScalar(), gbt_numeric_penalty(), and PLyNumber_ToJsonbValue().

{
    return NUMERIC_IS_NAN(num);
}

numeric_maximum_size()

int32 numeric_maximum_size

(

int32

typmod

)

Definition at line 696 of file numeric.c.

References DEC_DIGITS, NUMERIC_HDRSZ, and VARHDRSZ.

Referenced by type_maximum_size().

{
    int         precision;
    int         numeric_digits;

    if (typmod < (int32) (VARHDRSZ))
        return -1;

    /* precision (ie, max # of digits) is in upper bits of typmod */
    precision = ((typmod - VARHDRSZ) >> 16) & 0xffff;

    /*
     * This formula computes the maximum number of NumericDigits we could need
     * in order to store the specified number of decimal digits. Because the
     * weight is stored as a number of NumericDigits rather than a number of
     * decimal digits, it's possible that the first NumericDigit will contain
     * only a single decimal digit.  Thus, the first two decimal digits can
     * require two NumericDigits to store, but it isn't until we reach
     * DEC_DIGITS + 2 decimal digits that we potentially need a third
     * NumericDigit.
     */
    numeric_digits = (precision + 2 * (DEC_DIGITS - 1)) / DEC_DIGITS;

    /*
     * In most cases, the size of a numeric will be smaller than the value
     * computed below, because the varlena header will typically get toasted
     * down to a single byte before being stored on disk, and it may also be
     * possible to use a short numeric header.  But our job here is to compute
     * the worst case.
     */
    return NUMERIC_HDRSZ + (numeric_digits * sizeof(NumericDigit));
}

numeric_mod_opt_error()

Numeric numeric_mod_opt_error	(	Numeric	num1,
		Numeric	num2,
		bool *	have_error
	)

Definition at line 2722 of file numeric.c.

References NumericVar::digits, free_var(), init_var, init_var_from_num(), make_result(), make_result_opt_error(), mod_var(), NumericVar::ndigits, and NUMERIC_IS_NAN.

Referenced by executeItemOptUnwrapTarget(), and numeric_mod().

{
    Numeric     res;
    NumericVar  arg1;
    NumericVar  arg2;
    NumericVar  result;

    if (have_error)
        *have_error = false;

    if (NUMERIC_IS_NAN(num1) || NUMERIC_IS_NAN(num2))
        return make_result(&const_nan);

    init_var_from_num(num1, &arg1);
    init_var_from_num(num2, &arg2);

    init_var(&result);

    /*
     * If "have_error" is provided, check for division by zero here
     */
    if (have_error && (arg2.ndigits == 0 || arg2.digits[0] == 0))
    {
        *have_error = true;
        return NULL;
    }

    mod_var(&arg1, &arg2, &result);

    res = make_result_opt_error(&result, NULL);

    free_var(&result);

    return res;
}

numeric_mul_opt_error()

Numeric numeric_mul_opt_error	(	Numeric	num1,
		Numeric	num2,
		bool *	have_error
	)

Definition at line 2542 of file numeric.c.

References NumericVar::dscale, free_var(), init_var, init_var_from_num(), make_result(), make_result_opt_error(), mul_var(), and NUMERIC_IS_NAN.

Referenced by executeItemOptUnwrapTarget(), and numeric_mul().

{
    NumericVar  arg1;
    NumericVar  arg2;
    NumericVar  result;
    Numeric     res;

    /*
     * Handle NaN
     */
    if (NUMERIC_IS_NAN(num1) || NUMERIC_IS_NAN(num2))
        return make_result(&const_nan);

    /*
     * Unpack the values, let mul_var() compute the result and return it.
     * Unlike add_var() and sub_var(), mul_var() will round its result. In the
     * case of numeric_mul(), which is invoked for the * operator on numerics,
     * we request exact representation for the product (rscale = sum(dscale of
     * arg1, dscale of arg2)).
     */
    init_var_from_num(num1, &arg1);
    init_var_from_num(num2, &arg2);

    init_var(&result);
    mul_var(&arg1, &arg2, &result, arg1.dscale + arg2.dscale);

    res = make_result_opt_error(&result, have_error);

    free_var(&result);

    return res;
}

numeric_normalize()

char* numeric_normalize

(

Numeric

num

)

Definition at line 762 of file numeric.c.

References get_str_from_var(), init_var_from_num(), NUMERIC_IS_NAN, pstrdup(), and generate_unaccent_rules::str.

Referenced by make_scalar_key().

{
    NumericVar  x;
    char       *str;
    int         last;

    /*
     * Handle NaN
     */
    if (NUMERIC_IS_NAN(num))
        return pstrdup("NaN");

    init_var_from_num(num, &x);

    str = get_str_from_var(&x);

    /* If there's no decimal point, there's certainly nothing to remove. */
    if (strchr(str, '.') != NULL)
    {
        /*
         * Back up over trailing fractional zeroes.  Since there is a decimal
         * point, this loop will terminate safely.
         */
        last = strlen(str) - 1;
        while (str[last] == '0')
            last--;

        /* We want to get rid of the decimal point too, if it's now last. */
        if (str[last] == '.')
            last--;

        /* Delete whatever we backed up over. */
        str[last + 1] = '\0';
    }

    return str;
}

numeric_out_sci()

char* numeric_out_sci	(	Numeric	num,
		int	scale
	)

Definition at line 735 of file numeric.c.

References get_str_from_var_sci(), init_var_from_num(), NUMERIC_IS_NAN, pstrdup(), and generate_unaccent_rules::str.

Referenced by int8_to_char(), and numeric_to_char().

{
    NumericVar  x;
    char       *str;

    /*
     * Handle NaN
     */
    if (NUMERIC_IS_NAN(num))
        return pstrdup("NaN");

    init_var_from_num(num, &x);

    str = get_str_from_var_sci(&x, scale);

    return str;
}

numeric_sub_opt_error()

Numeric numeric_sub_opt_error	(	Numeric	num1,
		Numeric	num2,
		bool *	have_error
	)

Definition at line 2486 of file numeric.c.

References free_var(), init_var, init_var_from_num(), make_result(), make_result_opt_error(), NUMERIC_IS_NAN, and sub_var().

Referenced by executeItemOptUnwrapTarget(), and numeric_sub().

{
    NumericVar  arg1;
    NumericVar  arg2;
    NumericVar  result;
    Numeric     res;

    /*
     * Handle NaN
     */
    if (NUMERIC_IS_NAN(num1) || NUMERIC_IS_NAN(num2))
        return make_result(&const_nan);

    /*
     * Unpack the values, let sub_var() compute the result and return it.
     */
    init_var_from_num(num1, &arg1);
    init_var_from_num(num2, &arg2);

    init_var(&result);
    sub_var(&arg1, &arg2, &result);

    res = make_result_opt_error(&result, have_error);

    free_var(&result);

    return res;
}