include/nbsearch.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2009, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38 /*! \file
  39  * \brief API for neighborhood searching.
  40  *
  41  * The API is documented in more detail on a separate page:
  42  * \ref nbsearch
  43  *
  44  * The functions within this file can be used independently of the other parts
  45  * of the library.
  46  * The library also uses the functions internally.
  47  */
  48 #ifndef NBSEARCH_H
  49 #define NBSEARCH_H
  50
  51 #include "typedefs.h"
  52
  53 #include "indexutil.h"
  54
  55 #ifdef __cplusplus
  56 extern "C" {
  57 #endif
  58
  59 struct gmx_ana_pos_t;
  60
  61 /** Data structure for neighborhood searches. */
  62 typedef struct gmx_ana_nbsearch_t gmx_ana_nbsearch_t;
  63
  64 /** Create a new neighborhood search data structure. */
  65 int
  66 gmx_ana_nbsearch_create(gmx_ana_nbsearch_t **d, real cutoff, int maxn);
  67 /** Free memory allocated for neighborhood search. */
  68 void
  69 gmx_ana_nbsearch_free(gmx_ana_nbsearch_t *d);
  70
  71 /** Initializes neighborhood search for a new frame. */
  72 int
  73 gmx_ana_nbsearch_init(gmx_ana_nbsearch_t *d, t_pbc *pbc, int n, rvec x[]);
  74 /** Initializes neighborhood search for a frame using \c gmx_ana_pos_t.  */
  75 int
  76 gmx_ana_nbsearch_pos_init(gmx_ana_nbsearch_t *d, t_pbc *pbc,
  77                           struct gmx_ana_pos_t *p);
  78 /** Sets the exclusions for the next neighborhood search. */
  79 int
  80 gmx_ana_nbsearch_set_excl(gmx_ana_nbsearch_t *d, int nexcl, int excl[]);
  81 /** Check whether a point is within a neighborhood. */
  82 gmx_bool
  83 gmx_ana_nbsearch_is_within(gmx_ana_nbsearch_t *d, rvec x);
  84 /** Check whether a position is within a neighborhood. */
  85 gmx_bool
  86 gmx_ana_nbsearch_pos_is_within(gmx_ana_nbsearch_t *d,
  87                                struct gmx_ana_pos_t *p, int i);
  88 /** Calculates the minimun distance from the reference points. */
  89 real
  90 gmx_ana_nbsearch_mindist(gmx_ana_nbsearch_t *d, rvec x);
  91 /** Calculates the minimun distance from the reference points. */
  92 real
  93 gmx_ana_nbsearch_pos_mindist(gmx_ana_nbsearch_t *d,
  94                              struct gmx_ana_pos_t *p, int i);
  95 /** Finds the first reference position within the cutoff. */
  96 gmx_bool
  97 gmx_ana_nbsearch_first_within(gmx_ana_nbsearch_t *d, rvec x, int *jp);
  98 /** Finds the first reference position within the cutoff. */
  99 gmx_bool
 100 gmx_ana_nbsearch_pos_first_within(gmx_ana_nbsearch_t *d,
 101                                   struct gmx_ana_pos_t *p, int i, int *jp);
 102 /** Finds the next reference position within the cutoff. */
 103 gmx_bool
 104 gmx_ana_nbsearch_next_within(gmx_ana_nbsearch_t *d, int *jp);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif