-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbfrev.3.in
23 lines (22 loc) · 1005 Bytes
/
bfrev.3.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
.TH bfrev 3 "%RELEASE_DATE%" "bitfield %VERSION%" "Bit array manipulation library"
.SH NAME
bfrev, bifrev_ip \- reverse the order of bits in a bit array.
.SH SYNOPSIS
.nf
.B "#include <bitfield.h>
.sp
.BI "struct bitfield *bfrev(const struct bitfield *"instance ");
.BI "void *bfrev_ip(struct bitfield *"input ");
.fi
.SH DESCRIPTION
A bit array is represented by a "struct bitfield". It has two elements: an array of unsigned long integers \fIfield\fR and an unsigned integer \fIsize\fR.
.sp
The \fBbfrev()\fR function takes a pointer to bitfield \fIinput\fR and reverses the order of bits in it. The function returns a pointer to the new, reversed bitfield, or NULL on failure.
.sp
The \fBbfrev_ip()\fR function takes a pointer to bitfield \fIinstance\fR and reverses the order of bits in it. The changes are made "in place", in the original bitfield.
.sp
.SH "SEE ALSO"
For the full list of bitfield functions and their descriptions, see manual page for
.BR bitfield (3).
.SH AUTHOR
Vitalie CIUBOTARU