src/gromacs/selection/selectioncollection.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  37  * Declares gmx::SelectionCollection.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_selection
  42  */
  43 #ifndef GMX_SELECTION_SELECTIONCOLLECTION_H
  44 #define GMX_SELECTION_SELECTIONCOLLECTION_H
  45
  46 #include <cstdio>
  47
  48 #include <string>
  49 #include <vector>
  50
  51 #include "gromacs/legacyheaders/types/oenv.h"
  52 #include "gromacs/selection/selection.h" // For gmx::SelectionList
  53 #include "gromacs/utility/common.h"
  54
  55 struct gmx_ana_indexgrps_t;
  56 struct t_pbc;
  57 struct t_topology;
  58 struct t_trxframe;
  59
  60 namespace gmx
  61 {
  62
  63 class Options;
  64 class SelectionCompiler;
  65 class SelectionEvaluator;
  66
  67 /*! \brief
  68  * Collection of selections.
  69  *
  70  * This class is the main interface to the core of the selection engine.
  71  * It is used to initialize and manage a collection of selections that share
  72  * the same topology.  Selections within one collection can share variables and
  73  * can be optimized together.  Selections from two different collections do not
  74  * interact.
  75  *
  76  * The constructor creates an empty selection collection object.  To initialize
  77  * the object, either call initOptions(), or both setReferencePosType() and
  78  * setOutputPosType().  See these methods for more details on the
  79  * initialization options.
  80  *
  81  * After setting the default values, one or more selections can be parsed with
  82  * one or more calls to parseFromStdin(), parseFromFile(), and/or
  83  * parseFromString().  After all selections are parsed, the topology must be
  84  * set with setTopology() unless requiresTopology() returns false (the topology
  85  * can also be set earlier).
  86  * setIndexGroups() must also be called if external index group references are
  87  * used in the selections; it can be called at any point before compile().
  88  * Once all selections are parsed, they must be compiled all at once using
  89  * compile().
  90  *
  91  * After compilation, dynamic selections have the maximum number of atoms they
  92  * can evaluate to, but positions have undefined values (see \ref Selection and
  93  * SelectionPosition).  evaluate() can be used to update the selections for a
  94  * new frame.  evaluateFinal() can be called after all the frames have been
  95  * processed to restore the selection values back to the ones they were after
  96  * compile().
  97  *
  98  * At any point, requiresTopology() can be called to see whether the
  99  * information provided so far requires loading the topology.
 100  * printTree() can be used to print the internal representation of the
 101  * selections (mostly useful for debugging).
 102  *
 103  * Note that for trajectory analysis using TrajectoryAnalysisModule, the
 104  * SelectionCollection object is managed by Gromacs, and \ref Selection objects
 105  * are obtained from SelectionOption.
 106  *
 107  * \inpublicapi
 108  * \ingroup module_selection
 109  */
 110 class SelectionCollection
 111 {
 112     public:
 113         /*! \brief
 114          * Creates an empty selection collection.
 115          *
 116          * \throws  std::bad_alloc if out of memory.
 117          */
 118         SelectionCollection();
 119         ~SelectionCollection();
 120
 121         /*! \brief
 122          * Initializes options for setting global properties on the collection.
 123          *
 124          * \param[in,out] options Options object to initialize.
 125          * \throws        std::bad_alloc if out of memory.
 126          *
 127          * Adds options to \p options that can be used to set the default
 128          * position types (see setReferencePosType() and setOutputPosType())
 129          * and debugging flags.
 130          */
 131         void initOptions(Options *options);
 132
 133         /*! \brief
 134          * Sets the default reference position handling for a selection
 135          * collection.
 136          *
 137          * \param[in]     type      Default selection reference position type
 138          *     (one of the strings acceptable for
 139          *     PositionCalculationCollection::typeFromEnum()).
 140          * \throws  InternalError if \p type is invalid.
 141          *
 142          * Should be called before calling the parser functions, unless
 143          * initOptions() has been called.  In the latter case, can still be
 144          * used to override the default value (before initOptions() is called)
 145          * and/or the value provided through the Options object.
 146          *
 147          * Strong exception safety.
 148          */
 149         void setReferencePosType(const char *type);
 150         /*! \brief
 151          * Sets the default reference position handling for a selection
 152          * collection.
 153          *
 154          * \param[in]     type      Default selection output position type
 155          *     (one of the strings acceptable for
 156          *     PositionCalculationCollection::typeFromEnum()).
 157          * \throws  InternalError if \p type is invalid.
 158          *
 159          * Should be called before calling the parser functions, unless
 160          * initOptions() has been called.  In the latter case, can still be
 161          * used to override the default value (before initOptions() is called)
 162          * and/or the value provided through the Options object.
 163          *
 164          * Strong exception safety.
 165          */
 166         void setOutputPosType(const char *type);
 167         /*! \brief
 168          * Sets the debugging level for the selection collection.
 169          *
 170          * \param[in]   debugLevel  Debug level to set (0 = no debug
 171          *      information).
 172          *
 173          * initOptions() creates debugging options that can also be used to set
 174          * the debug level.  These are normally hidden, but if this method is
 175          * called before initOptions() with a non-zero \p debugLevel, they are
 176          * made visible.
 177          *
 178          * Mostly useful for debugging tools.
 179          *
 180          * Does not throw.
 181          */
 182         void setDebugLevel(int debugLevel);
 183
 184         /*! \brief
 185          * Returns true if the collection requires topology information for
 186          * evaluation.
 187          *
 188          * \returns true if any selection in the collection requires topology
 189          *      information.
 190          *
 191          * Before the parser functions have been called, the return value is
 192          * based just on the position types set.
 193          * After parser functions have been called, the return value also takes
 194          * into account the selection keywords used.
 195          *
 196          * Does not throw.
 197          */
 198         bool requiresTopology() const;
 199         /*! \brief
 200          * Sets the topology for the collection.
 201          *
 202          * \param[in]     top       Topology data.
 203          * \param[in]     natoms    Number of atoms. If <=0, the number of
 204          *      atoms in the topology is used.
 205          *
 206          * Either the topology must be provided, or \p natoms must be > 0.
 207          *
 208          * \p natoms determines the largest atom index that can be selected by
 209          * the selection: even if the topology contains more atoms, they will
 210          * not be selected.
 211          *
 212          * Does not throw currently, but this is subject to change when more
 213          * underlying code is converted to C++.
 214          */
 215         void setTopology(t_topology *top, int natoms);
 216         /*! \brief
 217          * Sets the external index groups to use for the selections.
 218          *
 219          * \param[in]  grps  Index groups to use for the selections.
 220          * \throws  std::bad_alloc if out of memory.
 221          * \throws  InconsistentInputError if a group reference cannot be resolved.
 222          *
 223          * Only the first call to this method can have a non-NULL \p grps.
 224          * At this point, any selections that have already been provided are
 225          * searched for references to external groups, and the references are
 226          * replaced by the contents of the groups.  If any referenced group
 227          * cannot be found in \p grps (or if \p grps is NULL and there are any
 228          * references), InconsistentInputError is thrown.
 229          *
 230          * The selection collection keeps a reference to \p grps until this
 231          * method is called with a NULL \p grps.
 232          * If this method is not called before compile(), it is automatically
 233          * called as setIndexGroups(NULL).
 234          */
 235         void setIndexGroups(gmx_ana_indexgrps_t *grps);
 236         /*! \brief
 237          * Parses selection(s) from standard input.
 238          *
 239          * \param[in]  count    Number of selections to parse
 240          *      (if -1, parse as many as provided by the user).
 241          * \param[in]  bInteractive Whether the parser should behave
 242          *      interactively.
 243          * \param[in]  context  Context to print for interactive input.
 244          * \returns    Vector of parsed selections.
 245          * \throws     std::bad_alloc if out of memory.
 246          * \throws     InvalidInputError if there is a parsing error
 247          *      (an interactive parser only throws this if too few selections
 248          *      are provided and the user forced the end of input).
 249          *
 250          * The returned objects remain valid for the lifetime of
 251          * the selection collection.
 252          * Some information about the selections only becomes available once
 253          * compile() has been called; see \ref Selection.
 254          *
 255          * The string provided to \p context should be such that it can replace
 256          * the three dots in "Specify selections ...:".  It can be empty.
 257          */
 258         SelectionList parseFromStdin(int count, bool bInteractive,
 259                                      const std::string &context);
 260         /*! \brief
 261          * Parses selection(s) from a file.
 262          *
 263          * \param[in]  filename Name of the file to parse selections from.
 264          * \returns    Vector of parsed selections.
 265          * \throws     std::bad_alloc if out of memory.
 266          * \throws     InvalidInputError if there is a parsing error.
 267          *
 268          * The returned objects remain valid for the lifetime of
 269          * the selection collection.
 270          * Some information about the selections only becomes available once
 271          * compile() has been called; see \ref Selection.
 272          */
 273         SelectionList parseFromFile(const std::string &filename);
 274         /*! \brief
 275          * Parses selection(s) from a string.
 276          *
 277          * \param[in]  str      String to parse selections from.
 278          * \returns    Vector of parsed selections.
 279          * \throws     std::bad_alloc if out of memory.
 280          * \throws     InvalidInputError if there is a parsing error.
 281          *
 282          * The returned objects remain valid for the lifetime of
 283          * the selection collection.
 284          * Some information about the selections only becomes available once
 285          * compile() has been called; see \ref Selection.
 286          */
 287         SelectionList parseFromString(const std::string &str);
 288         /*! \brief
 289          * Prepares the selections for evaluation and performs optimizations.
 290          *
 291          * \throws  InconsistentInputError if topology is required but not set.
 292          * \throws  InvalidInputError if setIndexGroups() has not been called
 293          *      and there are index group references.
 294          * \throws  unspecified if compilation fails (TODO: list/reduce these).
 295          *
 296          * Before compilation, selections should have been added to the
 297          * collection using the parseFrom*() functions.
 298          * The compiled selection collection can be passed to evaluate() to
 299          * evaluate the selection for a frame.
 300          * Before the compiled selection is evaluated, the selections indicate
 301          * the maximal set of atoms/positions to which they can be evaluated;
 302          * see \ref Selection.
 303          *
 304          * If an error occurs, the collection is cleared.
 305          *
 306          * The covered fraction information is initialized to ::CFRAC_NONE for
 307          * all selections.
 308          */
 309         void compile();
 310         /*! \brief
 311          * Evaluates selections in the collection.
 312          *
 313          * \param[in] fr  Frame for which the evaluation should be carried out.
 314          * \param[in] pbc PBC data, or NULL if no PBC should be used.
 315          * \throws    unspeficied  Multiple possible exceptions to indicate
 316          *      evaluation failure (TODO: enumerate).
 317          */
 318         void evaluate(t_trxframe *fr, t_pbc *pbc);
 319         /*! \brief
 320          * Evaluates the largest possible index groups from dynamic selections.
 321          *
 322          * \param[in] nframes Total number of frames.
 323          *
 324          * This method restores the selections to the state they were after
 325          * compile().
 326          *
 327          * \p nframes should equal the number of times evaluate() has been
 328          * called.
 329          *
 330          * Does not throw.
 331          */
 332         void evaluateFinal(int nframes);
 333
 334         /*! \brief
 335          * Prints a human-readable version of the internal selection element
 336          * tree.
 337          *
 338          * \param[in] fp      File handle to receive the output.
 339          * \param[in] bValues If true, the evaluated values of selection
 340          *      elements are printed as well.
 341          *
 342          * The output is very techical, and intended for debugging purposes.
 343          *
 344          * Does not throw.
 345          */
 346         void printTree(FILE *fp, bool bValues) const;
 347         /*! \brief
 348          * Prints the selection strings into an XVGR file as comments.
 349          *
 350          * \param[in] fp   Output file.
 351          * \param[in] oenv Output options structure.
 352          *
 353          * Does not throw.
 354          */
 355         void printXvgrInfo(FILE *fp, output_env_t oenv) const;
 356
 357     private:
 358         class Impl;
 359
 360         PrivateImplPointer<Impl> impl_;
 361
 362         /*! \brief
 363          * Needed for the compiler to freely modify the collection.
 364          */
 365         friend class SelectionCompiler;
 366         /*! \brief
 367          * Needed for the evaluator to freely modify the collection.
 368          */
 369         friend class SelectionEvaluator;
 370 };
 371
 372 } // namespace gmx
 373
 374 #endif