src/gmxlib/selection/mempool.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2009, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \internal \file
  39  * \brief Declarations for memory pooling functions.
  40  *
  41  * This is an implementation header: there should be no need to use it outside
  42  * this directory.
  43  */
  44 #ifndef GMX_SELECTION_MEMPOOL_H
  45 #define GMX_SELECTION_MEMPOOL_H
  46
  47 struct gmx_ana_index_t;
  48
  49 typedef struct gmx_sel_mempool_t gmx_sel_mempool_t;
  50
  51 /** Create an empty memory pool. */
  52 int
  53 _gmx_sel_mempool_create(gmx_sel_mempool_t **mpp);
  54 /** Destroy a memory pool. */
  55 void
  56 _gmx_sel_mempool_destroy(gmx_sel_mempool_t *mp);
  57
  58 /** Allocate memory from a memory pool. */
  59 int
  60 _gmx_sel_mempool_alloc(gmx_sel_mempool_t *mp, void **ptrp, size_t size);
  61 /** Release memory allocated from a memory pool. */
  62 void
  63 _gmx_sel_mempool_free(gmx_sel_mempool_t *mp, void *ptr);
  64 /** Set the size of a memory pool. */
  65 int
  66 _gmx_sel_mempool_reserve(gmx_sel_mempool_t *mp, size_t size);
  67
  68 /** Convenience function for allocating an index group from a memory pool. */
  69 int
  70 _gmx_sel_mempool_alloc_group(gmx_sel_mempool_t *mp, struct gmx_ana_index_t *g,
  71                              int isize);
  72 /** Convenience function for freeing an index group from a memory pool. */
  73 void
  74 _gmx_sel_mempool_free_group(gmx_sel_mempool_t *mp, struct gmx_ana_index_t *g);
  75
  76 #endif