zgels.c 15.8 KB
Newer Older
1 2
/**
 *
3 4
 * @copyright (c) 2009-2014 The University of Tennessee and The University
 *                          of Tennessee Research Foundation.
5 6
 *                          All rights reserved.
 * @copyright (c) 2012-2014 Inria. All rights reserved.
7
 * @copyright (c) 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, Univ. Bordeaux. All rights reserved.
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 *
 **/

/**
 *
 * @file zgels.c
 *
 *  MORSE computational routines
 *  MORSE is a software package provided by Univ. of Tennessee,
 *  Univ. of California Berkeley and Univ. of Colorado Denver
 *
 * @version 2.5.0
 * @comment This file has been automatically generated
 *          from Plasma 2.5.0 for MORSE 1.0.0
 * @author Jakub Kurzak
 * @author Mathieu Faverge
 * @author Emmanuel Agullo
 * @author Cedric Castagnede
 * @date 2010-11-15
 * @precisions normal z -> s d c
 *
 **/
30
#include "control/common.h"
Mathieu Faverge's avatar
Mathieu Faverge committed
31
#include <stdlib.h>
32

33
/**
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zgels - solves overdetermined or underdetermined linear systems involving an M-by-N
 *  matrix A using the QR or the LQ factorization of A.  It is assumed that A has full rank.
 *  The following options are provided:
 *
 *  # trans = MorseNoTrans and M >= N: find the least squares solution of an overdetermined
 *    system, i.e., solve the least squares problem: minimize || B - A*X ||.
 *
 *  # trans = MorseNoTrans and M < N:  find the minimum norm solution of an underdetermined
 *    system A * X = B.
 *
 *  Several right hand side vectors B and solution vectors X can be handled in a single call;
 *  they are stored as the columns of the M-by-NRHS right hand side matrix B and the N-by-NRHS
 *  solution matrix X.
 *
 *******************************************************************************
 *
 * @param[in] trans
 *          Intended usage:
 *          = MorseNoTrans:   the linear system involves A;
 *          = MorseConjTrans: the linear system involves A**H.
 *          Currently only MorseNoTrans is supported.
 *
 * @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 >= 0.
 *
 * @param[in] NRHS
 *          The number of right hand sides, i.e., the number of columns of the matrices B and X.
 *          NRHS >= 0.
 *
 * @param[in,out] A
 *          On entry, the M-by-N matrix A.
 *          On exit,
 *          if M >= N, A is overwritten by details of its QR factorization as returned by
 *                     MORSE_zgeqrf;
 *          if M < N, A is overwritten by details of its LQ factorization as returned by
 *                      MORSE_zgelqf.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,M).
 *
 * @param[out] descT
 *          On exit, auxiliary factorization data.
 *
 * @param[in,out] B
 *          On entry, the M-by-NRHS matrix B of right hand side vectors, stored columnwise;
 *          On exit, if return value = 0, B is overwritten by the solution vectors, stored
 *          columnwise:
 *          if M >= N, rows 1 to N of B contain the least squares solution vectors; the residual
 *          sum of squares for the solution in each column is given by the sum of squares of the
 *          modulus of elements N+1 to M in that column;
 *          if M < N, rows 1 to N of B contain the minimum norm solution vectors;
 *
 * @param[in] LDB
 *          The leading dimension of the array B. LDB >= MAX(1,M,N).
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *
 *******************************************************************************
 *
 * @sa MORSE_zgels_Tile
 * @sa MORSE_zgels_Tile_Async
 * @sa MORSE_cgels
 * @sa MORSE_dgels
 * @sa MORSE_sgels
 *
 ******************************************************************************/
110 111 112 113
int MORSE_zgels( MORSE_enum trans, int M, int N, int NRHS,
                 MORSE_Complex64_t *A, int LDA,
                 MORSE_desc_t *descT,
                 MORSE_Complex64_t *B, int LDB )
