ztrmm.c 13.2 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
 *
 **/

/**
 *
 * @file ztrmm.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 Mathieu Faverge
 * @author Emmanuel Agullo
 * @author Cedric Castagnede
 * @date 2010-11-15
 * @precisions normal z -> s d c
 *
 **/
29
#include "control/common.h"
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 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_ztrmm - Computes B = alpha*op( A )*B or B = alpha*B*op( A ).
 *
 *******************************************************************************
 *
 * @param[in] side
 *          Specifies whether A appears on the left or on the right of X:
 *          = MorseLeft:  A*X = B
 *          = MorseRight: X*A = B
 *
 * @param[in] uplo
 *          Specifies whether the matrix A is upper triangular or lower triangular:
 *          = MorseUpper: Upper triangle of A is stored;
 *          = MorseLower: Lower triangle of A is stored.
 *
 * @param[in] transA
 *          Specifies whether the matrix A is transposed, not transposed or conjugate transposed:
 *          = MorseNoTrans:   A is transposed;
 *          = MorseTrans:     A is not transposed;
 *          = MorseConjTrans: A is conjugate transposed.
 *
 * @param[in] diag
 *          Specifies whether or not A is unit triangular:
 *          = MorseNonUnit: A is non unit;
 *          = MorseUnit:    A us unit.
 *
 * @param[in] N
 *          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] alpha
 *          alpha specifies the scalar alpha.
 *
 * @param[in] A
 *          The triangular matrix A. If uplo = MorseUpper, the leading N-by-N upper triangular
 *          part of the array A contains the upper triangular matrix, and the strictly lower
 *          triangular part of A is not referenced. If uplo = MorseLower, the leading N-by-N
 *          lower triangular part of the array A contains the lower triangular matrix, and the
 *          strictly upper triangular part of A is not referenced. If diag = MorseUnit, the
 *          diagonal elements of A are also not referenced and are assumed to be 1.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,N).
 *
 * @param[in,out] B
 *          On entry, the N-by-NRHS 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
 *
 *******************************************************************************
 *
 * @sa MORSE_ztrmm_Tile
 * @sa MORSE_ztrmm_Tile_Async
 * @sa MORSE_ctrmm
 * @sa MORSE_dtrmm
 * @sa MORSE_strmm
 *
 ******************************************************************************/
int MORSE_ztrmm(MORSE_enum side, MORSE_enum uplo,
104 105 106 107
                MORSE_enum transA, MORSE_enum diag,
                int N, int NRHS, MORSE_Complex64_t alpha,
                MORSE_Complex64_t *A, int LDA,
                MORSE_Complex64_t *B, int LDB)
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
{
    int NB, NA;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
    MORSE_desc_t descA, descB;

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

    if (side == MorseLeft) {
123
        NA = N;
124
    } else {
125
        NA = NRHS;
126 127 128 129 130 131 132 133 134 135 136
    }

    /* Check input arguments */
    if (side != MorseLeft && side != MorseRight) {
        morse_error("MORSE_ztrmm", "illegal value of side");
        return -1;
    }
    if (uplo != MorseUpper && uplo != MorseLower) {
        morse_error("MORSE_ztrmm", "illegal value of uplo");
        return -2;
    }
Mathieu Faverge's avatar
Mathieu Faverge committed
137 138 139
    if (transA != MorseConjTrans &&
        transA != MorseNoTrans   &&
        transA != MorseTrans )
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    {
        morse_error("MORSE_ztrmm", "illegal value of transA");
        return -3;
    }
    if (diag != MorseUnit && diag != MorseNonUnit) {
        morse_error("MORSE_ztrmm", "illegal value of diag");
        return -4;
    }
    if (N < 0) {
        morse_error("MORSE_ztrmm", "illegal value of N");
        return -5;
    }
    if (NRHS < 0) {
        morse_error("MORSE_ztrmm", "illegal value of NRHS");
        return -6;
    }
156
    if (LDA < chameleon_max(1, NA)) {
157 158 159
        morse_error("MORSE_ztrmm", "illegal value of LDA");
        return -8;
    }
160
    if (LDB < chameleon_max(1, N)) {
161 162 163 164
        morse_error("MORSE_ztrmm", "illegal value of LDB");
        return -10;
    }
    /* Quick return */
Mathieu Faverge's avatar
Mathieu Faverge committed
165
    if (chameleon_min(N, NRHS) == 0)
166 167 168 169 170 171 172 173 174 175 176 177 178 179
        return MORSE_SUCCESS;

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

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

    morse_sequence_create(morse, &sequence);

180
    /* Submit the matrix conversion */
181 182 183 184
    morse_zlap2tile( morse, &descAl, &descAt, MorseUpperLower,
                     A, NB, NB, LDA, NA, NA, NA, sequence, &request );
    morse_zlap2tile( morse, &descBl, &descBt, MorseUpperLower,
                     B, NB, NB, LDB, NRHS, N,  NRHS, sequence, &request );
185 186 187 188 189

    /* Call the tile interface */
    MORSE_ztrmm_Tile_Async(
        side, uplo, transA, diag, alpha, &descA, &descB, sequence, &request);

190
    /* Submit the matrix conversion */
191 192 193 194
    morse_zooptile2lap(descB, B, NB, NB, LDB, NRHS,  sequence, &request);
    morse_sequence_wait(morse, sequence);
    morse_desc_mat_free(&descA);
    morse_desc_mat_free(&descB);
195 196 197 198 199

    status = sequence->status;
    morse_sequence_destroy(morse, sequence);
    return status;
}
200 201
/**
 ********************************************************************************
202 203 204 205 206 207 208 209 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_ztrmm_Tile - Computes triangular solve.
 *  Tile equivalent of MORSE_ztrmm().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] side
 *          Specifies whether A appears on the left or on the right of X:
 *          = MorseLeft:  A*X = B
 *          = MorseRight: X*A = B
 *
 * @param[in] uplo
 *          Specifies whether the matrix A is upper triangular or lower triangular:
 *          = MorseUpper: Upper triangle of A is stored;
 *          = MorseLower: Lower triangle of A is stored.
 *
 * @param[in] transA
 *          Specifies whether the matrix A is transposed, not transposed or conjugate transposed:
 *          = MorseNoTrans:   A is transposed;
 *          = MorseTrans:     A is not transposed;
 *          = MorseConjTrans: A is conjugate transposed.
 *
 * @param[in] diag
 *          Specifies whether or not A is unit triangular:
 *          = MorseNonUnit: A is non unit;
 *          = MorseUnit:    A us unit.
 *
 * @param[in] alpha
 *          alpha specifies the scalar alpha.
 *
 * @param[in] A
 *          The triangular matrix A. If uplo = MorseUpper, the leading N-by-N upper triangular
 *          part of the array A contains the upper triangular matrix, and the strictly lower
 *          triangular part of A is not referenced. If uplo = MorseLower, the leading N-by-N
 *          lower triangular part of the array A contains the lower triangular matrix, and the
 *          strictly upper triangular part of A is not referenced. If diag = MorseUnit, the
 *          diagonal elements of A are also not referenced and are assumed to be 1.
 *
 * @param[in,out] B
 *          On entry, the N-by-NRHS right hand side matrix B.
 *          On exit, if return value = 0, the N-by-NRHS solution matrix X.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_ztrmm
 * @sa MORSE_ztrmm_Tile_Async
 * @sa MORSE_ctrmm_Tile
 * @sa MORSE_dtrmm_Tile
 * @sa MORSE_strmm_Tile
 *
 ******************************************************************************/
