src/gromacs/selection/indexutil.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012,2013, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /*! \file
  36  * \brief API for handling index files and index groups.
  37  *
  38  * The API contains functions and data structures for handling index
  39  * files more conveniently than as several separate variables.
  40  * In addition to basic functions for initializing the data structures and
  41  * making copies, functions are provided for performing (most) set operations
  42  * on sorted index groups.
  43  * There is also a function for partitioning a index group based on
  44  * topology information such as residues or molecules.
  45  * Finally, there is a set of functions for constructing mappings between
  46  * an index group and its subgroups such.
  47  * These can be used with dynamic index group in calculations if one
  48  * needs to have a unique ID for each possible atom/residue/molecule in the
  49  * selection, e.g., for analysis of dynamics or for look-up tables.
  50  *
  51  * Mostly, these functions are used internally by the selection engine, but
  52  * it is necessary to use some of these functions in order to provide external
  53  * index groups to a gmx::SelectionCollection.
  54  * Some of the checking functions can be useful outside the selection engine to
  55  * check the validity of input groups.
  56  *
  57  * \author Teemu Murtola <teemu.murtola@gmail.com>
  58  * \inlibraryapi
  59  * \ingroup module_selection
  60  */
  61 #ifndef GMX_SELECTION_INDEXUTIL_H
  62 #define GMX_SELECTION_INDEXUTIL_H
  63
  64 #include <string>
  65
  66 #include "../legacyheaders/typedefs.h"
  67
  68 /** Stores a set of index groups. */
  69 typedef struct gmx_ana_indexgrps_t gmx_ana_indexgrps_t;
  70
  71 /*! \brief
  72  * Specifies the type of index partition or index mapping in several contexts.
  73  *
  74  * \see gmx_ana_index_make_block(), gmx_ana_indexmap_init()
  75  */
  76 typedef enum
  77 {
  78     INDEX_UNKNOWN, /**< Unknown index type.*/
  79     INDEX_ATOM,    /**< Each atom in a separate block.*/
  80     INDEX_RES,     /**< Each residue in a separate block.*/
  81     INDEX_MOL,     /**< Each molecule in a separate block.*/
  82     INDEX_ALL      /**< All atoms in a single block.*/
  83 } e_index_t;
  84
  85 /*! \brief
  86  * Stores a single index group.
  87  */
  88 typedef struct gmx_ana_index_t
  89 {
  90     /** Number of atoms. */
  91     int                 isize;
  92     /** List of atoms. */
  93     atom_id            *index;
  94     /** Number of items allocated for \p index. */
  95     int                 nalloc_index;
  96 } gmx_ana_index_t;
  97
  98 /*! \brief
  99  * Data structure for calculating index group mappings.
 100  */
 101 typedef struct gmx_ana_indexmap_t
 102 {
 103     /** Type of the mapping. */
 104     e_index_t           type;
 105     /*! \brief
 106      * Current reference IDs.
 107      *
 108      * This array provides a mapping from the current index group (last given
 109      * to gmx_ana_indexmap_update()) to the blocks in \p b, i.e., the
 110      * original index group used in gmx_ana_indexmap_init().
 111      * The mapping is zero-based.
 112      * If \p bMaskOnly is provided to gmx_ana_indexmap_update(), the indices
 113      * for blocks not present in the current group are set to -1, otherwise
 114      * they are removed completely and the \p nr field updated.
 115      */
 116     int                *refid;
 117     /*! \brief
 118      * Current mapped IDs.
 119      *
 120      * This array provides an arbitrary mapping from the current index group
 121      * to the original index group. Instead of a zero-based mapping, the
 122      * values from the \p orgid array are used. That is,
 123      * \c mapid[i]=orgid[refid[i]].
 124      * If \p bMaskOnly is provided to gmx_ana_indexmap_update(), this array
 125      * equals \p orgid.
 126      */
 127     int                *mapid;
 128     /*! \brief
 129      * Mapped block structure.
 130      *
 131      * A block structure that corresponds to the current index group.
 132      * \c mapb.nra and \c mapb.a correspond to the last mapped index group.
 133      */
 134     t_blocka            mapb;
 135
 136     /*! \brief
 137      * Arbitrary ID numbers for the blocks.
 138      *
 139      * This array has \p b.nr elements, each defining an ID number for a
 140      * block in \p b.
 141      * These are initialized in gmx_ana_indexmap_init() based on the type:
 142      *  - \ref INDEX_ATOM : the atom indices
 143      *  - \ref INDEX_RES :  the residue numbers
 144      *  - \ref INDEX_MOL :  the molecule numbers
 145      *
 146      * All the above numbers are zero-based.
 147      * After gmx_ana_indexmap_init(), the user is free to change these values
 148      * if the above are not appropriate.
 149      * The mapped values can be read through \p mapid.
 150      */
 151     int                *orgid;
 152
 153     /*! \brief
 154      * Block data that defines the mapping (internal use only).
 155      *
 156      * The data is initialized by gmx_ana_indexmap_init() and is not changed
 157      * after that.
 158      * Hence, it cannot be directly applied to the index group passed to
 159      * gmx_ana_indexmap_update() unless \p bMaskOnly was specified or the
 160      * index group is identical to the one provided to gmx_ana_indexmap_init().
 161      */
 162     t_blocka            b;
 163     /*! \brief
 164      * true if the current reference IDs are for the whole group (internal use only).
 165      *
 166      * This is used internally to optimize the evaluation such that
 167      * gmx_ana_indexmap_update() does not take any time if the group is
 168      * actually static.
 169      */
 170     bool                bStatic;
 171 } gmx_ana_indexmap_t;
 172
 173
 174 /*! \name Functions for handling gmx_ana_indexgrps_t
 175  */
 176 /*@{*/
 177 /** Reads index groups from a file or constructs them from topology. */
 178 void
 179 gmx_ana_indexgrps_init(gmx_ana_indexgrps_t **g, t_topology *top,
 180                        const char *fnm);
 181 /** Frees memory allocated for index groups. */
 182 void
 183 gmx_ana_indexgrps_free(gmx_ana_indexgrps_t *g);
 184 /** Returns true if the index group structure is emtpy. */
 185 bool
 186 gmx_ana_indexgrps_is_empty(gmx_ana_indexgrps_t *g);
 187
 188 /** Returns a pointer to an index group. */
 189 gmx_ana_index_t *
 190 gmx_ana_indexgrps_get_grp(gmx_ana_indexgrps_t *g, int n);
 191 /** Extracts a single index group. */
 192 bool
 193 gmx_ana_indexgrps_extract(gmx_ana_index_t *dest, std::string *destName,
 194                           gmx_ana_indexgrps_t *src, int n);
 195 /** Finds and extracts a single index group by name. */
 196 bool
 197 gmx_ana_indexgrps_find(gmx_ana_index_t *dest, std::string *destName,
 198                        gmx_ana_indexgrps_t *src, const char *name);
 199
 200 /** Writes out a list of index groups. */
 201 void
 202 gmx_ana_indexgrps_print(FILE *fp, gmx_ana_indexgrps_t *g, int maxn);
 203 /*@}*/
 204
 205 /*! \name Functions for handling gmx_ana_index_t
 206  */
 207 /*@{*/
 208 /** Reserves memory to store an index group of size \p isize. */
 209 void
 210 gmx_ana_index_reserve(gmx_ana_index_t *g, int isize);
 211 /** Frees any memory not necessary to hold the current contents. */
 212 void
 213 gmx_ana_index_squeeze(gmx_ana_index_t *g);
 214 /** Initializes an empty index group. */
 215 void
 216 gmx_ana_index_clear(gmx_ana_index_t *g);
 217 /** Constructs a \c gmx_ana_index_t from given values. */
 218 void
 219 gmx_ana_index_set(gmx_ana_index_t *g, int isize, atom_id *index, int nalloc);
 220 /** Creates a simple index group from the first to the \p natoms'th atom. */
 221 void
 222 gmx_ana_index_init_simple(gmx_ana_index_t *g, int natoms);
 223 /** Frees memory allocated for an index group. */
 224 void
 225 gmx_ana_index_deinit(gmx_ana_index_t *g);
 226 /** Copies a \c gmx_ana_index_t. */
 227 void
 228 gmx_ana_index_copy(gmx_ana_index_t *dest, gmx_ana_index_t *src, bool bAlloc);
 229
 230 /** Writes out the contents of a index group. */
 231 void
 232 gmx_ana_index_dump(FILE *fp, gmx_ana_index_t *g, int maxn);
 233
 234 /** Checks whether an index group is sorted. */
 235 bool
 236 gmx_ana_index_check_sorted(gmx_ana_index_t *g);
 237 /*@}*/
 238
 239 /*! \name Functions for set operations on gmx_ana_index_t
 240  */
 241 /*@{*/
 242 /** Sorts the indices within an index group. */
 243 void
 244 gmx_ana_index_sort(gmx_ana_index_t *g);
 245 /** Checks whether two index groups are equal. */
 246 bool
 247 gmx_ana_index_equals(gmx_ana_index_t *a, gmx_ana_index_t *b);
 248 /** Checks whether a sorted index group contains another sorted index group. */
 249 bool
 250 gmx_ana_index_contains(gmx_ana_index_t *a, gmx_ana_index_t *b);
 251
 252 /** Calculates the intersection between two sorted index groups. */
 253 void
 254 gmx_ana_index_intersection(gmx_ana_index_t *dest,
 255                            gmx_ana_index_t *a, gmx_ana_index_t *b);
 256 /** Calculates the set difference between two sorted index groups. */
 257 void
 258 gmx_ana_index_difference(gmx_ana_index_t *dest,
 259                          gmx_ana_index_t *a, gmx_ana_index_t *b);
 260 /** Calculates the size of the difference between two sorted index groups. */
 261 int
 262 gmx_ana_index_difference_size(gmx_ana_index_t *a, gmx_ana_index_t *b);
 263 /** Calculates the union of two sorted index groups. */
 264 void
 265 gmx_ana_index_union(gmx_ana_index_t *dest,
 266                     gmx_ana_index_t *a, gmx_ana_index_t *b);
 267 /** Merges two distinct sorted index groups. */
 268 void
 269 gmx_ana_index_merge(gmx_ana_index_t *dest,
 270                     gmx_ana_index_t *a, gmx_ana_index_t *b);
 271 /** Calculates the intersection and the difference in one call. */
 272 void
 273 gmx_ana_index_partition(gmx_ana_index_t *dest1, gmx_ana_index_t *dest2,
 274                         gmx_ana_index_t *src, gmx_ana_index_t *g);
 275 /*@}*/
 276
 277 /*! \name Functions for handling gmx_ana_indexmap_t and related things
 278  */
 279 /*@{*/
 280 /** Partition a group based on topology information. */
 281 void
 282 gmx_ana_index_make_block(t_blocka *t, t_topology *top, gmx_ana_index_t *g,
 283                          e_index_t type, bool bComplete);
 284 /** Checks whether a group consists of full blocks. */
 285 bool
 286 gmx_ana_index_has_full_blocks(gmx_ana_index_t *g, t_block *b);
 287 /** Checks whether a group consists of full blocks. */
 288 bool
 289 gmx_ana_index_has_full_ablocks(gmx_ana_index_t *g, t_blocka *b);
 290 /** Checks whether a group consists of full residues/molecules. */
 291 bool
 292 gmx_ana_index_has_complete_elems(gmx_ana_index_t *g, e_index_t type, t_topology *top);
 293
 294 /** Initializes an empty index group mapping. */
 295 void
 296 gmx_ana_indexmap_clear(gmx_ana_indexmap_t *m);
 297 /** Reserves memory for an index group mapping. */
 298 void
 299 gmx_ana_indexmap_reserve(gmx_ana_indexmap_t *m, int nr, int isize);
 300 /** Initializes an index group mapping. */
 301 void
 302 gmx_ana_indexmap_init(gmx_ana_indexmap_t *m, gmx_ana_index_t *g,
 303                       t_topology *top, e_index_t type);
 304 /** Sets an index group mapping to be static. */
 305 void
 306 gmx_ana_indexmap_set_static(gmx_ana_indexmap_t *m, t_blocka *b);
 307 /** Frees memory allocated for index group mapping. */
 308 void
 309 gmx_ana_indexmap_deinit(gmx_ana_indexmap_t *m);
 310 /** Makes a deep copy of an index group mapping. */
 311 void
 312 gmx_ana_indexmap_copy(gmx_ana_indexmap_t *dest, gmx_ana_indexmap_t *src, bool bFirst);
 313 /** Updates an index group mapping. */
 314 void
 315 gmx_ana_indexmap_update(gmx_ana_indexmap_t *m, gmx_ana_index_t *g, bool bMaskOnly);
 316 /*@}*/
 317
 318 #endif