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,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 /*! \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 <cstdio>
  65
  66 #include <string>
  67
  68 #include "gromacs/legacyheaders/types/simple.h"
  69 #include "gromacs/topology/block.h"
  70
  71 struct t_topology;
  72
  73 /** Stores a set of index groups. */
  74 struct gmx_ana_indexgrps_t;
  75
  76 /*! \brief
  77  * Specifies the type of index partition or index mapping in several contexts.
  78  *
  79  * \see gmx_ana_index_make_block(), gmx_ana_indexmap_init()
  80  */
  81 typedef enum
  82 {
  83     INDEX_UNKNOWN, /**< Unknown index type.*/
  84     INDEX_ATOM,    /**< Each atom in a separate block.*/
  85     INDEX_RES,     /**< Each residue in a separate block.*/
  86     INDEX_MOL,     /**< Each molecule in a separate block.*/
  87     INDEX_ALL      /**< All atoms in a single block.*/
  88 } e_index_t;
  89
  90 /*! \brief
  91  * Stores a single index group.
  92  */
  93 struct gmx_ana_index_t
  94 {
  95     /** Number of atoms. */
  96     int                 isize;
  97     /** List of atoms. */
  98     atom_id            *index;
  99     /** Number of items allocated for \p index. */
 100     int                 nalloc_index;
 101 };
 102
 103 /*! \brief
 104  * Data structure for calculating index group mappings.
 105  */
 106 struct gmx_ana_indexmap_t
 107 {
 108     /** Type of the mapping. */
 109     e_index_t           type;
 110     /*! \brief
 111      * Current reference IDs.
 112      *
 113      * This array provides a mapping from the current index group (last given
 114      * to gmx_ana_indexmap_update()) to the blocks in \p b, i.e., the
 115      * original index group used in gmx_ana_indexmap_init().
 116      * The mapping is zero-based.
 117      * If \p bMaskOnly is provided to gmx_ana_indexmap_update(), the indices
 118      * for blocks not present in the current group are set to -1, otherwise
 119      * they are removed completely and the \p nr field updated.
 120      */
 121     int                *refid;
 122     /*! \brief
 123      * Current mapped IDs.
 124      *
 125      * This array provides IDs for the current index group.  Instead of a
 126      * zero-based mapping that \p refid provides, the values from the \p orgid
 127      * array are used, thus allowing the mapping to be customized.
 128      * In other words, `mapid[i] = orgid[refid[i]]`.
 129      * If \p bMaskOnly is provided to gmx_ana_indexmap_update(), this array
 130      * equals \p orgid.
 131      */
 132     int                *mapid;
 133     /*! \brief
 134      * Mapped block structure.
 135      *
 136      * A block structure that corresponds to the current index group.
 137      * \c mapb.nra and \c mapb.a correspond to the last mapped index group.
 138      */
 139     t_blocka            mapb;
 140
 141     /*! \brief
 142      * Customizable ID numbers for the original blocks.
 143      *
 144      * This array has \p b.nr elements, each defining an original ID number for
 145      * a block in \p b (i.e., in the original group passed to
 146      * gmx_ana_indexmap_init()).
 147      * These are initialized in gmx_ana_indexmap_init() based on the type:
 148      *  - \ref INDEX_ATOM : the atom indices
 149      *  - \ref INDEX_RES :  the residue indices
 150      *  - \ref INDEX_MOL :  the molecule indices
 151      *
 152      * All the above numbers are zero-based.
 153      * After gmx_ana_indexmap_init(), the caller is free to change these values
 154      * if the above are not appropriate.
 155      * The mapped values can be read through \p mapid.
 156      */
 157     int                *orgid;
 158
 159     /*! \brief
 160      * Block data that defines the mapping (internal use only).
 161      *
 162      * The data is initialized by gmx_ana_indexmap_init() and is not changed
 163      * after that.
 164      * Hence, it cannot be directly applied to the index group passed to
 165      * gmx_ana_indexmap_update() unless \p bMaskOnly was specified or the
 166      * index group is identical to the one provided to gmx_ana_indexmap_init().
 167      */
 168     t_blocka            b;
 169     /*! \brief
 170      * true if the current reference IDs are for the whole group (internal use only).
 171      *
 172      * This is used internally to optimize the evaluation such that
 173      * gmx_ana_indexmap_update() does not take any time if the group is
 174      * actually static.
 175      */
 176     bool                bStatic;
 177 };
 178
 179
 180 /*! \name Functions for handling gmx_ana_indexgrps_t
 181  */
 182 /*@{*/
 183 /** Reads index groups from a file or constructs them from topology. */
 184 void
 185 gmx_ana_indexgrps_init(gmx_ana_indexgrps_t **g, t_topology *top,
 186                        const char *fnm);
 187 /** Frees memory allocated for index groups. */
 188 void
 189 gmx_ana_indexgrps_free(gmx_ana_indexgrps_t *g);
 190 /** Returns true if the index group structure is emtpy. */
 191 bool
 192 gmx_ana_indexgrps_is_empty(gmx_ana_indexgrps_t *g);
 193
 194 /** Returns a pointer to an index group. */
 195 gmx_ana_index_t *
 196 gmx_ana_indexgrps_get_grp(gmx_ana_indexgrps_t *g, int n);
 197 /** Extracts a single index group. */
 198 bool
 199 gmx_ana_indexgrps_extract(gmx_ana_index_t *dest, std::string *destName,
 200                           gmx_ana_indexgrps_t *src, int n);
 201 /** Finds and extracts a single index group by name. */
 202 bool
 203 gmx_ana_indexgrps_find(gmx_ana_index_t *dest, std::string *destName,
 204                        gmx_ana_indexgrps_t *src, const char *name);
 205
 206 /** Writes out a list of index groups. */
 207 void
 208 gmx_ana_indexgrps_print(FILE *fp, gmx_ana_indexgrps_t *g, int maxn);
 209 /*@}*/
 210
 211 /*! \name Functions for handling gmx_ana_index_t
 212  */
 213 /*@{*/
 214 /** Reserves memory to store an index group of size \p isize. */
 215 void
 216 gmx_ana_index_reserve(gmx_ana_index_t *g, int isize);
 217 /** Frees any memory not necessary to hold the current contents. */
 218 void
 219 gmx_ana_index_squeeze(gmx_ana_index_t *g);
 220 /** Initializes an empty index group. */
 221 void
 222 gmx_ana_index_clear(gmx_ana_index_t *g);
 223 /** Constructs a \c gmx_ana_index_t from given values. */
 224 void
 225 gmx_ana_index_set(gmx_ana_index_t *g, int isize, atom_id *index, int nalloc);
 226 /** Creates a simple index group from the first to the \p natoms'th atom. */
 227 void
 228 gmx_ana_index_init_simple(gmx_ana_index_t *g, int natoms);
 229 /** Frees memory allocated for an index group. */
 230 void
 231 gmx_ana_index_deinit(gmx_ana_index_t *g);
 232 /** Copies a \c gmx_ana_index_t. */
 233 void
 234 gmx_ana_index_copy(gmx_ana_index_t *dest, gmx_ana_index_t *src, bool bAlloc);
 235
 236 /** Writes out the contents of a index group. */
 237 void
 238 gmx_ana_index_dump(FILE *fp, gmx_ana_index_t *g, int maxn);
 239
 240 /*! \brief
 241  * Returns maximum atom index that appears in an index group.
 242  *
 243  * \param[in]  g      Index group to query.
 244  * \returns    Largest atom index that appears in \p g, or zero if \p g is empty.
 245  */
 246 int
 247 gmx_ana_index_get_max_index(gmx_ana_index_t *g);
 248 /** Checks whether an index group is sorted. */
 249 bool
 250 gmx_ana_index_check_sorted(gmx_ana_index_t *g);
 251 /*! \brief
 252  * Checks whether an index group has atoms from a defined range.
 253  *
 254  * \param[in]  g      Index group to check.
 255  * \param[in]  natoms Largest atom number allowed.
 256  * \returns    true if all atoms in the index group are in the
 257  *     range 0 to \p natoms (i.e., no atoms over \p natoms are referenced).
 258  */
 259 bool
 260 gmx_ana_index_check_range(gmx_ana_index_t *g, int natoms);
 261 /*@}*/
 262
 263 /*! \name Functions for set operations on gmx_ana_index_t
 264  */
 265 /*@{*/
 266 /** Sorts the indices within an index group. */
 267 void
 268 gmx_ana_index_sort(gmx_ana_index_t *g);
 269 /** Checks whether two index groups are equal. */
 270 bool
 271 gmx_ana_index_equals(gmx_ana_index_t *a, gmx_ana_index_t *b);
 272 /** Checks whether a sorted index group contains another sorted index group. */
 273 bool
 274 gmx_ana_index_contains(gmx_ana_index_t *a, gmx_ana_index_t *b);
 275
 276 /** Calculates the intersection between two sorted index groups. */
 277 void
 278 gmx_ana_index_intersection(gmx_ana_index_t *dest,
 279                            gmx_ana_index_t *a, gmx_ana_index_t *b);
 280 /** Calculates the set difference between two sorted index groups. */
 281 void
 282 gmx_ana_index_difference(gmx_ana_index_t *dest,
 283                          gmx_ana_index_t *a, gmx_ana_index_t *b);
 284 /** Calculates the size of the difference between two sorted index groups. */
 285 int
 286 gmx_ana_index_difference_size(gmx_ana_index_t *a, gmx_ana_index_t *b);
 287 /** Calculates the union of two sorted index groups. */
 288 void
 289 gmx_ana_index_union(gmx_ana_index_t *dest,
 290                     gmx_ana_index_t *a, gmx_ana_index_t *b);
 291 /** Merges two distinct sorted index groups. */
 292 void
 293 gmx_ana_index_merge(gmx_ana_index_t *dest,
 294                     gmx_ana_index_t *a, gmx_ana_index_t *b);
 295 /** Calculates the intersection and the difference in one call. */
 296 void
 297 gmx_ana_index_partition(gmx_ana_index_t *dest1, gmx_ana_index_t *dest2,
 298                         gmx_ana_index_t *src, gmx_ana_index_t *g);
 299 /*@}*/
 300
 301 /*! \name Functions for handling gmx_ana_indexmap_t and related things
 302  */
 303 /*@{*/
 304 /** Partition a group based on topology information. */
 305 void
 306 gmx_ana_index_make_block(t_blocka *t, t_topology *top, gmx_ana_index_t *g,
 307                          e_index_t type, bool bComplete);
 308 /** Checks whether a group consists of full blocks. */
 309 bool
 310 gmx_ana_index_has_full_blocks(gmx_ana_index_t *g, t_block *b);
 311 /** Checks whether a group consists of full blocks. */
 312 bool
 313 gmx_ana_index_has_full_ablocks(gmx_ana_index_t *g, t_blocka *b);
 314 /** Checks whether a group consists of full residues/molecules. */
 315 bool
 316 gmx_ana_index_has_complete_elems(gmx_ana_index_t *g, e_index_t type, t_topology *top);
 317
 318 /** Initializes an empty index group mapping. */
 319 void
 320 gmx_ana_indexmap_clear(gmx_ana_indexmap_t *m);
 321 /** Reserves memory for an index group mapping. */
 322 void
 323 gmx_ana_indexmap_reserve(gmx_ana_indexmap_t *m, int nr, int isize);
 324 /** Initializes an index group mapping. */
 325 void
 326 gmx_ana_indexmap_init(gmx_ana_indexmap_t *m, gmx_ana_index_t *g,
 327                       t_topology *top, e_index_t type);
 328 /*! \brief
 329  * Initializes `orgid` entries based on topology grouping.
 330  *
 331  * \param[in,out] m     Mapping structure to use/initialize.
 332  * \param[in]     top   Topology structure
 333  *     (can be NULL if not required for \p type).
 334  * \param[in]     type  Type of groups to use.
 335  * \returns  The number of groups of type \p type that were present in \p m.
 336  * \throws   InconsistentInputError if the blocks in \p m do not have a unique
 337  *     group (e.g., contain atoms from multiple residues with `type == INDEX_RES`).
 338  *
 339  * By default, the gmx_ana_indexmap_t::orgid fields are initialized to
 340  * atom/residue/molecule indices from the topology (see documentation for the
 341  * struct for more details).
 342  * This function can be used to set the field to a zero-based group index
 343  * instead.  The first block will always get `orgid[0] = 0`, and all following
 344  * blocks that belong to the same residue/molecule (\p type) will get the same
 345  * index.  Each time a block does not belong to the same group, it will get the
 346  * next available number.
 347  * If `type == INDEX_ATOM`, the `orgid` field is initialized as 0, 1, ...,
 348  * independent of whether the blocks are single atoms or not.
 349  *
 350  * Strong exception safety guarantee.
 351  */
 352 int
 353 gmx_ana_indexmap_init_orgid_group(gmx_ana_indexmap_t *m, t_topology *top,
 354                                   e_index_t type);
 355 /** Sets an index group mapping to be static. */
 356 void
 357 gmx_ana_indexmap_set_static(gmx_ana_indexmap_t *m, t_blocka *b);
 358 /** Frees memory allocated for index group mapping. */
 359 void
 360 gmx_ana_indexmap_deinit(gmx_ana_indexmap_t *m);
 361 /** Makes a deep copy of an index group mapping. */
 362 void
 363 gmx_ana_indexmap_copy(gmx_ana_indexmap_t *dest, gmx_ana_indexmap_t *src, bool bFirst);
 364 /** Updates an index group mapping. */
 365 void
 366 gmx_ana_indexmap_update(gmx_ana_indexmap_t *m, gmx_ana_index_t *g, bool bMaskOnly);
 367 /*@}*/
 368
 369 #endif