src/gromacs/correlationfunctions/crosscorr.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2018, 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 /*! \libinternal
  36  * \file
  37  * \brief
  38  * Declares routine for computing a cross correlation between two data sets
  39  *
  40  * \author David van der Spoel <david.vanderspoel@icm.uu.se>
  41  * \inlibraryapi
  42  * \ingroup module_correlationfunctions
  43  */
  44 #ifndef GMX_CROSSCORR_H
  45 #define GMX_CROSSCORR_H
  46
  47 #include "gromacs/utility/real.h"
  48
  49 /*! \brief
  50  * fft cross correlation algorithm.
  51  * Computes corr = f (.) g
  52  *
  53  * \param[in] n number of data point
  54  * \param[in] f First function
  55  * \param[in] g Second function
  56  * \param[out] corr The cross correlation
  57  */
  58 void cross_corr(int n, real f[], real g[], real corr[]);
  59
  60 /*! \brief
  61  * fft cross correlation algorithm.
  62  *
  63  * Computes corr[n] = f[n][i] (.) g[n][i], that is for nFunc
  64  * pairs of arrays n the cross correlation is computed in parallel
  65  * using OpenMP.
  66  *
  67  * \param[in] nFunc nuber of function to crosscorrelate
  68  * \param[in] nData number of data point in eatch function
  69  * \param[in] f 2D array of first function to crosscorrelate
  70  * \param[in] g 2D array of second function to crosscorrelate
  71  * \param[out] corr 2D array of the cross correlations
  72  */
  73 void many_cross_corr(int nFunc, int * nData, real ** f, real ** g, real ** corr);
  74
  75 #endif