zpotrf.c 10.3 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 27 28 29
 *
 **/

/**
 *
 * @file zpotrf.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 Jakub Kurzak
 * @author Mathieu Faverge
 * @author Emmanuel Agullo
 * @author Cedric Castagnede
 * @date 2010-11-15
 * @precisions normal z -> s d c
 *
 **/
30
#include "control/common.h"
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
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zpotrf - Computes the Cholesky factorization of a symmetric positive definite
 *  (or Hermitian positive definite in the complex case) matrix A.
 *  The factorization has the form
 *
 *    \f[ A = \{_{L\times L^H, if uplo = MorseLower}^{U^H\times U, if uplo = MorseUpper} \f]
 *
 *  where U is an upper triangular matrix and L is a lower triangular matrix.
 *
 *******************************************************************************
 *
 * @param[in] uplo
 *          = MorseUpper: Upper triangle of A is stored;
 *          = MorseLower: Lower triangle of A is stored.
 *
 * @param[in] N
 *          The order of the matrix A. N >= 0.
 *
 * @param[in,out] A
 *          On entry, the symmetric positive definite (or Hermitian) matrix A.
 *          If uplo = MorseUpper, the leading N-by-N upper triangular part of A
 *          contains the upper triangular part of the matrix A, and the strictly lower triangular
 *          part of A is not referenced.
 *          If UPLO = 'L', the leading N-by-N lower triangular part of A contains the lower
 *          triangular part of the matrix A, and the strictly upper triangular part of A is not
 *          referenced.
 *          On exit, if return value = 0, the factor U or L from the Cholesky factorization
 *          A = U**H*U or A = L*L**H.
 *
 * @param[in] LDA
 *          The leading dimension of the array A. LDA >= max(1,N).
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval <0 if -i, the i-th argument had an illegal value
 *          \retval >0 if i, the leading minor of order i of A is not positive definite, so the
 *               factorization could not be completed, and the solution has not been computed.
 *
 *******************************************************************************
 *
 * @sa MORSE_zpotrf_Tile
 * @sa MORSE_zpotrf_Tile_Async
 * @sa MORSE_cpotrf
 * @sa MORSE_dpotrf
 * @sa MORSE_spotrf
 * @sa MORSE_zpotrs
 *
 ******************************************************************************/
int MORSE_zpotrf(MORSE_enum uplo, int N,
87
                 MORSE_Complex64_t *A, int LDA)
88 89 90 91 92 93
{
    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
94 95
    MORSE_desc_t descAtl, descAtt;
    MORSE_desc_t descAll, descAlt;
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zpotrf", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    /* Check input arguments */
    if (uplo != MorseUpper && uplo != MorseLower) {
        morse_error("MORSE_zpotrf", "illegal value of uplo");
        return -1;
    }
    if (N < 0) {
        morse_error("MORSE_zpotrf", "illegal value of N");
        return -2;
    }
111
    if (LDA < chameleon_max(1, N)) {
112 113 114 115
        morse_error("MORSE_zpotrf", "illegal value of LDA");
        return -4;
    }
    /* Quick return */
116
    if (chameleon_max(N, 0) == 0)
117 118 119 120 121 122 123 124 125 126
        return MORSE_SUCCESS;

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

    /* Set NT */
127
    NB = MORSE_NB;
128 129 130

    morse_sequence_create(morse, &sequence);

131 132 133
    /* Submit the matrix conversion */
    morse_zlap2tile( morse, &descAl, &descAt, uplo,
                     A, NB, NB, LDA, N, N, N, sequence, &request );
134 135

    /* Call the tile interface */
136
    MORSE_zpotrf_Tile_Async(uplo, &descAt, sequence, &request);
137

138
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
139 140
    morse_ztile2lap( morse, &descAl, &descAt,
                     uplo, sequence, &request );
141 142 143 144 145

    morse_sequence_wait(morse, sequence);

    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
146 147 148 149 150 151 152

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

    return status;
}

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 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 209 210 211 212
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zpotrf_Tile - Computes the Cholesky factorization of a symmetric positive definite
 *  or Hermitian positive definite matrix.
 *  Tile equivalent of MORSE_zpotrf().
 *  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 A is stored;
 *          = MorseLower: Lower triangle of A is stored.
 *
 * @param[in] A
 *          On entry, the symmetric positive definite (or Hermitian) matrix A.
 *          If uplo = MorseUpper, the leading N-by-N upper triangular part of A
 *          contains the upper triangular part of the matrix A, and the strictly lower triangular
 *          part of A is not referenced.
 *          If UPLO = 'L', the leading N-by-N lower triangular part of A contains the lower
 *          triangular part of the matrix A, and the strictly upper triangular part of A is not
 *          referenced.
 *          On exit, if return value = 0, the factor U or L from the Cholesky factorization
 *          A = U**H*U or A = L*L**H.
 *
 *******************************************************************************
 *
 * @return
 *          \retval MORSE_SUCCESS successful exit
 *          \retval >0 if i, the leading minor of order i of A is not positive definite, so the
 *               factorization could not be completed, and the solution has not been computed.
 *
 *******************************************************************************
 *
 * @sa MORSE_zpotrf
 * @sa MORSE_zpotrf_Tile_Async
 * @sa MORSE_cpotrf_Tile
 * @sa MORSE_dpotrf_Tile
 * @sa MORSE_spotrf_Tile
 * @sa MORSE_zpotrs_Tile
 *
 ******************************************************************************/
int MORSE_zpotrf_Tile(MORSE_enum uplo, MORSE_desc_t *A)
{
    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_zpotrf_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    morse_sequence_create(morse, &sequence);
    MORSE_zpotrf_Tile_Async(uplo, A, sequence, &request);
213
    RUNTIME_desc_flush( A, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
214

Mathieu Faverge's avatar
Mathieu Faverge committed
215
    morse_sequence_wait(morse, sequence);
216 217 218 219 220 221

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

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
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zpotrf_Tile_Async - Computes the Cholesky factorization of a symmetric
 *  positive definite or Hermitian positive definite matrix.
 *  Non-blocking equivalent of MORSE_zpotrf_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_zpotrf
 * @sa MORSE_zpotrf_Tile
 * @sa MORSE_cpotrf_Tile_Async
 * @sa MORSE_dpotrf_Tile_Async
 * @sa MORSE_spotrf_Tile_Async
 * @sa MORSE_zpotrs_Tile_Async
 *
 ******************************************************************************/
int MORSE_zpotrf_Tile_Async(MORSE_enum uplo, MORSE_desc_t *A,
253
                            MORSE_sequence_t *sequence, MORSE_request_t *request)
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 284 285 286 287 288 289 290
{
    MORSE_context_t *morse;

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zpotrf_Tile_Async", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    if (sequence == NULL) {
        morse_fatal_error("MORSE_zpotrf_Tile_Async", "NULL sequence");
        return MORSE_ERR_UNALLOCATED;
    }
    if (request == NULL) {
        morse_fatal_error("MORSE_zpotrf_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_zpotrf_Tile_Async", "invalid descriptor");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    /* Check input arguments */
    if (A->nb != A->mb) {
        morse_error("MORSE_zpotrf_Tile_Async", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
    if (uplo != MorseUpper && uplo != MorseLower) {
        morse_error("MORSE_zpotrf_Tile_Async", "illegal value of uplo");
        return morse_request_fail(sequence, request, -1);
    }
    /* Quick return */
291 292 293 294
    /*
     if (chameleon_max(N, 0) == 0)
     return MORSE_SUCCESS;
     */
295 296 297 298
    morse_pzpotrf(uplo, A, sequence, request);

    return MORSE_SUCCESS;
}