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