summaryrefslogtreecommitdiff
path: root/include/num.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/num.h')
-rw-r--r--include/num.h235
1 files changed, 235 insertions, 0 deletions
diff --git a/include/num.h b/include/num.h
new file mode 100644
index 0000000000000..0b16ef8440367
--- /dev/null
+++ b/include/num.h
@@ -0,0 +1,235 @@
+/*
+ * *****************************************************************************
+ *
+ * Copyright (c) 2018-2020 Gavin D. Howard and contributors.
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * *****************************************************************************
+ *
+ * Definitions for the num type.
+ *
+ */
+
+#ifndef BC_NUM_H
+#define BC_NUM_H
+
+#include <limits.h>
+#include <stdbool.h>
+#include <stddef.h>
+#include <stdint.h>
+
+#include <sys/types.h>
+
+#include <status.h>
+#include <vector.h>
+
+#ifndef BC_ENABLE_EXTRA_MATH
+#define BC_ENABLE_EXTRA_MATH (1)
+#endif // BC_ENABLE_EXTRA_MATH
+
+#define BC_BASE (10)
+
+typedef unsigned long ulong;
+
+// For some reason, LONG_BIT is not defined in some versions of gcc.
+// I define it here to the minimum accepted value in the POSIX standard.
+#ifndef LONG_BIT
+#define LONG_BIT (32)
+#endif // LONG_BIT
+
+#ifndef BC_LONG_BIT
+#define BC_LONG_BIT LONG_BIT
+#endif // BC_LONG_BIT
+
+#if BC_LONG_BIT > LONG_BIT
+#error BC_LONG_BIT cannot be greater than LONG_BIT
+#endif // BC_LONG_BIT > LONG_BIT
+
+#if BC_LONG_BIT >= 64
+
+typedef int_least32_t BcDig;
+typedef uint64_t BcBigDig;
+
+#define BC_NUM_BIGDIG_MAX ((BcBigDig) UINT64_MAX)
+
+#define BC_BASE_DIGS (9)
+#define BC_BASE_POW (1000000000)
+
+#define BC_NUM_BIGDIG_C UINT64_C
+
+#elif BC_LONG_BIT >= 32
+
+typedef int_least16_t BcDig;
+typedef uint32_t BcBigDig;
+
+#define BC_NUM_BIGDIG_MAX ((BcBigDig) UINT32_MAX)
+
+#define BC_BASE_DIGS (4)
+#define BC_BASE_POW (10000)
+
+#define BC_NUM_BIGDIG_C UINT32_C
+
+#else
+
+#error BC_LONG_BIT must be at least 32
+
+#endif // BC_LONG_BIT >= 64
+
+#define BC_NUM_DEF_SIZE (8)
+
+typedef struct BcNum {
+ BcDig *restrict num;
+ size_t rdx;
+ size_t scale;
+ size_t len;
+ size_t cap;
+ bool neg;
+} BcNum;
+
+#if BC_ENABLE_EXTRA_MATH
+// Forward declaration
+struct BcRNG;
+#endif // BC_ENABLE_EXTRA_MATH
+
+#define BC_NUM_MIN_BASE (BC_NUM_BIGDIG_C(2))
+#define BC_NUM_MAX_POSIX_IBASE (BC_NUM_BIGDIG_C(16))
+#define BC_NUM_MAX_IBASE (BC_NUM_BIGDIG_C(36))
+// This is the max base allowed by bc_num_parseChar().
+#define BC_NUM_MAX_LBASE (BC_NUM_BIGDIG_C('Z' + BC_BASE + 1))
+#define BC_NUM_PRINT_WIDTH (BC_NUM_BIGDIG_C(69))
+
+#ifndef BC_NUM_KARATSUBA_LEN
+#define BC_NUM_KARATSUBA_LEN (BC_NUM_BIGDIG_C(32))
+#elif BC_NUM_KARATSUBA_LEN < 16
+#error BC_NUM_KARATSUBA_LEN must be at least 16.
+#endif // BC_NUM_KARATSUBA_LEN
+
+// A crude, but always big enough, calculation of
+// the size required for ibase and obase BcNum's.
+#define BC_NUM_BIGDIG_LOG10 (BC_NUM_DEF_SIZE)
+
+#define BC_NUM_NONZERO(n) ((n)->len)
+#define BC_NUM_ZERO(n) (!BC_NUM_NONZERO(n))
+#define BC_NUM_ONE(n) ((n)->len == 1 && (n)->rdx == 0 && (n)->num[0] == 1)
+
+#define BC_NUM_NUM_LETTER(c) ((c) - 'A' + BC_BASE)
+
+#define BC_NUM_KARATSUBA_ALLOCS (6)
+
+#define BC_NUM_ROUND_POW(s) (bc_vm_growSize((s), BC_BASE_DIGS - 1))
+#define BC_NUM_RDX(s) (BC_NUM_ROUND_POW(s) / BC_BASE_DIGS)
+
+#define BC_NUM_SIZE(n) ((n) * sizeof(BcDig))
+
+#if BC_DEBUG_CODE
+#define BC_NUM_PRINT(x) fprintf(stderr, "%s = %lu\n", #x, (unsigned long)(x))
+#define DUMP_NUM bc_num_dump
+#else // BC_DEBUG_CODE
+#undef DUMP_NUM
+#define DUMP_NUM(x,y)
+#define BC_NUM_PRINT(x)
+#endif // BC_DEBUG_CODE
+
+typedef void (*BcNumBinaryOp)(BcNum*, BcNum*, BcNum*, size_t);
+typedef size_t (*BcNumBinaryOpReq)(const BcNum*, const BcNum*, size_t);
+typedef void (*BcNumDigitOp)(size_t, size_t, bool);
+typedef void (*BcNumShiftAddOp)(BcDig*, const BcDig*, size_t);
+
+void bc_num_init(BcNum *restrict n, size_t req);
+void bc_num_setup(BcNum *restrict n, BcDig *restrict num, size_t cap);
+void bc_num_copy(BcNum *d, const BcNum *s);
+void bc_num_createCopy(BcNum *d, const BcNum *s);
+void bc_num_createFromBigdig(BcNum *n, BcBigDig val);
+void bc_num_clear(BcNum *restrict n);
+void bc_num_free(void *num);
+
+size_t bc_num_scale(const BcNum *restrict n);
+size_t bc_num_len(const BcNum *restrict n);
+
+void bc_num_bigdig(const BcNum *restrict n, BcBigDig *result);
+void bc_num_bigdig2(const BcNum *restrict n, BcBigDig *result);
+void bc_num_bigdig2num(BcNum *restrict n, BcBigDig val);
+
+#if BC_ENABLE_EXTRA_MATH
+void bc_num_irand(const BcNum *restrict a, BcNum *restrict b,
+ struct BcRNG *restrict rng);
+void bc_num_rng(const BcNum *restrict n, struct BcRNG *rng);
+void bc_num_createFromRNG(BcNum *restrict n, struct BcRNG *rng);
+#endif // BC_ENABLE_EXTRA_MATH
+
+void bc_num_add(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_sub(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_mul(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_div(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_mod(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_pow(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+#if BC_ENABLE_EXTRA_MATH
+void bc_num_places(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_lshift(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+void bc_num_rshift(BcNum *a, BcNum *b, BcNum *c, size_t scale);
+#endif // BC_ENABLE_EXTRA_MATH
+void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale);
+void bc_num_divmod(BcNum *a, BcNum *b, BcNum *c, BcNum *d, size_t scale);
+
+size_t bc_num_addReq(const BcNum* a, const BcNum* b, size_t scale);
+
+size_t bc_num_mulReq(const BcNum *a, const BcNum *b, size_t scale);
+size_t bc_num_powReq(const BcNum *a, const BcNum *b, size_t scale);
+#if BC_ENABLE_EXTRA_MATH
+size_t bc_num_placesReq(const BcNum *a, const BcNum *b, size_t scale);
+#endif // BC_ENABLE_EXTRA_MATH
+
+void bc_num_truncate(BcNum *restrict n, size_t places);
+ssize_t bc_num_cmp(const BcNum *a, const BcNum *b);
+
+#if DC_ENABLED
+void bc_num_modexp(BcNum *a, BcNum *b, BcNum *c, BcNum *restrict d);
+#endif // DC_ENABLED
+
+void bc_num_one(BcNum *restrict n);
+ssize_t bc_num_cmpZero(const BcNum *n);
+
+void bc_num_parse(BcNum *restrict n, const char *restrict val,
+ BcBigDig base, bool letter);
+void bc_num_print(BcNum *restrict n, BcBigDig base, bool newline);
+#if DC_ENABLED
+void bc_num_stream(BcNum *restrict n, BcBigDig base);
+#endif // DC_ENABLED
+
+#if BC_DEBUG_CODE
+void bc_num_printDebug(const BcNum *n, const char *name, bool emptyline);
+void bc_num_printDigs(const BcDig* n, size_t len, bool emptyline);
+void bc_num_printWithDigs(const BcNum *n, const char *name, bool emptyline);
+void bc_num_dump(const char *varname, const BcNum *n);
+#endif // BC_DEBUG_CODE
+
+extern const char bc_num_hex_digits[];
+extern const BcBigDig bc_num_pow10[BC_BASE_DIGS + 1];
+
+extern const BcDig bc_num_bigdigMax[];
+extern const size_t bc_num_bigdigMax_size;
+
+#endif // BC_NUM_H