zgelqs_param.c 11.9 KB
Newer Older
1 2
/**
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
3 4 5 6 7
 * @copyright 2009-2014 The University of Tennessee and The University
 *                      of Tennessee Research Foundation.
 *                      All rights reserved.
 * @copyright 2012-2017 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
8 9 10 11 12 13 14 15 16 17 18
 *
 **/

/**
 *
 * @file zgelqs_param.c
 *
 *  MORSE computational routines
 *  MORSE is a software package provided by Univ. of Tennessee,
 *  Univ. of California Berkeley and Univ. of Colorado Denver
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
19 20
 * @version 1.0.0
 * @author Raphael Boucherie
21
 * @author Mathieu Faverge
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
22
 * @date 2017-05-17
23 24 25 26
 * @precisions normal z -> s d c
 *
 **/
#include "control/common.h"
Mathieu Faverge's avatar
Mathieu Faverge committed
27
#include <stdlib.h>
28

BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
29 30
/**
 *******************************************************************************
31 32 33 34 35 36 37 38
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zgelqs_param - Compute a minimum-norm solution min || A*X - B || using the LQ factorization
 *  A = L*Q computed by MORSE_zgelqf.
 *
 *******************************************************************************
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
39 40 41
 * @param[in] qrtree
 *          The tree used for the factorization
 *
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 * @param[in] M
 *          The number of rows of the matrix A. M >= 0.
 *
 * @param[in] N
 *          The number of columns of the matrix A. N >= M >= 0.
 *
 * @param[in] NRHS
 *          The number of columns of B. NRHS >= 0.
 *
 * @param[in] A
 *          Details of the LQ factorization of the original matrix A as returned by MORSE_zgelqf.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= M.
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
57 58 59 60
 * @param[in] descTS
 *          Auxiliary factorization data, computed by MORSE_zgelqf.
 *
 * @param[in] descTT
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
 *          Auxiliary factorization data, computed by MORSE_zgelqf.
 *
 * @param[in,out] B
 *          On entry, the M-by-NRHS right hand side matrix B.
 *          On exit, the N-by-NRHS solution matrix X.
 *
 * @param[in] LDB
 *          The leading dimension of the array B. LDB >= N.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *
 *******************************************************************************
 *
 * @sa MORSE_zgelqs_param_Tile
 * @sa MORSE_zgelqs_param_Tile_Async
 * @sa MORSE_cgelqs
 * @sa MORSE_dgelqs
 * @sa MORSE_sgelqs
 * @sa MORSE_zgelqf
 *
 ******************************************************************************/
86 87 88 89
int MORSE_zgelqs_param( const libhqr_tree_t *qrtree, int M, int N, int NRHS,
                        MORSE_Complex64_t *A, int LDA,
                        MORSE_desc_t *descTS, MORSE_desc_t *descTT,
                        MORSE_Complex64_t *B, int LDB )
