elpa_generated_legacy.h

Go to the documentation of this file.

 int elpa_solve_evp_real_double(int na, int nev, double *a, int lda, double *ev, double *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_REAL_ELPA_KERNEL_API, int useQR, int useGPU, char *method);
 int elpa_solve_evp_real_single(int na, int nev, float *a, int lda, float *ev, float *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_REAL_ELPA_KERNEL_API, int useQR, int useGPU, char *method);
 #include <complex.h>
 int elpa_solve_evp_complex_double(int na, int nev, double complex *a, int lda, double *ev, double complex *q, int ldq, int nblk, int matrixCols,
                                   int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_COMPLEX_ELPA_KERNEL_API, int useGPU, char *method);
 #include <complex.h>
 int elpa_solve_evp_complex_single(int na, int nev, complex float *a, int lda, float *ev, complex float *q, int ldq, int nblk, int matrixCols,
                                   int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_COMPLEX_ELPA_KERNEL_API, int useGPU, char *method);
 #include <complex.h>
 int elpa_get_communicators(int mpi_comm_world, int my_prow, int my_pcol, int *mpi_comm_rows, int *mpi_comm_cols);
 int elpa_solve_evp_real_1stage_double_precision(int na, int nev, double *a, int lda, double *ev, double *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int useGPU);
 int elpa_solve_evp_real_1stage_single_precision(int na, int nev, float *a, int lda, float *ev, float *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int useGPU);
 int elpa_solve_evp_complex_1stage_double_precision(int na, int nev, double complex *a, int lda, double *ev, double complex *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int useGPU);
 int elpa_solve_evp_complex_1stage_single_precision(int na, int nev,  complex float *a, int lda, float *ev, complex float *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int useGPU);
 /*
 \brief  C interface to solve double-precision tridiagonal eigensystem with divide and conquer method
 \details

 *\param na                    Matrix dimension
 *\param nev                   number of eigenvalues/vectors to be computed
 *\param d                     array d(na) on input diagonal elements of tridiagonal matrix, on
 *                             output the eigenvalues in ascending order
 *\param e                     array e(na) on input subdiagonal elements of matrix, on exit destroyed
 *\param q                     on exit : matrix q(ldq,matrixCols) contains the eigenvectors
 *\param ldq                   leading dimension of matrix q
 *\param nblk                  blocksize of cyclic distribution, must be the same in both directions!
 *\param matrixCols            columns of matrix q
 *\param mpi_comm_rows         MPI communicator for rows
 *\param mpi_comm_cols         MPI communicator for columns
 *\param wantDebug             give more debug information if 1, else 0
 *\result success              int 1 on success, else 0
 */
 int elpa_solve_tridi_double(int na, int nev, double *d, double *e, double *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface to solve single-precision tridiagonal eigensystem with divide and conquer method
 \details

 \param na                    Matrix dimension
 \param nev                   number of eigenvalues/vectors to be computed
 \param d                     array d(na) on input diagonal elements of tridiagonal matrix, on
                              output the eigenvalues in ascending order
 \param e                     array e(na) on input subdiagonal elements of matrix, on exit destroyed
 \param q                     on exit : matrix q(ldq,matrixCols) contains the eigenvectors
 \param ldq                   leading dimension of matrix q
 \param nblk                  blocksize of cyclic distribution, must be the same in both directions!
 \param matrixCols            columns of matrix q
 \param mpi_comm_rows         MPI communicator for rows
 \param mpi_comm_cols         MPI communicator for columns
 \param wantDebug             give more debug information if 1, else 0
 \result success              int 1 on success, else 0
 */
 int elpa_solve_tridi_single(int na, int nev, float *d, float *e, float *q, int ldq, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface for elpa_mult_at_b_real_double: Performs C : = A**T * B for double-precision matrices
         where   A is a square matrix (na,na) which is optionally upper or lower triangular
                 B is a (na,ncb) matrix
                 C is a (na,ncb) matrix where optionally only the upper or lower
                   triangle may be computed
 \details
 \param  uplo_a               'U' if A is upper triangular
                              'L' if A is lower triangular
                              anything else if A is a full matrix
                              Please note: This pertains to the original A (as set in the calling program)
                                           whereas the transpose of A is used for calculations
                              If uplo_a is 'U' or 'L', the other triangle is not used at all,
                              i.e. it may contain arbitrary numbers
 \param uplo_c                'U' if only the upper diagonal part of C is needed
                              'L' if only the upper diagonal part of C is needed
                              anything else if the full matrix C is needed
                              Please note: Even when uplo_c is 'U' or 'L', the other triangle may be
                                            written to a certain extent, i.e. one shouldn't rely on the content there!
 \param na                    Number of rows/columns of A, number of rows of B and C
 \param ncb                   Number of columns  of B and C
 \param a                     matrix a
 \param lda                   leading dimension of matrix a
 \param ldaCols               columns of matrix a
 \param b                     matrix b
 \param ldb                   leading dimension of matrix b
 \param ldbCols               columns of matrix b
 \param nblk                  blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param c                     matrix c
 \param ldc                   leading dimension of matrix c
 \param ldcCols               columns of matrix c
 \result success              int report success (1) or failure (0)
 */
 int elpa_mult_at_b_real_double(char uplo_a, char uplo_c, int na, int ncb, double *a, int lda, int ldaCols, double *b, int ldb, int ldbCols, int nlbk, int mpi_comm_rows, int mpi_comm_cols, double *c, int ldc, int ldcCols);
 /*
 \brief  C interface for elpa_mult_at_b_real_single: Performs C : = A**T * B for single-precision matrices
         where   A is a square matrix (na,na) which is optionally upper or lower triangular
                 B is a (na,ncb) matrix
                 C is a (na,ncb) matrix where optionally only the upper or lower
                   triangle may be computed
 \details
 \param  uplo_a               'U' if A is upper triangular
                              'L' if A is lower triangular
                              anything else if A is a full matrix
                              Please note: This pertains to the original A (as set in the calling program)
                                           whereas the transpose of A is used for calculations
                              If uplo_a is 'U' or 'L', the other triangle is not used at all,
                              i.e. it may contain arbitrary numbers
 \param uplo_c                'U' if only the upper diagonal part of C is needed
                              'L' if only the upper diagonal part of C is needed
                              anything else if the full matrix C is needed
                              Please note: Even when uplo_c is 'U' or 'L', the other triangle may be
                                            written to a certain extent, i.e. one shouldn't rely on the content there!
 \param na                    Number of rows/columns of A, number of rows of B and C
 \param ncb                   Number of columns  of B and C
 \param a                     matrix a
 \param lda                   leading dimension of matrix a
 \param ldaCols               columns of matrix a
 \param b                     matrix b
 \param ldb                   leading dimension of matrix b
 \param ldbCols               columns of matrix b
 \param nblk                  blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param c                     matrix c
 \param ldc                   leading dimension of matrix c
 \result success              int report success (1) or failure (0)
 */
 int elpa_mult_at_b_real_single(char uplo_a, char uplo_c, int na, int ncb, float *a, int lda, int ldaCols, float *b, int ldb, int ldbCols, int nlbk, int mpi_comm_rows, int mpi_comm_cols, float *c, int ldc, int ldcCols);
 /*
 \brief C interface for elpa_mult_ah_b_complex_double: Performs C : = A**H * B for double-precision matrices
         where   A is a square matrix (na,na) which is optionally upper or lower triangular
                 B is a (na,ncb) matrix
                 C is a (na,ncb) matrix where optionally only the upper or lower
                   triangle may be computed
 \details

 \param  uplo_a               'U' if A is upper triangular
                              'L' if A is lower triangular
                              anything else if A is a full matrix
                              Please note: This pertains to the original A (as set in the calling program)
                                           whereas the transpose of A is used for calculations
                              If uplo_a is 'U' or 'L', the other triangle is not used at all,
                              i.e. it may contain arbitrary numbers
 \param uplo_c                'U' if only the upper diagonal part of C is needed
                              'L' if only the upper diagonal part of C is needed
                              anything else if the full matrix C is needed
                              Please note: Even when uplo_c is 'U' or 'L', the other triangle may be
                                            written to a certain extent, i.e. one shouldn't rely on the content there!
 \param na                    Number of rows/columns of A, number of rows of B and C
 \param ncb                   Number of columns  of B and C
 \param a                     matrix a
 \param lda                   leading dimension of matrix a
 \param b                     matrix b
 \param ldb                   leading dimension of matrix b
 \param nblk                  blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param c                     matrix c
 \param ldc                   leading dimension of matrix c
 \result success              int reports success (1) or failure (0)
 */
 int elpa_mult_ah_b_complex_double(char uplo_a, char uplo_c, int na, int ncb, double complex *a, int lda, int ldaCols, double complex *b, int ldb, int ldbCols, int nblk, int mpi_comm_rows, int mpi_comm_cols, double complex *c, int ldc, int ldcCols);
 /*
 \brief C interface for elpa_mult_ah_b_complex_single: Performs C : = A**H * B for single-precision matrices
         where   A is a square matrix (na,na) which is optionally upper or lower triangular
                 B is a (na,ncb) matrix
                 C is a (na,ncb) matrix where optionally only the upper or lower
                   triangle may be computed
 \details

 \param  uplo_a               'U' if A is upper triangular
                              'L' if A is lower triangular
                              anything else if A is a full matrix
                              Please note: This pertains to the original A (as set in the calling program)
                                           whereas the transpose of A is used for calculations
                              If uplo_a is 'U' or 'L', the other triangle is not used at all,
                              i.e. it may contain arbitrary numbers
 \param uplo_c                'U' if only the upper diagonal part of C is needed
                              'L' if only the upper diagonal part of C is needed
                              anything else if the full matrix C is needed
                              Please note: Even when uplo_c is 'U' or 'L', the other triangle may be
                                            written to a certain extent, i.e. one shouldn't rely on the content there!
 \param na                    Number of rows/columns of A, number of rows of B and C
 \param ncb                   Number of columns  of B and C
 \param a                     matrix a
 \param lda                   leading dimension of matrix a
 \param b                     matrix b
 \param ldb                   leading dimension of matrix b
 \param nblk                  blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param c                     matrix c
 \param ldc                   leading dimension of matrix c
 \result success              int reports success (1) or failure (0)
 */
 int elpa_mult_ah_b_complex_single(char uplo_a, char uplo_c, int na, int ncb, complex float *a, int lda, int ldaCols, complex float *b, int ldb, int ldbCols, int nblk, int mpi_comm_rows, int mpi_comm_cols, complex float *c, int ldc, int ldcCols);
 /*
 \brief  C interface to elpa_invert_trm_real_double: Inverts a real double-precision upper triangular matrix
 \details
 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be inverted
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              The lower triangle is not referenced.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_invert_trm_real_double(int na, double *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface to elpa_invert_trm_real_single: Inverts a real single-precision upper triangular matrix
 \details
 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be inverted
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              The lower triangle is not referenced.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_invert_trm_real_single(int na, float *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface to elpa_invert_trm_complex_double: Inverts a double-precision complex upper triangular matrix
 \details
 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be inverted
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              The lower triangle is not referenced.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_invert_trm_complex_double(int na, double complex *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface to elpa_invert_trm_complex_single: Inverts a single-precision complex upper triangular matrix
 \details
 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be inverted
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              The lower triangle is not referenced.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_invert_trm_complex_single(int na, complex float *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  elpa_cholesky_real_double: Cholesky factorization of a double-precision real symmetric matrix
 \details

 *\param  na                   Order of matrix
 *\param  a(lda,matrixCols)    Distributed matrix which should be factorized.
 *                             Distribution is like in Scalapack.
 *                             Only upper triangle is needs to be set.
 *                             On return, the upper triangle contains the Cholesky factor
 *                             and the lower triangle is set to 0.
 *\param  lda                  Leading dimension of a
 *\param  matrixCols           local columns of matrix a
 *\param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 *\param  mpi_comm_rows        MPI communicator for rows
 *\param  mpi_comm_cols        MPI communicator for columns
 *\param wantDebug             int more debug information on failure if 1, else 0
 *\result succes               int reports success (1) or failure (0)
 */
 int elpa_cholesky_real_double(int na, double *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  elpa_cholesky_real_single: Cholesky factorization of a single-precision real symmetric matrix
 \details

 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be factorized.
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              On return, the upper triangle contains the Cholesky factor
                              and the lower triangle is set to 0.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_cholesky_real_single(int na, float *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface elpa_cholesky_complex_double: Cholesky factorization of a double-precision complex hermitian matrix
 \details
 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be factorized.
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              On return, the upper triangle contains the Cholesky factor
                              and the lower triangle is set to 0.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure, if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_cholesky_complex_double(int na, double complex *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 /*
 \brief  C interface elpa_cholesky_complex_single: Cholesky factorization of a single-precision complex hermitian matrix
 \details
 \param  na                   Order of matrix
 \param  a(lda,matrixCols)    Distributed matrix which should be factorized.
                              Distribution is like in Scalapack.
                              Only upper triangle is needs to be set.
                              On return, the upper triangle contains the Cholesky factor
                              and the lower triangle is set to 0.
 \param  lda                  Leading dimension of a
 \param                       matrixCols  local columns of matrix a
 \param  nblk                 blocksize of cyclic distribution, must be the same in both directions!
 \param  mpi_comm_rows        MPI communicator for rows
 \param  mpi_comm_cols        MPI communicator for columns
 \param wantDebug             int more debug information on failure, if 1, else 0
 \result succes               int reports success (1) or failure (0)
 */
 int elpa_cholesky_complex_single(int na, complex float *a, int lda, int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int wantDebug);
 int elpa_solve_evp_real_2stage_double_precision(int na, int nev, double *a, int lda, double *ev, double *q, int ldq, int nblk, 
 int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_REAL_ELPA_KERNEL_API, int useQR, int useGPU);
 int elpa_solve_evp_real_2stage_single_precision(int na, int nev, float *a, int lda, float *ev, float *q, int ldq, int nblk, 
 int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_REAL_ELPA_KERNEL_API, int useQR, int useGPU);
 #include <complex.h>
 int elpa_solve_evp_complex_2stage_double_precision(int na, int nev, double complex *a, int lda, double *ev, double complex *q, int ldq, 
 int nblk, int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_COMPLEX_ELPA_KERNEL_API, int useGPU);
 #include <complex.h>
 int elpa_solve_evp_complex_2stage_single_precision(int na, int nev, complex float *a, int lda, float *ev, complex float *q, int ldq, int nblk, 
 int matrixCols, int mpi_comm_rows, int mpi_comm_cols, int mpi_comm_all, int THIS_COMPLEX_ELPA_KERNEL_API, int useGPU);