LAPACK  3.10.1
LAPACK: Linear Algebra PACKage
lapacke_zgesdd_work.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 middle-level C interface to LAPACK function zgesdd
30 * Author: Intel Corporation
31 *****************************************************************************/
32 
33 #include "lapacke_utils.h"
34 
35 lapack_int LAPACKE_zgesdd_work( int matrix_layout, char jobz, lapack_int m,
36  lapack_int n, lapack_complex_double* a,
37  lapack_int lda, double* s,
38  lapack_complex_double* u, lapack_int ldu,
39  lapack_complex_double* vt, lapack_int ldvt,
40  lapack_complex_double* work, lapack_int lwork,
41  double* rwork, lapack_int* iwork )
42 {
43  lapack_int info = 0;
44  if( matrix_layout == LAPACK_COL_MAJOR ) {
45  /* Call LAPACK function and adjust info */
46  LAPACK_zgesdd( &jobz, &m, &n, a, &lda, s, u, &ldu, vt, &ldvt, work,
47  &lwork, rwork, iwork, &info );
48  if( info < 0 ) {
49  info = info - 1;
50  }
51  } else if( matrix_layout == LAPACK_ROW_MAJOR ) {
52  lapack_int nrows_u = ( LAPACKE_lsame( jobz, 'a' ) ||
53  LAPACKE_lsame( jobz, 's' ) ||
54  ( LAPACKE_lsame( jobz, 'o' ) && m<n) ) ? m : 1;
55  lapack_int ncols_u = ( LAPACKE_lsame( jobz, 'a' ) ||
56  ( LAPACKE_lsame( jobz, 'o' ) && m<n) ) ? m :
57  ( LAPACKE_lsame( jobz, 's' ) ? MIN(m,n) : 1);
58  lapack_int nrows_vt = ( LAPACKE_lsame( jobz, 'a' ) ||
59  ( LAPACKE_lsame( jobz, 'o' ) && m>=n) ) ? n :
60  ( LAPACKE_lsame( jobz, 's' ) ? MIN(m,n) : 1);
61  lapack_int lda_t = MAX(1,m);
62  lapack_int ldu_t = MAX(1,nrows_u);
63  lapack_int ldvt_t = MAX(1,nrows_vt);
64  lapack_complex_double* a_t = NULL;
65  lapack_complex_double* u_t = NULL;
66  lapack_complex_double* vt_t = NULL;
67  /* Check leading dimension(s) */
68  if( lda < n ) {
69  info = -6;
70  LAPACKE_xerbla( "LAPACKE_zgesdd_work", info );
71  return info;
72  }
73  if( ldu < ncols_u ) {
74  info = -9;
75  LAPACKE_xerbla( "LAPACKE_zgesdd_work", info );
76  return info;
77  }
78  if( ldvt < n ) {
79  info = -11;
80  LAPACKE_xerbla( "LAPACKE_zgesdd_work", info );
81  return info;
82  }
83  /* Query optimal working array(s) size if requested */
84  if( lwork == -1 ) {
85  LAPACK_zgesdd( &jobz, &m, &n, a, &lda_t, s, u, &ldu_t, vt, &ldvt_t,
86  work, &lwork, rwork, iwork, &info );
87  return (info < 0) ? (info - 1) : info;
88  }
89  /* Allocate memory for temporary array(s) */
90  a_t = (lapack_complex_double*)
91  LAPACKE_malloc( sizeof(lapack_complex_double) * lda_t * MAX(1,n) );
92  if( a_t == NULL ) {
93  info = LAPACK_TRANSPOSE_MEMORY_ERROR;
94  goto exit_level_0;
95  }
96  if( LAPACKE_lsame( jobz, 'a' ) || LAPACKE_lsame( jobz, 's' ) ||
97  ( LAPACKE_lsame( jobz, 'o' ) && (m<n) ) ) {
98  u_t = (lapack_complex_double*)
99  LAPACKE_malloc( sizeof(lapack_complex_double) *
100  ldu_t * MAX(1,ncols_u) );
101  if( u_t == NULL ) {
102  info = LAPACK_TRANSPOSE_MEMORY_ERROR;
103  goto exit_level_1;
104  }
105  }
106  if( LAPACKE_lsame( jobz, 'a' ) || LAPACKE_lsame( jobz, 's' ) ||
107  ( LAPACKE_lsame( jobz, 'o' ) && (m>=n) ) ) {
108  vt_t = (lapack_complex_double*)
109  LAPACKE_malloc( sizeof(lapack_complex_double) *
110  ldvt_t * MAX(1,n) );
111  if( vt_t == NULL ) {
112  info = LAPACK_TRANSPOSE_MEMORY_ERROR;
113  goto exit_level_2;
114  }
115  }
116  /* Transpose input matrices */
117  LAPACKE_zge_trans( matrix_layout, m, n, a, lda, a_t, lda_t );
118  /* Call LAPACK function and adjust info */
119  LAPACK_zgesdd( &jobz, &m, &n, a_t, &lda_t, s, u_t, &ldu_t, vt_t,
120  &ldvt_t, work, &lwork, rwork, iwork, &info );
121  if( info < 0 ) {
122  info = info - 1;
123  }
124  /* Transpose output matrices */
125  LAPACKE_zge_trans( LAPACK_COL_MAJOR, m, n, a_t, lda_t, a, lda );
126  if( LAPACKE_lsame( jobz, 'a' ) || LAPACKE_lsame( jobz, 's' ) ||
127  ( LAPACKE_lsame( jobz, 'o' ) && (m<n) ) ) {
128  LAPACKE_zge_trans( LAPACK_COL_MAJOR, nrows_u, ncols_u, u_t, ldu_t,
129  u, ldu );
130  }
131  if( LAPACKE_lsame( jobz, 'a' ) || LAPACKE_lsame( jobz, 's' ) ||
132  ( LAPACKE_lsame( jobz, 'o' ) && (m>=n) ) ) {
133  LAPACKE_zge_trans( LAPACK_COL_MAJOR, nrows_vt, n, vt_t, ldvt_t, vt,
134  ldvt );
135  }
136  /* Release memory and exit */
137  if( LAPACKE_lsame( jobz, 'a' ) || LAPACKE_lsame( jobz, 's' ) ||
138  ( LAPACKE_lsame( jobz, 'o' ) && (m>=n) ) ) {
139  LAPACKE_free( vt_t );
140  }
141 exit_level_2:
142  if( LAPACKE_lsame( jobz, 'a' ) || LAPACKE_lsame( jobz, 's' ) ||
143  ( LAPACKE_lsame( jobz, 'o' ) && (m<n) ) ) {
144  LAPACKE_free( u_t );
145  }
146 exit_level_1:
147  LAPACKE_free( a_t );
148 exit_level_0:
149  if( info == LAPACK_TRANSPOSE_MEMORY_ERROR ) {
150  LAPACKE_xerbla( "LAPACKE_zgesdd_work", info );
151  }
152  } else {
153  info = -1;
154  LAPACKE_xerbla( "LAPACKE_zgesdd_work", info );
155  }
156  return info;
157 }
LAPACK_zgesdd
#define LAPACK_zgesdd(...)
Definition: lapack.h:3301
lapack_int
#define lapack_int
Definition: lapack.h:83
lapack_complex_double
#define lapack_complex_double
Definition: lapack.h:63
LAPACK_COL_MAJOR
#define LAPACK_COL_MAJOR
Definition: lapacke.h:53
LAPACKE_free
#define LAPACKE_free(p)
Definition: lapacke.h:46
LAPACK_ROW_MAJOR
#define LAPACK_ROW_MAJOR
Definition: lapacke.h:52
LAPACKE_malloc
#define LAPACKE_malloc(size)
Definition: lapacke.h:43
LAPACK_TRANSPOSE_MEMORY_ERROR
#define LAPACK_TRANSPOSE_MEMORY_ERROR
Definition: lapacke.h:56
LAPACKE_lsame
lapack_logical LAPACKE_lsame(char ca, char cb)
Definition: lapacke_lsame.c:35
LAPACKE_xerbla
void LAPACKE_xerbla(const char *name, lapack_int info)
Definition: lapacke_xerbla.c:36
LAPACKE_zge_trans
void LAPACKE_zge_trans(int matrix_layout, lapack_int m, lapack_int n, const lapack_complex_double *in, lapack_int ldin, lapack_complex_double *out, lapack_int ldout)
Definition: lapacke_zge_trans.c:39
MIN
#define MIN(x, y)
Definition: lapacke_utils.h:49
MAX
#define MAX(x, y)
Definition: lapacke_utils.h:46
lapacke_utils.h
LAPACKE_zgesdd_work
lapack_int LAPACKE_zgesdd_work(int matrix_layout, char jobz, lapack_int m, lapack_int n, lapack_complex_double *a, lapack_int lda, double *s, lapack_complex_double *u, lapack_int ldu, lapack_complex_double *vt, lapack_int ldvt, lapack_complex_double *work, lapack_int lwork, double *rwork, lapack_int *iwork)
Definition: lapacke_zgesdd_work.c:35