blaswrap_core.h

Go to the documentation of this file.

/*
 *Wrapper for a variety of LAPACK routines.

Copyright (C) 2010 Joseph Pingenot

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef _____LIBLAPACKWRAP_BLASWRAP_<llw_typeset>_H______
#define _____LIBLAPACKWRAP_BLASWRAP_<llw_typeset>_H______

#ifdef __cplusplus
extern "C" {
#endif

  /**\note Generic LLW data types are placed in this header file.
   *defining LLW_<llw_typeset>_FOO helps translate the generic
   *  core lapackwrap and blaswrap patterns to the final version.
   *  An alternative method would be translating each genericized
   *  core datatype into the specific data type.  However, that would
   *  require a more complicated, multi-substitution method (e.g. with
   *  a perl script.  This may come later, when I've gotten more experience
   *  using this lib.
   */
#include <liblapackwrap/lapackwrap_types_<llw_typeset>.h>

  /**This is to ensure safety.
   *If you don't care, you can save some cycles at the expense of
   *  "guaranteeing" safety for the data you're passing in read-only
   *  by commenting out this define.  This will make all const arrays
   *  non-const and therefore not "guaranteed" to not be modified by the
   *  routines.  This is effected, in addition to the const keyword, by
   *  copying each array into a secondary one via memcopy().  Turning
   *  this off saves that copy, which is the largst cost of this safety.
   */
#define LLW_CONST const

  /**frontend for llw_double_gemm but if you don't have a matrix C yet (clearly, if you're calling this routine, you want one.
   */
  int llw_<llw_typeset>_gemm_a(char transa, char transb, int M, int N, int K, LLW_<llw_typeset>_COMPLEX *alpha, LLW_CONST LLW_<llw_typeset>_COMPLEX *A, int LDA, LLW_CONST LLW_<llw_typeset>_COMPLEX *B, int LDB, LLW_<llw_typeset>_COMPLEX **C);

  /**Performs matrix-matrix multiplication.
   */
  int llw_<llw_typeset>_gemm(char transa, char transb, int M, int N, int K, LLW_<llw_typeset>_COMPLEX *alpha, LLW_CONST LLW_<llw_typeset>_COMPLEX *A, int LDA, LLW_CONST LLW_<llw_typeset>_COMPLEX *B, int LDB, LLW_<llw_typeset>_COMPLEX *beta, LLW_<llw_typeset>_COMPLEX *C, int LDC);


#ifdef __cplusplus
}
#endif

#endif