2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2009,2010,2011,2012,2013, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Implements functions in evaluate.h.
40 * One of the major bottlenecks for selection performance is that all the
41 * evaluation is carried out for atoms.
42 * There are several cases when the evaluation could be done for residues
43 * or molecules instead, including keywords that select by residue and
44 * cases where residue centers are used as reference positions.
45 * Implementing this would require a mechanism for recognizing whether
46 * something can be evaluated by residue/molecule instead by atom, and
47 * converting selections by residue/molecule into selections by atom
50 * \author Teemu Murtola <teemu.murtola@gmail.com>
51 * \ingroup module_selection
55 #include "gromacs/legacyheaders/maths.h"
56 #include "gromacs/legacyheaders/smalloc.h"
57 #include "gromacs/legacyheaders/vec.h"
59 #include "gromacs/selection/indexutil.h"
60 #include "gromacs/selection/poscalc.h"
61 #include "gromacs/selection/selection.h"
62 #include "gromacs/selection/selmethod.h"
63 #include "gromacs/utility/exceptions.h"
64 #include "gromacs/utility/gmxassert.h"
68 #include "selectioncollection-impl.h"
71 using gmx::SelectionTreeElement;
72 using gmx::SelectionTreeElementPointer;
78 * Reserves memory for a selection element from the evaluation memory pool.
80 * This class implements RAII semantics for allocating memory for selection
81 * element values from a selection evaluation memory pool.
83 * \ingroup module_selection
85 class MempoolSelelemReserver
88 //! Constructs a reserver without initial reservation.
89 MempoolSelelemReserver() {}
91 * Constructs a reserver with initial reservation.
93 * \param[in,out] sel Selection element for which to reserve.
94 * \param[in] count Number of values to reserve.
98 MempoolSelelemReserver(const SelectionTreeElementPointer &sel, int count)
102 //! Frees any memory allocated using this reserver.
103 ~MempoolSelelemReserver()
107 sel_->mempoolRelease();
112 * Reserves memory for selection element values using this reserver.
114 * \param[in,out] sel Selection element for which to reserve.
115 * \param[in] count Number of values to reserve.
117 * Allocates space to store \p count output values in \p sel from the
118 * memory pool associated with \p sel, or from the heap if there is no
119 * memory pool. Type of values to allocate is automatically determined
122 void reserve(const SelectionTreeElementPointer &sel, int count)
124 GMX_RELEASE_ASSERT(!sel_,
125 "Can only reserve one element with one instance");
126 sel->mempoolReserve(count);
131 SelectionTreeElementPointer sel_;
135 * Reserves memory for an index group from the evaluation memory pool.
137 * This class implements RAII semantics for allocating memory for an index
138 * group from a selection evaluation memory pool.
140 * \ingroup module_selection
142 class MempoolGroupReserver
146 * Creates a reserver associated with a given memory pool.
148 * \param mp Memory pool from which to reserve memory.
150 explicit MempoolGroupReserver(gmx_sel_mempool_t *mp)
154 //! Frees any memory allocated using this reserver.
155 ~MempoolGroupReserver()
159 _gmx_sel_mempool_free_group(mp_, g_);
164 * Reserves memory for an index group using this reserver.
166 * \param[in,out] g Index group to reserve.
167 * \param[in] count Number of atoms to reserve space for.
169 * Allocates memory from the memory pool to store \p count atoms in
172 void reserve(gmx_ana_index_t *g, int count)
174 GMX_RELEASE_ASSERT(g_ == NULL, "Can only reserve one element with one instance");
175 _gmx_sel_mempool_alloc_group(mp_, g, count);
180 gmx_sel_mempool_t *mp_;
185 * Assigns a temporary value for a selection element.
187 * This class implements RAII semantics for temporarily assigning the value
188 * pointer of a selection element to point to a different location.
190 * \ingroup module_selection
192 class SelelemTemporaryValueAssigner
195 //! Constructs an assigner without an initial assignment.
196 SelelemTemporaryValueAssigner()
197 : old_ptr_(NULL), old_nalloc_(0)
201 * Constructs an assigner with an initial assignment.
203 * \param[in,out] sel Selection element for which to assign.
204 * \param[in] vsource Element to which \p sel values will point to.
208 SelelemTemporaryValueAssigner(const SelectionTreeElementPointer &sel,
209 const SelectionTreeElement &vsource)
211 assign(sel, vsource);
213 //! Undoes any temporary assignment done using this assigner.
214 ~SelelemTemporaryValueAssigner()
218 _gmx_selvalue_setstore_alloc(&sel_->v, old_ptr_, old_nalloc_);
223 * Assigns a temporary value pointer.
225 * \param[in,out] sel Selection element for which to assign.
226 * \param[in] vsource Element to which \p sel values will point to.
228 * Assigns the value pointer in \p sel to point to the values in
229 * \p vsource, i.e., any access/modification to values in \p sel
230 * actually accesses values in \p vsource.
232 void assign(const SelectionTreeElementPointer &sel,
233 const SelectionTreeElement &vsource)
235 GMX_RELEASE_ASSERT(!sel_,
236 "Can only assign one element with one instance");
237 GMX_RELEASE_ASSERT(sel->v.type == vsource.v.type,
238 "Mismatching selection value types");
239 old_ptr_ = sel->v.u.ptr;
240 old_nalloc_ = sel->v.nalloc;
241 _gmx_selvalue_setstore(&sel->v, vsource.v.u.ptr);
246 SelectionTreeElementPointer sel_;
254 * \param[in] fp File handle to receive the output.
255 * \param[in] evalfunc Function pointer to print.
258 _gmx_sel_print_evalfunc_name(FILE *fp, gmx::sel_evalfunc evalfunc)
264 else if (evalfunc == &_gmx_sel_evaluate_root)
268 else if (evalfunc == &_gmx_sel_evaluate_static)
270 fprintf(fp, "static");
272 else if (evalfunc == &_gmx_sel_evaluate_subexpr_simple)
274 fprintf(fp, "subexpr_simple");
276 else if (evalfunc == &_gmx_sel_evaluate_subexpr_staticeval)
278 fprintf(fp, "subexpr_staticeval");
280 else if (evalfunc == &_gmx_sel_evaluate_subexpr)
282 fprintf(fp, "subexpr");
284 else if (evalfunc == &_gmx_sel_evaluate_subexprref_simple)
286 fprintf(fp, "ref_simple");
288 else if (evalfunc == &_gmx_sel_evaluate_subexprref)
292 else if (evalfunc == &_gmx_sel_evaluate_method)
294 fprintf(fp, "method");
296 else if (evalfunc == &_gmx_sel_evaluate_modifier)
300 else if (evalfunc == &_gmx_sel_evaluate_not)
304 else if (evalfunc == &_gmx_sel_evaluate_and)
308 else if (evalfunc == &_gmx_sel_evaluate_or)
312 else if (evalfunc == &_gmx_sel_evaluate_arithmetic)
314 fprintf(fp, "arithmetic");
318 fprintf(fp, "%p", (void*)(evalfunc));
323 * \param[out] data Evaluation data structure to initialize.
324 * \param[in] mp Memory pool for intermediate evaluation values.
325 * \param[in] gall Index group with all the atoms.
326 * \param[in] top Topology structure for evaluation.
327 * \param[in] fr New frame for evaluation.
328 * \param[in] pbc New PBC information for evaluation.
331 _gmx_sel_evaluate_init(gmx_sel_evaluate_t *data,
332 gmx_sel_mempool_t *mp, gmx_ana_index_t *gall,
333 t_topology *top, t_trxframe *fr, t_pbc *pbc)
343 * Recursively initializes the flags for evaluation.
345 * \param[in,out] sel Selection element to clear.
347 * The \ref SEL_INITFRAME flag is set for \ref SEL_EXPRESSION elements whose
348 * method defines the \p init_frame callback (see sel_framefunc()), and
349 * cleared for other elements.
351 * The \ref SEL_EVALFRAME flag is cleared for all elements.
354 init_frame_eval(SelectionTreeElementPointer sel)
358 sel->flags &= ~(SEL_INITFRAME | SEL_EVALFRAME);
359 if (sel->type == SEL_EXPRESSION)
361 if (sel->u.expr.method && sel->u.expr.method->init_frame)
363 sel->flags |= SEL_INITFRAME;
366 if (sel->child && sel->type != SEL_SUBEXPRREF)
368 init_frame_eval(sel->child);
377 SelectionEvaluator::SelectionEvaluator()
382 * \param[in,out] coll The selection collection to evaluate.
383 * \param[in] fr Frame for which the evaluation should be carried out.
384 * \param[in] pbc PBC data, or NULL if no PBC should be used.
385 * \returns 0 on successful evaluation, a non-zero error code on error.
387 * This functions sets the global variables for topology, frame and PBC,
388 * clears some information in the selection to initialize the evaluation
389 * for a new frame, and evaluates \p sel and all the selections pointed by
390 * the \p next pointers of \p sel.
392 * This is the only function that user code should call if they want to
393 * evaluate a selection for a new frame.
396 SelectionEvaluator::evaluate(SelectionCollection *coll,
397 t_trxframe *fr, t_pbc *pbc)
399 gmx_ana_selcollection_t *sc = &coll->impl_->sc_;
400 gmx_sel_evaluate_t data;
402 _gmx_sel_evaluate_init(&data, sc->mempool, &sc->gall, sc->top, fr, pbc);
403 init_frame_eval(sc->root);
404 SelectionTreeElementPointer sel = sc->root;
407 /* Clear the evaluation group of subexpressions */
408 if (sel->child && sel->child->type == SEL_SUBEXPR
409 && sel->child->evaluate != NULL)
411 sel->child->u.cgrp.isize = 0;
412 /* Not strictly necessary, because the value will be overwritten
413 * during first evaluation of the subexpression anyways, but we
414 * clear the group for clarity. Note that this is _not_ done during
415 * compilation because of some additional complexities involved
416 * (see compiler.cpp), so it should not be relied upon in
417 * _gmx_sel_evaluate_subexpr(). */
418 if (sel->child->v.type == GROUP_VALUE)
420 sel->child->v.u.g->isize = 0;
425 sel->evaluate(&data, sel, NULL);
429 /* Update selection information */
430 SelectionDataList::const_iterator isel;
431 for (isel = sc->sel.begin(); isel != sc->sel.end(); ++isel)
433 internal::SelectionData &sel = **isel;
434 sel.refreshMassesAndCharges(sc->top);
435 sel.updateCoveredFractionForFrame();
440 * \param[in,out] coll The selection collection to evaluate.
441 * \param[in] nframes Total number of frames.
444 SelectionEvaluator::evaluateFinal(SelectionCollection *coll, int nframes)
446 gmx_ana_selcollection_t *sc = &coll->impl_->sc_;
448 SelectionDataList::const_iterator isel;
449 for (isel = sc->sel.begin(); isel != sc->sel.end(); ++isel)
451 internal::SelectionData &sel = **isel;
452 sel.restoreOriginalPositions(sc->top);
453 sel.computeAverageCoveredFraction(nframes);
460 * \param[in] data Data for the current frame.
461 * \param[in] sel Selection element being evaluated.
462 * \param[in] g Group for which \p sel should be evaluated.
463 * \returns 0 on success, a non-zero error code on error.
465 * Evaluates each child of \p sel in \p g.
468 _gmx_sel_evaluate_children(gmx_sel_evaluate_t *data,
469 const SelectionTreeElementPointer &sel,
472 SelectionTreeElementPointer child = sel->child;
477 child->evaluate(data, child, g);
484 * \param[in] data Data for the current frame.
485 * \param[in] sel Selection element being evaluated.
486 * \param[in] g Group for which \p sel should be evaluated
487 * (not used, can be NULL).
488 * \returns 0 on success, a non-zero error code on error.
490 * Evaluates the first child element in the group defined by \p sel->u.cgrp.
491 * If \p sel->u.cgrp is empty, nothing is done.
492 * The value of \p sel is not touched (root elements do not evaluate to
495 * This function can be used as gmx::SelectionTreeElement::evaluate for
496 * \ref SEL_ROOT elements.
499 _gmx_sel_evaluate_root(gmx_sel_evaluate_t *data,
500 const SelectionTreeElementPointer &sel,
503 if (sel->u.cgrp.isize == 0 || !sel->child->evaluate)
508 sel->child->evaluate(data, sel->child,
509 sel->u.cgrp.isize < 0 ? NULL : &sel->u.cgrp);
513 * \param[in] data Data for the current frame.
514 * \param[in] sel Selection element being evaluated.
515 * \param[in] g Group for which \p sel should be evaluated.
516 * \returns 0 for success.
518 * Sets the value of \p sel to the intersection of \p g and \p sel->u.cgrp.
520 * This function can be used as gmx::SelectionTreeElement::evaluate for
521 * \ref SEL_CONST elements with value type \ref GROUP_VALUE.
524 _gmx_sel_evaluate_static(gmx_sel_evaluate_t *data,
525 const SelectionTreeElementPointer &sel,
528 gmx_ana_index_intersection(sel->v.u.g, &sel->u.cgrp, g);
532 /*********************************************************************
533 * SUBEXPRESSION EVALUATION
534 *********************************************************************/
537 * \param[in] data Data for the current frame.
538 * \param[in] sel Selection element being evaluated.
539 * \param[in] g Group for which \p sel should be evaluated.
540 * \returns 0 on success, a non-zero error code on error.
542 * Evaluates the child element (there should be exactly one) in \p g.
543 * The compiler has taken care that the child actually stores the evaluated
544 * value in the value pointer of this element.
546 * This function is used as gmx::SelectionTreeElement::evaluate for
547 * \ref SEL_SUBEXPR elements that are used only once, and hence do not need
548 * full subexpression handling.
551 _gmx_sel_evaluate_subexpr_simple(gmx_sel_evaluate_t *data,
552 const SelectionTreeElementPointer &sel,
555 if (sel->child->evaluate)
557 sel->child->evaluate(data, sel->child, g);
559 sel->v.nr = sel->child->v.nr;
563 * \param[in] data Data for the current frame.
564 * \param[in] sel Selection element being evaluated.
565 * \param[in] g Group for which \p sel should be evaluated.
566 * \returns 0 on success, a non-zero error code on error.
568 * If this is the first call for this frame, evaluates the child element
569 * there should be exactly one in \p g.
570 * The compiler has taken care that the child actually stores the evaluated
571 * value in the value pointer of this element.
572 * Assumes that \p g is persistent for the duration of the whole evaluation.
574 * This function is used as gmx::SelectionTreeElement::evaluate for
575 * \ref SEL_SUBEXPR elements that have a static evaluation group, and hence do
576 * not need full subexpression handling.
579 _gmx_sel_evaluate_subexpr_staticeval(gmx_sel_evaluate_t *data,
580 const SelectionTreeElementPointer &sel,
583 if (sel->u.cgrp.isize == 0)
585 sel->child->evaluate(data, sel->child, g);
586 sel->v.nr = sel->child->v.nr;
589 sel->u.cgrp.isize = -1;
593 gmx_ana_index_set(&sel->u.cgrp, g->isize, g->index, 0);
599 * \param[in] data Data for the current frame.
600 * \param[in] sel Selection element being evaluated.
601 * \param[in] g Group for which \p sel should be evaluated.
602 * \returns 0 on success, a non-zero error code on error.
604 * Finds the part of \p g for which the subexpression
605 * has not yet been evaluated by comparing \p g to \p sel->u.cgrp.
606 * If the part is not empty, the child expression is evaluated for this
607 * part, and the results merged to the old values of the child.
608 * The value of \p sel itself is undefined after the call.
611 * The call to gmx_ana_index_difference() can take quite a lot of unnecessary
612 * time if the subexpression is evaluated either several times for the same
613 * group or for completely distinct groups.
614 * However, in the majority of cases, these situations occur when
615 * _gmx_sel_evaluate_subexpr_staticeval() can be used, so this should not be a
619 _gmx_sel_evaluate_subexpr(gmx_sel_evaluate_t *data,
620 const SelectionTreeElementPointer &sel,
623 gmx_ana_index_t gmiss;
625 MempoolGroupReserver gmissreserver(data->mp);
626 if (sel->u.cgrp.isize == 0)
629 SelelemTemporaryValueAssigner assigner(sel->child, *sel);
630 sel->child->evaluate(data, sel->child, g);
632 gmx_ana_index_copy(&sel->u.cgrp, g, false);
637 gmissreserver.reserve(&gmiss, g->isize);
638 gmx_ana_index_difference(&gmiss, g, &sel->u.cgrp);
642 MempoolSelelemReserver reserver(sel->child, gmiss.isize);
643 /* Evaluate the missing values for the child */
644 sel->child->evaluate(data, sel->child, &gmiss);
645 /* Merge the missing values to the existing ones. */
646 if (sel->v.type == GROUP_VALUE)
648 gmx_ana_index_merge(sel->v.u.g, sel->child->v.u.g, sel->v.u.g);
654 i = sel->u.cgrp.isize - 1;
656 /* TODO: This switch is kind of ugly, but it may be difficult to
657 * do this portably without C++ templates. */
661 for (k = sel->u.cgrp.isize + gmiss.isize - 1; k >= 0; k--)
663 if (i < 0 || (j >= 0 && sel->u.cgrp.index[i] < gmiss.index[j]))
665 sel->v.u.i[k] = sel->child->v.u.i[j--];
669 sel->v.u.i[k] = sel->v.u.i[i--];
675 for (k = sel->u.cgrp.isize + gmiss.isize - 1; k >= 0; k--)
677 if (i < 0 || (j >= 0 && sel->u.cgrp.index[i] < gmiss.index[j]))
679 sel->v.u.r[k] = sel->child->v.u.r[j--];
683 sel->v.u.r[k] = sel->v.u.r[i--];
689 // Note: with the currently allowed syntax, this case is never
691 for (k = sel->u.cgrp.isize + gmiss.isize - 1; k >= 0; k--)
693 if (i < 0 || (j >= 0 && sel->u.cgrp.index[i] < gmiss.index[j]))
695 sel->v.u.s[k] = sel->child->v.u.s[j--];
699 sel->v.u.s[k] = sel->v.u.s[i--];
705 /* TODO: Implement this */
706 GMX_THROW(gmx::NotImplementedError("position subexpressions not implemented properly"));
710 GMX_THROW(gmx::InternalError("Invalid subexpression type"));
713 gmx_ana_index_merge(&sel->u.cgrp, &sel->u.cgrp, &gmiss);
718 * \param[in] data Data for the current frame.
719 * \param[in] sel Selection element being evaluated.
720 * \param[in] g Group for which \p sel should be evaluated.
721 * \returns 0 for success.
723 * Sets the value pointers of the child and its child to point to the same
724 * memory as the value pointer of this element to avoid copying, and then
725 * evaluates evaluates the child.
727 * This function is used as gmx::SelectionTreeElement:evaluate for
728 * \ref SEL_SUBEXPRREF elements for which the \ref SEL_SUBEXPR does not have
732 _gmx_sel_evaluate_subexprref_simple(gmx_sel_evaluate_t *data,
733 const SelectionTreeElementPointer &sel,
738 _gmx_selvalue_setstore(&sel->child->v, sel->v.u.ptr);
739 _gmx_selvalue_setstore_alloc(&sel->child->child->v, sel->v.u.ptr,
740 sel->child->child->v.nalloc);
741 sel->child->evaluate(data, sel->child, g);
743 sel->v.nr = sel->child->v.nr;
746 sel->u.param->val.nr = sel->v.nr;
747 if (sel->u.param->nvalptr)
749 *sel->u.param->nvalptr = sel->u.param->val.nr;
755 * \param[in] data Data for the current frame.
756 * \param[in] sel Selection element being evaluated.
757 * \param[in] g Group for which \p sel should be evaluated.
758 * \returns 0 on success, a non-zero error code on error.
760 * If the value type is \ref POS_VALUE, the value of the child is simply
761 * copied to set the value of \p sel (the child subexpression should
762 * already have been evaluated by its root).
763 * If the value type is something else, the child is evaluated for the
764 * group \p g, and the value of the child is then copied.
765 * There should be only one child element.
767 * This function is used as gmx::SelectionTreeElement::evaluate for
768 * \ref SEL_SUBEXPRREF elements.
771 _gmx_sel_evaluate_subexprref(gmx_sel_evaluate_t *data,
772 const SelectionTreeElementPointer &sel,
777 if (g != NULL && sel->child->evaluate != NULL)
779 sel->child->evaluate(data, sel->child, g);
781 const SelectionTreeElementPointer &expr = sel->child;
787 sel->v.nr = expr->v.nr;
788 memcpy(sel->v.u.i, expr->v.u.i, sel->v.nr*sizeof(*sel->v.u.i));
792 sel->v.nr = g->isize;
793 /* Extract the values corresponding to g */
794 for (i = j = 0; i < g->isize; ++i, ++j)
796 while (sel->child->u.cgrp.index[j] < g->index[i])
800 sel->v.u.i[i] = expr->v.u.i[j];
808 sel->v.nr = expr->v.nr;
809 memcpy(sel->v.u.r, expr->v.u.r, sel->v.nr*sizeof(*sel->v.u.r));
813 sel->v.nr = g->isize;
814 /* Extract the values corresponding to g */
815 for (i = j = 0; i < g->isize; ++i, ++j)
817 while (sel->child->u.cgrp.index[j] < g->index[i])
821 sel->v.u.r[i] = expr->v.u.r[j];
829 sel->v.nr = expr->v.nr;
830 memcpy(sel->v.u.s, expr->v.u.s, sel->v.nr*sizeof(*sel->v.u.s));
834 sel->v.nr = g->isize;
835 /* Extract the values corresponding to g */
836 for (i = j = 0; i < g->isize; ++i, ++j)
838 while (sel->child->u.cgrp.index[j] < g->index[i])
842 sel->v.u.s[i] = expr->v.u.s[j];
848 /* Currently, there is no need to do anything fancy here,
849 * but some future extensions may need a more flexible
851 gmx_ana_pos_copy(sel->v.u.p, expr->v.u.p, false);
857 gmx_ana_index_copy(sel->v.u.g, expr->v.u.g, false);
861 gmx_ana_index_intersection(sel->v.u.g, expr->v.u.g, g);
865 default: /* should not be reached */
866 GMX_THROW(gmx::InternalError("Invalid subexpression reference type"));
868 /* Store the number of values if needed */
871 sel->u.param->val.nr = sel->v.nr;
872 if (sel->u.param->nvalptr)
874 *sel->u.param->nvalptr = sel->u.param->val.nr;
879 /********************************************************************
880 * METHOD EXPRESSION EVALUATION
881 ********************************************************************/
884 * \param[in] data Data for the current frame.
885 * \param[in] sel Selection element being evaluated.
886 * \param[in] g Group for which \p sel should be evaluated.
887 * \returns 0 on success, a non-zero error code on error.
889 * Evaluates each child of a \ref SEL_EXPRESSION element.
890 * The value of \p sel is not touched.
892 * This function is not used as gmx::SelectionTreeElement::evaluate,
893 * but is used internally.
896 _gmx_sel_evaluate_method_params(gmx_sel_evaluate_t *data,
897 const SelectionTreeElementPointer &sel,
900 SelectionTreeElementPointer child = sel->child;
903 if (child->evaluate && !(child->flags & SEL_EVALFRAME))
905 if (child->flags & SEL_ATOMVAL)
907 child->evaluate(data, child, g);
911 child->flags |= SEL_EVALFRAME;
912 child->evaluate(data, child, NULL);
920 * \param[in] data Data for the current frame.
921 * \param[in] sel Selection element being evaluated.
922 * \param[in] g Group for which \p sel should be evaluated.
923 * \returns 0 on success, a non-zero error code on error.
925 * Evaluates all child selections (using _gmx_sel_evaluate_method_params())
926 * to evaluate any parameter values.
927 * If this is the first time this expression is evaluated for
928 * the frame, sel_framefunc() callback is called if one is provided.
929 * If a reference position calculation has been initialized for this element,
930 * the positions are also updated, and sel_updatefunc_pos() is used to
931 * evaluate the value. Otherwise, sel_updatefunc() is used.
933 * This function is used as gmx::SelectionTreeElement::evaluate for
934 * \ref SEL_EXPRESSION elements.
937 _gmx_sel_evaluate_method(gmx_sel_evaluate_t *data,
938 const SelectionTreeElementPointer &sel,
941 _gmx_sel_evaluate_method_params(data, sel, g);
942 if (sel->flags & SEL_INITFRAME)
944 sel->flags &= ~SEL_INITFRAME;
945 sel->u.expr.method->init_frame(data->top, data->fr, data->pbc,
950 gmx_ana_poscalc_update(sel->u.expr.pc, sel->u.expr.pos, g,
951 data->fr, data->pbc);
952 sel->u.expr.method->pupdate(data->top, data->fr, data->pbc,
953 sel->u.expr.pos, &sel->v,
958 sel->u.expr.method->update(data->top, data->fr, data->pbc, g,
959 &sel->v, sel->u.expr.mdata);
964 * \param[in] data Data for the current frame.
965 * \param[in] sel Selection element being evaluated.
966 * \param[in] g Group for which \p sel should be evaluated.
967 * \returns 0 on success, a non-zero error code on error.
969 * Evaluates all child selections (using _gmx_sel_evaluate_method_params())
970 * to evaluate any parameter values.
971 * If this is the first time this expression is evaluated for
972 * the frame, sel_framefunc() callback is called if one is provided.
973 * The modifier is then evaluated using sel_updatefunc_pos().
975 * This function is used as gmx::SelectionTreeElement::evaluate for
976 * \ref SEL_MODIFIER elements.
979 _gmx_sel_evaluate_modifier(gmx_sel_evaluate_t *data,
980 const SelectionTreeElementPointer &sel,
983 _gmx_sel_evaluate_method_params(data, sel, g);
984 if (sel->flags & SEL_INITFRAME)
986 sel->flags &= ~SEL_INITFRAME;
987 sel->u.expr.method->init_frame(data->top, data->fr, data->pbc,
990 GMX_RELEASE_ASSERT(sel->child != NULL,
991 "Modifier element with a value must have a child");
992 if (sel->child->v.type != POS_VALUE)
994 GMX_THROW(gmx::NotImplementedError("Non-position valued modifiers not implemented"));
996 sel->u.expr.method->pupdate(data->top, data->fr, data->pbc,
998 &sel->v, sel->u.expr.mdata);
1002 /********************************************************************
1003 * BOOLEAN EXPRESSION EVALUATION
1004 ********************************************************************/
1007 * \param[in] data Data for the current frame.
1008 * \param[in] sel Selection element being evaluated.
1009 * \param[in] g Group for which \p sel should be evaluated.
1010 * \returns 0 on success, a non-zero error code on error.
1012 * Evaluates the child element (there should be only one) in the group
1013 * \p g, and then sets the value of \p sel to the complement of the
1016 * This function is used as gmx::SelectionTreeElement::evaluate for
1017 * \ref SEL_BOOLEAN elements with \ref BOOL_NOT.
1020 _gmx_sel_evaluate_not(gmx_sel_evaluate_t *data,
1021 const SelectionTreeElementPointer &sel,
1024 MempoolSelelemReserver reserver(sel->child, g->isize);
1025 sel->child->evaluate(data, sel->child, g);
1026 gmx_ana_index_difference(sel->v.u.g, g, sel->child->v.u.g);
1030 * \param[in] data Data for the current frame.
1031 * \param[in] sel Selection element being evaluated.
1032 * \param[in] g Group for which \p sel should be evaluated.
1033 * \returns 0 on success, a non-zero error code on error.
1035 * Short-circuiting evaluation of logical AND expressions.
1037 * Starts by evaluating the first child element in the group \p g.
1038 * The each following child element is evaluated in the intersection
1039 * of all the previous values until all children have been evaluated
1040 * or the intersection becomes empty.
1041 * The value of \p sel is set to the intersection of all the (evaluated)
1044 * If the first child does not have an evaluation function, it is skipped
1045 * and the evaluation is started at the second child.
1046 * This happens if the first child is a constant expression and during
1047 * compilation it was detected that the evaluation group is always a subset
1048 * of the constant group
1049 * (currently, the compiler never detects this).
1051 * This function is used as gmx::SelectionTreeElement::evaluate for
1052 * \ref SEL_BOOLEAN elements with \ref BOOL_AND.
1055 _gmx_sel_evaluate_and(gmx_sel_evaluate_t *data,
1056 const SelectionTreeElementPointer &sel,
1059 SelectionTreeElementPointer child = sel->child;
1060 /* Skip the first child if it does not have an evaluation function. */
1061 if (!child->evaluate)
1063 child = child->next;
1065 /* Evaluate the first child */
1067 MempoolSelelemReserver reserver(child, g->isize);
1068 child->evaluate(data, child, g);
1069 gmx_ana_index_copy(sel->v.u.g, child->v.u.g, false);
1071 child = child->next;
1072 while (child && sel->v.u.g->isize > 0)
1074 MempoolSelelemReserver reserver(child, sel->v.u.g->isize);
1075 child->evaluate(data, child, sel->v.u.g);
1076 gmx_ana_index_intersection(sel->v.u.g, sel->v.u.g, child->v.u.g);
1077 child = child->next;
1082 * \param[in] data Data for the current frame.
1083 * \param[in] sel Selection element being evaluated.
1084 * \param[in] g Group for which \p sel should be evaluated.
1085 * \returns 0 on success, a non-zero error code on error.
1087 * Short-circuiting evaluation of logical OR expressions.
1089 * Starts by evaluating the first child element in the group \p g.
1090 * For each subsequent child, finds the part of \p g that is not
1091 * included the value of any previous child, and evaluates the child
1092 * in that group until the last child is evaluated or all of \p g
1093 * is included in some child value.
1094 * The value of \p sel is set to the union of all the (evaluated)
1097 * If the first child does not have an evaluation function, its value is
1098 * used without evaluation.
1099 * This happens if the first child is a constant expression, the selection
1100 * has been compiled, and the evaluation group is the same for each frame.
1101 * In this case, the compiler has taken care of that the child value is a
1102 * subset of \p g, making it unnecessary to evaluate it.
1104 * This function is used as gmx::SelectionTreeElement::evaluate for
1105 * \ref SEL_BOOLEAN elements with \ref BOOL_OR.
1108 _gmx_sel_evaluate_or(gmx_sel_evaluate_t *data,
1109 const SelectionTreeElementPointer &sel,
1112 gmx_ana_index_t tmp, tmp2;
1114 SelectionTreeElementPointer child = sel->child;
1115 if (child->evaluate)
1117 MempoolSelelemReserver reserver(child, g->isize);
1118 child->evaluate(data, child, g);
1119 gmx_ana_index_partition(sel->v.u.g, &tmp, g, child->v.u.g);
1123 gmx_ana_index_partition(sel->v.u.g, &tmp, g, child->v.u.g);
1125 child = child->next;
1126 while (child && tmp.isize > 0)
1129 MempoolSelelemReserver reserver(child, tmp.isize);
1130 child->evaluate(data, child, &tmp);
1131 gmx_ana_index_partition(&tmp, &tmp2, &tmp, child->v.u.g);
1133 sel->v.u.g->isize += tmp.isize;
1134 tmp.isize = tmp2.isize;
1135 tmp.index = tmp2.index;
1136 child = child->next;
1138 gmx_ana_index_sort(sel->v.u.g);
1142 /********************************************************************
1143 * ARITHMETIC EVALUATION
1144 ********************************************************************/
1147 * \param[in] data Data for the current frame.
1148 * \param[in] sel Selection element being evaluated.
1149 * \param[in] g Group for which \p sel should be evaluated.
1150 * \returns 0 on success, a non-zero error code on error.
1153 _gmx_sel_evaluate_arithmetic(gmx_sel_evaluate_t *data,
1154 const SelectionTreeElementPointer &sel,
1158 real lval, rval = 0., val = 0.;
1160 const SelectionTreeElementPointer &left = sel->child;
1161 const SelectionTreeElementPointer &right = left->next;
1163 SelelemTemporaryValueAssigner assigner;
1164 MempoolSelelemReserver reserver;
1167 assigner.assign(left, *sel);
1170 reserver.reserve(right, g->isize);
1173 else if (right && right->mempool)
1175 assigner.assign(right, *sel);
1177 _gmx_sel_evaluate_children(data, sel, g);
1179 n = (sel->flags & SEL_SINGLEVAL) ? 1 : g->isize;
1182 bool bArithNeg = (sel->u.arith.type == ARITH_NEG);
1183 GMX_ASSERT(right || bArithNeg,
1184 "Right operand cannot be null except for negations");
1185 for (i = i1 = i2 = 0; i < n; ++i)
1187 lval = left->v.u.r[i1];
1190 rval = right->v.u.r[i2];
1192 switch (sel->u.arith.type)
1194 case ARITH_PLUS: val = lval + rval; break;
1195 case ARITH_MINUS: val = lval - rval; break;
1196 case ARITH_NEG: val = -lval; break;
1197 case ARITH_MULT: val = lval * rval; break;
1198 case ARITH_DIV: val = lval / rval; break;
1199 case ARITH_EXP: val = pow(lval, rval); break;
1201 sel->v.u.r[i] = val;
1202 if (!(left->flags & SEL_SINGLEVAL))
1206 if (!bArithNeg && !(right->flags & SEL_SINGLEVAL))