src/gromacs/linearalgebra/gmx_blas.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2008, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  *
  31  * And Hey:
  32  * Gallium Rubidium Oxygen Manganese Argon Carbon Silicon
  33  */
  34 /*! \internal \file
  35  * \brief
  36  * Header definitions for the standard BLAS library.
  37  *
  38  * This is the subset of BLAS routines used for the
  39  * linear algebra operations in Gromacs.
  40  * Do NOT use this for other purposes - we only provide this as a
  41  * simple fallback/reference implementation when no optimized BLAS
  42  * is present. If you need an implementation for your own code
  43  * there are several much faster versions out there.
  44  *
  45  * All routines are compatible with the BLAS reference implementation,
  46  * meaning they assume fortran-style matrix row/column organization.
  47  *
  48  * There is plenty of documentation for these routines available
  49  * at http://www.netlib.org/blas , so there is no point in repeating
  50  * it here.
  51  */
  52 #ifndef GMX_BLAS_H
  53 #define GMX_BLAS_H
  54
  55 /*! \cond */
  56
  57 #ifdef HAVE_CONFIG_H
  58 #include "config.h"
  59 #endif
  60 #ifndef F77_FUNC
  61 #define F77_FUNC(name,NAME) name ## _
  62 #endif
  63
  64 /* Suppress Cygwin compiler warnings from using newlib version of
  65  * ctype.h */
  66 #ifdef GMX_CYGWIN
  67 #undef toupper
  68 #endif
  69
  70 #ifdef __cplusplus
  71 extern "C" {
  72 #endif
  73 #if 0
  74 }
  75 #endif
  76
  77 /* Double precision versions */
  78 double
  79 F77_FUNC(dasum,DASUM)(int *n, double *dx, int *incx);
  80
  81 void
  82 F77_FUNC(daxpy,DAXPY)(int *n, double *da, double *dx, int *incx, double *dy, int *incy);
  83
  84 void
  85 F77_FUNC(dcopy,DCOPY)(int *n, double *dx, int *incx, double *dy, int *incy);
  86
  87 double
  88 F77_FUNC(ddot,DDOT)(int *n, double *dx, int *incx, double *dy, int *incy);
  89
  90 void
  91 F77_FUNC(dgemm,DGEMM)(const char *transa, const char *transb, int *m, int *n, int *k,
  92        double *alpha, double *a, int *lda, double *b, int *ldb,
  93        double *beta, double *c, int *ldc);
  94
  95 void
  96 F77_FUNC(dgemv,DGEMV)(const char *trans, int *m, int *n, double *alpha, double *a, int *lda,
  97        double *x, int *incx, double *beta, double *y, int *incy);
  98
  99 void
 100 F77_FUNC(dger,DGER)(int *m, int *n, double *alpha, double *x, int *incx,
 101       double *y, int *incy, double *a, int *lda);
 102
 103 double
 104 F77_FUNC(dnrm2,DNRM2)(int  *n, double *x, int *incx);
 105
 106 void
 107 F77_FUNC(drot,DROT)(int *n, double *dx, int *incx,
 108       double *dy, int *incy, double *c, double *s);
 109
 110 void
 111 F77_FUNC(dscal,DSCAL)(int *n, double *fact, double *dx, int *incx);
 112
 113 void
 114 F77_FUNC(dswap,DSWAP)(int *n, double *dx, int *incx, double *dy, int *incy);
 115
 116 void
 117 F77_FUNC(dsymv,DSYMV)(const char *uplo, int *n, double *alpha, double *a, int *lda,
 118        double *x, int *incx, double *beta, double *y, int *incy);
 119
 120 void
 121 F77_FUNC(dsyr2,DSYR2)(const char *uplo, int *n, double *alpha, double *x, int *incx,
 122        double *y, int *incy, double *a, int *lda);
 123
 124 void
 125 F77_FUNC(dsyr2k,DSYR2K)(const char *uplo, const char *trans, int *n, int *k, double *alpha, double *a,
 126         int *lda, double *b, int *ldb, double *beta, double *c, int *ldc);
 127
 128 void
 129 F77_FUNC(dtrmm,DTRMM)(const char *side, const char *uplo, const char *transa, const char *diag, int *m, int *n,
 130        double *alpha, double *a, int *lda, double *b, int *ldb);
 131
 132 void
 133 F77_FUNC(dtrmv,DTRMV)(const char *uplo, const char *trans, const char *diag, int *n,
 134        double *a, int *lda, double *x, int *incx);
 135
 136 void
 137 F77_FUNC(dtrsm,DTRSM)(const char *side, const char *uplo, const char *transa, const char *diag, int *m, int *n,
 138        double *alpha, double *a,int *lda, double *b, int *ldb);
 139
 140 int
 141 F77_FUNC(idamax,IDAMAX)(int *n, double *dx, int *incx);
 142
 143
 144
 145 /* Single precision versions */
 146 float
 147 F77_FUNC(sasum,SASUM)(int *n, float *dx, int *incx);
 148
 149 void
 150 F77_FUNC(saxpy,SAXPY)(int *n, float *da, float *dx, int *incx, float *dy, int *incy);
 151
 152 void
 153 F77_FUNC(scopy,SCOPY)(int *n, float *dx, int *incx, float *dy, int *incy);
 154
 155 float
 156 F77_FUNC(sdot,SDOT)(int *n, float *dx, int *incx, float *dy, int *incy);
 157
 158 void
 159 F77_FUNC(sgemm,SGEMM)(const char *transa, const char *transb, int *m, int *n, int *k,
 160        float *alpha, float *a, int *lda, float *b, int *ldb,
 161        float *beta, float *c, int *ldc);
 162
 163 void
 164 F77_FUNC(sgemv,SGEMV)(const char *trans, int *m, int *n, float *alpha, float *a, int *lda,
 165        float *x, int *incx, float *beta, float *y, int *incy);
 166
 167 void
 168 F77_FUNC(sger,SGER)(int *m, int *n, float *alpha, float *x, int *incx,
 169       float *y, int *incy, float *a, int *lda);
 170
 171 float
 172 F77_FUNC(snrm2,SNRM2)(int  *n, float *x, int *incx);
 173
 174 void
 175 F77_FUNC(srot,SROT)(int *n, float *dx, int *incx,
 176       float *dy, int *incy, float *c, float *s);
 177
 178 void
 179 F77_FUNC(sscal,SSCAL)(int *n, float *fact, float *dx, int *incx);
 180
 181 void
 182 F77_FUNC(sswap,SSWAP)(int *n, float *dx, int *incx, float *dy, int *incy);
 183
 184 void
 185 F77_FUNC(ssymv,SSYMV)(const char *uplo, int *n, float *alpha, float *a, int *lda,
 186        float *x, int *incx, float *beta, float *y, int *incy);
 187
 188 void
 189 F77_FUNC(ssyr2,SSYR2)(const char *uplo, int *n, float *alpha, float *x, int *incx,
 190        float *y, int *incy, float *a, int *lda);
 191
 192 void
 193 F77_FUNC(ssyr2k,SSYR2K)(const char *uplo, const char *trans, int *n, int *k, float *alpha, float *a,
 194         int *lda, float *b, int *ldb, float *beta, float *c, int *ldc);
 195
 196 void
 197 F77_FUNC(strmm,STRMM)(const char *side, const char *uplo, const char *transa, const char *diag, int *m, int *n,
 198        float *alpha, float *a, int *lda, float *b, int *ldb);
 199
 200 void
 201 F77_FUNC(strmv,STRMV)(const char *uplo, const char *trans, const char *diag, int *n,
 202        float *a, int *lda, float *x, int *incx);
 203
 204 void
 205 F77_FUNC(strsm,STRSM)(const char *side, const char *uplo, const char *transa, const char *diag, int *m, int *n,
 206        float *alpha, float *a,int *lda, float *b, int *ldb);
 207
 208 int
 209 F77_FUNC(isamax,ISAMAX)(int *n, float *dx, int *incx);
 210
 211
 212 #ifdef __cplusplus
 213 }
 214 #endif
 215
 216 /*! \endcond */
 217
 218 #endif /* GMX_BLAS_H */