API Reference

Namespaces

Namespace Description

Namespace	Description
`beman::big_int`	Contains all components of the library except literals and polymorphic memory resource support
`beman::big_int::literals`	User-defined literals
`beman::big_int::pmr`	Types with `std::pmr` support

beman::big_int

Contains all components of the library except literals and polymorphic memory resource support

beman::big_int::literals

User-defined literals

beman::big_int::pmr

Types with std::pmr support

Types

Type Description

Type	Description
`uint_multiprecision_t`	The limb type of a `big_int`
`basic_big_int`	The template of a big integer type. Analogous to `std::basic_string`
`big_int`	A big integer type using default small value optimizations and allocator
`std::formatter<basic_big_int>`	Formatter specialization that plugs a `basic_big_int` into `std::format`

uint_multiprecision_t

The limb type of a big_int

basic_big_int

The template of a big integer type. Analogous to std::basic_string

big_int

A big integer type using default small value optimizations and allocator

std::formatter<basic_big_int>

Formatter specialization that plugs a basic_big_int into std::format

Functions

<charconv>

Function Description

Function	Description
`to_chars`	Writes the textual representation of a `basic_big_int` into a character buffer
`from_chars`	Parses a `basic_big_int` from its textual representation

to_chars

Writes the textual representation of a basic_big_int into a character buffer

from_chars

Parses a basic_big_int from its textual representation

String conversions

Function Description

Function	Description
`to_string`	Returns a `std::string` holding the textual representation of a `basic_big_int`
`to_wstring`	Returns a `std::wstring` holding the textual representation of a `basic_big_int`

to_string

Returns a std::string holding the textual representation of a basic_big_int

to_wstring

Returns a std::wstring holding the textual representation of a basic_big_int

Specialized algorithms

Function Description

Function	Description
`swap`	Exchanges the values of two `basic_big_int` objects of the same type, without allocating

swap

Exchanges the values of two basic_big_int objects of the same type, without allocating

Numeric functions

Function Description

Function	Description
`abs`	Returns the absolute value (magnitude) of a `basic_big_int`
`saturating_cast`	Converts a `basic_big_int` to a built-in integer type, clamping to its range
`in_range`	Returns the Boolean result of the range-check if a `basic_big_int` can be represented within the range of another given type
`gcd`	Returns the greatest common divisor of two integers, at least one of them a `basic_big_int`
`lcm`	Returns the least common multiple of two integers, at least one of them a `basic_big_int`
`midpoint`	Returns half the sum of two integers, at least one of them a `basic_big_int`, rounded toward the first

abs

Returns the absolute value (magnitude) of a basic_big_int

saturating_cast

Converts a basic_big_int to a built-in integer type, clamping to its range

in_range

Returns the Boolean result of the range-check if a basic_big_int can be represented within the range of another given type

gcd

Returns the greatest common divisor of two integers, at least one of them a basic_big_int

lcm

Returns the least common multiple of two integers, at least one of them a basic_big_int

midpoint

Returns half the sum of two integers, at least one of them a basic_big_int, rounded toward the first

Edit this Page