zgelqf_param.c 10.2 KB
Newer Older
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
1 2 3 4 5
/**
 *
 * @copyright (c) 2009-2014 The University of Tennessee and The University
 *                          of Tennessee Research Foundation.
 *                          All rights reserved.
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
6
 * @copyright (c) 2012-2017 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria, Univ. Bordeaux. All rights reserved.
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
7 8 9 10 11 12 13 14 15 16 17
 *
 **/

/**
 *
 * @file zgelqf_param.c
 *
 *  MORSE computational routines
 *  MORSE is a software package provided by Univ. of Tennessee,
 *  Univ. of California Berkeley and Univ. of Colorado Denver
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
18
 * @version 1.0.0
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
19
 * @author Mathieu Faverge
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
20 21
 * @author Raphael Boucherie
 * @date 2017-05-17
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
22 23 24 25 26 27 28 29 30 31 32 33 34 35
 * @precisions normal z -> s d c
 *
 **/
#include "control/common.h"

/**
 *******************************************************************************
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zgelqf_param - Computes the tile LQ factorization of a complex M-by-N matrix A: A = L * Q.
 *
 *******************************************************************************
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
36 37 38
 * @param[in] qrtree
 *          The tree used for the factorization
 *
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
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
 * @param[in] M
 *          The number of rows of the matrix A. M >= 0.
 *
 * @param[in] N
 *          The number of columns of the matrix A. N >= 0.
 *
 * @param[in,out] A
 *          On entry, the M-by-N matrix A.
 *          On exit, the elements on and below the diagonal of the array contain the m-by-min(M,N)
 *          lower trapezoidal matrix L (L is lower triangular if M <= N); the elements above the
 *          diagonal represent the unitary matrix Q as a product of elementary reflectors, stored
 *          by tiles.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,M).
 *
 * @param[out] descT
 *          On exit, auxiliary factorization data, required by MORSE_zgelqs to solve the system
 *          of equations.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *
 *******************************************************************************
 *
 * @sa MORSE_zgelqf_param_Tile
 * @sa MORSE_zgelqf_param_Tile_Async
 * @sa MORSE_cgelqf
 * @sa MORSE_dgelqf
 * @sa MORSE_sgelqf
 * @sa MORSE_zgelqs
 *
 ******************************************************************************/
75 76 77
int MORSE_zgelqf_param( const libhqr_tree_t *qrtree, int M, int N,
                        MORSE_Complex64_t *A, int LDA,
                        MORSE_desc_t *descTS, MORSE_desc_t *descTT )
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
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;
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119

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

    /* Check input arguments */
    if (M < 0) {
        morse_error("MORSE_zgelqf_param", "illegal value of M");
        return -1;
    }
    if (N < 0) {
        morse_error("MORSE_zgelqf_param", "illegal value of N");
        return -2;
    }
    if (LDA < chameleon_max(1, M)) {
        morse_error("MORSE_zgelqf_param", "illegal value of LDA");
        return -4;
    }

    /* Quick return */
    if (chameleon_min(M, N) == 0)
        return MORSE_SUCCESS;

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

    /* Set NT */
    NB = MORSE_NB;

120
    morse_sequence_create( morse, &sequence );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
121

122
    /* Submit the matrix conversion */
123
    morse_zlap2tile( morse, &descAl, &descAt, MorseDescInout, MorseUpperLower,
124
                     A, NB, NB, LDA, N, M, N, sequence, &request );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
125 126

    /* Call the tile interface */
127
    MORSE_zgelqf_param_Tile_Async( qrtree, &descAt, descTS, descTT, sequence, &request );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
128

Mathieu Faverge's avatar
Cleanup  
Mathieu Faverge committed
129
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
130
    morse_ztile2lap( morse, &descAl, &descAt,
131
                     MorseDescInout, MorseUpperLower, sequence, &request );
132 133
    MORSE_Desc_Flush( descTS, sequence );
    MORSE_Desc_Flush( descTT, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
134

135
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
136

Mathieu Faverge's avatar
Mathieu Faverge committed
137 138
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
139 140

    status = sequence->status;
141
    morse_sequence_destroy( morse, sequence );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
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 170 171 172 173 174 175 176 177 178 179 180 181 182 183
    return status;
}

