zgesv_incpiv.c 12 KB
Newer Older
1 2
/**
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
3 4
 * @copyright 2009-2014 The University of Tennessee and The University of
 *                      Tennessee Research Foundation. All rights reserved.
5 6
 * @copyright 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
7
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
8
 ***
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 * @file zgesv_incpiv.c
 *
 *  MORSE computational routines
 *  Release Date: November, 15th 2009
 *  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
 *
 **/
27
#include "control/common.h"
28

29 30
/**
 ********************************************************************************
31 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
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zgesv_incpiv - Computes the solution to a system of linear equations A * X = B,
 *  where A is an N-by-N matrix and X and B are N-by-NRHS matrices.
 *  The tile LU decomposition with partial tile pivoting and row interchanges is used to factor A.
 *  The factored form of A is then used to solve the system of equations A * X = B.
 *
 *******************************************************************************
 *
 * @param[in] N
 *          The number of linear equations, i.e., the order of the matrix A. N >= 0.
 *
 * @param[in] NRHS
 *          The number of right hand sides, i.e., the number of columns of the matrix B.
 *          NRHS >= 0.
 *
 * @param[in,out] A
 *          On entry, the N-by-N coefficient matrix A.
 *          On exit, the tile L and U factors from the factorization (not equivalent to LAPACK).
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,N).
 *
 * @param[out] descL
 *          On exit, auxiliary factorization data, related to the tile L factor,
 *          necessary to solve the system of equations.
 *
 * @param[out] IPIV
 *          On exit, the pivot indices that define the permutations (not equivalent to LAPACK).
 *
 * @param[in,out] B
 *          On entry, the N-by-NRHS matrix of right hand side matrix B.
 *          On exit, if return value = 0, the N-by-NRHS solution matrix X.
 *
 * @param[in] LDB
 *          The leading dimension of the array B. LDB >= max(1,N).
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *          \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
 *               but the factor U is exactly singular, so the solution could not be computed.
 *
 *******************************************************************************
 *
 * @sa MORSE_zgesv_incpiv_Tile
 * @sa MORSE_zgesv_incpiv_Tile_Async
 * @sa MORSE_cgesv_incpiv
 * @sa MORSE_dgesv_incpiv
 * @sa MORSE_sgesv_incpiv
 *
 ******************************************************************************/
