matrice.h

/*
 *  Definition of Lorene class Matrice
 *
 */

/*
 *   Copyright (c) 1999-2001 Philippe Grandclement
 *
 *   This file is part of LORENE.
 *
 *   LORENE is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   LORENE is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with LORENE; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


#ifndef __MATRICE_H_
#define __MATRICE_H_

/*
 * $Id: matrice.h,v 1.14 2014/10/13 08:52:35 j_novak Exp $
 * $Log: matrice.h,v $
 * Revision 1.14  2014/10/13 08:52:35  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.13  2014/10/06 15:09:40  j_novak
 * Modified #include directives to use c++ syntax.
 *
 * Revision 1.12  2005/10/24 09:22:21  p_grandclement
 * addition of annule_hard for matrices
 *
 * Revision 1.11  2005/09/16 12:28:16  j_novak
 * New method del_deriv() and shorter version for set(i,j).
 *
 * Revision 1.10  2005/01/25 12:47:32  j_novak
 * Added some member arithmetic and operator=(Tbl).
 *
 * Revision 1.9  2004/12/29 12:27:35  j_novak
 * permute is now a Itbl* which array is sent directly to the LAPACK routines.
 * It is now possible to solve a general system (i.e. even if the Matrice
 * is not in a banded form).
 *
 * Revision 1.8  2004/08/24 09:14:40  p_grandclement
 * Addition of some new operators, like Poisson in 2d... It now requieres the
 * GSL library to work.
 *
 * Also, the way a variable change is stored by a Param_elliptic is changed and
 * no longer uses Change_var but rather 2 Scalars. The codes using that feature
 * will requiere some modification. (It should concern only the ones about monopoles)
 *
 * Revision 1.7  2004/03/22 13:12:42  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.6  2002/09/24 10:49:41  e_gourgoulhon
 *
 * Modif commentaires.
 *
 * Revision 1.5  2002/09/24 08:34:12  e_gourgoulhon
 *
 * Added member function transpose()
 * and matrix multiplication
 *
 * Revision 1.4  2002/09/13 09:17:33  j_novak
 * Modif. commentaires
 *
 * Revision 1.3  2002/06/17 14:05:17  j_novak
 * friend functions are now also declared outside the class definition
 *
 * Revision 1.2  2002/01/03 13:18:40  j_novak
 * Optimization: the members set(i,j) and operator(i,j) of class Matrice are
 * now defined inline. Matrice is a friend class of Tbl.
 *
 * Revision 1.1.1.1  2001/11/20 15:19:27  e_gourgoulhon
 * LORENE
 *
 * Revision 2.12  1999/11/30  17:45:28  phil
 * changement de prototypage
 *
 * Revision 2.11  1999/10/25  08:02:11  eric
 * Changements commentaires.
 *
 * Revision 2.10  1999/10/12  16:04:06  phil
 * Doc
 *
 * Revision 2.9  1999/10/12  15:59:09  phil
 * Documentation
 *
 * Revision 2.8  1999/10/12  09:42:07  phil
 * retour
 *
 * Revision 2.7  1999/10/12  09:39:38  phil
 * passage en const
 *
 * Revision 2.6  1999/10/11  09:35:40  phil
 * changement prototypage arithmetique
 *
 * Revision 2.5  1999/10/05  17:02:32  phil
 * ajout de determinant et val_propre
 *
 * Revision 2.4  1999/09/20  11:25:25  phil
 * passage en Doc++
 *
 * Revision 2.3  1999/09/20  11:18:53  phil
 * *** empty log message ***
 *
 * Revision 2.2  1999/04/13  13:56:11  phil
 * suppression de proto.h
 *
 * Revision 2.1  1999/04/07  14:53:38  phil
 * Changement de prototypage
 *
 * Revision 2.0  1999/04/07  14:03:59  phil
 * *** empty log message ***
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/matrice.h,v 1.14 2014/10/13 08:52:35 j_novak Exp $
 *
 */

//fichiers includes
#include <cstdio>

#include "type_parite.h"
#include "tbl.h"
#include "itbl.h"

namespace Lorene {
class Matrice {
    //Elements
    private:
    
    int etat ; 
    
    Tbl* std ; 
    
    
    mutable int ku ;    
    mutable int kl ;    
    
    mutable Tbl* band ;
    
    
    mutable Tbl* lu ;   
    mutable Itbl* permute ; 
    
    // Constructeurs destructeurs
    public:
    Matrice (int size1, int size2 ) ;
    
    Matrice (const Matrice& ) ; 
    
    Matrice (const Tbl& tab) ;

    ~Matrice() ; 
    
        //Gestion memoire
    private:
    void del_t() ;
    void del_deriv() ; 

    // manipulation des etats
    public:
    int get_etat() const { return etat ; }; 

    void set_etat_qcq()  ;

    void set_etat_zero() ;

     void set_etat_nondef() ;
     
     void annule_hard() ;


    public:
    int get_dim(int i) const ;
    
    Tbl get_array() const {return *std; } ; 
    
    // affectation
    public: 
    void operator=(double x) ;

    void operator=(const Matrice& ) ; 
    void operator=(const Tbl& ) ; 
 
    //Impression
    friend ostream& operator<<(ostream& , const Matrice& ) ; 
        
    // extraction d'un element :
    public:
    double& set(int j, int i) {
      assert (etat == ETATQCQ) ;
      assert ((i>=0) && (i<std->dim.dim[0])) ;
      assert( (j>=0) && (j<std->dim.dim[1]) ) ;
      if ( (band != 0x0) || (lu != 0x0) ) del_deriv() ;
      return std->t[std->dim.dim[0] * j + i] ;
    } ;
    
    double operator()(int j , int i) const {
      assert(etat != ETATNONDEF) ;
      assert( (i>=0) && (i<std->dim.dim[0]) ) ;
      assert( (j>=0) && (j<std->dim.dim[1]) ) ;
      if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
      }
      else return std->t[std->dim.dim[0] * j + i] ;
    };
    
    // Passage matrice a bande
    void set_band (int up, int low) const ;
    
    // Decomposition LU
    void set_lu () const ;
        
    // Inversion de la matrice
    Tbl inverse (const Tbl& sec_membre) const ;

    // Les valeurs propres :
    Tbl val_propre() const ;    
    Matrice vect_propre() const ;
    
    double determinant() const ;

    Matrice transpose() const ;
    

    // Member arithmetics
    // ------------------
    public:
    void operator+=(const Matrice &) ; 
    void operator+=(double) ; 
    void operator-=(const Matrice &) ;  
    void operator-=(double) ; 
    void operator*=(double) ; 
    void operator/=(double) ; 

    // Operateurs amis
    friend Matrice operator+ (const Matrice&, const Matrice& ) ;
    friend Matrice operator- (const Matrice&, const Matrice& ) ;
    friend Matrice operator* (const Matrice&, double ) ;
    friend Matrice operator* (double, const Matrice& ) ;
    friend Matrice operator* (const Matrice&, const Matrice& ) ;
    friend Matrice operator/ (const Matrice&,  double ) ;
} ;
ostream& operator<<(ostream& , const Matrice& ) ; 

Matrice operator+ (const Matrice&, const Matrice& ) ; 
Matrice operator- (const Matrice&, const Matrice& ) ; 
Matrice operator* (const Matrice&, double ) ;
Matrice operator* (double, const Matrice& ) ;
Matrice operator* (const Matrice&, const Matrice& ) ; 
Matrice operator/ (const Matrice&,  double ) ; 

}
#endif