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 dgesvd
30 * Author: Intel Corporation
31 *****************************************************************************/
32 
33 #include "lapacke_utils.h"
34 
LAPACKE_dgesvd_work(int matrix_layout,char jobu,char jobvt,lapack_int m,lapack_int n,double * a,lapack_int lda,double * s,double * u,lapack_int ldu,double * vt,lapack_int ldvt,double * work,lapack_int lwork)35 lapack_int LAPACKE_dgesvd_work( int matrix_layout, char jobu, char jobvt,
36                                 lapack_int m, lapack_int n, double* a,
37                                 lapack_int lda, double* s, double* u,
38                                 lapack_int ldu, double* vt, lapack_int ldvt,
39                                 double* work, lapack_int lwork )
40 {
41     lapack_int info = 0;
42     if( matrix_layout == LAPACK_COL_MAJOR ) {
43         /* Call LAPACK function and adjust info */
44         LAPACK_dgesvd( &jobu, &jobvt, &m, &n, a, &lda, s, u, &ldu, vt, &ldvt,
45                        work, &lwork, &info );
46         if( info < 0 ) {
47             info = info - 1;
48         }
49     } else if( matrix_layout == LAPACK_ROW_MAJOR ) {
50         lapack_int nrows_u = ( LAPACKE_lsame( jobu, 'a' ) ||
51                              LAPACKE_lsame( jobu, 's' ) ) ? m : 1;
52         lapack_int ncols_u = LAPACKE_lsame( jobu, 'a' ) ? m :
53                              ( LAPACKE_lsame( jobu, 's' ) ? MIN(m,n) : 1);
54         lapack_int nrows_vt = LAPACKE_lsame( jobvt, 'a' ) ? n :
55                               ( LAPACKE_lsame( jobvt, 's' ) ? MIN(m,n) : 1);
56         lapack_int ncols_vt = ( LAPACKE_lsame( jobvt, 'a' ) ||
57                                LAPACKE_lsame( jobvt, 's' ) ) ? n : 1;
58         lapack_int lda_t = MAX(1,m);
59         lapack_int ldu_t = MAX(1,nrows_u);
60         lapack_int ldvt_t = MAX(1,nrows_vt);
61         double* a_t = NULL;
62         double* u_t = NULL;
63         double* vt_t = NULL;
64         /* Check leading dimension(s) */
65         if( lda < n ) {
66             info = -7;
67             LAPACKE_xerbla( "LAPACKE_dgesvd_work", info );
68             return info;
69         }
70         if( ldu < ncols_u ) {
71             info = -10;
72             LAPACKE_xerbla( "LAPACKE_dgesvd_work", info );
73             return info;
74         }
75         if( ldvt < ncols_vt ) {
76             info = -12;
77             LAPACKE_xerbla( "LAPACKE_dgesvd_work", info );
78             return info;
79         }
80         /* Query optimal working array(s) size if requested */
81         if( lwork == -1 ) {
82             LAPACK_dgesvd( &jobu, &jobvt, &m, &n, a, &lda_t, s, u, &ldu_t, vt,
83                            &ldvt_t, work, &lwork, &info );
84             return (info < 0) ? (info - 1) : info;
85         }
86         /* Allocate memory for temporary array(s) */
87         a_t = (double*)LAPACKE_malloc( sizeof(double) * lda_t * MAX(1,n) );
88         if( a_t == NULL ) {
89             info = LAPACK_TRANSPOSE_MEMORY_ERROR;
90             goto exit_level_0;
91         }
92         if( LAPACKE_lsame( jobu, 'a' ) || LAPACKE_lsame( jobu, 's' ) ) {
93             u_t = (double*)
94                 LAPACKE_malloc( sizeof(double) * ldu_t * MAX(1,ncols_u) );
95             if( u_t == NULL ) {
96                 info = LAPACK_TRANSPOSE_MEMORY_ERROR;
97                 goto exit_level_1;
98             }
99         }
100         if( LAPACKE_lsame( jobvt, 'a' ) || LAPACKE_lsame( jobvt, 's' ) ) {
101             vt_t = (double*)
102                 LAPACKE_malloc( sizeof(double) * ldvt_t * MAX(1,n) );
103             if( vt_t == NULL ) {
104                 info = LAPACK_TRANSPOSE_MEMORY_ERROR;
105                 goto exit_level_2;
106             }
107         }
108         /* Transpose input matrices */
109         LAPACKE_dge_trans( matrix_layout, m, n, a, lda, a_t, lda_t );
110         /* Call LAPACK function and adjust info */
111         LAPACK_dgesvd( &jobu, &jobvt, &m, &n, a_t, &lda_t, s, u_t, &ldu_t, vt_t,
112                        &ldvt_t, work, &lwork, &info );
113         if( info < 0 ) {
114             info = info - 1;
115         }
116         /* Transpose output matrices */
117         LAPACKE_dge_trans( LAPACK_COL_MAJOR, m, n, a_t, lda_t, a, lda );
118         if( LAPACKE_lsame( jobu, 'a' ) || LAPACKE_lsame( jobu, 's' ) ) {
119             LAPACKE_dge_trans( LAPACK_COL_MAJOR, nrows_u, ncols_u, u_t, ldu_t,
120                                u, ldu );
121         }
122         if( LAPACKE_lsame( jobvt, 'a' ) || LAPACKE_lsame( jobvt, 's' ) ) {
123             LAPACKE_dge_trans( LAPACK_COL_MAJOR, nrows_vt, n, vt_t, ldvt_t, vt,
124                                ldvt );
125         }
126         /* Release memory and exit */
127         if( LAPACKE_lsame( jobvt, 'a' ) || LAPACKE_lsame( jobvt, 's' ) ) {
128             LAPACKE_free( vt_t );
129         }
130 exit_level_2:
131         if( LAPACKE_lsame( jobu, 'a' ) || LAPACKE_lsame( jobu, 's' ) ) {
132             LAPACKE_free( u_t );
133         }
134 exit_level_1:
135         LAPACKE_free( a_t );
136 exit_level_0:
137         if( info == LAPACK_TRANSPOSE_MEMORY_ERROR ) {
138             LAPACKE_xerbla( "LAPACKE_dgesvd_work", info );
139         }
140     } else {
141         info = -1;
142         LAPACKE_xerbla( "LAPACKE_dgesvd_work", info );
143     }
144     return info;
145 }
146