blob: d2009d58b2a6bf59e4a41cf316dc7c04136bbcba (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Int.get_bit 3 2025-09-21 "Tomo man-pages"
.SH NAME
Int.get_bit \- check whether a bit is set
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Int.get_bit\ :\ func(i:\ Int,\ bit_index:\ Int\ ->\ Bool)
.fi
.SH DESCRIPTION
In the binary representation of an integer, check whether a given bit index is set to 1 or not.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
i Int The integer whose bits are being inspected. -
bit_index Int The index of the bit to check (1-indexed). -
.TE
.SH RETURN
Whether or not the given bit index is set to 1 in the binary representation of the integer.
.SH NOTES
For fixed-size integers, the bit index must be between 1 and the number of bits in that integer (i.e. 1-64 for `Int64`). For `Int`, the bit index must be between 1 and `Int64.max`. Values outside this range will produce a runtime error.
.SH EXAMPLES
.EX
assert (6).get_bit(1) == no
assert (6).get_bit(2) == yes
assert (6).get_bit(3) == yes
assert (6).get_bit(4) == no
.EE
|