90 91 92 93 94 95
{
    int NB;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
Mathieu Faverge's avatar
Mathieu Faverge committed
96 97
    MORSE_desc_t descAl, descAt;
    MORSE_desc_t descBl, descBt;
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zgelqs_param", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }

    /* Check input arguments */
    if (M < 0) {
        morse_error("MORSE_zgelqs_param", "illegal value of M");
        return -1;
    }
    if (N < 0 || M > N) {
        morse_error("MORSE_zgelqs_param", "illegal value of N");
        return -2;
    }
    if (NRHS < 0) {
        morse_error("MORSE_zgelqs_param", "illegal value of N");
        return -3;
    }
    if (LDA < chameleon_max(1, M)) {
        morse_error("MORSE_zgelqs_param", "illegal value of LDA");
        return -5;
    }
    if (LDB < chameleon_max(1, chameleon_max(1, N))) {
        morse_error("MORSE_zgelqs_param", "illegal value of LDB");
        return -8;
    }
    /* Quick return */
    if (chameleon_min(M, chameleon_min(N, NRHS)) == 0) {
        return MORSE_SUCCESS;
    }

    /* Tune NB & IB depending on M, N & NRHS; Set NBNBSIZE */
    status = morse_tune(MORSE_FUNC_ZGELS, M, N, NRHS);
    if (status != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqs_param", "morse_tune() failed");
        return status;
    }

    /* Set NT */
    NB = MORSE_NB;

141
    morse_sequence_create( morse, &sequence );
142

143
    /* Submit the matrix conversion */
144
    morse_zlap2tile( morse, &descAl, &descAt, MorseDescInput, MorseUpperLower,
145
                     A, NB, NB, LDA, N, M, N, sequence, &request );
146
    morse_zlap2tile( morse, &descBl, &descBt, MorseDescInout, MorseUpperLower,
147
                     B, NB, NB, LDB, NRHS, N, NRHS, sequence, &request );
148 149

    /* Call the tile interface */
150
    MORSE_zgelqs_param_Tile_Async( qrtree, &descAt, descTS, descTT, &descBt, sequence, &request );
151

Mathieu Faverge's avatar
Cleanup  
Mathieu Faverge committed
152
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
153
    morse_ztile2lap( morse, &descAl, &descAt,
154
                     MorseDescInput, MorseUpperLower, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
155
    morse_ztile2lap( morse, &descBl, &descBt,
156
                     MorseDescInout, MorseUpperLower, sequence, &request );
157 158
    MORSE_Desc_Flush( descTS, sequence );
    MORSE_Desc_Flush( descTT, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
159

160
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
161

Mathieu Faverge's avatar
Mathieu Faverge committed
162 163 164
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
    morse_ztile2lap_cleanup( morse, &descBl, &descBt );
165 166

    status = sequence->status;
167
    morse_sequence_destroy( morse, sequence );
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    return status;
}

/**
 *******************************************************************************
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zgelqs_param_Tile - Computes a minimum-norm solution using previously computed
 *  LQ factorization.
 *  Tile equivalent of MORSE_zgelqs_param().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] A
 *          Details of the LQ factorization of the original matrix A as returned by MORSE_zgelqf.
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
188 189 190 191
 * @param[in] TS
 *          Auxiliary factorization data, computed by MORSE_zgelqf.
 *
 * @param[in] TT
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
 *          Auxiliary factorization data, computed by MORSE_zgelqf.
 *
 * @param[in,out] B
 *          On entry, the M-by-NRHS right hand side matrix B.
 *          On exit, the N-by-NRHS solution matrix X.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zgelqs_param
 * @sa MORSE_zgelqs_param_Tile_Async
 * @sa MORSE_cgelqs_Tile
 * @sa MORSE_dgelqs_Tile
 * @sa MORSE_sgelqs_Tile
 * @sa MORSE_zgelqf_Tile
 *
 ******************************************************************************/
213 214
int MORSE_zgelqs_param_Tile( const libhqr_tree_t *qrtree, MORSE_desc_t *A,
                             MORSE_desc_t *TS, MORSE_desc_t *TT, MORSE_desc_t *B )
215 216 217 218 219 220 221 222 223 224 225
{
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
    int status;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zgelqs_param_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
226 227
    morse_sequence_create( morse, &sequence );

228
    MORSE_zgelqs_param_Tile_Async( qrtree, A, TS, TT, B, sequence, &request );
229

230
    MORSE_Desc_Flush( A, sequence );
231 232
    MORSE_Desc_Flush( TS, sequence );
    MORSE_Desc_Flush( TT, sequence );
233
    MORSE_Desc_Flush( B, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
234

235
    morse_sequence_wait( morse, sequence );
236
    status = sequence->status;
237
    morse_sequence_destroy( morse, sequence );
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    return status;
}

/**
 *******************************************************************************
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zgelqs_param_Tile_Async - Computes a minimum-norm solution using previously
 *  computed LQ factorization.
 *  Non-blocking equivalent of MORSE_zgelqs_param_Tile().
 *  May return before the computation is finished.
 *  Allows for pipelining of operations at runtime.
 *
 *******************************************************************************
 *
 * @param[in] sequence
 *          Identifies the sequence of function calls that this call belongs to
 *          (for completion checks and exception handling purposes).
 *
 * @param[out] request
 *          Identifies this function call (for exception handling purposes).
 *
 *******************************************************************************
 *
 * @sa MORSE_zgelqs_param
 * @sa MORSE_zgelqs_param_Tile
 * @sa MORSE_cgelqs_Tile_Async
 * @sa MORSE_dgelqs_Tile_Async
 * @sa MORSE_sgelqs_Tile_Async
 * @sa MORSE_zgelqf_Tile_Async
 *
 ******************************************************************************/
271 272
int MORSE_zgelqs_param_Tile_Async( const libhqr_tree_t *qrtree, MORSE_desc_t *A, MORSE_desc_t *TS, MORSE_desc_t *TT, MORSE_desc_t *B,
                                   MORSE_sequence_t *sequence, MORSE_request_t *request )
273 274 275 276
{
    MORSE_desc_t *subB;
    MORSE_desc_t *subA;
    MORSE_context_t *morse;
Mathieu Faverge's avatar
Mathieu Faverge committed
277
    MORSE_desc_t D, *Dptr = NULL;
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zgelqs_param_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zgelqs_param_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zgelqs_param_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
Mathieu Faverge's avatar
Mathieu Faverge committed
293
    if (sequence->status == MORSE_SUCCESS) {
294
        request->status = MORSE_SUCCESS;
Mathieu Faverge's avatar
Mathieu Faverge committed
295 296
    }
    else {
297
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);
Mathieu Faverge's avatar
Mathieu Faverge committed
298
    }
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqs_param_Tile", "invalid first descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(TS) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqs_param_Tile", "invalid second descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(TT) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqs_param_Tile", "invalid third descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(B) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqs_param_Tile", "invalid fourth descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if (A->nb != A->mb || B->nb != B->mb) {
        morse_error("MORSE_zgelqs_param_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Quick return */
323 324 325 326 327
    /*
     if (chameleon_min(M, chameleon_min(N, NRHS)) == 0) {
     return MORSE_SUCCESS;
     }
     */
328
    /* subB = morse_desc_submatrix(B, A->m, 0, A->n-A->m, B->n);
Mathieu Faverge's avatar
Mathieu Faverge committed
329
     morse_pzlaset( MorseUpperLower, 0., 0., subB, sequence, request );
330
     free(subB); */
331 332 333

    subB = morse_desc_submatrix(B, 0, 0, A->m, B->n);
    subA = morse_desc_submatrix(A, 0, 0, A->m, A->m);
Mathieu Faverge's avatar
Mathieu Faverge committed
334
    morse_pztrsm( MorseLeft, MorseLower, MorseNoTrans, MorseNonUnit, 1.0, subA, subB, sequence, request );
335 336 337
    free(subA);
    free(subB);

BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
338
#if defined(CHAMELEON_COPY_DIAG)
Mathieu Faverge's avatar
Mathieu Faverge committed
339 340 341 342 343
    {
        int m = chameleon_min(A->mt, A->nt) * A->mb;
        morse_zdesc_alloc(D, A->mb, A->nb, m, A->n, 0, 0, m, A->n, );
        Dptr = &D;
    }
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
344
#endif
345

Mathieu Faverge's avatar
Mathieu Faverge committed
346
    morse_pzunmlq_param( qrtree, MorseLeft, MorseConjTrans, A, B, TS, TT, Dptr, sequence, request );
Mathieu Faverge's avatar
Mathieu Faverge committed
347
    if (Dptr != NULL) {
348 349 350 351 352 353
        MORSE_Desc_Flush( A, sequence );
        MORSE_Desc_Flush( B, sequence );
        MORSE_Desc_Flush( TS, sequence );
        MORSE_Desc_Flush( TT, sequence );
        MORSE_Desc_Flush( Dptr, sequence );
        morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
354
        morse_desc_mat_free( Dptr );
Mathieu Faverge's avatar
Mathieu Faverge committed
355
    }
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
356
    (void)D;
357 358
    return MORSE_SUCCESS;
}