zplrnt.c 7.97 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 zplrnt.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
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zplrnt - Generate a random matrix by tiles.
 *
 *******************************************************************************
 *
 * @param[in] M
 *          The number of rows of A.
 *
 * @param[in] N
 *          The order of the matrix A. N >= 0.
 *
 * @param[out] A
 *          On exit, The random matrix A generated.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,M).
 *
 * @param[in] seed
 *          The seed used in the random generation.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *
 *******************************************************************************
 *
 * @sa MORSE_zplrnt_Tile
 * @sa MORSE_zplrnt_Tile_Async
 * @sa MORSE_cplrnt
 * @sa MORSE_dplrnt
 * @sa MORSE_splrnt
 * @sa MORSE_zplghe
 * @sa MORSE_zplgsy
 *
 ******************************************************************************/
int MORSE_zplrnt( int M, int N,
73 74
                  MORSE_Complex64_t *A, int LDA,
                  unsigned long long int seed )
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
{
    int NB;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
    MORSE_desc_t descA;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zplrnt", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    /* Check input arguments */
    if (M < 0) {
        morse_error("MORSE_zplrnt", "illegal value of M");
        return -1;
    }
    if (N < 0) {
        morse_error("MORSE_zplrnt", "illegal value of N");
        return -2;
    }
97
    if (LDA < chameleon_max(1, M)) {
98 99 100 101
        morse_error("MORSE_zplrnt", "illegal value of LDA");
        return -4;
    }
    /* Quick return */
Mathieu Faverge's avatar
Mathieu Faverge committed
102
    if (chameleon_min(M, N) == 0)
103 104 105 106 107 108 109 110
        return MORSE_SUCCESS;

    /* 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_zplrnt", "morse_tune() failed");
        return status;
    }
Mathieu Faverge's avatar
Mathieu Faverge committed
111

112 113 114 115 116 117 118 119
    /* Set NT */
    NB = MORSE_NB;
    morse_sequence_create(morse, &sequence);
    morse_zdesc_alloc(descA, NB, NB, LDA, N, 0, 0, M, N, morse_desc_mat_free(&descA));

    /* Call the tile interface */
    MORSE_zplrnt_Tile_Async( &descA, seed, sequence, &request );

Mathieu Faverge's avatar
Mathieu Faverge committed
120 121 122
    morse_ztile2lap( morse, &descAl, &descAt,
                     MorseUpperLower, sequence, &request );

123
    morse_sequence_wait(morse, sequence);
Mathieu Faverge's avatar
Mathieu Faverge committed
124

Mathieu Faverge's avatar
Mathieu Faverge committed
125 126
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
127 128 129 130 131 132 133

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

    return status;
}

134 135
/**
 ********************************************************************************
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zplrnt_Tile - Generate a random matrix by tiles.
 *  Tile equivalent of MORSE_zplrnt().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] A
 *          On exit, The random matrix A generated.
 *
 * @param[in] seed
 *          The seed used in the random generation.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zplrnt
 * @sa MORSE_zplrnt_Tile_Async
 * @sa MORSE_cplrnt_Tile
 * @sa MORSE_dplrnt_Tile
 * @sa MORSE_splrnt_Tile
 * @sa MORSE_zplghe_Tile
 * @sa MORSE_zplgsy_Tile
 *
 ******************************************************************************/
int MORSE_zplrnt_Tile( MORSE_desc_t *A,
170
                       unsigned long long int seed )
171 172 173 174 175 176 177 178 179 180 181 182 183
{
    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_zplrnt_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    morse_sequence_create(morse, &sequence);
    MORSE_zplrnt_Tile_Async( A, seed, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
184

185
    morse_sequence_wait(morse, sequence);
Mathieu Faverge's avatar
Mathieu Faverge committed
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
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zplrnt_Tile_Async - Generate a random matrix by tiles.
 *  Non-blocking equivalent of MORSE_zplrnt_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_zplrnt
 * @sa MORSE_zplrnt_Tile
 * @sa MORSE_cplrnt_Tile_Async
 * @sa MORSE_dplrnt_Tile_Async
 * @sa MORSE_splrnt_Tile_Async
 * @sa MORSE_zplghe_Tile_Async
 * @sa MORSE_zplgsy_Tile_Async
 *
 ******************************************************************************/
int MORSE_zplrnt_Tile_Async( MORSE_desc_t     *A,
223 224 225
                             unsigned long long int seed,
                             MORSE_sequence_t *sequence,
                             MORSE_request_t  *request)
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
{
    MORSE_context_t *morse;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zplrnt_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zplrnt_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zplrnt_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_zplrnt_Tile", "invalid descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if (A->nb != A->mb) {
        morse_error("MORSE_zplrnt_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }

    /* Quick return */
Mathieu Faverge's avatar
Mathieu Faverge committed
260
    if (chameleon_min( A->m, A->n ) == 0)
261 262
        return MORSE_SUCCESS;

Mathieu Faverge's avatar
Mathieu Faverge committed
263
    morse_pzplrnt(A, seed, sequence, request);
264 265 266

    return MORSE_SUCCESS;
}