aboutsummaryrefslogtreecommitdiffstats
path: root/libj2_fls_j2u.3
blob: 9b63423c7b6b916cb85c45ff43e71d6dc46595ee (plain) (blame)
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
41
42
43
44
45
46
47
48
49
50
51
52
.TH LIBJ2_FLS_J2U 3 LIBJ2
.SH NAME
libj2_fls_j2u \- Find last set bit

.SH SYNOPSIS
.nf
#include <libj2.h>

unsigned \fBlibj2_fls_j2u\fP(const struct libj2_j2u *\fIa\fP);
.fi
.PP
Link with
.IR -lj2 .

.SH DESCRIPTION
The
.BR libj2_fls_j2u ()
function returns the index of the most
significant set bit in
.IR a ,
where the index is counted from 1,
and from the the least significant bit.
.PP
In the case that no bit in
.I a
is set, 0 is returned.
.PP
.I a
is assumed to be
.RI non- NULL .

.SH RETURN VALUE
The
.BR libj2_fls_j2u ()
function returns the one-based index of
the last set bit in
.IR a ,
or 0 if no bit is set.

.SH ERRORS
The
.BR libj2_fls_j2u ()
function cannot fail.

.SH SEE ALSO
.BR libj2 (7),
.BR libj2_flc_j2u (3),
.BR libj2_ffs_j2u (3),
.BR libj2_clz_j2u (3),
.BR libj2_kls_j2u (3),
.BR libj2_cls_j2u (3),
.BR libj2_slc_j2u (3)