src/gromacs/selection/selelem.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2009,2010,2011,2012,2013, 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  * Implements functions in selelem.h.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #include <cstring>
  43
  44 #include "gromacs/legacyheaders/smalloc.h"
  45
  46 #include "gromacs/selection/indexutil.h"
  47 #include "gromacs/selection/poscalc.h"
  48 #include "gromacs/selection/position.h"
  49 #include "gromacs/selection/selmethod.h"
  50 #include "gromacs/utility/exceptions.h"
  51 #include "gromacs/utility/gmxassert.h"
  52 #include "gromacs/utility/stringutil.h"
  53
  54 #include "keywords.h"
  55 #include "mempool.h"
  56 #include "selelem.h"
  57
  58 /*!
  59  * \param[in] sel Selection for which the string is requested
  60  * \returns   Pointer to a string that corresponds to \p sel->type.
  61  *
  62  * The return value points to a string constant and should not be \p free'd.
  63  *
  64  * The function returns NULL if \p sel->type is not one of the valid values.
  65  */
  66 const char *
  67 _gmx_selelem_type_str(const gmx::SelectionTreeElement &sel)
  68 {
  69     switch (sel.type)
  70     {
  71         case SEL_CONST:      return "CONST";
  72         case SEL_EXPRESSION: return "EXPR";
  73         case SEL_BOOLEAN:    return "BOOL";
  74         case SEL_ARITHMETIC: return "ARITH";
  75         case SEL_ROOT:       return "ROOT";
  76         case SEL_SUBEXPR:    return "SUBEXPR";
  77         case SEL_SUBEXPRREF: return "REF";
  78         case SEL_GROUPREF:   return "GROUPREF";
  79         case SEL_MODIFIER:   return "MODIFIER";
  80     }
  81     return NULL;
  82 }
  83
  84 /*!
  85  * \param[in] val Value structore for which the string is requested.
  86  * \returns   Pointer to a string that corresponds to \p val->type,
  87  *   NULL if the type value is invalid.
  88  *
  89  * The return value points to a string constant and should not be \p free'd.
  90  */
  91 const char *
  92 _gmx_sel_value_type_str(const gmx_ana_selvalue_t *val)
  93 {
  94     switch (val->type)
  95     {
  96         case NO_VALUE:       return "NONE";
  97         case INT_VALUE:      return "INT";
  98         case REAL_VALUE:     return "REAL";
  99         case STR_VALUE:      return "STR";
 100         case POS_VALUE:      return "VEC";
 101         case GROUP_VALUE:    return "GROUP";
 102     }
 103     return NULL;
 104 }
 105
 106 /*! \copydoc _gmx_selelem_type_str() */
 107 const char *
 108 _gmx_selelem_boolean_type_str(const gmx::SelectionTreeElement &sel)
 109 {
 110     switch (sel.u.boolt)
 111     {
 112         case BOOL_NOT:  return "NOT"; break;
 113         case BOOL_AND:  return "AND"; break;
 114         case BOOL_OR:   return "OR";  break;
 115         case BOOL_XOR:  return "XOR"; break;
 116     }
 117     return NULL;
 118 }
 119
 120
 121 namespace gmx
 122 {
 123
 124 SelectionTreeElement::SelectionTreeElement(e_selelem_t type)
 125 {
 126     this->type       = type;
 127     this->flags      = (type != SEL_ROOT) ? SEL_ALLOCVAL : 0;
 128     if (type == SEL_BOOLEAN)
 129     {
 130         this->v.type = GROUP_VALUE;
 131         this->flags |= SEL_ALLOCDATA;
 132     }
 133     else
 134     {
 135         this->v.type = NO_VALUE;
 136     }
 137     _gmx_selvalue_clear(&this->v);
 138     std::memset(&this->u, 0, sizeof(this->u));
 139     this->evaluate   = NULL;
 140     this->mempool    = NULL;
 141     this->cdata      = NULL;
 142 }
 143
 144 SelectionTreeElement::~SelectionTreeElement()
 145 {
 146     /* Free the children.
 147      * Must be done before freeing other data, because the children may hold
 148      * references to data in this element. */
 149     child.reset();
 150
 151     freeValues();
 152     freeExpressionData();
 153     freeCompilerData();
 154 }
 155
 156 void SelectionTreeElement::freeValues()
 157 {
 158     mempoolRelease();
 159     if ((flags & SEL_ALLOCDATA) && v.u.ptr)
 160     {
 161         /* The number of position/group structures is constant, so the
 162          * backup of using sel->v.nr should work for them.
 163          * For strings, we report an error if we don't know the allocation
 164          * size here. */
 165         int n = (v.nalloc > 0) ? v.nalloc : v.nr;
 166         switch (v.type)
 167         {
 168             case STR_VALUE:
 169                 GMX_RELEASE_ASSERT(v.nalloc != 0,
 170                                    "SEL_ALLOCDATA should only be set for allocated "
 171                                    "STR_VALUE values");
 172                 for (int i = 0; i < n; ++i)
 173                 {
 174                     sfree(v.u.s[i]);
 175                 }
 176                 break;
 177             case GROUP_VALUE:
 178                 for (int i = 0; i < n; ++i)
 179                 {
 180                     gmx_ana_index_deinit(&v.u.g[i]);
 181                 }
 182                 break;
 183             default: /* No special handling for other types */
 184                 break;
 185         }
 186     }
 187     if (v.nalloc > 0)
 188     {
 189         if (v.type == POS_VALUE)
 190         {
 191             delete [] v.u.p;
 192         }
 193         else
 194         {
 195             sfree(v.u.ptr);
 196         }
 197     }
 198     _gmx_selvalue_setstore(&v, NULL);
 199     if (type == SEL_SUBEXPRREF && u.param)
 200     {
 201         u.param->val.u.ptr = NULL;
 202     }
 203 }
 204
 205 void
 206 SelectionTreeElement::freeExpressionData()
 207 {
 208     if (type == SEL_EXPRESSION || type == SEL_MODIFIER)
 209     {
 210         _gmx_selelem_free_method(u.expr.method, u.expr.mdata);
 211         u.expr.mdata  = NULL;
 212         u.expr.method = NULL;
 213         /* Free position data */
 214         delete u.expr.pos;
 215         u.expr.pos = NULL;
 216         /* Free position calculation data */
 217         if (u.expr.pc)
 218         {
 219             gmx_ana_poscalc_free(u.expr.pc);
 220             u.expr.pc = NULL;
 221         }
 222     }
 223     if (type == SEL_ARITHMETIC)
 224     {
 225         sfree(u.arith.opstr);
 226         u.arith.opstr = NULL;
 227     }
 228     if (type == SEL_SUBEXPR || type == SEL_ROOT
 229         || (type == SEL_CONST && v.type == GROUP_VALUE))
 230     {
 231         gmx_ana_index_deinit(&u.cgrp);
 232     }
 233     if (type == SEL_GROUPREF)
 234     {
 235         sfree(u.gref.name);
 236     }
 237 }
 238
 239 void SelectionTreeElement::mempoolReserve(int count)
 240 {
 241     if (!mempool)
 242     {
 243         return;
 244     }
 245     switch (v.type)
 246     {
 247         case INT_VALUE:
 248             v.u.i = static_cast<int *>(
 249                     _gmx_sel_mempool_alloc(mempool, sizeof(*v.u.i)*count));
 250             break;
 251
 252         case REAL_VALUE:
 253             v.u.r = static_cast<real *>(
 254                     _gmx_sel_mempool_alloc(mempool, sizeof(*v.u.r)*count));
 255             break;
 256
 257         case GROUP_VALUE:
 258             _gmx_sel_mempool_alloc_group(mempool, v.u.g, count);
 259             break;
 260
 261         default:
 262             GMX_THROW(gmx::InternalError("Memory pooling not implemented for requested type"));
 263     }
 264 }
 265
 266 void SelectionTreeElement::mempoolRelease()
 267 {
 268     if (!mempool)
 269     {
 270         return;
 271     }
 272     switch (v.type)
 273     {
 274         case INT_VALUE:
 275         case REAL_VALUE:
 276             _gmx_sel_mempool_free(mempool, v.u.ptr);
 277             _gmx_selvalue_setstore(&v, NULL);
 278             break;
 279
 280         case GROUP_VALUE:
 281             if (v.u.g)
 282             {
 283                 _gmx_sel_mempool_free_group(mempool, v.u.g);
 284             }
 285             break;
 286
 287         default:
 288             GMX_THROW(gmx::InternalError("Memory pooling not implemented for requested type"));
 289     }
 290 }
 291
 292 void SelectionTreeElement::fillNameIfMissing(const char *selectionText)
 293 {
 294     GMX_RELEASE_ASSERT(type == SEL_ROOT,
 295                        "Should not be called for non-root elements");
 296     if (name().empty())
 297     {
 298         // Check whether the actual selection given was from an external group,
 299         // and if so, use the name of the external group.
 300         SelectionTreeElementPointer child = this->child;
 301         while (child->type == SEL_MODIFIER)
 302         {
 303             if (!child->child || child->child->type != SEL_SUBEXPRREF
 304                 || !child->child->child)
 305             {
 306                 break;
 307             }
 308             child = child->child->child;
 309         }
 310         if (child->type == SEL_EXPRESSION
 311             && child->child && child->child->type == SEL_SUBEXPRREF
 312             && child->child->child)
 313         {
 314             if (child->child->child->type == SEL_CONST
 315                 && child->child->child->v.type == GROUP_VALUE)
 316             {
 317                 setName(child->child->child->name());
 318                 return;
 319             }
 320             // If the group reference is still unresolved, leave the name empty
 321             // and fill it later.
 322             if (child->child->child->type == SEL_GROUPREF)
 323             {
 324                 return;
 325             }
 326         }
 327         // If there still is no name, use the selection string.
 328         setName(selectionText);
 329     }
 330 }
 331
 332 void SelectionTreeElement::resolveIndexGroupReference(gmx_ana_indexgrps_t *grps)
 333 {
 334     GMX_RELEASE_ASSERT(type == SEL_GROUPREF,
 335                        "Should only be called for index group reference elements");
 336     if (grps == NULL)
 337     {
 338         std::string message = formatString(
 339                     "Cannot match '%s', because index groups are not available.",
 340                     name().c_str());
 341         GMX_THROW(InconsistentInputError(message));
 342     }
 343
 344     gmx_ana_index_t foundGroup;
 345     std::string     foundName;
 346     if (u.gref.name != NULL)
 347     {
 348         if (!gmx_ana_indexgrps_find(&foundGroup, &foundName, grps, u.gref.name))
 349         {
 350             std::string message = formatString(
 351                         "Cannot match '%s', because no such index group can be found.",
 352                         name().c_str());
 353             GMX_THROW(InconsistentInputError(message));
 354         }
 355     }
 356     else
 357     {
 358         if (!gmx_ana_indexgrps_extract(&foundGroup, &foundName, grps, u.gref.id))
 359         {
 360             std::string message = formatString(
 361                         "Cannot match '%s', because no such index group can be found.",
 362                         name().c_str());
 363             GMX_THROW(InconsistentInputError(message));
 364         }
 365     }
 366
 367     if (!gmx_ana_index_check_sorted(&foundGroup))
 368     {
 369         gmx_ana_index_deinit(&foundGroup);
 370         std::string message = formatString(
 371                     "Group '%s' ('%s') cannot be used in selections, "
 372                     "because atom indices in it are not sorted and/or "
 373                     "it contains duplicate atoms.",
 374                     foundName.c_str(), name().c_str());
 375         GMX_THROW(InconsistentInputError(message));
 376     }
 377
 378     sfree(u.gref.name);
 379     type = SEL_CONST;
 380     gmx_ana_index_set(&u.cgrp, foundGroup.isize, foundGroup.index,
 381                       foundGroup.nalloc_index);
 382     setName(foundName);
 383 }
 384
 385 } // namespace gmx
 386
 387 /*!
 388  * \param[in,out] sel   Selection element to set the type for.
 389  * \param[in]     vtype Value type for the selection element.
 390  *
 391  * If the new type is \ref GROUP_VALUE or \ref POS_VALUE, the
 392  * \ref SEL_ALLOCDATA flag is also set.
 393  *
 394  * This function should only be called at most once for each element,
 395  * preferably right after calling _gmx_selelem_create().
 396  */
 397 void
 398 _gmx_selelem_set_vtype(const gmx::SelectionTreeElementPointer &sel,
 399                        e_selvalue_t                            vtype)
 400 {
 401     GMX_RELEASE_ASSERT(sel->type != SEL_BOOLEAN || vtype == GROUP_VALUE,
 402                        "Boolean elements must have a group value");
 403     GMX_RELEASE_ASSERT(sel->v.type == NO_VALUE || vtype == sel->v.type,
 404                        "_gmx_selelem_set_vtype() called more than once");
 405     sel->v.type = vtype;
 406     if (vtype == GROUP_VALUE || vtype == POS_VALUE)
 407     {
 408         sel->flags |= SEL_ALLOCDATA;
 409     }
 410 }
 411
 412 /*!
 413  * \param[in] method Method to free.
 414  * \param[in] mdata  Method data to free.
 415  */
 416 void
 417 _gmx_selelem_free_method(gmx_ana_selmethod_t *method, void *mdata)
 418 {
 419     sel_freefunc free_func = NULL;
 420
 421     /* Save the pointer to the free function. */
 422     if (method && method->free)
 423     {
 424         free_func = method->free;
 425     }
 426
 427     /* Free the method itself.
 428      * Has to be done before freeing the method data, because parameter
 429      * values are typically stored in the method data, and here we may
 430      * access them. */
 431     if (method)
 432     {
 433         int  i, j;
 434
 435         /* Free the memory allocated for the parameters that are not managed
 436          * by the selection method itself. */
 437         for (i = 0; i < method->nparams; ++i)
 438         {
 439             gmx_ana_selparam_t *param = &method->param[i];
 440
 441             if (param->val.u.ptr)
 442             {
 443                 if (param->val.type == GROUP_VALUE)
 444                 {
 445                     for (j = 0; j < param->val.nr; ++j)
 446                     {
 447                         gmx_ana_index_deinit(&param->val.u.g[j]);
 448                     }
 449                 }
 450                 else if (param->val.type == POS_VALUE)
 451                 {
 452                     if (param->val.nalloc > 0)
 453                     {
 454                         delete[] param->val.u.p;
 455                         _gmx_selvalue_setstore(&param->val, NULL);
 456                     }
 457                 }
 458
 459                 if (param->val.nalloc > 0)
 460                 {
 461                     sfree(param->val.u.ptr);
 462                 }
 463             }
 464         }
 465         sfree(method->param);
 466         sfree(method);
 467     }
 468     /* Free method data. */
 469     if (mdata)
 470     {
 471         if (free_func)
 472         {
 473             free_func(mdata);
 474         }
 475         else
 476         {
 477             sfree(mdata);
 478         }
 479     }
 480 }
 481
 482 /*!
 483  * \param[in] fp      File handle to receive the output.
 484  * \param[in] sel     Root of the selection subtree to print.
 485  * \param[in] bValues If true, the evaluated values of selection elements
 486  *   are printed as well.
 487  * \param[in] level   Indentation level, starting from zero.
 488  */
 489 void
 490 _gmx_selelem_print_tree(FILE *fp, const gmx::SelectionTreeElement &sel,
 491                         bool bValues, int level)
 492 {
 493     int          i;
 494
 495     fprintf(fp, "%*c %s %s", level*2+1, '*',
 496             _gmx_selelem_type_str(sel), _gmx_sel_value_type_str(&sel.v));
 497     if (!sel.name().empty())
 498     {
 499         fprintf(fp, " \"%s\"", sel.name().c_str());
 500     }
 501     fprintf(fp, " flg=");
 502     if (sel.flags & SEL_FLAGSSET)
 503     {
 504         fprintf(fp, "s");
 505     }
 506     if (sel.flags & SEL_SINGLEVAL)
 507     {
 508         fprintf(fp, "S");
 509     }
 510     if (sel.flags & SEL_ATOMVAL)
 511     {
 512         fprintf(fp, "A");
 513     }
 514     if (sel.flags & SEL_VARNUMVAL)
 515     {
 516         fprintf(fp, "V");
 517     }
 518     if (sel.flags & SEL_DYNAMIC)
 519     {
 520         fprintf(fp, "D");
 521     }
 522     if (!(sel.flags & SEL_VALFLAGMASK))
 523     {
 524         fprintf(fp, "0");
 525     }
 526     if (sel.flags & SEL_ALLOCVAL)
 527     {
 528         fprintf(fp, "Av");
 529     }
 530     if (sel.flags & SEL_ALLOCDATA)
 531     {
 532         fprintf(fp, "Ad");
 533     }
 534     if (sel.mempool)
 535     {
 536         fprintf(fp, "P");
 537     }
 538     if (sel.type == SEL_CONST)
 539     {
 540         if (sel.v.type == INT_VALUE)
 541         {
 542             fprintf(fp, " %d", sel.v.u.i[0]);
 543         }
 544         else if (sel.v.type == REAL_VALUE)
 545         {
 546             fprintf(fp, " %f", sel.v.u.r[0]);
 547         }
 548         else if (sel.v.type == GROUP_VALUE)
 549         {
 550             const gmx_ana_index_t *g = sel.v.u.g;
 551             if (!g || g->isize == 0)
 552             {
 553                 g = &sel.u.cgrp;
 554             }
 555             fprintf(fp, " (%d atoms)", g->isize);
 556         }
 557     }
 558     else if (sel.type == SEL_BOOLEAN)
 559     {
 560         fprintf(fp, " %s", _gmx_selelem_boolean_type_str(sel));
 561     }
 562     else if (sel.type == SEL_EXPRESSION
 563              && sel.u.expr.method->name == sm_compare.name)
 564     {
 565         _gmx_selelem_print_compare_info(fp, sel.u.expr.mdata);
 566     }
 567     if (sel.evaluate)
 568     {
 569         fprintf(fp, " eval=");
 570         _gmx_sel_print_evalfunc_name(fp, sel.evaluate);
 571     }
 572     if (!(sel.flags & SEL_ALLOCVAL))
 573     {
 574         fprintf(fp, " (ext)");
 575     }
 576     fprintf(fp, "\n");
 577
 578     if ((sel.type == SEL_CONST && sel.v.type == GROUP_VALUE) || sel.type == SEL_ROOT)
 579     {
 580         const gmx_ana_index_t *g = sel.v.u.g;
 581         if (!g || g->isize == 0 || sel.evaluate != NULL)
 582         {
 583             g = &sel.u.cgrp;
 584         }
 585         if (g->isize < 0)
 586         {
 587             fprintf(fp, "%*c group: (null)\n", level*2+1, ' ');
 588         }
 589         else if (g->isize > 0)
 590         {
 591             fprintf(fp, "%*c group:", level*2+1, ' ');
 592             if (g->isize <= 20)
 593             {
 594                 for (i = 0; i < g->isize; ++i)
 595                 {
 596                     fprintf(fp, " %d", g->index[i] + 1);
 597                 }
 598             }
 599             else
 600             {
 601                 fprintf(fp, " %d atoms", g->isize);
 602             }
 603             fprintf(fp, "\n");
 604         }
 605     }
 606     else if (sel.type == SEL_EXPRESSION)
 607     {
 608         if (sel.u.expr.pc)
 609         {
 610             fprintf(fp, "%*c COM", level*2+3, '*');
 611             fprintf(fp, "\n");
 612         }
 613     }
 614
 615     if (sel.cdata)
 616     {
 617         _gmx_selelem_print_compiler_info(fp, sel, level);
 618     }
 619
 620     if (bValues && sel.type != SEL_CONST && sel.type != SEL_ROOT && sel.v.u.ptr)
 621     {
 622         fprintf(fp, "%*c value: ", level*2+1, ' ');
 623         switch (sel.v.type)
 624         {
 625             case POS_VALUE:
 626                 /* In normal use, the pointer should never be NULL, but it's
 627                  * useful to have the check for debugging to avoid accidental
 628                  * segfaults when printing the selection tree. */
 629                 if (sel.v.u.p->x)
 630                 {
 631                     fprintf(fp, "(%f, %f, %f)",
 632                             sel.v.u.p->x[0][XX], sel.v.u.p->x[0][YY],
 633                             sel.v.u.p->x[0][ZZ]);
 634                 }
 635                 else
 636                 {
 637                     fprintf(fp, "(null)");
 638                 }
 639                 break;
 640             case GROUP_VALUE:
 641                 fprintf(fp, "%d atoms", sel.v.u.g->isize);
 642                 if (sel.v.u.g->isize < 20)
 643                 {
 644                     if (sel.v.u.g->isize > 0)
 645                     {
 646                         fprintf(fp, ":");
 647                     }
 648                     for (i = 0; i < sel.v.u.g->isize; ++i)
 649                     {
 650                         fprintf(fp, " %d", sel.v.u.g->index[i] + 1);
 651                     }
 652                 }
 653                 break;
 654             default:
 655                 fprintf(fp, "???");
 656                 break;
 657         }
 658         fprintf(fp, "\n");
 659     }
 660
 661     /* Print the subexpressions with one more level of indentation */
 662     gmx::SelectionTreeElementPointer child = sel.child;
 663     while (child)
 664     {
 665         if (!(sel.type == SEL_SUBEXPRREF && child->type == SEL_SUBEXPR))
 666         {
 667             _gmx_selelem_print_tree(fp, *child, bValues, level+1);
 668         }
 669         child = child->next;
 670     }
 671 }
 672
 673 /*!
 674  * \param[in] root Root of the subtree to query.
 675  * \returns true if \p root or any any of its elements require topology
 676  *   information, false otherwise.
 677  */
 678 bool
 679 _gmx_selelem_requires_top(const gmx::SelectionTreeElement &root)
 680 {
 681     if (root.type == SEL_EXPRESSION || root.type == SEL_MODIFIER)
 682     {
 683         if (root.u.expr.method && (root.u.expr.method->flags & SMETH_REQTOP))
 684         {
 685             return true;
 686         }
 687         if (root.u.expr.pc && gmx_ana_poscalc_requires_top(root.u.expr.pc))
 688         {
 689             return true;
 690         }
 691     }
 692     gmx::SelectionTreeElementPointer child = root.child;
 693     while (child)
 694     {
 695         if (_gmx_selelem_requires_top(*child))
 696         {
 697             return true;
 698         }
 699         child = child->next;
 700     }
 701     return false;
 702 }