zplghe.c 8.78 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-2016 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
 *
 * @file zplghe.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
17 18
 * @comment This file is a copy of zplghe.c
 *          wich has been automatically generated
19 20 21 22
 *          from Plasma 2.5.0 for MORSE 1.0.0
 * @author Mathieu Faverge
 * @author Emmanuel Agullo
 * @author Cedric Castagnede
23 24 25
 * @author Rade Mathis
 * @author Florent Pruvost
 * @date 2016-08-01
26 27 28
 * @precisions normal z -> c
 *
 **/
29
#include "control/common.h"
30

31 32
/**
 ********************************************************************************
33 34 35
 *
 * @ingroup MORSE_Complex64_t
 *
36
 *  MORSE_zplghe - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
37 38 39 40
 *
 *******************************************************************************
 *
 * @param[in] bump
Mathieu Faverge's avatar
Mathieu Faverge committed
41
 *          The value to add to the diagonal to be sure
42 43 44 45 46
 *          to have a positive definite matrix.
 *
 * @param[in] N
 *          The order of the matrix A. N >= 0.
 *
47 48 49
 * @param[in] uplo
 *          The part of the Matrix wich will be generated.
 *
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
 * @param[out] A
 *          On exit, The random hermitian 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_zplghe_Tile
 * @sa MORSE_zplghe_Tile_Async
 * @sa MORSE_cplghe
 * @sa MORSE_dplghe
 * @sa MORSE_splghe
72
 * @sa MORSE_zplghe
73 74
 *
 ******************************************************************************/
75 76 77
int MORSE_zplghe( double bump, MORSE_enum uplo, int N,
                  MORSE_Complex64_t *A, int LDA,
                  unsigned long long int seed )
78 79 80 81 82 83
{
    int NB;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
Mathieu Faverge's avatar
Mathieu Faverge committed
84
    MORSE_desc_t descAl, descAt;
85 86 87 88 89 90 91 92 93 94 95

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

    /* Tune NB depending on M, N & NRHS; Set NBNB */
    status = morse_tune(MORSE_FUNC_ZGEMM, N, N, 0);
    if (status != MORSE_SUCCESS) {
        morse_error("MORSE_zplghe", "morse_tune() failed");
        return status;
    }
Mathieu Faverge's avatar
Mathieu Faverge committed
110

111 112
    /* Set NT */
    NB = MORSE_NB;
113
    morse_sequence_create( morse, &sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
114

115
    /* Submit the matrix conversion */
116
    morse_zlap2tile( morse, &descAl, &descAt, MorseDescOutput, uplo,
117
                     A, NB, NB, LDA, N, N, N, sequence, &request );
118 119

    /* Call the tile interface */
120
    MORSE_zplghe_Tile_Async( bump, uplo, &descAt, seed, sequence, &request );
121

Mathieu Faverge's avatar
Cleanup  
Mathieu Faverge committed
122
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
123
    morse_ztile2lap( morse, &descAl, &descAt,
124
                     MorseDescOutput, uplo, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
125

126
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
127

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

    status = sequence->status;
132
    morse_sequence_destroy( morse, sequence );
133 134 135 136

    return status;
}

137 138
/**
 ********************************************************************************
139 140 141
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
142
 *  MORSE_zplghe_Tile - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
143 144 145 146 147 148 149 150
 *  Tile equivalent of MORSE_zplghe().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in] bump
Mathieu Faverge's avatar
Mathieu Faverge committed
151
 *          The value to add to the diagonal to be sure
152 153
 *          to have a positive definite matrix.
 *
154 155 156
 * @param[in] uplo
 *          The part of the Matrix wich will be generated.
 *
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
 * @param[in] A
 *          On exit, The random hermitian matrix A generated.
 *
 * @param[in] seed
 *          The seed used in the random generation.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zplghe
 * @sa MORSE_zplghe_Tile_Async
 * @sa MORSE_cplghe_Tile
 * @sa MORSE_dplghe_Tile
 * @sa MORSE_splghe_Tile
175
 * @sa MORSE_zplghe_Tile
176 177
 *
 ******************************************************************************/
178 179
int MORSE_zplghe_Tile( double bump, MORSE_enum uplo, MORSE_desc_t *A,
                       unsigned long long int seed )
180 181 182 183 184 185 186 187 188 189 190
{
    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_zplghe_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
191 192
    morse_sequence_create( morse, &sequence );

193
    MORSE_zplghe_Tile_Async( bump, uplo, A, seed, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
194

195
    MORSE_Desc_Flush( A, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
196

197
    morse_sequence_wait( morse, sequence );
198
    status = sequence->status;
199
    morse_sequence_destroy( morse, sequence );
200 201 202
    return status;
}

203 204
/**
 ********************************************************************************
205 206 207
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
208
 *  MORSE_zplghe_Tile_Async - Generate a random hermitian (positive definite if 'bump' is large enough) half-matrix by tiles.
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
 *  Non-blocking equivalent of MORSE_zplghe_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_zplghe
 * @sa MORSE_zplghe_Tile
 * @sa MORSE_cplghe_Tile_Async
 * @sa MORSE_dplghe_Tile_Async
 * @sa MORSE_splghe_Tile_Async
 * @sa MORSE_zplghe_Tile_Async
 *
 ******************************************************************************/
232 233 234
int MORSE_zplghe_Tile_Async( double                 bump,
                             MORSE_enum             uplo,
                             MORSE_desc_t             *A,
235
                             unsigned long long int seed,
236 237
                             MORSE_sequence_t  *sequence,
                             MORSE_request_t    *request )
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
{
    MORSE_context_t *morse;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zplghe_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zplghe_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zplghe_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
Mathieu Faverge's avatar
Mathieu Faverge committed
255
    if (sequence->status == MORSE_SUCCESS) {
256
        request->status = MORSE_SUCCESS;
Mathieu Faverge's avatar
Mathieu Faverge committed
257 258
    }
    else {
259
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);
Mathieu Faverge's avatar
Mathieu Faverge committed
260
    }
261 262 263 264 265 266 267 268 269 270 271 272 273

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zplghe_Tile", "invalid descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if (A->nb != A->mb) {
        morse_error("MORSE_zplghe_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }

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

Mathieu Faverge's avatar
Mathieu Faverge committed
277
    morse_pzplghe( bump, uplo, A, seed, sequence, request );
278 279 280

    return MORSE_SUCCESS;
}