src/gromacs/selection/selvalue.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2012, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements functions in selvalue.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #include "gromacs/legacyheaders/smalloc.h"
  43
  44 #include "gromacs/selection/indexutil.h"
  45 #include "gromacs/selection/position.h"
  46 #include "gromacs/selection/selvalue.h"
  47 #include "gromacs/utility/gmxassert.h"
  48
  49 /*!
  50  * \param[out] val  Output structure
  51  *
  52  * The type of \p val is not touched.
  53  * Any contents of \p val are discarded without freeing.
  54  */
  55 void
  56 _gmx_selvalue_clear(gmx_ana_selvalue_t *val)
  57 {
  58     val->nr     = 0;
  59     val->u.ptr  = NULL;
  60     val->nalloc = 0;
  61 }
  62
  63 /*!
  64  * \param[in,out] val  Value structure to allocate.
  65  * \param[in]     n    Maximum number of values needed.
  66  * \returns       Zero on success.
  67  *
  68  * Reserves memory for the values within \p val to store at least \p n values,
  69  * of the type specified in the \p val structure.
  70  *
  71  * If the type is \ref POS_VALUE or \ref GROUP_VALUE, memory is reserved for
  72  * the data structures, but no memory is reserved inside these newly allocated
  73  * data structures.
  74  * Similarly, for \ref STR_VALUE values, the pointers are set to NULL.
  75  * For other values, the memory is uninitialized.
  76  */
  77 int
  78 _gmx_selvalue_reserve(gmx_ana_selvalue_t *val, int n)
  79 {
  80     int  i;
  81
  82     if (val->nalloc == -1)
  83     {
  84         return 0;
  85     }
  86
  87     if (!val->u.ptr || val->nalloc < n)
  88     {
  89         switch (val->type)
  90         {
  91             case INT_VALUE:   srenew(val->u.i, n); break;
  92             case REAL_VALUE:  srenew(val->u.r, n); break;
  93             case STR_VALUE:
  94                 srenew(val->u.s, n);
  95                 for (i = val->nalloc; i < n; ++i)
  96                 {
  97                     val->u.s[i] = NULL;
  98                 }
  99                 break;
 100             case POS_VALUE:
 101                 GMX_RELEASE_ASSERT(val->u.ptr == NULL,
 102                                    "Reallocation of position values not supported");
 103                 val->u.p = new gmx_ana_pos_t[n];
 104                 break;
 105             case GROUP_VALUE:
 106                 srenew(val->u.g, n);
 107                 for (i = val->nalloc; i < n; ++i)
 108                 {
 109                     gmx_ana_index_clear(&val->u.g[i]);
 110                 }
 111                 break;
 112             case NO_VALUE:    break;
 113         }
 114         val->nalloc = n;
 115     }
 116     return 0;
 117 }
 118
 119 /*!
 120  * \param[in,out] val    Value structure to allocate.
 121  * \param[in]     ptr    Pointer where the values should be stored.
 122  * \returns       Zero on success.
 123  *
 124  * Automatic memory management is disabled for \p ptr, unless \p ptr is NULL.
 125  */
 126 int
 127 _gmx_selvalue_setstore(gmx_ana_selvalue_t *val, void *ptr)
 128 {
 129     val->u.ptr  = ptr;
 130     val->nalloc = (ptr ? -1 : 0);
 131     return 0;
 132 }
 133
 134 /*!
 135  * \param[in,out] val    Value structure to allocate.
 136  * \param[in]     ptr    Pointer where the values should be stored.
 137  * \param[in]     nalloc Number of values allocated for \p ptr.
 138  * \returns       Zero on success.
 139  */
 140 int
 141 _gmx_selvalue_setstore_alloc(gmx_ana_selvalue_t *val, void *ptr, int nalloc)
 142 {
 143     val->u.ptr  = ptr;
 144     val->nalloc = nalloc;
 145     return 0;
 146 }