glib/gprimes.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GLib Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __G_PRIMES_H__
  26 #define __G_PRIMES_H__
  27
  28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  29 #error "Only <glib.h> can be included directly."
  30 #endif
  31
  32 #include <glib/gtypes.h>
  33
  34 G_BEGIN_DECLS
  35
  36 /* Prime numbers.
  37  */
  38
  39 /* This function returns prime numbers spaced by approximately 1.5-2.0
  40  * and is for use in resizing data structures which prefer
  41  * prime-valued sizes.  The closest spaced prime function returns the
  42  * next largest prime, or the highest it knows about which is about
  43  * MAXINT/4.
  44  */
  45 GLIB_AVAILABLE_IN_ALL
  46 guint      g_spaced_primes_closest (guint num) G_GNUC_CONST;
  47
  48 G_END_DECLS
  49
  50 #endif /* __G_PRIMES_H__ */