86 87 88 89
int MORSE_zgesv_incpiv( int N, int NRHS,
                        MORSE_Complex64_t *A, int LDA,
                        MORSE_desc_t *descL, int *IPIV,
                        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;
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

    morse = morse_context_self();
    if (morse == NULL) {
        morse_error("MORSE_zgesv_incpiv", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    /* Check input arguments */
    if (N < 0) {
        morse_error("MORSE_zgesv_incpiv", "illegal value of N");
        return -1;
    }
    if (NRHS < 0) {
        morse_error("MORSE_zgesv_incpiv", "illegal value of NRHS");
        return -2;
    }
113
    if (LDA < chameleon_max(1, N)) {
114 115 116
        morse_error("MORSE_zgesv_incpiv", "illegal value of LDA");
        return -4;
    }
117
    if (LDB < chameleon_max(1, N)) {
118 119 120 121
        morse_error("MORSE_zgesv_incpiv", "illegal value of LDB");
        return -8;
    }
    /* Quick return */
Mathieu Faverge's avatar
Mathieu Faverge committed
122
    if (chameleon_min(N, NRHS) == 0)
123 124 125 126 127 128 129 130 131 132 133 134
        return MORSE_SUCCESS;

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

    /* Set NT & NTRHS */
    NB    = MORSE_NB;

135
    morse_sequence_create( morse, &sequence );
136

137
    /* Submit the matrix conversion */
138
    morse_zlap2tile( morse, &descAl, &descAt, MorseDescInout, MorseUpperLower,
139
                     A, NB, NB, LDA, N, N, N, sequence, &request );
140
    morse_zlap2tile( morse, &descBl, &descBt, MorseDescInout, MorseUpperLower,
141
                     B, NB, NB, LDB, NRHS, N, NRHS, sequence, &request );
142 143

    /* Call the tile interface */
144
    MORSE_zgesv_incpiv_Tile_Async( &descAt, descL, IPIV, &descBt, sequence, &request );
145

Mathieu Faverge's avatar
Mathieu Faverge committed
146
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
147
    morse_ztile2lap( morse, &descAl, &descAt,
148
                     MorseDescInout, MorseUpperLower, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
149
    morse_ztile2lap( morse, &descBl, &descBt,
150
                     MorseDescInout, MorseUpperLower, sequence, &request );
151
    MORSE_Desc_Flush( descL, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
152

153
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
154

Mathieu Faverge's avatar
Mathieu Faverge committed
155 156 157
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
    morse_ztile2lap_cleanup( morse, &descBl, &descBt );
158

159
    status = sequence->status;
160
    morse_sequence_destroy( morse, sequence );
161 162
    return status;
}
163 164
/**
 ********************************************************************************
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zgesv_incpiv_Tile - Solves a system of linear equations using the tile LU factorization.
 *  Tile equivalent of MORSE_zgetrf_incpiv().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in,out] A
 *          On entry, the N-by-N coefficient matrix A.
 *          On exit, the tile L and U factors from the factorization (not equivalent to LAPACK).
 *
 * @param[in,out] L
 *          On exit, auxiliary factorization data, related to the tile L factor,
 *          necessary to solve the system of equations.
 *
 * @param[out] IPIV
 *          On exit, the pivot indices that define the permutations (not equivalent to LAPACK).
 *
 * @param[in,out] B
 *          On entry, the N-by-NRHS matrix of right hand side matrix B.
 *          On exit, if return value = 0, the N-by-NRHS solution matrix X.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
 *               but the factor U is exactly singular, so the solution could not be computed.
 *
 *******************************************************************************
 *
 * @sa MORSE_zgesv_incpiv
 * @sa MORSE_zgesv_incpiv_Tile_Async
 * @sa MORSE_cgesv_incpiv_Tile
 * @sa MORSE_dgesv_incpiv_Tile
 * @sa MORSE_sgesv_incpiv_Tile
 * @sa MORSE_zcgesv_Tile
 *
 ******************************************************************************/
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
208
int MORSE_zgesv_incpiv_Tile( MORSE_desc_t *A, MORSE_desc_t *L, int *IPIV, MORSE_desc_t *B )
209 210 211 212 213 214 215 216 217 218 219
{
    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_zgesv_incpiv_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
220 221
    morse_sequence_create( morse, &sequence );

222
    MORSE_zgesv_incpiv_Tile_Async( A, L, IPIV, B, sequence, &request );
223

224
    MORSE_Desc_Flush( A, sequence );
225
    MORSE_Desc_Flush( L, sequence );
226
    MORSE_Desc_Flush( B, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
227

228
    morse_sequence_wait( morse, sequence );
229
    status = sequence->status;
230
    morse_sequence_destroy( morse, sequence );
231 232 233
    return status;
}

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_Async
 *
 *  MORSE_zgesv_incpiv_Tile_Async - Solves a system of linear equations using the tile
 *  LU factorization.
 *  Non-blocking equivalent of MORSE_zgesv_incpiv_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_zgesv_incpiv
 * @sa MORSE_zgesv_incpiv_Tile
 * @sa MORSE_cgesv_incpiv_Tile_Async
 * @sa MORSE_dgesv_incpiv_Tile_Async
 * @sa MORSE_sgesv_incpiv_Tile_Async
 * @sa MORSE_zcgesv_Tile_Async
 *
 ******************************************************************************/
264 265
int MORSE_zgesv_incpiv_Tile_Async( MORSE_desc_t *A, MORSE_desc_t *L, int *IPIV, MORSE_desc_t *B,
                                   MORSE_sequence_t *sequence, MORSE_request_t *request )
266 267
{
    MORSE_context_t *morse;
268
    MORSE_desc_t D, *Dptr = NULL;
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zgesv_incpiv_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zgesv_incpiv_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zgesv_incpiv_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
Mathieu Faverge's avatar
Mathieu Faverge committed
284
    if (sequence->status == MORSE_SUCCESS) {
285
        request->status = MORSE_SUCCESS;
Mathieu Faverge's avatar
Mathieu Faverge committed
286 287
    }
    else {
288
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);
Mathieu Faverge's avatar
Mathieu Faverge committed
289
    }
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zgesv_incpiv_Tile", "invalid first descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(L) != MORSE_SUCCESS) {
        morse_error("MORSE_zgesv_incpiv_Tile", "invalid second descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(B) != MORSE_SUCCESS) {
        morse_error("MORSE_zgesv_incpiv_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_zgesv_incpiv_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Quick return */
310 311 312 313
    /*
     if (chameleon_min(N, NRHS) == 0)
     return MORSE_SUCCESS;
     */
314

315 316 317 318 319 320 321 322 323
#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

    morse_pzgetrf_incpiv( A, L, Dptr, IPIV, sequence, request );
324

Mathieu Faverge's avatar
Mathieu Faverge committed
325
    morse_pztrsmpl( A, B, L, IPIV, sequence, request );
326

Mathieu Faverge's avatar
Mathieu Faverge committed
327
    morse_pztrsm( MorseLeft, MorseUpper, MorseNoTrans, MorseNonUnit, (MORSE_Complex64_t)1.0, A, B, sequence, request );
328

329 330 331 332 333 334 335 336 337
    if (Dptr != NULL) {
        MORSE_Desc_Flush( A, sequence );
        MORSE_Desc_Flush( L, sequence );
        MORSE_Desc_Flush( Dptr, sequence );
        MORSE_Desc_Flush( B, sequence );
        morse_sequence_wait( morse, sequence );
        morse_desc_mat_free( Dptr );
    }
    (void)D;
338 339
    return MORSE_SUCCESS;
}