zpotri.c 9.47 KB
Newer Older
1
/**
2 3
 *
 * @file zpotri.c
4
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
5 6
 * @copyright 2009-2014 The University of Tennessee and The University of
 *                      Tennessee Research Foundation. All rights reserved.
7 8
 * @copyright 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
 *                      Univ. Bordeaux. All rights reserved.
9
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
10
 ***
11 12 13 14 15 16
 *
 *
 *  MORSE computational routines
 *  MORSE is a software package provided by Univ. of Tennessee,
 *  Univ. of California Berkeley and Univ. of Colorado Denver
 *
Mathieu Faverge's avatar
Mathieu Faverge committed
17
 * @version 1.0.0
18 19 20 21 22 23 24 25 26
 * @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
 *
 **/
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
 *
 * @ingroup MORSE_Complex64_t
 *
 *  MORSE_zpotri - Computes the inverse of a complex Hermitian positive definite
 *  matrix A using the Cholesky factorization A = U**H*U or A = L*L**H
 *  computed by MORSE_zpotrf.
 *
 *******************************************************************************
 *
 * @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 triangular factor U or L from the Cholesky
 *          factorization A = U**H*U or A = L*L**H, as computed by
 *          MORSE_zpotrf.
 *          On exit, the upper or lower triangle of the (Hermitian)
 *          inverse of A, overwriting the input factor U or L.
 *
 * @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 (i,i) element of the factor U or L is
 *                zero, and the inverse could not be computed.
 *
 *******************************************************************************
 *
 * @sa MORSE_zpotri_Tile
 * @sa MORSE_zpotri_Tile_Async
 * @sa MORSE_cpotri
 * @sa MORSE_dpotri
 * @sa MORSE_spotri
 * @sa MORSE_zpotrf
 *
 ******************************************************************************/
75 76
int MORSE_zpotri( MORSE_enum uplo, int N,
                  MORSE_Complex64_t *A, int LDA )
