-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbfcmp.3.in
20 lines (19 loc) · 1001 Bytes
/
bfcmp.3.in
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
.TH bfcmp 3 "%RELEASE_DATE%" "bitfield %VERSION%" "Bit array manipulation library"
.SH NAME
bfcmp \- compare two bit arrays.
.SH SYNOPSIS
.nf
.B "#include <bitfield.h>
.sp
.BI "unsigned int bfcmp(const struct bitfield *"input1 ", const struct bitfield *"input2 ", char **"errmsg ");
.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 \fBbfcmp()\fR function takes pointers to two bitfields, \fIinput1\fR and \fIinput2\fR, and a pointer to a string \fIerrmsg\fR, and compares them bit-to-bit. The function returns 0 if the two bitfields are identical, 1 if they differ or 2 if they have different size. In case the bitfields are different or have different size, the function also returns an error message \fIerrmsg\fR.
.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