src/gromacs/selection/selectioncollection-impl.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 /*! \internal \file
  36  * \brief
  37  * Declares private implementation class for gmx::SelectionCollection.
  38  *
  39  * This header also defines ::gmx_ana_selcollection_t, which is used in the old
  40  * C code for handling selection collections.
  41  *
  42  * \author Teemu Murtola <teemu.murtola@gmail.com>
  43  * \ingroup module_selection
  44  */
  45 #ifndef GMX_SELECTION_SELECTIONCOLLECTION_IMPL_H
  46 #define GMX_SELECTION_SELECTIONCOLLECTION_IMPL_H
  47
  48 #include <string>
  49 #include <vector>
  50
  51 #include <boost/scoped_ptr.hpp>
  52
  53 #include "gromacs/onlinehelp/helptopicinterface.h"
  54 #include "gromacs/selection/indexutil.h"
  55 #include "gromacs/selection/selection.h" // For gmx::SelectionList
  56 #include "gromacs/selection/selectioncollection.h"
  57 #include "gromacs/utility/uniqueptr.h"
  58
  59 #include "poscalc.h"
  60 #include "selelem.h"
  61
  62 struct gmx_sel_mempool_t;
  63 struct t_pbc;
  64 struct t_topology;
  65 struct t_trxframe;
  66
  67 namespace gmx
  68 {
  69
  70 //! Smart pointer for managing an internal selection data object.
  71 typedef gmx_unique_ptr<internal::SelectionData>::type SelectionDataPointer;
  72 //! Container for storing a list of selections internally.
  73 typedef std::vector<SelectionDataPointer> SelectionDataList;
  74
  75 class SelectionParserSymbolTable;
  76
  77 } // namespace gmx
  78
  79 /*! \internal \brief
  80  * Information for a collection of selections.
  81  *
  82  * \ingroup module_selection
  83  */
  84 struct gmx_ana_selcollection_t
  85 {
  86     //! Position calculation collection used for selection position evaluation.
  87     gmx::PositionCalculationCollection  pcc;
  88     //! Root of the selection element tree.
  89     gmx::SelectionTreeElementPointer    root;
  90     /*! \brief
  91      * Array of compiled selections.
  92      *
  93      * Has the responsibility of managing the memory for the contained objects,
  94      * but note that gmx::Selection instances also hold pointers to the
  95      * objects.
  96      */
  97     gmx::SelectionDataList         sel;
  98     /** Number of variables defined. */
  99     int                            nvars;
 100     /** Selection strings for variables. */
 101     char                         **varstrs;
 102
 103     /** Topology for the collection. */
 104     t_topology                                        *top;
 105     /** Index group that contains all the atoms. */
 106     gmx_ana_index_t                                    gall;
 107     /** Memory pool used for selection evaluation. */
 108     gmx_sel_mempool_t                                 *mempool;
 109     //! Parser symbol table.
 110     boost::scoped_ptr<gmx::SelectionParserSymbolTable> symtab;
 111     //! Root of help topic tree (NULL is no help yet requested).
 112     gmx::HelpTopicPointer                              rootHelp;
 113 };
 114
 115 namespace gmx
 116 {
 117
 118 class ExceptionInitializer;
 119
 120 /*! \internal \brief
 121  * Private implemention class for SelectionCollection.
 122  *
 123  * \ingroup module_selection
 124  */
 125 class SelectionCollection::Impl
 126 {
 127     public:
 128         /*! \brief
 129          * Creates a new selection collection.
 130          *
 131          * \throws  std::bad_alloc if out of memory.
 132          */
 133         Impl();
 134         ~Impl();
 135
 136         /*! \brief
 137          * Clears the symbol table of the selection collection.
 138          *
 139          * Does not throw.
 140          */
 141         void clearSymbolTable();
 142         /*! \brief
 143          * Replace group references by group contents.
 144          *
 145          * \param[in]    root    Root of selection tree to process.
 146          * \param        errors  Object for reporting any error messages.
 147          * \throws std::bad_alloc if out of memory.
 148          *
 149          * Recursively searches the selection tree for unresolved external
 150          * references.  If one is found, finds the referenced group in
 151          * \a grps_ and replaces the reference with a constant element that
 152          * contains the atoms from the referenced group.  Any failures to
 153          * resolve references are reported to \p errors.
 154          */
 155         void resolveExternalGroups(const gmx::SelectionTreeElementPointer &root,
 156                                    ExceptionInitializer                   *errors);
 157
 158         //! Internal data, used for interfacing with old C code.
 159         gmx_ana_selcollection_t sc_;
 160         //! Default reference position type for selections.
 161         std::string             rpost_;
 162         //! Default output position type for selections.
 163         std::string             spost_;
 164         //! Largest atom index needed by the selections for evaluation.
 165         int                     maxAtomIndex_;
 166         /*! \brief
 167          * Debugging level for the collection.
 168          *
 169          * Possible values:
 170          *  - 0: no debugging
 171          *  - 1: print selection trees after parsing and compilation
 172          *  - 2: like 1, also print intermediate compilation trees
 173          *  - 3: like 1, also print the tree after evaluation
 174          *  - 4: combine 2 and 3
 175          */
 176         int                     debugLevel_;
 177         //! Whether setIndexGroups() has been called.
 178         bool                    bExternalGroupsSet_;
 179         //! External index groups (can be NULL).
 180         gmx_ana_indexgrps_t    *grps_;
 181 };
 182
 183 /*! \internal
 184  * \brief
 185  * Implements selection evaluation.
 186  *
 187  * This class is used to implement SelectionCollection::evaluate() and
 188  * SelectionCollection::evaluateFinal().
 189  *
 190  * \ingroup module_selection
 191  */
 192 class SelectionEvaluator
 193 {
 194     public:
 195         SelectionEvaluator();
 196
 197         /*! \brief
 198          * Evaluates selections in a collection.
 199          */
 200         void evaluate(SelectionCollection *sc, t_trxframe *fr, t_pbc *pbc);
 201         /*! \brief
 202          * Evaluates the final state for dynamic selections.
 203          */
 204         void evaluateFinal(SelectionCollection *sc, int nframes);
 205 };
 206
 207 } // namespace gmx
 208
 209 #endif