zlange.c 9.26 KB
Newer Older
1 2 3 4 5 6
/**
 *
 * @copyright (c) 2009-2014 The University of Tennessee and The University
 *                          of Tennessee Research Foundation.
 *                          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
 *
 **/

/**
 *
 * @file zlange.c
 *
 *  MORSE computational routines
 *  MORSE is a software package provided by Inria Bordeaux - Sud-Ouest, LaBRI,
 *  University of Bordeaux, Bordeaux INP
 *
 * @version 2.6.0
 * @comment This file has been automatically generated
 *          from Plasma 2.6.0 for MORSE 1.0.0
 * @author Mathieu Faverge
 * @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 86 87 88 89 90 91 92 93 94
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zlange returns the value
 *
 *     zlange = ( max(abs(A(i,j))), NORM = MorseMaxNorm
 *              (
 *              ( norm1(A),         NORM = MorseOneNorm
 *              (
 *              ( normI(A),         NORM = MorseInfNorm
 *              (
 *              ( normF(A),         NORM = MorseFrobeniusNorm
 *
 *  where norm1 denotes the one norm of a matrix (maximum column sum),
 *  normI denotes the infinity norm of a matrix (maximum row sum) and
 *  normF denotes the Frobenius norm of a matrix (square root of sum
 *  of squares). Note that max(abs(A(i,j))) is not a consistent matrix
 *  norm.
 *
 *******************************************************************************
 *
 * @param[in] norm
 *          = MorseMaxNorm: Max norm
 *          = MorseOneNorm: One norm
 *          = MorseInfNorm: Infinity norm
 *          = MorseFrobeniusNorm: Frobenius norm
 *
 * @param[in] M
 *          The number of rows of the matrix A. M >= 0. When M = 0,
 *          the returned value is set to zero.
 *
 * @param[in] N
 *          The number of columns of the matrix A. N >= 0. When N = 0,
 *          the returned value is set to zero.
 *
 * @param[in] A
 *          The M-by-N matrix A.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,M).
 *
 *******************************************************************************
 *
 * @return
 *          \retval the norm described above.
 *
 *******************************************************************************
 *
 * @sa MORSE_zlange_Tile
 * @sa MORSE_zlange_Tile_Async
 * @sa MORSE_clange
 * @sa MORSE_dlange
 * @sa MORSE_slange
 *
 ******************************************************************************/
double MORSE_zlange(MORSE_enum norm, int M, int N,
                    MORSE_Complex64_t *A, int LDA)
{
    int NB;
    int status;
    double value;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
95
    MORSE_desc_t descAl, descAt;
96 97 98 99 100 101 102 103

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zlange", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    /* Check input arguments */
    if ( (norm != MorseMaxNorm) && (norm != MorseOneNorm)
104
         && (norm != MorseInfNorm) && (norm != MorseFrobeniusNorm) ) {
105 106 107 108 109 110 111 112 113 114 115
        morse_error("MORSE_zlange", "illegal value of norm");
        return -1;
    }
    if (M < 0) {
        morse_error("MORSE_zlange", "illegal value of M");
        return -2;
    }
    if (N < 0) {
        morse_error("MORSE_zlange", "illegal value of N");
        return -3;
    }
116
    if (LDA < chameleon_max(1, M)) {
117 118 119 120 121
        morse_error("MORSE_zlange", "illegal value of LDA");
        return -5;
    }

    /* Quick return */
Mathieu Faverge's avatar
Mathieu Faverge committed
122
    if (chameleon_min(N, M) == 0)
123
        return (double)0.0;
124 125 126 127 128 129 130 131 132 133 134 135 136

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

    /* Set NT */
    NB   = MORSE_NB;

    morse_sequence_create(morse, &sequence);

137
    /* Submit the matrix conversion */
138 139
    morse_zlap2tile( morse, &descAl, &descAt, MorseUpperLower,
                     A, NB, NB, LDA, N, M, N, sequence, &request );
140 141

    /* Call the tile interface */
142
    MORSE_zlange_Tile_Async( norm, &descAt, &value, sequence, &request );
143

Mathieu Faverge's avatar
Mathieu Faverge committed
144
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
145 146 147
    morse_ztile2lap( morse, &descAl, &descAt,
                     MorseUpperLower, sequence, &request );

148
    morse_sequence_wait(morse, sequence);
Mathieu Faverge's avatar
Mathieu Faverge committed
149

Mathieu Faverge's avatar
Mathieu Faverge committed
150 151
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
152 153 154 155 156

    morse_sequence_destroy(morse, sequence);
    return value;
}

157 158
/**
 ********************************************************************************
159 160 161 162 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 208
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zlange_Tile - Tile equivalent of MORSE_zlange().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] norm
 *          = MorseMaxNorm: Max norm
 *          = MorseOneNorm: One norm
 *          = MorseInfNorm: Infinity norm
 *          = MorseFrobeniusNorm: Frobenius norm
 *
 * @param[in] A
 *          On entry, the triangular factor U or L.
 *          On exit, if UPLO = 'U', the upper triangle of A is
 *          overwritten with the upper triangle of the product U * U';
 *          if UPLO = 'L', the lower triangle of A is overwritten with
 *          the lower triangle of the product L' * L.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zlange
 * @sa MORSE_zlange_Tile_Async
 * @sa MORSE_clange_Tile
 * @sa MORSE_dlange_Tile
 * @sa MORSE_slange_Tile
 *
 ******************************************************************************/
double MORSE_zlange_Tile(MORSE_enum norm, MORSE_desc_t *A)
{
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
    double value;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zlange_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    morse_sequence_create(morse, &sequence);
209
    MORSE_zlange_Tile_Async( norm, A, &value, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
210

211
    morse_sequence_wait(morse, sequence);
Mathieu Faverge's avatar
Mathieu Faverge committed
212

213 214 215 216
    morse_sequence_destroy(morse, sequence);
    return value;
}

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 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zlange_Tile_Async - Non-blocking equivalent of MORSE_zlange_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_zlange
 * @sa MORSE_zlange_Tile
 * @sa MORSE_clange_Tile_Async
 * @sa MORSE_dlange_Tile_Async
 * @sa MORSE_slange_Tile_Async
 *
 ******************************************************************************/
int MORSE_zlange_Tile_Async(MORSE_enum norm, MORSE_desc_t *A, double *value,
                            MORSE_sequence_t *sequence, MORSE_request_t *request)
{
    MORSE_context_t *morse;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zlange_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zlange_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zlange_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_zlange_Tile", "invalid descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if (A->nb != A->mb) {
        morse_error("MORSE_zlange_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if ( (norm != MorseMaxNorm) && (norm != MorseOneNorm)
         && (norm != MorseInfNorm) && (norm != MorseFrobeniusNorm) ) {
        morse_error("MORSE_zlange", "illegal value of norm");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Quick return */
Mathieu Faverge's avatar
Mathieu Faverge committed
284
    if (chameleon_min(A->m, A->n) == 0) {
285 286 287 288 289 290 291 292
        *value = 0.0;
        return MORSE_SUCCESS;
    }

    morse_pzlange(norm, A, value, sequence, request);

    return MORSE_SUCCESS;
}