scilab/modules/arnoldi/includes/eigs.h

   1 /*
   2  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
   3  * Copyright (C) 2011 - Scilab Enterprises - Adeline CARNIS
   4  *
   5  * This file must be used under the terms of the CeCILL.
   6  * This source file is licensed as described in the file COPYING, which
   7  * you should have received as part of this distribution.  The terms
   8  * are also available at
   9  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
  10  *
  11  */
  12 /*--------------------------------------------------------------------------*/
  13 #ifndef __EIGS_H__
  14 #define __EIGS_H__
  15 #include "doublecomplex.h"
  16
  17 /**
  18  * @TODO add comment
  19  *
  20  * @param AR
  21  * @param AC
  22  * @param N
  23  * @param Acomplex
  24  * @param Asym
  25  * @param B
  26  * @param BC
  27  * @param Bcomplex
  28  * @param matB
  29  * @param nev
  30  * @param SIGMA
  31  * @param which
  32  * @param maxiter
  33  * @param tol
  34  * @param NCV
  35  * @param RESID
  36  * @param RESIDC
  37  * @param INFO
  38  * @param cholB
  39  * @param INFO_EUPD
  40  * @param eigenvalue
  41  * @param eigenvector
  42  * @return <ReturnValue>
  43  */
  44 int eigs(double *AR, doublecomplex *AC, int N, int Acomplex, int Asym,
  45          double* B,  doublecomplex* BC, int Bcomplex, int matB, int nev,
  46          doublecomplex* SIGMA, char* which, double* maxiter, double* tol,
  47          double* NCV, double* RESID, doublecomplex* RESIDC, int* INFO,
  48          double* cholB, int INFO_EUPD, doublecomplex* eigenvalue,
  49          doublecomplex* eigenvector);
  50
  51 #endif /* __EIGS_H__ */
  52 /*--------------------------------------------------------------------------*/
  53