77 78 79 80 81 82
{
    int NB;
    int status;
    MORSE_context_t *morse;
    MORSE_sequence_t *sequence = NULL;
    MORSE_request_t request = MORSE_REQUEST_INITIALIZER;
83
    MORSE_desc_t descAl, descAt;
84 85 86 87 88 89 90

    morse = morse_context_self();
    if (morse == NULL) {
        morse_fatal_error("MORSE_zpotri", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
    /* Check input arguments */
Mathieu Faverge's avatar
Mathieu Faverge committed
91
    if ((uplo != MorseUpper) && (uplo != MorseLower)) {
92 93 94 95 96 97 98
        morse_error("MORSE_zpotri", "illegal value of uplo");
        return -1;
    }
    if (N < 0) {
        morse_error("MORSE_zpotri", "illegal value of N");
        return -2;
    }
99
    if (LDA < chameleon_max(1, N)) {
100 101 102 103
        morse_error("MORSE_zpotri", "illegal value of LDA");
        return -4;
    }
    /* Quick return */
104
    if (chameleon_max(N, 0) == 0)
105 106 107 108 109 110 111 112 113 114 115 116
        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_zpotri", "morse_tune() failed");
        return status;
    }

    /* Set NT */
    NB   = MORSE_NB;

117
    morse_sequence_create( morse, &sequence );
118

119
    /* Submit the matrix conversion */
120
    morse_zlap2tile( morse, &descAl, &descAt, MorseDescInout, uplo,
121
                     A, NB, NB, LDA, N, N, N, sequence, &request );
122 123

    /* Call the tile interface */
124
    MORSE_zpotri_Tile_Async( uplo, &descAt, sequence, &request );
125

Mathieu Faverge's avatar
Mathieu Faverge committed
126
    /* Submit the matrix conversion back */
Mathieu Faverge's avatar
Mathieu Faverge committed
127
    morse_ztile2lap( morse, &descAl, &descAt,
128
                     MorseDescInout, uplo, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
129

130
    morse_sequence_wait( morse, sequence );
Mathieu Faverge's avatar
Mathieu Faverge committed
131

Mathieu Faverge's avatar
Mathieu Faverge committed
132 133
    /* Cleanup the temporary data */
    morse_ztile2lap_cleanup( morse, &descAl, &descAt );
134 135

    status = sequence->status;
136
    morse_sequence_destroy( morse, sequence );
137 138 139
    return status;
}

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 170 171 172 173 174 175 176 177 178 179 180 181 182 183
 *
 * @ingroup MORSE_Complex64_t_Tile
 *
 *  MORSE_zpotri_Tile - Computes the inverse of a complex Hermitian
 *  positive definite matrix A using the Cholesky factorization
 *  A = U**H*U or A = L*L**H computed by MORSE_zpotrf.
 *  Tile equivalent of MORSE_zpotri().
 *  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 triangular factor U or L from the Cholesky
 *          factorization A = U**H*U or A = L*L**H, as computed by
 *          MORSE_zpotrf.
 *          On exit, the upper or lower triangle of the (Hermitian)
 *          inverse of A, overwriting the input factor U or L.
 *
 *******************************************************************************
 *
 * @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_zpotri
 * @sa MORSE_zpotri_Tile_Async
 * @sa MORSE_cpotri_Tile
 * @sa MORSE_dpotri_Tile
 * @sa MORSE_spotri_Tile
 * @sa MORSE_zpotrf_Tile
 *
 ******************************************************************************/
Mathieu Faverge's avatar
Minor  
Mathieu Faverge committed
184
int MORSE_zpotri_Tile( MORSE_enum uplo, MORSE_desc_t *A )
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_zpotri_Tile", "MORSE not initialized");
        return MORSE_ERR_NOT_INITIALIZED;
    }
196 197
    morse_sequence_create( morse, &sequence );

198
    MORSE_zpotri_Tile_Async( uplo, A, sequence, &request );
Mathieu Faverge's avatar
Mathieu Faverge committed
199

200
    MORSE_Desc_Flush( A, sequence );
201

202
    morse_sequence_wait( morse, sequence );
203
    status = sequence->status;
204
    morse_sequence_destroy( morse, sequence );
205 206 207
    return status;
}

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
 *
 * @ingroup MORSE_Complex64_t_Tile_Async
 *
 *  MORSE_zpotri_Tile_Async - Computes the inverse of a complex Hermitian
 *  positive definite matrix A using the Cholesky factorization A = U**H*U
 *  or A = L*L**H computed by MORSE_zpotrf.
 *  Non-blocking equivalent of MORSE_zpotri_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_zpotri
 * @sa MORSE_zpotri_Tile
 * @sa MORSE_cpotri_Tile_Async
 * @sa MORSE_dpotri_Tile_Async
 * @sa MORSE_spotri_Tile_Async
 * @sa MORSE_zpotrf_Tile_Async
 *
 ******************************************************************************/
239 240
int MORSE_zpotri_Tile_Async( MORSE_enum uplo, MORSE_desc_t *A,
                             MORSE_sequence_t *sequence, MORSE_request_t *request )
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
{
    MORSE_context_t *morse;

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

    /* Check descriptors for correctness */
    if (morse_desc_check(A) != MORSE_SUCCESS) {
        morse_error("MORSE_zpotri_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_zpotri_Tile_Async", "only square tiles supported");
        return morse_request_fail(sequence, request, MORSE_ERR_ILLEGAL_VALUE);
    }
Mathieu Faverge's avatar
Mathieu Faverge committed
275
    if ((uplo != MorseUpper) && (uplo != MorseLower)) {
276 277 278 279
        morse_error("MORSE_zpotri_Tile_Async", "illegal value of uplo");
        return morse_request_fail(sequence, request, -1);
    }
    /* Quick return */
280 281 282 283
    /*
     if (chameleon_max(N, 0) == 0)
     return MORSE_SUCCESS;
     */
Mathieu Faverge's avatar
Mathieu Faverge committed
284
    morse_pztrtri( uplo, MorseNonUnit, A, sequence, request );
285

Mathieu Faverge's avatar
Mathieu Faverge committed
286
    morse_pzlauum( uplo, A, sequence, request );
287 288 289

    return MORSE_SUCCESS;
}