2 * *****************************************************************************
4 * SPDX-License-Identifier: BSD-2-Clause
6 * Copyright (c) 2018-2023 Gavin D. Howard and contributors.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
11 * * Redistributions of source code must retain the above copyright notice, this
12 * list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright notice,
15 * this list of conditions and the following disclaimer in the documentation
16 * and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
30 * *****************************************************************************
32 * The public header for the bc library.
39 // TODO: Add a generation index when building with Valgrind to check for
40 // use-after-free's or double frees.
61 #define ssize_t SSIZE_T
64 #define BCL_SEED_ULONGS (4)
65 #define BCL_SEED_SIZE (sizeof(long) * BCL_SEED_ULONGS)
67 // For some reason, LONG_BIT is not defined in some versions of gcc.
68 // I define it here to the minimum accepted value in the POSIX standard.
74 #define BC_LONG_BIT LONG_BIT
77 #if BC_LONG_BIT > LONG_BIT
78 #error BC_LONG_BIT cannot be greater than LONG_BIT
79 #endif // BC_LONG_BIT > LONG_BIT
81 // For more information about the items here, see the either the
82 // manuals/bcl.3.md or manuals/bcl.3 manuals.
84 // BclBigDig is a fixed-size integer type that bcl can convert numbers to.
86 // BclRandInt is the type of fixed-size integer natively returned by the
87 // pseudo-random number generator.
90 typedef uint64_t BclBigDig;
91 typedef uint64_t BclRandInt;
93 #elif BC_LONG_BIT >= 32
95 typedef uint32_t BclBigDig;
96 typedef uint32_t BclRandInt;
100 #error BC_LONG_BIT must be at least 32
102 #endif // BC_LONG_BIT >= 64
104 #ifndef BC_ENABLE_LIBRARY
105 #define BC_ENABLE_LIBRARY (1)
106 #endif // BC_ENABLE_LIBRARY
108 #if BC_ENABLE_LIBRARY
110 typedef enum BclError
114 BCL_ERROR_INVALID_NUM,
115 BCL_ERROR_INVALID_CONTEXT,
118 BCL_ERROR_MATH_NEGATIVE,
119 BCL_ERROR_MATH_NON_INTEGER,
120 BCL_ERROR_MATH_OVERFLOW,
121 BCL_ERROR_MATH_DIVIDE_BY_ZERO,
123 BCL_ERROR_PARSE_INVALID_STR,
125 BCL_ERROR_FATAL_ALLOC_ERR,
126 BCL_ERROR_FATAL_UNKNOWN_ERR,
132 typedef struct BclNumber
140 typedef struct BclCtxt* BclContext;
155 bcl_abortOnFatalError(void);
158 bcl_setAbortOnFatalError(bool abrt);
161 bcl_leadingZeroes(void);
164 bcl_setLeadingZeroes(bool leadingZeroes);
167 bcl_digitClamp(void);
170 bcl_setDigitClamp(bool digitClamp);
176 bcl_pushContext(BclContext ctxt);
179 bcl_popContext(void);
185 bcl_ctxt_create(void);
188 bcl_ctxt_free(BclContext ctxt);
191 bcl_ctxt_freeNums(BclContext ctxt);
194 bcl_ctxt_scale(BclContext ctxt);
197 bcl_ctxt_setScale(BclContext ctxt, size_t scale);
200 bcl_ctxt_ibase(BclContext ctxt);
203 bcl_ctxt_setIbase(BclContext ctxt, size_t ibase);
206 bcl_ctxt_obase(BclContext ctxt);
209 bcl_ctxt_setObase(BclContext ctxt, size_t obase);
212 bcl_err(BclNumber n);
215 bcl_num_create(void);
218 bcl_num_free(BclNumber n);
221 bcl_num_neg(BclNumber n);
224 bcl_num_setNeg(BclNumber n, bool neg);
227 bcl_num_scale(BclNumber n);
230 bcl_num_setScale(BclNumber n, size_t scale);
233 bcl_num_len(BclNumber n);
236 bcl_copy(BclNumber d, BclNumber s);
239 bcl_dup(BclNumber s);
242 bcl_bigdig(BclNumber n, BclBigDig* result);
245 bcl_bigdig_keep(BclNumber n, BclBigDig* result);
248 bcl_bigdig2num(BclBigDig val);
251 bcl_add(BclNumber a, BclNumber b);
254 bcl_add_keep(BclNumber a, BclNumber b);
257 bcl_sub(BclNumber a, BclNumber b);
260 bcl_sub_keep(BclNumber a, BclNumber b);
263 bcl_mul(BclNumber a, BclNumber b);
266 bcl_mul_keep(BclNumber a, BclNumber b);
269 bcl_div(BclNumber a, BclNumber b);
272 bcl_div_keep(BclNumber a, BclNumber b);
275 bcl_mod(BclNumber a, BclNumber b);
278 bcl_mod_keep(BclNumber a, BclNumber b);
281 bcl_pow(BclNumber a, BclNumber b);
284 bcl_pow_keep(BclNumber a, BclNumber b);
287 bcl_lshift(BclNumber a, BclNumber b);
290 bcl_lshift_keep(BclNumber a, BclNumber b);
293 bcl_rshift(BclNumber a, BclNumber b);
296 bcl_rshift_keep(BclNumber a, BclNumber b);
299 bcl_sqrt(BclNumber a);
302 bcl_sqrt_keep(BclNumber a);
305 bcl_divmod(BclNumber a, BclNumber b, BclNumber* c, BclNumber* d);
308 bcl_divmod_keep(BclNumber a, BclNumber b, BclNumber* c, BclNumber* d);
311 bcl_modexp(BclNumber a, BclNumber b, BclNumber c);
314 bcl_modexp_keep(BclNumber a, BclNumber b, BclNumber c);
317 bcl_cmp(BclNumber a, BclNumber b);
320 bcl_zero(BclNumber n);
323 bcl_one(BclNumber n);
326 bcl_parse(const char* restrict val);
329 bcl_string(BclNumber n);
332 bcl_string_keep(BclNumber n);
335 bcl_irand(BclNumber a);
338 bcl_irand_keep(BclNumber a);
341 bcl_frand(size_t places);
344 bcl_ifrand(BclNumber a, size_t places);
347 bcl_ifrand_keep(BclNumber a, size_t places);
350 bcl_rand_seedWithNum(BclNumber n);
353 bcl_rand_seedWithNum_keep(BclNumber n);
356 bcl_rand_seed(unsigned char seed[BCL_SEED_SIZE]);
359 bcl_rand_reseed(void);
362 bcl_rand_seed2num(void);
368 bcl_rand_bounded(BclRandInt bound);
370 #endif // BC_ENABLE_LIBRARY