src/gromacs/selection/selvalue.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2012,2013,2014, 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 "gmxpre.h"
  43
  44 #include "selvalue.h"
  45
  46 #include "gromacs/selection/indexutil.h"
  47 #include "gromacs/selection/position.h"
  48 #include "gromacs/utility/gmxassert.h"
  49 #include "gromacs/utility/smalloc.h"
  50
  51 /*!
  52  * \param[out] val  Output structure
  53  *
  54  * The type of \p val is not touched.
  55  * Any contents of \p val are discarded without freeing.
  56  */
  57 void
  58 _gmx_selvalue_clear(gmx_ana_selvalue_t *val)
  59 {
  60     val->nr     = 0;
  61     val->u.ptr  = NULL;
  62     val->nalloc = 0;
  63 }
  64
  65 /*!
  66  * \param[in,out] val  Value structure to allocate.
  67  * \param[in]     n    Maximum number of values needed.
  68  * \returns       Zero on success.
  69  *
  70  * Reserves memory for the values within \p val to store at least \p n values,
  71  * of the type specified in the \p val structure.
  72  *
  73  * If the type is \ref POS_VALUE or \ref GROUP_VALUE, memory is reserved for
  74  * the data structures, but no memory is reserved inside these newly allocated
  75  * data structures.
  76  * Similarly, for \ref STR_VALUE values, the pointers are set to NULL.
  77  * For other values, the memory is uninitialized.
  78  */
  79 int
  80 _gmx_selvalue_reserve(gmx_ana_selvalue_t *val, int n)
  81 {
  82     int  i;
  83
  84     if (val->nalloc == -1)
  85     {
  86         return 0;
  87     }
  88
  89     if (!val->u.ptr || val->nalloc < n)
  90     {
  91         switch (val->type)
  92         {
  93             case INT_VALUE:   srenew(val->u.i, n); break;
  94             case REAL_VALUE:  srenew(val->u.r, n); break;
  95             case STR_VALUE:
  96                 srenew(val->u.s, n);
  97                 for (i = val->nalloc; i < n; ++i)
  98                 {
  99                     val->u.s[i] = NULL;
 100                 }
 101                 break;
 102             case POS_VALUE:
 103                 GMX_RELEASE_ASSERT(val->u.ptr == NULL,
 104                                    "Reallocation of position values not supported");
 105                 val->u.p = new gmx_ana_pos_t[n];
 106                 break;
 107             case GROUP_VALUE:
 108                 srenew(val->u.g, n);
 109                 for (i = val->nalloc; i < n; ++i)
 110                 {
 111                     gmx_ana_index_clear(&val->u.g[i]);
 112                 }
 113                 break;
 114             case NO_VALUE:    break;
 115         }
 116         val->nalloc = n;
 117     }
 118     return 0;
 119 }
 120
 121 /*!
 122  * \param[in,out] val    Value structure to allocate.
 123  * \param[in]     ptr    Pointer where the values should be stored.
 124  * \returns       Zero on success.
 125  *
 126  * Automatic memory management is disabled for \p ptr, unless \p ptr is NULL.
 127  */
 128 int
 129 _gmx_selvalue_setstore(gmx_ana_selvalue_t *val, void *ptr)
 130 {
 131     val->u.ptr  = ptr;
 132     val->nalloc = (ptr ? -1 : 0);
 133     return 0;
 134 }
 135
 136 /*!
 137  * \param[in,out] val    Value structure to allocate.
 138  * \param[in]     ptr    Pointer where the values should be stored.
 139  * \param[in]     nalloc Number of values allocated for \p ptr.
 140  * \returns       Zero on success.
 141  */
 142 int
 143 _gmx_selvalue_setstore_alloc(gmx_ana_selvalue_t *val, void *ptr, int nalloc)
 144 {
 145     val->u.ptr  = ptr;
 146     val->nalloc = nalloc;
 147     return 0;
 148 }