114 115 116 117 118 119 120
{
    int i, j;
    int NB;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
121 122
    MORSE_desc_t descAl, descAt;
    MORSE_desc_t descBl, descBt;
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146

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

    /* Check input arguments */
    if (trans != MorseNoTrans) {
        morse_error("MORSE_zgels", "only MorseNoTrans supported");
        return MORSE_ERR_NOT_SUPPORTED;
    }
    if (M < 0) {
        morse_error("MORSE_zgels", "illegal value of M");
        return -2;
    }
    if (N < 0) {
        morse_error("MORSE_zgels", "illegal value of N");
        return -3;
    }
    if (NRHS < 0) {
        morse_error("MORSE_zgels", "illegal value of NRHS");
        return -4;
    }
147
    if (LDA < chameleon_max(1, M)) {
148 149 150
        morse_error("MORSE_zgels", "illegal value of LDA");
        return -6;
    }
151
    if (LDB < chameleon_max(1, chameleon_max(M, N))) {
152 153 154 155
        morse_error("MORSE_zgels", "illegal value of LDB");
        return -9;
    }
    /* Quick return */
156 157
    if (chameleon_min(M, chameleon_min(N, NRHS)) == 0) {
        for (i = 0; i < chameleon_max(M, N); i++)
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
            for (j = 0; j < NRHS; j++)
                B[j*LDB+i] = 0.0;
        return MORSE_SUCCESS;
    }

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

    /* Set NT */
    NB = MORSE_NB;

173
    morse_sequence_create( morse, &sequence );
174

175
    /* Submit the matrix conversion */
176
    if ( M >= N ) {
177
        morse_zlap2tile( morse, &descAl, &descAt, MorseDescInout, MorseUpperLower,
178
                         A, NB, NB, LDA, N, M, N, sequence, &request );
179
        morse_zlap2tile( morse, &descBl, &descBt, MorseDescInout, MorseUpperLower,
180
                         B, NB, NB, LDB, NRHS, M, NRHS, sequence, &request );
181
    } else {
182
        /* Submit the matrix conversion */
183
        morse_zlap2tile( morse, &descAl, &descAt, MorseDescInout, MorseUpperLower,
184
                         A, NB, NB, LDA, N, M, N, sequence, &request );
185
        morse_zlap2tile( morse, &descBl, &descBt, MorseDescInout, MorseUpperLower,
186
                         B, NB, NB, LDB, NRHS, N, NRHS, sequence, &request );
187 188 189
    }

    /* Call the tile interface */
190
    MORSE_zgels_Tile_Async( MorseNoTrans, &descAt, descT, &descBt, sequence, &request );
191

Mathieu Faverge's avatar
Mathieu Faverge committed
192
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
193
    morse_ztile2lap( morse, &descAl, &descAt,
194
                     MorseDescInout, MorseUpperLower, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
195
    morse_ztile2lap( morse, &descBl, &descBt,
196
                     MorseDescInout, MorseUpperLower, sequence, &request );
197
    MORSE_Desc_Flush( descT, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
198

199
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
200

Mathieu Faverge's avatar
Mathieu Faverge committed
201 202 203
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
    morse_ztile2lap_cleanup( morse, &descBl, &descBt );
204

205
    status = sequence->status;
206
    morse_sequence_destroy( morse, sequence );
207 208 209
    return status;
}

210 211
/**
 ********************************************************************************
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 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
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zgels_Tile - Solves overdetermined or underdetermined linear system of equations
 *  using the tile QR or the tile LQ factorization.
 *  Tile equivalent of MORSE_zgels().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] trans
 *          Intended usage:
 *          = MorseNoTrans:   the linear system involves A;
 *          = MorseConjTrans: the linear system involves A**H.
 *          Currently only MorseNoTrans is supported.
 *
 * @param[in,out] A
 *          On entry, the M-by-N matrix A.
 *          On exit,
 *          if M >= N, A is overwritten by details of its QR factorization as returned by
 *                     MORSE_zgeqrf;
 *          if M < N, A is overwritten by details of its LQ factorization as returned by
 *                      MORSE_zgelqf.
 *
 * @param[out] T
 *          On exit, auxiliary factorization data.
 *
 * @param[in,out] B
 *          On entry, the M-by-NRHS matrix B of right hand side vectors, stored columnwise;
 *          On exit, if return value = 0, B is overwritten by the solution vectors, stored
 *          columnwise:
 *          if M >= N, rows 1 to N of B contain the least squares solution vectors; the residual
 *          sum of squares for the solution in each column is given by the sum of squares of the
 *          modulus of elements N+1 to M in that column;
 *          if M < N, rows 1 to N of B contain the minimum norm solution vectors;
 *
 *******************************************************************************
 *
 * @return
 *          \return MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zgels
 * @sa MORSE_zgels_Tile_Async
 * @sa MORSE_cgels_Tile
 * @sa MORSE_dgels_Tile
 * @sa MORSE_sgels_Tile
 *
 ******************************************************************************/
264 265
int MORSE_zgels_Tile( MORSE_enum trans, MORSE_desc_t *A,
                      MORSE_desc_t *T, MORSE_desc_t *B )
266 267 268 269 270 271 272 273 274 275 276
{
    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_zgels_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
277 278
    morse_sequence_create( morse, &sequence );

279
    MORSE_zgels_Tile_Async( trans, A, T, B, sequence, &request );
280

281
    MORSE_Desc_Flush( A, sequence );
282
    MORSE_Desc_Flush( T, sequence );
283
    MORSE_Desc_Flush( B, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
284

285
    morse_sequence_wait( morse, sequence );
286
    status = sequence->status;
287
    morse_sequence_destroy( morse, sequence );
288 289 290
    return status;
}

291 292
/**
 ********************************************************************************
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zgels_Tile_Async - Solves overdetermined or underdetermined linear
 *  system of equations using the tile QR or the tile LQ factorization.
 *  Non-blocking equivalent of MORSE_zgels_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_zgels
 * @sa MORSE_zgels_Tile
 * @sa MORSE_cgels_Tile_Async
 * @sa MORSE_dgels_Tile_Async
 * @sa MORSE_sgels_Tile_Async
 *
 ******************************************************************************/
320 321 322
int MORSE_zgels_Tile_Async( MORSE_enum trans, MORSE_desc_t *A,
                            MORSE_desc_t *T, MORSE_desc_t *B,
                            MORSE_sequence_t *sequence, MORSE_request_t *request )
323 324 325 326
{
    MORSE_desc_t *subA;
    MORSE_desc_t *subB;
    MORSE_context_t *morse;
327
    MORSE_desc_t D, *Dptr = NULL;
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zgels_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zgels_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zgels_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
Mathieu Faverge's avatar
Mathieu Faverge committed
343
    if (sequence->status == MORSE_SUCCESS) {
344
        request->status = MORSE_SUCCESS;
Mathieu Faverge's avatar
Mathieu Faverge committed
345 346
    }
    else {
347
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);
Mathieu Faverge's avatar
Mathieu Faverge committed
348
    }
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zgels_Tile", "invalid first descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(T) != MORSE_SUCCESS) {
        morse_error("MORSE_zgels_Tile", "invalid second descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(B) != MORSE_SUCCESS) {
        morse_error("MORSE_zgels_Tile", "invalid third 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_zgels_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (trans != MorseNoTrans) {
        morse_error("MORSE_zgels_Tile", "only MorseNoTrans supported");
        return morse_request_fail(sequence, request, MORSE_ERR_NOT_SUPPORTED);
    }
    /* Quick return  - currently NOT equivalent to LAPACK's:
373 374 375 376 377 378
     if (chameleon_min(M, chameleon_min(N, NRHS)) == 0) {
     for (i = 0; i < chameleon_max(M, N); i++)
     for (j = 0; j < NRHS; j++)
     B[j*LDB+i] = 0.0;
     return MORSE_SUCCESS;
     }
379 380
     */
    if (A->m >= A->n) {
381 382 383 384 385 386 387 388

#if defined(CHAMELEON_COPY_DIAG)
        {
            int n = chameleon_min(A->mt, A->nt) * A->nb;
            morse_zdesc_alloc(D, A->mb, A->nb, A->m, n, 0, 0, A->m, n, );
            Dptr = &D;
        }
#endif
389 390
        if (morse->householder == MORSE_FLAT_HOUSEHOLDER) {

Mathieu Faverge's avatar
Mathieu Faverge committed
391
            morse_pzgeqrf( A, T, Dptr, sequence, request );
392

Mathieu Faverge's avatar
Mathieu Faverge committed
393
            morse_pzunmqr( MorseLeft, MorseConjTrans, A, B, T, Dptr, sequence, request );
394 395
        }
        else {
Mathieu Faverge's avatar
Mathieu Faverge committed
396
            morse_pzgeqrfrh( A, T, Dptr, MORSE_RHBLK, sequence, request );
397

Mathieu Faverge's avatar
Mathieu Faverge committed
398
            morse_pzunmqrrh( MorseLeft, MorseConjTrans, A, B, T, Dptr, MORSE_RHBLK, sequence, request );
399 400 401
        }
        subB = morse_desc_submatrix(B, 0, 0, A->n, B->n);
        subA = morse_desc_submatrix(A, 0, 0, A->n, A->n);
Mathieu Faverge's avatar
Mathieu Faverge committed
402
        morse_pztrsm( MorseLeft, MorseUpper, MorseNoTrans, MorseNonUnit, 1.0, subA, subB, sequence, request );
403

404 405 406
    }
    else {
        /* subB = morse_desc_submatrix(B, A->m, 0, A->n-A->m, B->n);
Mathieu Faverge's avatar
Mathieu Faverge committed
407
         morse_pzlaset( MorseUpperLower, 0., 0., subB, sequence, request );
408
         free(subB); */
409 410 411 412 413 414 415
#if defined(CHAMELEON_COPY_DIAG)
        {
            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;
        }
#endif
416
        if (morse->householder == MORSE_FLAT_HOUSEHOLDER) {
Mathieu Faverge's avatar
Mathieu Faverge committed
417
            morse_pzgelqf( A, T, Dptr, sequence, request );
418 419
        }
        else {
Mathieu Faverge's avatar
Mathieu Faverge committed
420
            morse_pzgelqfrh( A, T, Dptr, MORSE_RHBLK, sequence, request );
421 422 423
        }
        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
424
        morse_pztrsm( MorseLeft, MorseLower, MorseNoTrans, MorseNonUnit, 1.0, subA, subB, sequence, request );
425 426

        if (morse->householder == MORSE_FLAT_HOUSEHOLDER) {
Mathieu Faverge's avatar
Mathieu Faverge committed
427
            morse_pzunmlq( MorseLeft, MorseConjTrans, A, B, T, Dptr, sequence, request );
428 429
        }
        else {
Mathieu Faverge's avatar
Mathieu Faverge committed
430
            morse_pzunmlqrh( MorseLeft, MorseConjTrans, A, B, T, Dptr, MORSE_RHBLK, sequence, request );
431 432
        }
    }
433 434 435 436 437

    free(subA);
    free(subB);

    if (Dptr != NULL) {
438 439 440 441 442
        MORSE_Desc_Flush( A, sequence );
        MORSE_Desc_Flush( T, sequence );
        MORSE_Desc_Flush( B, sequence );
        MORSE_Desc_Flush( Dptr, sequence );
        morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
443
        morse_desc_mat_free( Dptr );
444 445
    }
    (void)D;
446 447
    return MORSE_SUCCESS;
}