flint.h

Allocates size bytes and returns a pointer to them. Throws on failure. With the system malloc a request of 0 bytes may also count as a failure on platforms where malloc(0) returns NULL.

Resizes the block ptr, previously returned by flint_malloc, flint_calloc or flint_realloc, to size bytes and returns the (possibly moved) block. If ptr is NULL, this is flint_malloc(size). Throws on failure.

Allocates an array of num objects of size bytes each, with every byte set to zero. Throws on failure.

Frees a block returned by flint_malloc, flint_calloc or flint_realloc. NULL is allowed and does nothing (with the default memory functions).

flint_aligned_alloc allocates size bytes at an address that is a multiple of alignment, which must be a power of two and at least sizeof(ulong); size must be a multiple of alignment (checked only with assertions enabled). Throws on failure. The block must be freed with flint_aligned_free.

Install or retrieve the functions called by flint_malloc, flint_calloc, flint_realloc and flint_free. Installing new functions also makes flint_aligned_alloc and flint_aligned_free use the new alloc_func and free_func (with over-allocation).

As __flint_set_memory_functions and __flint_get_memory_functions, including the functions behind flint_aligned_alloc and flint_aligned_free. aligned_alloc_func takes the alignment first and the size second.

Registers a function to be called by the next flint_cleanup or flint_cleanup_master in the current thread. Modules that build thread-local caches register their cleanup functions this way; user code can do the same.

Frees the data cached by the current thread: calls the registered cleanup functions (and forgets them), frees MPFR's caches and returns the memory of the fmpz reuse pool. It does not touch the global shared caches, which other threads may be reading, or the thread pool. In a build with --enable-reentrant and without thread-local storage it does nothing.

Frees everything FLINT has cached: shuts down the global thread pool, frees the shared caches of thread_support.h, and then does what flint_cleanup does for the current thread. Call it once, from the main thread, after all other threads have finished with FLINT, typically just before the program exits. It makes memory checkers such as Valgrind report no reachable blocks; it is not needed for correctness.

Initialise a state with the default seed, and clear it. The state holds no allocated memory, but every flint_rand_init should be matched by a flint_rand_clear.

Set or read the two words of the state. Setting the state to values read earlier repeats the sequence from that point.

Deprecated: the first four are the old names of flint_rand_init, flint_rand_clear, flint_rand_set_seed and flint_rand_get_seed; flint_rand_alloc and flint_rand_free allocate and free a state with flint_malloc and flint_free.

Deprecated: initialise and clear a GMP random state stored in state, used internally by some old random functions.

Returns the factor by which test programs scale their numbers of iterations: the value of the environment variable FLINT_TEST_MULTIPLIER if it is set to a number between 0 and 100000, and 1 otherwise. The value is read once and cached.

Sort the array buf of len elements of size bytes each in nondecreasing order. The comparison function receives pointers to two elements and the pointer data, and returns a negative, zero or positive int according to whether the first element is smaller than, equal to or larger than the second.

Versions of printf, fprintf, sprintf, snprintf, vprintf, vfprintf, vsprintf and vsnprintf that also accept the length modifier w for ulong and slong (%wu, %wd, %wx, ...) and conversions %{type} that print FLINT and GMP objects, such as %{fmpz}, %{fmpz_poly} or %{arb}. They return the number of characters written, or a negative value on error.

Versions of scanf, fscanf and sscanf that also accept the length modifier w: %wu reads a ulong and %wd an slong. FLINT types cannot be read this way; use the _read or _set_str functions of the modules.

Calls va_end(vlist). It exists for bindings from languages that cannot call the va_end macro.

Internal helper of the formatted output functions. Returns the number of arguments consumed by the conversion specification fmt (one, plus one for each * width or precision) and sets *floating to 1 if it is a floating-point conversion.

Raises an exception of kind exc. The message msg is a flint_printf format string followed by its arguments. Does not return.

Flushes standard output and standard error and calls the abort function, by default the C library's abort. Does not return.

Makes flint_abort call func instead of abort. The function must not return; it may, for example, call exit or longjmp out of FLINT. After a longjmp out of a FLINT function, the objects that function was modifying may be in an inconsistent state and memory may leak.

Makes flint_throw call func(exc, msg, ap) instead of the default handler. The handler must call va_end(ap) and must not return.