lapackwrap_real_single.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_LAPACKWRAP_real_single_H______
#define _____LIBLAPACKWRAP_LAPACKWRAP_real_single_H______

#ifdef __cplusplus
extern "C" {
#endif

  /**\note Generic LLW data types are placed in this header file.
   *defining LLW_real_single_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_real_single.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

  /**wrapper around dstegr/dstegr_
   *\arg jobz passed straight into LAPACK
   *\arg range passed straight into LAPACK
   *\arg N passed straight into LAPACK
   *\arg D passed straight into LAPACK
   *\arg E passed straight into LAPACK
   *\arg VL passed straight into LAPACK
   *\arg VU passed straight into LAPACK
   *\arg IL passed straight into LAPACK
   *\arg IU passed straight into LAPACK
   *\arg M passed straight into LAPACK
   *\arg W passed straight into LAPACK
   *\arg Z passed straight into LAPACK
   *\arg LDZ passed straight into LAPACK
   *\arg ISUPPZ passed straight into LAPACK
   *\return INFO, 100*the following error values:
   * 1: Failed to allocate space.
   */
  int llw_real_single_stegr(char jobz, char range, int N, LLW_CONST LLW_real_single_REAL *D, LLW_CONST LLW_real_single_REAL *E, LLW_real_single_REAL VL, LLW_real_single_REAL VU, int IL, int IU, int *M, LLW_real_single_REAL* W, LLW_real_single_COMPLEX* Z, int LDZ, int* ISUPPZ);
  /**same as dstegr, but allocation of W, Z, and SUPPZ is done internally
   *\arg jobz passed straight into LAPACK
   *\arg range passed straight into LAPACK
   *\arg N passed straight into LAPACK
   *\arg D passed straight into LAPACK
   *\arg E passed straight into LAPACK
   *\arg VL passed straight into LAPACK
   *\arg VU passed straight into LAPACK
   *\arg IL passed straight into LAPACK
   *\arg IU passed straight into LAPACK
   *\arg M passed straight into LAPACK
   *\arg W pointer to a pointer to a LLW_real_single_REAL; will be used to store eigvals
   *\arg Z pointer to a pointer to a LLW_real_single_REAL; will be used to store eigvecs (column-major)
   *\arg LDZ pointer to an int; will be used to store number of eigvecs in Z
   *\arg ISUPPZ pointer to pointer to a LLW_real_single_REAL; will be used to store support of matrix.
   *\return INFO, 100*the following error values:
   * 1: Failed to allocate space.
   */
  int llw_real_single_stegr_a(char jobz, char range, int N, LLW_CONST LLW_real_single_REAL *D, LLW_CONST LLW_real_single_REAL *E, LLW_real_single_REAL VL, LLW_real_single_REAL VU, int IL, int IU, int *M, LLW_real_single_REAL** W, LLW_real_single_COMPLEX** Z, int *LDZ, int** ISUPPZ);

  /**This is the same as llw_real_single_sbtrd, but with dynamic allocation of D, E, and Q.
   */
  int llw_real_single_sbtrd_a(char vect, char uplo, int N, int KD, LLW_CONST LLW_real_single_COMPLEX* A, int LDAB, LLW_real_single_REAL** D, LLW_real_single_REAL **E, LLW_real_single_COMPLEX** Q);
  /**Gets the tri-diagonal matrix for a banded matrix.
   */
  int llw_real_single_sbtrd(char vect, char uplo, int N, int KD, LLW_CONST LLW_real_single_COMPLEX* AB, int LDAB, LLW_real_single_REAL* D, LLW_real_single_REAL* E, LLW_real_single_COMPLEX* Q, int LDQ);

  /**Gets the tridiagonal matrix for a symmetric matrix.
   *\param uplo 'U' if upper triangle is desired, 'L' if lower triangle
   *\param N size of an edge of A (since it's symmetric, is NxN)
   *\param A original matrix 
   *\param D the diagonal of the final tridiag matrix
   *\param E the upper (lower) subdiagonal.
   *\param TAU LLW_CONSTs (needed for llw_real_single_orgr to get Q
   *\param a_out pointer to a pointer to a LLW_real_single_REAL; used to save the resulting matrix (is A with output stored in it, as described by netlib's documentation on sytrd.
   *\return INFO, 100*the following error values:
   * 1: Failed to allocate space.
   *\note A is LLW_CONST, so it will be preserved.  If you want the tri-diagonal matrix, use a_out.
   */
  int llw_real_single_sytrd(char uplo, int N, LLW_CONST LLW_real_single_COMPLEX* A, LLW_real_single_REAL* D, LLW_real_single_REAL* E, LLW_real_single_COMPLEX* TAU, LLW_real_single_COMPLEX **a_out);

  /**Turns the output of a tridiagonalization into a matrix which will help convert the eigvals to the old basis
   *\return INFO, 100*the following error values:
   * 1: Failed to allocate space.
   *\note A is NOT LLW_CONST. orgtr will overwrite it.  This is probably what you want, so it's preserved.
   */
  int llw_real_single_orgtr(char uplo, int N, LLW_real_single_COMPLEX* A, LLW_real_single_COMPLEX* TAU);

#ifdef __cplusplus
}
#endif


#endif