int MORSE_ztrmm_Tile(MORSE_enum side, MORSE_enum uplo,
264 265
                     MORSE_enum transA, MORSE_enum diag,
                     MORSE_Complex64_t alpha, MORSE_desc_t *A, MORSE_desc_t *B)
266 267 268 269 270 271 272 273 274 275 276 277 278
{
    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_ztrmm_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    morse_sequence_create(morse, &sequence);
    MORSE_ztrmm_Tile_Async(side, uplo, transA, diag, alpha, A, B, sequence, &request);
279 280
    RUNTIME_desc_flush( A, sequence );
    RUNTIME_desc_flush( B, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
281
    morse_sequence_wait(morse, sequence);
Mathieu Faverge's avatar
Mathieu Faverge committed
282

283 284 285 286 287
    status = sequence->status;
    morse_sequence_destroy(morse, sequence);
    return status;
}

288 289
/**
 ********************************************************************************
290 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
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_ztrmm_Tile_Async - Performs triangular matrix multiplication.
 *  Non-blocking equivalent of MORSE_ztrmm_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_ztrmm
 * @sa MORSE_ztrmm_Tile
 * @sa MORSE_ctrmm_Tile_Async
 * @sa MORSE_dtrmm_Tile_Async
 * @sa MORSE_strmm_Tile_Async
 *
 ******************************************************************************/
int MORSE_ztrmm_Tile_Async(MORSE_enum side, MORSE_enum uplo,
317 318 319
                           MORSE_enum transA, MORSE_enum diag,
                           MORSE_Complex64_t alpha, MORSE_desc_t *A, MORSE_desc_t *B,
                           MORSE_sequence_t *sequence, MORSE_request_t *request)
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 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 373 374 375 376 377
{
    MORSE_context_t *morse;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_ztrmm_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_ztrmm_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_ztrmm_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
    if (sequence->status == MORSE_SUCCESS)
        request->status = MORSE_SUCCESS;
    else
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_ztrmm_Tile", "invalid first descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(B) != MORSE_SUCCESS) {
        morse_error("MORSE_ztrmm_Tile", "invalid second 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_ztrmm_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (side != MorseLeft && side != MorseRight) {
        morse_error("MORSE_ztrmm_Tile", "illegal value of side");
        return morse_request_fail(sequence, request, -1);
    }
    if (uplo != MorseUpper && uplo != MorseLower) {
        morse_error("MORSE_ztrmm_Tile", "illegal value of uplo");
        return morse_request_fail(sequence, request, -2);
    }
    if (transA != MorseConjTrans && transA != MorseNoTrans && transA != MorseTrans) {
        morse_error("MORSE_ztrmm_Tile", "illegal value of transA");
        return morse_request_fail(sequence, request, -3);
    }
    if (diag != MorseUnit && diag != MorseNonUnit) {
        morse_error("MORSE_ztrmm_Tile", "illegal value of diag");
        return morse_request_fail(sequence, request, -4);
    }

    /* Quick return */
    morse_pztrmm(side, uplo, transA, diag, alpha, A, B, sequence, request);

    return MORSE_SUCCESS;
}