diff options
Diffstat (limited to 'libj2_clz_j2u.3')
| -rw-r--r-- | libj2_clz_j2u.3 | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/libj2_clz_j2u.3 b/libj2_clz_j2u.3 new file mode 100644 index 0000000..765c442 --- /dev/null +++ b/libj2_clz_j2u.3 @@ -0,0 +1,53 @@ +.TH LIBJ2_CLZ_J2U 3 LIBJ2 +.SH NAME +libj2_clz_j2u \- Count leading zeroes + +.SH SYNOPSIS +.nf +#include <libj2.h> + +unsigned \fBlibj2_clz_j2u\fP(const struct libj2_j2u *\fIa\fP); +.fi +.PP +Link with +.IR -lj2 . + +.SH DESCRIPTION +The +.BR libj2_clz_j2u () +function returns the number of leading cleared bits in +.IR a . +.PP +In the case that all bits in +.I a +are cleared, all of them are counted as leading. +.PP +.I a +is assumed to be +.RI non- NULL . + +.SH RETURN VALUE +The +.BR libj2_clz_j2u () +function returns the number of cleared bits that +are more significant than the most significant +set bits in +.IR a , +or the total number of bits in +.I a +if all its bits are cleared. + +.SH ERRORS +The +.BR libj2_clz_j2u () +function cannot fail. + +.SH SEE ALSO +.BR libj2 (7), +.BR libj2_clo_j2u (3), +.BR libj2_ctz_j2u (3), +.BR libj2_cz_j2u (3), +.BR libj2_flc_j2u (3), +.BR libj2_kls_j2u (3), +.BR libj2_cls_j2u (3), +.BR libj2_slc_j2u (3) |
