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