summaryrefslogtreecommitdiff
path: root/doc/ck_ht_grow_spmc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ck_ht_grow_spmc')
-rw-r--r--doc/ck_ht_grow_spmc98
1 files changed, 0 insertions, 98 deletions
diff --git a/doc/ck_ht_grow_spmc b/doc/ck_ht_grow_spmc
deleted file mode 100644
index 70e6055fde2c..000000000000
--- a/doc/ck_ht_grow_spmc
+++ /dev/null
@@ -1,98 +0,0 @@
-.\"
-.\" Copyright 2012-2013 Samy Al Bahra.
-.\" 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 March 29, 2012
-.Dt CK_HT_GROW_SPMC 3
-.Sh NAME
-.Nm ck_ht_grow_spmc
-.Nd resize a hash table if necessary
-.Sh LIBRARY
-Concurrency Kit (libck, \-lck)
-.Sh SYNOPSIS
-.In ck_ht.h
-.Ft bool
-.Fn ck_ht_grow_spmc "ck_ht_t *ht" "uint64_t capacity"
-.Sh DESCRIPTION
-The
-.Fn ck_ht_grow_spmc
-function will resize the hash table in order to be able to
-at least store the number of entries specified by
-.Fa capacity
-at a load factor of one. The default load hash table load factor is
-0.5. If you wish to minimize the likelihood of memory allocations
-for a hash table meant to store n entries then specify a capacity
-of 2n. The default behavior of ck_ht is to round
-.Fa capacity
-to the next available power of two if it is not already a power
-of two.
-.Pp
-This function is safe to call in the presence of concurrent
-.Xr ck_ht_get_spmc 3
-operations.
-.Sh RETURN VALUES
-Upon successful completion
-.Fn ck_ht_grow_spmc
-returns
-.Dv true
-and otherwise returns a
-.Dv false
-value.
-.Sh ERRORS
-.Bl -tag -width Er
-Behavior is undefined if
-.Fa ht
-is uninitialized. The function will only return
-.Dv false
-if there are internal memory allocation failures.
-.El
-.Sh SEE ALSO
-.Xr ck_ht_stat 3 ,
-.Xr ck_ht_init 3 ,
-.Xr ck_ht_destroy 3 ,
-.Xr ck_ht_hash 3 ,
-.Xr ck_ht_hash_direct 3 ,
-.Xr ck_ht_set_spmc 3 ,
-.Xr ck_ht_put_spmc 3 ,
-.Xr ck_ht_gc 3 ,
-.Xr ck_ht_get_spmc 3 ,
-.Xr ck_ht_remove_spmc 3 ,
-.Xr ck_ht_reset_spmc 3 ,
-.Xr ck_ht_reset_size_spmc 3 ,
-.Xr ck_ht_count 3 ,
-.Xr ck_ht_entry_empty 3 ,
-.Xr ck_ht_entry_key_set 3 ,
-.Xr ck_ht_entry_key_set_direct 3 ,
-.Xr ck_ht_entry_key 3 ,
-.Xr ck_ht_entry_key_length 3 ,
-.Xr ck_ht_entry_value 3 ,
-.Xr ck_ht_entry_set 3 ,
-.Xr ck_ht_entry_set_direct 3 ,
-.Xr ck_ht_entry_key_direct 3 ,
-.Xr ck_ht_entry_value_direct 3 ,
-.Xr ck_ht_iterator_init 3 ,
-.Xr ck_ht_next 3
-.Pp
-Additional information available at http://concurrencykit.org/