src/gromacs/selection/compiler.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2013,2019,2020, 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 gmx::SelectionCompiler.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #ifndef GMX_SELECTION_COMPILER_H
  43 #define GMX_SELECTION_COMPILER_H
  44
  45 namespace gmx
  46 {
  47
  48 class SelectionCollection;
  49
  50 /*! \internal
  51  * \brief
  52  * Implements selection compilation.
  53  *
  54  * This function is used to implement SelectionCollection::compile().
  55  * It prepares the selections in a selection collection for evaluation and
  56  * performs some optimizations.
  57  *
  58  * Before compilation, the selection collection should have been initialized
  59  * with gmx_ana_selcollection_parse_*().
  60  * The compiled selection collection can be passed to
  61  * gmx_ana_selcollection_evaluate() to evaluate the selection for a frame.
  62  * If an error occurs, \p coll is cleared.
  63  *
  64  * The covered fraction information in \p coll is initialized to
  65  * \ref CFRAC_NONE.
  66  *
  67  * See \ref page_module_selection_compiler.
  68  *
  69  * \param[in, out] coll Selection collection to work on.
  70  *
  71  * \ingroup module_selection
  72  */
  73 void compileSelection(SelectionCollection* coll);
  74
  75 } // namespace gmx
  76
  77 #endif