bitstring(3): Describe bit_fls and bit_nsearch.
authorVenkatesh Srinivas <me@endeavour.zapto.org>
Wed, 8 Dec 2010 06:55:34 +0000 (22:55 -0800)
committerVenkatesh Srinivas <me@endeavour.zapto.org>
Wed, 8 Dec 2010 06:55:34 +0000 (22:55 -0800)
share/man/man3/Makefile
share/man/man3/bitstring.3

index fd305ac..68b58ed 100644 (file)
@@ -7,7 +7,8 @@ MAN=    assert.3 bitstring.3 end.3 fpgetround.3 intro.3 queue.3 \
 MLINKS+=bitstring.3 bit_alloc.3 bitstring.3 bit_clear.3 \
        bitstring.3 bit_decl.3 bitstring.3 bit_ffc.3 bitstring.3 bit_ffs.3 \
        bitstring.3 bit_nclear.3 bitstring.3 bit_nset.3 bitstring.3 bit_set.3 \
-       bitstring.3 bitstr_size.3 bitstring.3 bit_test.3
+       bitstring.3 bitstr_size.3 bitstring.3 bit_test.3 bit_fls.3 \
+       bitstring.3 bit_nsearch.3
 MLINKS+=end.3 edata.3 end.3 etext.3
 MLINKS+=fpgetround.3 fpsetround.3 fpgetround.3 fpgetmask.3
 MLINKS+=fpgetround.3 fpsetmask.3 fpgetround.3 fpgetsticky.3
index 3e39861..1ac0d05 100644 (file)
 .Nm bit_clear ,
 .Nm bit_decl ,
 .Nm bit_ffs ,
+.Nm bit_fls ,
 .Nm bit_nclear ,
 .Nm bit_nset ,
+.Nm bit_nsearch ,
 .Nm bit_set ,
 .Nm bitstr_size ,
 .Nm bit_test
 .Ft void
 .Fn bit_ffs "bitstr_t *name" "int nbits" "int *value"
 .Ft void
+.Fn bit_fls "bitstr_t *name" "int nbits" "int *value"
+.Ft void
 .Fn bit_nclear "bitstr_t *name" "int start" "int stop"
 .Ft void
 .Fn bit_nset "bitstr_t *name" "int start" "int stop"
 .Ft void
+.Fn bit_nsearch "bitstr_t *name" "int nbits" "int *value" "int len"
+.Ft void
 .Fn bit_set "bitstr_t *name" "int bit"
 .Ft int
 .Fn bitstr_size "int nbits"
@@ -154,6 +160,26 @@ If all bits are set, the location referenced by
 .Fa value
 is set to \-1.
 .Pp
+The macro
+.Fn bit_fls
+stores in the location referenced by
+.Fa value
+the zero-based number of the highest bit set in array of
+.Fa nbits
+bits referenced by 
+.Fa name.
+.Pp
+The macro
+.Fn bit_nsearch
+stores in the location referenced by 
+.Fa value
+the zero-based index of a span of clear bits of length
+.Fa len
+in the array of
+.Fa nbits 
+bits referenced by 
+.Fa name.
+.Pp
 The arguments to these macros are evaluated only once and may safely
 have side effects.
 .Sh EXAMPLES
@@ -189,3 +215,9 @@ The
 .Nm bitstring
 functions first appeared in
 .Bx 4.4 .
+The 
+.Fn bit_fls
+and
+.Fn bit_nsearch
+routines first appeared in 
+.Dx 2.9.