summaryrefslogtreecommitdiff
path: root/doc/ck_bitmap_iterator_init
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ck_bitmap_iterator_init')
-rw-r--r--doc/ck_bitmap_iterator_init70
1 files changed, 0 insertions, 70 deletions
diff --git a/doc/ck_bitmap_iterator_init b/doc/ck_bitmap_iterator_init
deleted file mode 100644
index d67c6595ed77..000000000000
--- a/doc/ck_bitmap_iterator_init
+++ /dev/null
@@ -1,70 +0,0 @@
-.\"
-.\" Copyright 2012-2013 Samy Al Bahra.
-.\" Copyright 2012-2013 Shreyas Prasad.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\"
-.Dd April 27, 2012
-.Dt CK_BITMAP_ITERATOR_INIT 3
-.Sh NAME
-.Nm ck_bitmap_iterator_init
-.Nd initialize bitmap iterator
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_ht.h
-.Pp
-.Ft void
-.Fn ck_bitmap_iterator_init "ck_bitmap_iterator_t *iterator" "ck_bitmap_t *bitmap"
-.Sh DESCRIPTION
-The
-.Fn ck_bitmap_iterator_init
-function will initialize the object pointed to by
-the
-.Fa iterator
-argument for use with
-.Fa bitmap .
-.Pp
-An iterator is used to iterate through set bitmap bits
-with the
-.Xr ck_bitmap_next 3
-function.
-.Sh RETURN VALUES
-The
-.Fn ck_bitmap_iterator_init
-function does not return a value.
-.Sh ERRORS
-This function will not fail.
-.Sh SEE ALSO
-.Xr ck_bitmap_base 3 ,
-.Xr ck_bitmap_size 3 ,
-.Xr ck_bitmap_init 3 ,
-.Xr ck_bitmap_set 3 ,
-.Xr ck_bitmap_reset 3 ,
-.Xr ck_bitmap_clear 3 ,
-.Xr ck_bitmap_bits 3 ,
-.Xr ck_bitmap_buffer 3 ,
-.Xr ck_bitmap_next 3
-.Pp
-Additional information available at http://concurrencykit.org/