/**
 *******************************************************************************
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zgelqf_param_Tile - Computes the tile LQ factorization of a matrix.
 *  Tile equivalent of MORSE_zgelqf_param().
 *  Operates on matrices stored by tiles.
 *  All matrices are passed through descriptors.
 *  All dimensions are taken from the descriptors.
 *
 *******************************************************************************
 *
 * @param[in,out] A
 *          On entry, the M-by-N matrix A.
 *          On exit, the elements on and below the diagonal of the array contain the m-by-min(M,N)
 *          lower trapezoidal matrix L (L is lower triangular if M <= N); the elements above the
 *          diagonal represent the unitary matrix Q as a product of elementary reflectors, stored
 *          by tiles.
 *
 * @param[out] T
 *          On exit, auxiliary factorization data, required by MORSE_zgelqs to solve the system
 *          of equations.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *
 *******************************************************************************
 *
 * @sa MORSE_zgelqf_param
 * @sa MORSE_zgelqf_param_Tile_Async
 * @sa MORSE_cgelqf_Tile
 * @sa MORSE_dgelqf_Tile
 * @sa MORSE_sgelqf_Tile
 * @sa MORSE_zgelqs_Tile
 *
 ******************************************************************************/
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
184
int MORSE_zgelqf_param_Tile( const libhqr_tree_t *qrtree, MORSE_desc_t *A, MORSE_desc_t *TS, MORSE_desc_t *TT )
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
185 186 187 188 189 190 191 192 193 194 195
{
    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_zgelqf_param_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
196 197
    morse_sequence_create( morse, &sequence );

198
    MORSE_zgelqf_param_Tile_Async( qrtree, A, TS, TT, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
199

200 201 202
    MORSE_Desc_Flush( A, sequence );
    MORSE_Desc_Flush( TS, sequence );
    MORSE_Desc_Flush( TT, sequence );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
203

204
    morse_sequence_wait( morse, sequence );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
205
    status = sequence->status;
206
    morse_sequence_destroy( morse, sequence );
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
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
    return status;
}

/**
 *******************************************************************************
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zgelqf_param_Tile_Async - Computes the tile LQ factorization of a matrix.
 *  Non-blocking equivalent of MORSE_zgelqf_param_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_zgelqf_param
 * @sa MORSE_zgelqf_param_Tile
 * @sa MORSE_cgelqf_Tile_Async
 * @sa MORSE_dgelqf_Tile_Async
 * @sa MORSE_sgelqf_Tile_Async
 * @sa MORSE_zgelqs_Tile_Async
 *
 ******************************************************************************/
239 240
int MORSE_zgelqf_param_Tile_Async( const libhqr_tree_t *qrtree, MORSE_desc_t *A, MORSE_desc_t *TS, MORSE_desc_t *TT,
                                   MORSE_sequence_t *sequence, MORSE_request_t *request )
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
241 242
{
    MORSE_context_t *morse;
Mathieu Faverge's avatar
Mathieu Faverge committed
243
    MORSE_desc_t D, *Dptr = NULL;
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zgelqf_param_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zgelqf_param_Tile", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zgelqf_param_Tile", "NULL request");
        return MORSE_ERR_UNALLOCATED;
    }
    /* Check sequence status */
Mathieu Faverge's avatar
Mathieu Faverge committed
259
    if (sequence->status == MORSE_SUCCESS) {
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
260
        request->status = MORSE_SUCCESS;
Mathieu Faverge's avatar
Mathieu Faverge committed
261 262
    }
    else {
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
263
        return morse_request_fail(sequence, request, MORSE_ERR_SEQUENCE_FLUSHED);
Mathieu Faverge's avatar
Mathieu Faverge committed
264
    }
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqf_param_Tile", "invalid first descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(TS) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqf_param_Tile", "invalid second descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (morse_desc_check(TT) != MORSE_SUCCESS) {
        morse_error("MORSE_zgelqf_param_Tile", "invalid third descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if (A->nb != A->mb) {
        morse_error("MORSE_zgelqf_param_Tile", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Quick return */
285 286 287 288
    /*
     if (chameleon_min(M, N) == 0)
     return MORSE_SUCCESS;
     */
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
289
#if defined(CHAMELEON_COPY_DIAG)
Mathieu Faverge's avatar
Mathieu Faverge committed
290 291 292 293 294
    {
        int m = chameleon_min(A->mt, A->nt) * A->mb;
        morse_zdesc_alloc(D, A->mb, A->nb, m, A->n, 0, 0, m, A->n, );
        Dptr = &D;
    }
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
295
#endif
Mathieu Faverge's avatar
Mathieu Faverge committed
296

Mathieu Faverge's avatar
Mathieu Faverge committed
297
    morse_pzgelqf_param( qrtree, A, TS, TT, Dptr, sequence, request );
Mathieu Faverge's avatar
Mathieu Faverge committed
298
    if (Dptr != NULL) {
299 300 301 302 303
        MORSE_Desc_Flush( A, sequence );
        MORSE_Desc_Flush( TS, sequence );
        MORSE_Desc_Flush( TT, sequence );
        MORSE_Desc_Flush( Dptr, sequence );
        morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
304
        morse_desc_mat_free( Dptr );
Mathieu Faverge's avatar
Mathieu Faverge committed
305
    }
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
306
    (void)D;
BOUCHERIE Raphael's avatar
BOUCHERIE Raphael committed
307 308
    return MORSE_SUCCESS;
}