libflame  revision_anchor
Functions
FLA_Svd_ext.c File Reference

(r)

Functions

FLA_Error FLA_Svd_ext (FLA_Svd_type jobu, FLA_Trans transu, FLA_Svd_type jobv, FLA_Trans transv, FLA_Obj A, FLA_Obj s, FLA_Obj U, FLA_Obj V)
 

Function Documentation

◆ FLA_Svd_ext()

FLA_Error FLA_Svd_ext ( FLA_Svd_type  jobu,
FLA_Trans  transu,
FLA_Svd_type  jobv,
FLA_Trans  transv,
FLA_Obj  A,
FLA_Obj  s,
FLA_Obj  U,
FLA_Obj  V 
)
28 {
29  FLA_Error r_val = FLA_SUCCESS;
30  dim_t n_iter_max = 30;
31  dim_t k_accum = 32;
32  dim_t b_alg = 512;
33  dim_t min_m_n = FLA_Obj_min_dim( A );
34  dim_t m_A = FLA_Obj_length( A );
35  dim_t n_A = FLA_Obj_width( A );
36  FLA_Bool u_flipped = FALSE;
37  FLA_Bool v_flipped = FALSE;
38  FLA_Obj W; // Dummy variable for partitioning of matrices.
39 
40  // Check parameters.
41  if ( FLA_Check_error_level() >= FLA_MIN_ERROR_CHECKING )
42  FLA_Svd_ext_check( jobu, transu, jobv, transv, A, s, U, V );
43 
44  // Transpose U and V to match dimensions used in SVD.
45  if ( ( transu == FLA_TRANSPOSE || transu == FLA_CONJ_TRANSPOSE ) &&
46  ( jobu != FLA_SVD_VECTORS_NONE && jobu != FLA_SVD_VECTORS_MIN_OVERWRITE ) )
47  {
48  FLA_Obj_flip_base( &U );
49  FLA_Obj_flip_view( &U );
50  u_flipped = TRUE;
51  }
52  if ( ( transv == FLA_TRANSPOSE || transv == FLA_CONJ_TRANSPOSE ) &&
53  ( jobv != FLA_SVD_VECTORS_NONE && jobv != FLA_SVD_VECTORS_MIN_OVERWRITE ) )
54  {
55  FLA_Obj_flip_base( &V );
56  FLA_Obj_flip_view( &V );
57  v_flipped = TRUE;
58  }
59 
60  // Partition U and V if necessary.
61  if ( jobu == FLA_SVD_VECTORS_MIN_COPY ) FLA_Part_1x2( U, &U, &W, min_m_n, FLA_LEFT );
62  if ( jobv == FLA_SVD_VECTORS_MIN_COPY ) FLA_Part_1x2( V, &V, &W, min_m_n, FLA_LEFT );
63 
64  if ( m_A >= n_A )
65  {
66  r_val = FLA_Svd_ext_u_unb_var1( jobu, jobv,
67  n_iter_max,
68  A, s, U, V,
69  k_accum, b_alg );
70 
71  // Recover U and V.
72  if ( u_flipped == TRUE )
73  {
74  if ( FLA_Obj_is_complex( U ) )
75  FLA_Conjugate( U );
76  FLA_Obj_flip_base( &U );
77  }
78  if ( v_flipped == TRUE )
79  {
80  if ( FLA_Obj_is_complex( V ) )
81  FLA_Conjugate( V );
82  FLA_Obj_flip_base( &V );
83  }
84  }
85  else
86  {
87  // Flip A and exchange U and V parameters.
88  FLA_Obj_flip_base( &A );
89  FLA_Obj_flip_view( &A );
90 
91  // Note that U and V are also swapped.
92  r_val = FLA_Svd_ext_u_unb_var1( jobv, jobu,
93  n_iter_max,
94  A, s, V, U,
95  k_accum, b_alg );
96 
97  // Recover A.
98  FLA_Obj_flip_base( &A );
99 
100  // Recover U and V. Consider a case that U and V are not created.
101  if ( u_flipped == TRUE )
102  FLA_Obj_flip_base( &U );
103  else if ( jobu != FLA_SVD_VECTORS_NONE &&
104  jobu != FLA_SVD_VECTORS_MIN_OVERWRITE )
105  if ( FLA_Obj_is_complex( U ) )
106  FLA_Conjugate( U );
107 
108  if ( v_flipped == TRUE )
109  FLA_Obj_flip_base( &V );
110  else if ( jobv != FLA_SVD_VECTORS_NONE &&
111  jobv != FLA_SVD_VECTORS_MIN_OVERWRITE )
112  if ( FLA_Obj_is_complex( V ) )
113  FLA_Conjugate( V );
114  }
115 
116  return r_val;
117 }
FLA_Error FLA_Svd_ext_u_unb_var1(FLA_Svd_type jobu, FLA_Svd_type jobv, dim_t n_iter_max, FLA_Obj A, FLA_Obj s, FLA_Obj V, FLA_Obj U, dim_t k_accum, dim_t b_alg)
Definition: FLA_Svd_ext_u_unb_var1.c:14
FLA_Error FLA_Svd_ext_check(FLA_Svd_type jobu, FLA_Trans transu, FLA_Svd_type jobv, FLA_Trans transv, FLA_Obj A, FLA_Obj s, FLA_Obj U, FLA_Obj V)
Definition: FLA_Svd_ext_check.c:13
FLA_Error FLA_Obj_flip_view(FLA_Obj *obj)
Definition: FLA_Obj.c:669
FLA_Error FLA_Obj_flip_base(FLA_Obj *obj)
Definition: FLA_Obj.c:647
dim_t FLA_Obj_width(FLA_Obj obj)
Definition: FLA_Query.c:123
FLA_Error FLA_Part_1x2(FLA_Obj A, FLA_Obj *A1, FLA_Obj *A2, dim_t nb, FLA_Side side)
Definition: FLA_View.c:110
dim_t FLA_Obj_length(FLA_Obj obj)
Definition: FLA_Query.c:116
FLA_Bool FLA_Obj_is_complex(FLA_Obj A)
Definition: FLA_Query.c:324
unsigned int FLA_Check_error_level(void)
Definition: FLA_Check.c:18
dim_t FLA_Obj_min_dim(FLA_Obj obj)
Definition: FLA_Query.c:153
int FLA_Error
Definition: FLA_type_defs.h:47
unsigned long dim_t
Definition: FLA_type_defs.h:71
int FLA_Bool
Definition: FLA_type_defs.h:46
FLA_Error FLA_Conjugate(FLA_Obj A)
Definition: FLA_Conjugate.c:13
Definition: FLA_type_defs.h:159

References FLA_Check_error_level(), FLA_Conjugate(), FLA_Obj_flip_base(), FLA_Obj_flip_view(), FLA_Obj_is_complex(), FLA_Obj_length(), FLA_Obj_min_dim(), FLA_Obj_width(), FLA_Part_1x2(), FLA_Svd_ext_check(), and FLA_Svd_ext_u_unb_var1().