MySQL 8.4.3
Source Code Documentation
decimal.h
Go to the documentation of this file.
1/* Copyright (c) 2000, 2024, Oracle and/or its affiliates.
2
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6
7 This program is designed to work with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have either included with
13 the program or referenced in the documentation.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
23
24#ifndef DECIMAL_INCLUDED
25#define DECIMAL_INCLUDED
26
27#ifndef MYSQL_ABI_CHECK
28#include <stdlib.h>
29#endif
30
31#include "my_inttypes.h"
32#include "my_macros.h"
33
34typedef enum {
39 FLOOR
42
43/**
44 intg is the number of *decimal* digits (NOT number of decimal_digit_t's !)
45 before the point
46 frac is the number of decimal digits after the point
47 len is the length of buf (length of allocated space) in decimal_digit_t's,
48 not in bytes
49 sign false means positive, true means negative
50 buf is an array of decimal_digit_t's
51 */
52struct decimal_t {
53 int intg, frac, len;
54 bool sign;
56};
57
58#ifndef MYSQL_ABI_CHECK
59void widen_fraction(int new_frac, decimal_t *d);
60int string2decimal(const char *from, decimal_t *to, const char **end);
61int decimal2string(const decimal_t *from, char *to, int *to_len,
62 int fixed_precision, int fixed_decimals);
63inline int decimal2string(const decimal_t *from, char *to, int *to_len) {
64 return decimal2string(from, to, to_len, 0, 0);
65}
66int decimal2ulonglong(const decimal_t *from, ulonglong *to);
68int decimal2longlong(const decimal_t *from, longlong *to);
70int decimal2double(const decimal_t *from, double *to);
71int double2decimal(double from, decimal_t *to);
72int decimal_actual_fraction(const decimal_t *from);
73int decimal2bin(const decimal_t *from, uchar *to, int precision, int scale);
74int bin2decimal(const uchar *from, decimal_t *to, int precision, int scale,
75 bool keep_prec = false);
76
77/**
78 Convert decimal to lldiv_t.
79 The integer part is stored in to->quot.
80 The fractional part is multiplied to 10^9 and stored to to->rem.
81 @param from Decimal value
82 @param [out] to lldiv_t value
83 @retval 0 on success
84 @retval !0 in error
85*/
86int decimal2lldiv_t(const decimal_t *from, lldiv_t *to);
87
88/**
89 Convert double value to lldiv_t value.
90 @param nr The double value to convert from.
91 @param [out] lld The lldit_t variable to convert to.
92 @return 0 on success, error code on error.
93
94 Integer part goes into lld.quot.
95 Fractional part multiplied to 1000000000 (10^9) goes to lld.rem.
96 Typically used in datetime calculations to split seconds
97 and nanoseconds.
98 */
99int double2lldiv_t(double nr, lldiv_t *lld);
100int decimal_size(int precision, int scale);
101int decimal_bin_size(int precision, int scale);
102
103int decimal_intg(const decimal_t *from);
104int decimal_add(const decimal_t *from1, const decimal_t *from2, decimal_t *to);
105int decimal_sub(const decimal_t *from1, const decimal_t *from2, decimal_t *to);
106int decimal_cmp(const decimal_t *from1, const decimal_t *from2);
107int decimal_mul(const decimal_t *from1, const decimal_t *from2, decimal_t *to);
108int decimal_div(const decimal_t *from1, const decimal_t *from2, decimal_t *to,
109 int scale_incr);
110int decimal_mod(const decimal_t *from1, const decimal_t *from2, decimal_t *to);
111int decimal_round(const decimal_t *from, decimal_t *to, int new_scale,
113int decimal_is_zero(const decimal_t *from);
114void max_decimal(int precision, int frac, decimal_t *to);
115int decimal_shift(decimal_t *dec, int shift);
116
117/* set a decimal_t to zero */
118static inline void decimal_make_zero(decimal_t *dec) {
119 dec->buf[0] = 0;
120 dec->intg = 1;
121 dec->frac = 0;
122 dec->sign = false;
123}
124
125/**
126 Returns the length of the buffer to hold string representation
127 of the decimal (including decimal dot, possible sign and \0)
128*/
129static inline int decimal_string_size(const decimal_t *dec) {
130 return (dec->intg ? dec->intg : 1) + dec->frac + (dec->frac > 0) + 2;
131}
132
133/*
134 conventions:
135
136 decimal_smth() == 0 -- everything's ok
137 decimal_smth() <= 1 -- result is usable, but precision loss is
138 possible decimal_smth() <= 2 -- result can be unusable, most significant
139 digits could've been lost decimal_smth() > 2 -- no result was generated
140*/
141
142#define E_DEC_OK 0
143#define E_DEC_TRUNCATED 1
144#define E_DEC_OVERFLOW 2
145#define E_DEC_DIV_ZERO 4
146#define E_DEC_BAD_NUM 8
147#define E_DEC_OOM 16
148
149#define E_DEC_FATAL_ERROR \
150 (E_DEC_OVERFLOW | E_DEC_DIV_ZERO | E_DEC_BAD_NUM | E_DEC_OOM)
151#define E_DEC_ERROR (E_DEC_FATAL_ERROR | E_DEC_TRUNCATED)
152
153#endif // MYSQL_ABI_CHECK
154
155#endif // DECIMAL_INCLUDED
int decimal_round(const decimal_t *from, decimal_t *to, int new_scale, decimal_round_mode mode)
Definition: decimal.cc:1653
int decimal_bin_size(int precision, int scale)
Definition: decimal.cc:1631
int decimal2longlong(const decimal_t *from, longlong *to)
Definition: decimal.cc:1175
int ulonglong2decimal(ulonglong from, decimal_t *to)
Definition: decimal.cc:1139
int decimal_mul(const decimal_t *from1, const decimal_t *from2, decimal_t *to)
Definition: decimal.cc:2083
static int decimal_string_size(const decimal_t *dec)
Returns the length of the buffer to hold string representation of the decimal (including decimal dot,...
Definition: decimal.h:129
int bin2decimal(const uchar *from, decimal_t *to, int precision, int scale, bool keep_prec=false)
Definition: decimal.cc:1486
int decimal_mod(const decimal_t *from1, const decimal_t *from2, decimal_t *to)
Definition: decimal.cc:2510
int double2lldiv_t(double nr, lldiv_t *lld)
Convert double value to lldiv_t value.
Definition: decimal.cc:1244
decimal_round_mode
Definition: decimal.h:34
@ CEILING
Definition: decimal.h:38
@ FLOOR
Definition: decimal.h:39
@ HALF_UP
Definition: decimal.h:37
@ TRUNCATE
Definition: decimal.h:35
@ HALF_EVEN
Definition: decimal.h:36
int decimal_add(const decimal_t *from1, const decimal_t *from2, decimal_t *to)
Definition: decimal.cc:2034
int decimal_is_zero(const decimal_t *from)
Definition: decimal.cc:2054
int longlong2decimal(longlong from, decimal_t *to)
Definition: decimal.cc:1144
int decimal_actual_fraction(const decimal_t *from)
Definition: decimal.cc:486
int decimal2lldiv_t(const decimal_t *from, lldiv_t *to)
Convert decimal to lldiv_t.
Definition: decimal.cc:1222
void max_decimal(int precision, int frac, decimal_t *to)
Definition: decimal.cc:432
int32 decimal_digit_t
Definition: decimal.h:41
int decimal2ulonglong(const decimal_t *from, ulonglong *to)
Definition: decimal.cc:1151
int decimal2bin(const decimal_t *from, uchar *to, int precision, int scale)
Definition: decimal.cc:1351
int decimal_div(const decimal_t *from1, const decimal_t *from2, decimal_t *to, int scale_incr)
Definition: decimal.cc:2478
int decimal_shift(decimal_t *dec, int shift)
Definition: decimal.cc:760
int decimal_size(int precision, int scale)
Definition: decimal.cc:1606
int string2decimal(const char *from, decimal_t *to, const char **end)
Definition: decimal.cc:932
static void decimal_make_zero(decimal_t *dec)
Definition: decimal.h:118
int decimal2double(const decimal_t *from, double *to)
Definition: decimal.cc:1075
int decimal2string(const decimal_t *from, char *to, int *to_len, int fixed_precision, int fixed_decimals)
Definition: decimal.cc:526
int decimal_cmp(const decimal_t *from1, const decimal_t *from2)
Definition: decimal.cc:2044
void widen_fraction(int new_frac, decimal_t *d)
Add zeros behind comma to increase precision of decimal.
Definition: decimal.cc:1048
int decimal_intg(const decimal_t *from)
Returns the number of decimal digits before the decimal point in a decimal_t, with any insignificant ...
Definition: decimal.cc:2028
int double2decimal(double from, decimal_t *to)
Definition: decimal.cc:1100
int decimal_sub(const decimal_t *from1, const decimal_t *from2, decimal_t *to)
Definition: decimal.cc:2039
static const std::string dec("DECRYPTION")
Some integer typedefs for easier portability.
unsigned long long int ulonglong
Definition: my_inttypes.h:56
unsigned char uchar
Definition: my_inttypes.h:52
long long int longlong
Definition: my_inttypes.h:55
int32_t int32
Definition: my_inttypes.h:66
Some common macros.
Cursor end()
A past-the-end Cursor.
Definition: rules_table_service.cc:192
mode
Definition: file_handle.h:61
intg is the number of decimal digits (NOT number of decimal_digit_t's !) before the point frac is the...
Definition: decimal.h:52
int frac
Definition: decimal.h:53
decimal_digit_t * buf
Definition: decimal.h:55
int intg
Definition: decimal.h:53
bool sign
Definition: decimal.h:54
int len
Definition: decimal.h:53