[kdbus] sync with kdbus (kdbus.h - commit: 5ae1ecac44cb)

[platform/upstream/glib.git] / glib / gprimes.c

diff --git a/glib/gprimes.c b/glib/gprimes.c
index 6698c56..caa6418 100644 (file)
--- a/glib/gprimes.c
+++ b/glib/gprimes.c
@@ -12,9 +12,7 @@
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
 /*
@@ -71,16 +69,28 @@ static const guint g_primes[] =
   13845163,
 };
 
-static const guint g_nprimes = sizeof (g_primes) / sizeof (g_primes[0]);
-
+/**
+ * g_spaced_primes_closest:
+ * @num: a #guint
+ *
+ * Gets the smallest prime number from a built-in array of primes which
+ * is larger than @num. This is used within GLib to calculate the optimum
+ * size of a #GHashTable.
+ *
+ * The built-in array of primes ranges from 11 to 13845163 such that
+ * each prime is approximately 1.5-2 times the previous prime.
+ *
+ * Returns: the smallest prime number from a built-in array of primes
+ *     which is larger than @num
+ */
 guint
 g_spaced_primes_closest (guint num)
 {
   gint i;
 
-  for (i = 0; i < g_nprimes; i++)
+  for (i = 0; i < G_N_ELEMENTS (g_primes); i++)
     if (g_primes[i] > num)
       return g_primes[i];
 
-  return g_primes[g_nprimes - 1];
+  return g_primes[G_N_ELEMENTS (g_primes) - 1];
 }