Note

Arb was merged into FLINT in 2023.

The documentation on arblib.org will no longer be updated.

See the FLINT documentation instead.

acf.h – complex floating-point numbers

Types, macros and constants

type acf_struct

type acf_t

An acf_struct consists of a pair of arf_struct:s. An acf_t is defined as an array of length one of type acf_struct, permitting an acf_t to be passed by reference.

type acf_ptr

Alias for acf_struct *, used for vectors of numbers.

type acf_srcptr

Alias for const acf_struct *, used for vectors of numbers when passed as constant input to functions.

acf_realref(x)

Macro returning a pointer to the real part of x as an arf_t.

acf_imagref(x)

Macro returning a pointer to the imaginary part of x as an arf_t.

Memory management

void acf_init(acf_t x)

Initializes the variable x for use, and sets its value to zero.

void acf_clear(acf_t x)

Clears the variable x, freeing or recycling its allocated memory.

void acf_swap(acf_t z, acf_t x)

Swaps z and x efficiently.

slong acf_allocated_bytes(const acf_t x)

Returns the total number of bytes heap-allocated internally by this object. The count excludes the size of the structure itself. Add sizeof(acf_struct) to get the size of the object as a whole.

Basic manipulation

arf_ptr acf_real_ptr(acf_t z)

arf_ptr acf_imag_ptr(acf_t z)

Returns a pointer to the real or imaginary part of z.

void acf_set(acf_t z, const acf_t x)

Sets z to the value x.

int acf_equal(const acf_t x, const acf_t y)

Returns whether x and y are equal.

Arithmetic

int acf_add(acf_t res, const acf_t x, const acf_t y, slong prec, arf_rnd_t rnd)

int acf_sub(acf_t res, const acf_t x, const acf_t y, slong prec, arf_rnd_t rnd)

int acf_mul(acf_t res, const acf_t x, const acf_t y, slong prec, arf_rnd_t rnd)

Sets res to the sum, difference or product of x or y, correctly rounding the real and imaginary parts in direction rnd. The return flag has the least significant bit set if the real part is inexact, and the second least significant bit set if the imaginary part is inexact.

Approximate arithmetic

The following operations are not correctly rounded. The rnd parameter specifies the final direction of rounding, but intermediate roundings are implementation-defined.

void acf_approx_inv(acf_t res, const acf_t x, slong prec, arf_rnd_t rnd)

void acf_approx_div(acf_t res, const acf_t x, const acf_t y, slong prec, arf_rnd_t rnd)

void acf_approx_sqrt(acf_t res, const acf_t x, slong prec, arf_rnd_t rnd)

Computes an approximate inverse, quotient or square root.

void acf_approx_dot(acf_t res, const acf_t initial, int subtract, acf_srcptr x, slong xstep, acf_srcptr y, slong ystep, slong len, slong prec, arf_rnd_t rnd)

Computes an approximate dot product, with the same meaning of the parameters as arb_dot().