zsyrk.c 12.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 zsyrk.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
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zsyrk - Performs one of the hermitian rank k operations
 *
 *    \f[ C = \alpha [ op( A ) \times conjg( op( A )' )] + \beta C \f],
 *
 *  where op( X ) is one of
 *
 *    op( X ) = X  or op( X ) = conjg( X' )
 *
 *  where alpha and beta are real scalars, C is an n-by-n hermitian
 *  matrix and A is an n-by-k matrix in the first case and a k-by-n
 *  matrix in the second case.
 *
 *******************************************************************************
 *
 * @param[in] uplo
 *          = MorseUpper: Upper triangle of C is stored;
 *          = MorseLower: Lower triangle of C is stored.
 *
 * @param[in] trans
 *          Specifies whether the matrix A is transposed or conjugate transposed:
 *          = MorseNoTrans:   A is not transposed;
 *          = MorseTrans  :   A is transposed.
 *
 * @param[in] N
 *          N specifies the order of the matrix C. N must be at least zero.
 *
 * @param[in] K
 *          K specifies the number of columns of the matrix op( A ).
 *
 * @param[in] alpha
 *          alpha specifies the scalar alpha.
 *
 * @param[in] A
 *          A is a LDA-by-ka matrix, where ka is K when trans = MorseNoTrans,
 *          and is N otherwise.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA must be at least
 *          max( 1, N ) if trans == MorseNoTrans, otherwise LDA must
 *          be at least max( 1, K ).
 *
 * @param[in] beta
 *          beta specifies the scalar beta
 *
 * @param[in,out] C
 *          C is a LDC-by-N matrix.
 *          On exit, the array uplo part of the matrix is overwritten
 *          by the uplo part of the updated matrix.
 *
 * @param[in] LDC
 *          The leading dimension of the array C. LDC >= max( 1, N ).
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zsyrk_Tile
 * @sa MORSE_csyrk
 * @sa MORSE_dsyrk
 * @sa MORSE_ssyrk
 *
 ******************************************************************************/
int MORSE_zsyrk(MORSE_enum uplo, MORSE_enum trans, int N, int K,
102 103
                MORSE_Complex64_t alpha, MORSE_Complex64_t *A, int LDA,
                MORSE_Complex64_t beta,  MORSE_Complex64_t *C, int LDC)
104 105 106 107
{
    int NB;
    int Am, An;
    int status;
Mathieu Faverge's avatar
Mathieu Faverge committed
108 109
    MORSE_desc_t descAl, descAt;
    MORSE_desc_t descCl, descCt;
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;

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

    /* Check input arguments */
    if ((uplo != MorseUpper) && (uplo != MorseLower)) {
        morse_error("MORSE_zsyrk", "illegal value of uplo");
        return -1;
    }
    if ((trans != MorseNoTrans) && (trans != MorseTrans)) {
        morse_error("MORSE_zsyrk", "illegal value of trans");
        return -2;
    }
129
    if ( trans == MorseNoTrans ) {
130 131 132 133 134 135 136 137 138 139 140 141
        Am = N; An = K;
    } else {
        Am = K; An = N;
    }
    if (N < 0) {
        morse_error("MORSE_zsyrk", "illegal value of N");
        return -3;
    }
    if (K < 0) {
        morse_error("MORSE_zsyrk", "illegal value of K");
        return -4;
    }
142
    if (LDA < chameleon_max(1, Am)) {
143 144 145
        morse_error("MORSE_zsyrk", "illegal value of LDA");
        return -7;
    }
146
    if (LDC < chameleon_max(1, N)) {
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
        morse_error("MORSE_zsyrk", "illegal value of LDC");
        return -10;
    }

    /* Quick return */
    if (N == 0 ||
        ((alpha == (MORSE_Complex64_t)0.0 || K == 0.0) && beta == (MORSE_Complex64_t)1.0))
        return MORSE_SUCCESS;

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

    /* Set MT & NT & KT */
    NB = MORSE_NB;

    morse_sequence_create(morse, &sequence);

168
    /* Submit the matrix conversion */
169 170 171 172
    morse_zlap2tile( morse, &descAl, &descAt, MorseUpperLower,
                     A, NB, NB, LDA, An, Am, An, sequence, &request );
    morse_zlap2tile( morse, &descCl, &descCt, MorseUpperLower,
                     C, NB, NB, LDC, N, N,  N, sequence, &request );
173 174 175 176

    /* Call the tile interface */
    MORSE_zsyrk_Tile_Async(uplo, trans, alpha, &descA, beta, &descC, sequence, &request);

Mathieu Faverge's avatar
Cleanup  
Mathieu Faverge committed
177
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
178 179 180
    morse_ztile2lap( morse, &descCl, &descCt,
                     MorseUpperLower, sequence, &request );

181
    morse_sequence_wait(morse, sequence);
Mathieu Faverge's avatar
Mathieu Faverge committed
182

Mathieu Faverge's avatar
Mathieu Faverge committed
183 184 185
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
    morse_ztile2lap_cleanup( morse, &descCl, &descCt );
186 187 188 189 190 191

    status = sequence->status;
    morse_sequence_destroy(morse, sequence);
    return status;
}

192 193
/**
 ********************************************************************************
194 195 196 197 198 199 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
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zsyrk_Tile - Performs rank k update.
 *  Tile equivalent of MORSE_zsyrk().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] uplo
 *          = MorseUpper: Upper triangle of C is stored;
 *          = MorseLower: Lower triangle of C is stored.
 *
 * @param[in] trans
 *          Specifies whether the matrix A is transposed or conjugate transposed:
 *          = MorseNoTrans:   A is not transposed;
 *          = MorseTrans:     A is transposed.
 *
 * @param[in] alpha
 *          alpha specifies the scalar alpha.
 *
 * @param[in] A
 *          A is a LDA-by-ka matrix, where ka is K when trans = MorseNoTrans,
 *          and is N otherwise.
 *
 * @param[in] beta
 *          beta specifies the scalar beta
 *
 * @param[in,out] C
 *          C is a LDC-by-N matrix.
 *          On exit, the array uplo part of the matrix is overwritten
 *          by the uplo part of the updated matrix.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zsyrk_Tile
 * @sa MORSE_csyrk
 * @sa MORSE_dsyrk
 * @sa MORSE_ssyrk
 *
 ******************************************************************************/
int MORSE_zsyrk_Tile(MORSE_enum uplo, MORSE_enum trans,
243 244
                     MORSE_Complex64_t alpha, MORSE_desc_t *A,
                     MORSE_Complex64_t beta,  MORSE_desc_t *C)
245 246 247 248 249 250 251 252 253 254 255 256 257
{
    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_zsyrk_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    morse_sequence_create(morse, &sequence);
    MORSE_zsyrk_Tile_Async(uplo, trans, alpha, A, beta, C, sequence, &request);
258 259
    RUNTIME_desc_flush( A, sequence );
    RUNTIME_desc_flush( C, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
260

Mathieu Faverge's avatar
Mathieu Faverge committed
261
    morse_sequence_wait(morse, sequence);
262

263 264 265 266 267
    status = sequence->status;
    morse_sequence_destroy(morse, sequence);
    return status;
}

268 269
/**
 ********************************************************************************
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zsyrk_Tile_Async - Performs rank-k update.
 *  Non-blocking equivalent of MORSE_zsyrk_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_zsyrk
 * @sa MORSE_zsyrk_Tile
 * @sa MORSE_csyrk_Tile_Async
 * @sa MORSE_dsyrk_Tile_Async
 * @sa MORSE_ssyrk_Tile_Async
 *
 ******************************************************************************/
int MORSE_zsyrk_Tile_Async(MORSE_enum uplo, MORSE_enum trans,
297 298 299
                           MORSE_Complex64_t alpha, MORSE_desc_t *A,
                           MORSE_Complex64_t beta,  MORSE_desc_t *C,
                           MORSE_sequence_t *sequence, MORSE_request_t *request)
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 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
{
    MORSE_context_t *morse;
    int N, K;
    int Am, An, Amb;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zsyrk_Tile_Async", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zsyrk_Tile_Async", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zsyrk_Tile_Async", "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_zsyrk_Tile_Async", "invalid first descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(C) != MORSE_SUCCESS) {
        morse_error("MORSE_zsyrk_Tile_Async", "invalid third descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if ((uplo != MorseUpper) && (uplo != MorseLower)) {
        morse_error("MORSE_zsyrk", "illegal value of uplo");
        return morse_request_fail(sequence, request, -1);
    }
    if ((trans != MorseNoTrans) && (trans != MorseTrans)) {
        morse_error("MORSE_zsyrk", "illegal value of transA");
        return morse_request_fail(sequence, request, -2);
    }

    if ( trans == MorseNoTrans ) {
        Am  = A->m;
        An  = A->n;
        Amb = A->mb;
    } else {
        Am  = A->n;
        An  = A->m;
        Amb = A->nb;
    }

    if (C->mb != C->nb) {
        morse_error("MORSE_zsyrk_Tile_Async", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (Amb != C->mb) {
        morse_error("MORSE_zsyrk_Tile_Async", "tile sizes have to match");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (C->m != C->n) {
        morse_error("MORSE_zsyrk_Tile_Async", "only square matrix C is supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (Am != C->m) {
        morse_error("MORSE_zsyrk_Tile_Async", "sizes of matrices have to match");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }

    N = C->m;
    K = An;

    /* Quick return */
    if ( N == 0 ||
375
         ((alpha == (MORSE_Complex64_t)0.0 || K == 0) && beta == (MORSE_Complex64_t)1.0))
376 377 378 379 380 381
        return MORSE_SUCCESS;

    morse_pzsyrk(uplo, trans, alpha, A, beta, C, sequence, request);

    return MORSE_SUCCESS;
}