nmrSymmetricEigenProblem.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*
  
  (C) Copyright 2013 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/

#include <cisstNumerical/nmrNetlib.h>
#include <cisstVector/vctDynamicMatrix.h>
#include <cisstNumerical/nmrExport.h>

#ifndef _nmrSymmetricEigenProblem_h
#define _nmrSymmetricEigenProblem_h

class nmrSymmetricEigenProblem{

public:
  
  class Data{
  public:
    
    char JOBZ;                     // 'N' eigenvalues; 'V' eigenvalues+vectors
    char RANGE;                    // 'A' all; 'V' half open, 'I' ith value
    char UPLO;                     // 'U' upper triangle, 'L' lower

    CISSTNETLIB_INTEGER N;         // order of matrix 
    CISSTNETLIB_DOUBLE* A;         // matrix
    CISSTNETLIB_INTEGER LDA;       // lead dimension of matrix A (column stride)
    
    CISSTNETLIB_DOUBLE VL;         // eigen value lower bound 
    CISSTNETLIB_DOUBLE VU;         // eigen value upper bound 

    CISSTNETLIB_INTEGER IL;        // eigen value lower index
    CISSTNETLIB_INTEGER IU;        // eigen value upper index

    char DLAMCH;                   // double precision machine parameters
    CISSTNETLIB_DOUBLE ABSTOL;     // absolute tolerance

    CISSTNETLIB_INTEGER M;         // number of eigen values found
    CISSTNETLIB_DOUBLE* W;         // vector of eigenvalues

    CISSTNETLIB_DOUBLE* Z;         // matrix of eigenvectors
    CISSTNETLIB_INTEGER LDZ;       // leading dimension of Z
    CISSTNETLIB_INTEGER* ISUPPZ;   // eigenvectors support
    
    CISSTNETLIB_DOUBLE* WORK;      // workspace
    CISSTNETLIB_INTEGER LWORK;     // workspace size

    CISSTNETLIB_INTEGER* IWORK;    // workspace
    CISSTNETLIB_INTEGER LIWORK;    // workspace size

    CISSTNETLIB_INTEGER INFO;      // info value

    // Create empty data
    Data();

    // Create and fill data 
    Data( vctDynamicMatrix<double>& A,
          vctDynamicVector<double>& D,
          vctDynamicMatrix<double>& V );

    ~Data();

    // Check the system of equation for inconsistencies
    void CheckSystem( const vctDynamicMatrix<double>& A,
                      const vctDynamicVector<double>& D,
                      const vctDynamicMatrix<double>& V );

    // Print errors if any
    void CheckInfo() const;

    // Free the data block
    void Free();

  };

  enum Errno{ ESUCCESS, EFAILURE };

};



nmrSymmetricEigenProblem::Errno CISST_EXPORT
nmrSymmetricEigenProblem
( vctDynamicMatrix<double>& A,
  vctDynamicVector<double>& D,
  vctDynamicMatrix<double>& V );


nmrSymmetricEigenProblem::Errno CISST_EXPORT
nmrSymmetricEigenProblem
( vctDynamicMatrix<double>& A,
  vctDynamicVector<double>& D,
  vctDynamicMatrix<double>& V,
  nmrSymmetricEigenProblem::Data& data );

#endif