src/gromacs/selection/selvalue.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2014,2019,2021, 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  * Declares ::gmx_ana_selvalue_t.
  38  *
  39  * There should be no need to use the data structures in this file directly
  40  * unless implementing a custom selection routine.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \ingroup module_selection
  44  */
  45 #ifndef GMX_SELECTION_SELVALUE_H
  46 #define GMX_SELECTION_SELVALUE_H
  47
  48 #include "gromacs/utility/real.h"
  49
  50 /** Defines the value type of a different selection objects. */
  51 typedef enum
  52 {
  53     NO_VALUE,   /**< No value; either an error condition or an boolean
  54                      parameter. */
  55     INT_VALUE,  /**< One or more integer values. */
  56     REAL_VALUE, /**< One or more real values. */
  57     STR_VALUE,  /**< One or more string values. */
  58     POS_VALUE,  /**< One or more position values. */
  59     GROUP_VALUE /**< One group of atoms. */
  60 } e_selvalue_t;
  61
  62 /*! \internal
  63  * \brief
  64  * Describes a value of a selection expression or of a selection method
  65  * parameter.
  66  *
  67  * Which field in the union is used depends on the \p type.
  68  */
  69 typedef struct gmx_ana_selvalue_t
  70 {
  71     /** Type of the value. */
  72     e_selvalue_t type;
  73     /*! \brief
  74      * Number of values in the array pointed by the union.
  75      *
  76      * Note that for position and group values, it is the number of
  77      * data structures in the array, not the number of positions or
  78      * the number of atoms in the group.
  79      */
  80     int nr;
  81     /** Pointer to the value. */
  82     union
  83     {
  84         /*! \brief
  85          * Generic pointer for operations that do not need type information.
  86          *
  87          * Needs to be the first member to be able to use initialized arrays.
  88          */
  89         void* ptr;
  90         /** Integer value(s) (type \ref INT_VALUE). */
  91         int* i;
  92         /** Real value(s) (type \ref REAL_VALUE). */
  93         real* r;
  94         /** String value(s) (type \ref STR_VALUE). */
  95         char** s;
  96         /** Structure for the position value(s) (type \ref POS_VALUE). */
  97         struct gmx_ana_pos_t* p;
  98         /** Group value (type \ref GROUP_VALUE). */
  99         struct gmx_ana_index_t* g;
 100         /** Boolean value (only parameters of type \ref NO_VALUE); */
 101         bool* b;
 102     } u;
 103     /*! \brief
 104      * Number of elements allocated for the value array.
 105      */
 106     int nalloc;
 107 } gmx_ana_selvalue_t;
 108
 109 /*! \brief
 110  * Initializes an empty selection value structure.
 111  *
 112  * \param[out] val  Output structure
 113  *
 114  * The type of \p val is not touched.
 115  * Any contents of \p val are discarded without freeing.
 116  */
 117 void _gmx_selvalue_clear(gmx_ana_selvalue_t* val);
 118 /*! \brief
 119  * Frees memory allocated for a selection value structure.
 120  *
 121  * \param[in,out] val  Values to free.
 122  *
 123  * The type of \p val is not touched.
 124  * If memory is not allocated, the value pointers are simply cleared without
 125  * freeing.
 126  */
 127 void _gmx_selvalue_free(gmx_ana_selvalue_t* val);
 128 /*! \brief
 129  * Reserve memory for storing selection values.
 130  *
 131  * \param[in,out] val  Value structure to allocate.
 132  * \param[in]     n    Maximum number of values needed.
 133  *
 134  * Reserves memory for the values within \p val to store at least \p n values,
 135  * of the type specified in the \p val structure.
 136  *
 137  * If the type is \ref POS_VALUE or \ref GROUP_VALUE, memory is reserved for
 138  * the data structures, but no memory is reserved inside these newly allocated
 139  * data structures.
 140  * Similarly, for \ref STR_VALUE values, the pointers are set to NULL.
 141  * For other values, the memory is uninitialized.
 142  */
 143 void _gmx_selvalue_reserve(gmx_ana_selvalue_t* val, int n);
 144 /*! \brief
 145  * Gets and releases the memory pointer for storing selection values.
 146  *
 147  * \param[in,out] val    Value structure to release.
 148  * \param[out]    ptr    Pointer where the values are stored.
 149  * \param[out]    nalloc Pointer where the values are stored.
 150  *
 151  * Returns the pointer where values of \p val were stored in \p ptr and
 152  * \p nalloc, and clears the memory in \p val.
 153  */
 154 void _gmx_selvalue_getstore_and_release(gmx_ana_selvalue_t* val, void** ptr, int* nalloc);
 155 /*! \brief
 156  * Sets the memory for storing selection values.
 157  *
 158  * \param[in,out] val    Value structure to set storage for.
 159  * \param[in]     ptr    Pointer where the values should be stored.
 160  *
 161  * Automatic memory management is disabled for \p ptr.
 162  * Asserts if \p val had a previous storage that it owned, as that would result
 163  * in a memory leak.
 164  */
 165 void _gmx_selvalue_setstore(gmx_ana_selvalue_t* val, void* ptr);
 166 /*! \brief
 167  * Sets the memory for storing selection values and marks it for automatic freeing.
 168  *
 169  * \param[in,out] val    Value structure to set storage for.
 170  * \param[in]     ptr    Pointer where the values should be stored.
 171  * \param[in]     nalloc Number of values allocated for \p ptr.
 172  *
 173  * Asserts if \p val had a previous storage that it owned, as that would result
 174  * in a memory leak.
 175  */
 176 void _gmx_selvalue_setstore_alloc(gmx_ana_selvalue_t* val, void* ptr, int nalloc);
 177
 178 #endif