baml.Int

(internal) Maps one full-range draw onto [lower, upper), returning upper when the draw must be rejected.

Returns the largest representable int, 2^62 - 1 (4_611_686_018_427_387_903).

Returns the smallest representable int, -2^62 (-4_611_686_018_427_387_904). int.min_value().abs() panics.

Parses text as a base ten signed integer.

Accepts an optional leading + or - followed by one or more ASCII digits, and nothing else: no surrounding whitespace, no underscores, no other numeric formats. The value must fit the 63-bit int range.

Throws

• baml.errors.ParseError if text is empty, holds a non-digit character, or names a value outside the int range.

Examples

int.parse("42")       // 42
int.parse("-7")       // -7
int.parse("+0")       // 0
int.parse("")         // throws — empty
int.parse("12a")      // throws — non-digit
int.parse(" 5 ")      // throws — whitespace; trim first
int.parse("99999999999999999999")  // throws — out of range

Returns a uniformly distributed random integer in the half-open range [lower, upper), drawn from rng.

rng defaults to random.SystemRandom, the host's cryptographic entropy source; pass a seeded generator to make the draw reproducible. Even the widest representable half-open range works. Rejection sampling avoids modulo bias, so one result may consume several values from rng.

Throws

• baml.errors.InvalidArgument if lower >= upper, which would leave the range empty.

Examples

int.random(0, 10)         // some value in {0, 1, ..., 9}
int.random(-5, 5)         // some value in {-5, -4, ..., 4}
int.random(0, 1)          // always 0  (single-element range)
int.random(5, 5)          // throws — empty range
int.random(10, 0)         // throws — lower > upper

// Reproducible: the same seed replays the same values.
let rng = baml.random.Xoshiro256PlusPlus.new(seed = my_seed);
int.random(0, 10, rng = rng)

Returns the absolute value of self.

Panics

• baml.panics.IntegerOverflow for int.min_value(), whose absolute value 2^62 is one past int.max_value().

Examples

(-7).abs()             // 7
(3).abs()              // 3
int.min_value().abs()  // panics

Returns the total number of one bits, also known as the population count or "popcount".

Examples

(0).count_ones()   // 0
(7).count_ones()   // 3
(-1).count_ones()  // 64

Returns the total number of zero bits.

Examples

(0).count_zeros()   // 64
(-1).count_zeros()  // 0

Returns the largest n such that base ** n <= self: the logarithm of self in base, rounded down.

Throws

• baml.errors.InvalidArgument if self <= 0 or base < 2.

Examples

(1000).ilog(10)   // 3
(1024).ilog(2)    // 10
(1).ilog(10)      // 0
(0).ilog(10)      // throws
(10).ilog(1)      // throws

Returns the largest r such that r * r <= self: the integer square root of self.

Throws

• baml.errors.InvalidArgument if self is negative.

Examples

(10).isqrt()   // 3
(16).isqrt()   // 4
(-1).isqrt()   // throws

Returns the number of leading one bits.

Examples

(0).leading_ones()   // 0
(-1).leading_ones()  // 64

Returns the number of leading zero bits.

Examples

(0).leading_zeros()  // 64
(1).leading_zeros()  // 63
(-1).leading_zeros() // 0   (all ones)

Returns self ** exp, saturating instead of panicking on overflow: int.max_value() for positive overflow, int.min_value() for negative.

0 ** 0 is 1, by convention. A negative exp gives 0, because the exact value 1 / self ** -exp lies in (-1, 1) for |self| > 1 and rounds toward zero. That holds uniformly: for self == 1 or self == -1 the exact value is ±1, and the result is still 0.

Examples

(2).pow(10)      // 1024
(2).pow(0)       // 1
(0).pow(0)       // 1   (convention)
(2).pow(-1)      // 0
(-2).pow(3)      // -8
(10).pow(100)    // saturates to int.max_value()

Returns the number of trailing one bits.

Examples

(7).trailing_ones()   // 3   (binary 111)
(8).trailing_ones()   // 0
(-1).trailing_ones()  // 64

Returns the number of trailing zero bits.

Examples

(0).trailing_zeros()  // 64
(8).trailing_zeros()  // 3   (binary 1000)
(1).trailing_zeros()  // 0