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