LAPACK  3.6.1
LAPACK: Linear Algebra PACKage
lapacke_cgesvd.c
Go to the documentation of this file.
1 /*****************************************************************************
2  Copyright (c) 2014, Intel Corp.
3  All rights reserved.
4 
5  Redistribution and use in source and binary forms, with or without
6  modification, are permitted provided that the following conditions are met:
7 
8  * Redistributions of source code must retain the above copyright notice,
9  this list of conditions and the following disclaimer.
10  * Redistributions in binary form must reproduce the above copyright
11  notice, this list of conditions and the following disclaimer in the
12  documentation and/or other materials provided with the distribution.
13  * Neither the name of Intel Corporation nor the names of its contributors
14  may be used to endorse or promote products derived from this software
15  without specific prior written permission.
16 
17  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  THE POSSIBILITY OF SUCH DAMAGE.
28 *****************************************************************************
29 * Contents: Native high-level C interface to LAPACK function cgesvd
30 * Author: Intel Corporation
31 * Generated November 2015
32 *****************************************************************************/
33 
34 #include "lapacke_utils.h"
35 
36 lapack_int LAPACKE_cgesvd( int matrix_layout, char jobu, char jobvt,
38  lapack_int lda, float* s, lapack_complex_float* u,
40  lapack_int ldvt, float* superb )
41 {
42  lapack_int info = 0;
43  lapack_int lwork = -1;
44  float* rwork = NULL;
45  lapack_complex_float* work = NULL;
46  lapack_complex_float work_query;
47  lapack_int i;
48  if( matrix_layout != LAPACK_COL_MAJOR && matrix_layout != LAPACK_ROW_MAJOR ) {
49  LAPACKE_xerbla( "LAPACKE_cgesvd", -1 );
50  return -1;
51  }
52 #ifndef LAPACK_DISABLE_NAN_CHECK
53  /* Optionally check input matrices for NaNs */
54  if( LAPACKE_cge_nancheck( matrix_layout, m, n, a, lda ) ) {
55  return -6;
56  }
57 #endif
58  /* Allocate memory for working array(s) */
59  rwork = (float*)LAPACKE_malloc( sizeof(float) * MAX(1,5*MIN(m,n)) );
60  if( rwork == NULL ) {
62  goto exit_level_0;
63  }
64  /* Query optimal working array(s) size */
65  info = LAPACKE_cgesvd_work( matrix_layout, jobu, jobvt, m, n, a, lda, s, u,
66  ldu, vt, ldvt, &work_query, lwork, rwork );
67  if( info != 0 ) {
68  goto exit_level_1;
69  }
70  lwork = LAPACK_C2INT( work_query );
71  /* Allocate memory for work arrays */
72  work = (lapack_complex_float*)
73  LAPACKE_malloc( sizeof(lapack_complex_float) * lwork );
74  if( work == NULL ) {
76  goto exit_level_1;
77  }
78  /* Call middle-level interface */
79  info = LAPACKE_cgesvd_work( matrix_layout, jobu, jobvt, m, n, a, lda, s, u,
80  ldu, vt, ldvt, work, lwork, rwork );
81  /* Backup significant data from working array(s) */
82  for( i=0; i<MIN(m,n)-1; i++ ) {
83  superb[i] = rwork[i];
84  }
85  /* Release memory and exit */
86  LAPACKE_free( work );
87 exit_level_1:
88  LAPACKE_free( rwork );
89 exit_level_0:
90  if( info == LAPACK_WORK_MEMORY_ERROR ) {
91  LAPACKE_xerbla( "LAPACKE_cgesvd", info );
92  }
93  return info;
94 }
lapack_int LAPACKE_cgesvd_work(int matrix_layout, char jobu, char jobvt, lapack_int m, lapack_int n, lapack_complex_float *a, lapack_int lda, float *s, lapack_complex_float *u, lapack_int ldu, lapack_complex_float *vt, lapack_int ldvt, lapack_complex_float *work, lapack_int lwork, float *rwork)
#define LAPACK_ROW_MAJOR
Definition: lapacke.h:119
#define LAPACK_WORK_MEMORY_ERROR
Definition: lapacke.h:122
lapack_int LAPACKE_cgesvd(int matrix_layout, char jobu, char jobvt, lapack_int m, lapack_int n, lapack_complex_float *a, lapack_int lda, float *s, lapack_complex_float *u, lapack_int ldu, lapack_complex_float *vt, lapack_int ldvt, float *superb)
#define lapack_complex_float
Definition: lapacke.h:74
#define MIN(x, y)
Definition: lapacke_utils.h:50
lapack_logical LAPACKE_cge_nancheck(int matrix_layout, lapack_int m, lapack_int n, const lapack_complex_float *a, lapack_int lda)
#define MAX(x, y)
Definition: lapacke_utils.h:47
#define LAPACKE_free(p)
Definition: lapacke.h:113
#define LAPACKE_malloc(size)
Definition: lapacke.h:110
#define LAPACK_C2INT(x)
Definition: lapacke.h:116
#define LAPACK_COL_MAJOR
Definition: lapacke.h:120
void LAPACKE_xerbla(const char *name, lapack_int info)
#define lapack_int
Definition: lapacke.h:47