tbl.h

/*
 *  Definition of Lorene class Tbl
 *
 */

/*
 *   Copyright (c) 1999-2000 Jean-Alain Marck
 *   Copyright (c) 1999-2001 Eric Gourgoulhon
 *
 *   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 __TBL_H_
#define __TBL_H_

/*
 * Classe de tableaux de dimension determinee (actuellement 1, 2 et 3)
 *
 */

/*
 * $Id: tbl.h,v 1.14 2024/01/26 17:44:25 g_servignat Exp $
 * $Log: tbl.h,v $
 * Revision 1.14  2024/01/26 17:44:25  g_servignat
 * Updated the Pseudopolytrope_1D class to be consistent with the paper (i.e. with a GPP in the middle)
 *
 * Revision 1.13  2014/10/13 08:52:37  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.12  2014/10/06 15:09:40  j_novak
 * Modified #include directives to use c++ syntax.
 *
 * Revision 1.11  2012/01/17 10:20:57  j_penner
 * function added: Heaviside
 *
 * Revision 1.10  2006/09/25 10:01:45  p_grandclement
 * Addition of N-dimensional Tbl
 *
 * Revision 1.9  2004/12/02 09:33:04  p_grandclement
 * *** empty log message ***
 *
 * Revision 1.8  2004/03/22 13:12:43  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.7  2003/11/06 14:43:37  e_gourgoulhon
 * Gave a name to const arguments in certain method prototypes (e.g.
 * constructors) to correct a bug of DOC++.
 *
 * Revision 1.6  2002/10/16 14:36:29  j_novak
 * Reorganization of #include instructions of standard C++, in order to
 * use experimental version 3 of gcc.
 *
 * Revision 1.5  2002/09/24 10:49:42  e_gourgoulhon
 *
 * Modif commentaires.
 *
 * Revision 1.4  2002/09/24 08:33:35  e_gourgoulhon
 *
 * Added constructor from Matrice
 *
 * 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.11  1999/12/02  17:52:59  phil
 * *** empty log message ***
 *
 * Revision 2.10  1999/11/23  13:31:27  eric
 * Le constructeur Tbl::Tbl(const Dim_tbl ) devient Tbl::Tbl(const Dim_tbl& ).
 * Le constructeur Tbl::Tbl(const Grille3d* ) devient
 *   Tbl(const Grille3d& ).
 *
 * Revision 2.9  1999/11/15  16:36:08  eric
 * Le membre dim est desormais un Dim_tbl et non plus un pointeur sur un
 * Dim_tbl.
 *
 * Revision 2.8  1999/10/29  15:04:07  eric
 * Suppression des fonctions membres min() et max():
 * elles deviennent des fonctions externes.
 * Ajout de fonctions mathematiques (abs, norme, etc...).
 *
 * Revision 2.7  1999/10/18  15:05:48  eric
 * La fonction membre annule() est rebaptisee annule_hard().
 *
 * Revision 2.6  1999/10/01  10:18:18  eric
 * Amelioration des commentaires.
 *
 * Revision 2.5  1999/09/30  12:50:59  eric
 *  Constructeur a 1 parametre rendu explicit.
 * Amelioration des commentaires.
 *
 * Revision 2.4  1999/09/24  14:23:01  eric
 * Depoussierage.
 * Documentation.
 *
 * Revision 2.3  1999/03/02  18:54:36  eric
 * Ajout de la fonction affiche_seuil.
 *
 * Revision 2.2  1999/02/23  10:40:55  hyc
 * *** empty log message ***
 *
 *
 * Revision 2.0  1998/12/02  11:11:16  hyc
 * Version 2
 *
 * $Header: /cvsroot/Lorene/C++/Include/tbl.h,v 1.14 2024/01/26 17:44:25 g_servignat Exp $
 *
 */


// Fichiers includes
#include <cassert>
#include <cstdlib>

#include "type_parite.h"
#include "dim_tbl.h"
#include "itbl.h"

namespace Lorene {
class Grille3d ;
class Matrice ;


class Tbl {

  friend class Matrice ;

    // Data : 
    // -----
    private:
    int etat ;  

    public:
        Dim_tbl dim ;       
    double* t ;     

    // Constructors - Destructor
    // -------------------------
    
    public:
    explicit Tbl(int size0) ;           

    Tbl(int size1, int size0) ;     
    
    Tbl(int size2, int size1, int size0) ;  

    Tbl(int size3, int size2, int size1, int size0) ;       
    Tbl(Itbl sizes) ;   
    
    explicit Tbl(const Grille3d& grid) ; 
    explicit Tbl(const Dim_tbl& dim) ;   
    explicit Tbl(FILE* ) ;  
    Tbl(const Tbl& a) ;     
    
    explicit Tbl(const Matrice& mat) ;
    

    ~Tbl() ;            

    // Assignement
    // -----------
    void operator=(const Tbl& ) ;   
    void operator=(double ) ; 
    void operator=(int ) ;   

    // Memory management
    // -----------------
    private:
    void del_t() ;      

    public:

    void set_etat_nondef() ;    
    
    void set_etat_zero() ;          

    void set_etat_qcq() ;           
    
    void annule_hard() ;            
    
    // Access to individual elements
    // -----------------------------
    public:
    double& set(int i) {
        assert (etat == ETATQCQ) ;
        assert( dim.ndim == 1 ) ; 
        assert( i >= 0 ) ; 
        assert( i < dim.dim[0] ) ;
        return t[i] ;
    } ;
    
    void affecte(int i, double val) {
        assert (etat == ETATQCQ) ;
        assert( dim.ndim == 1 ) ; 
        assert( i >= 0 ) ; 
        assert( i < dim.dim[0] ) ;
        t[i] = val ;
    } ;
    double operator()(int i) const {
        assert(etat != ETATNONDEF) ;
        assert( dim.ndim == 1 ) ; 
        assert( i >= 0 ) ; 
        assert( i < dim.dim[0] ) ;
        if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
        }
        else return t[i] ;
    };

    double& set(int j, int i) {
        assert (etat == ETATQCQ) ;
        assert( dim.ndim == 2 ) ;
        assert( (i>=0) && (i<dim.dim[0]) ) ;
        assert( (j>=0) && (j<dim.dim[1]) ) ;
        return t[dim.dim[0] * j + i] ;
    };

    double operator()(int j, int i) const {
        assert(etat != ETATNONDEF) ;
        assert( dim.ndim == 2 ) ;
        assert( (i>=0) && (i<dim.dim[0]) ) ;
        assert( (j>=0) && (j<dim.dim[1]) ) ;
        if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
        }
        else return t[dim.dim[0] * j + i] ;
    };

    double& set(int k, int j, int i) {  
        assert (etat == ETATQCQ) ;
        assert( dim.ndim == 3 ) ;
        assert( (i>=0) && (i<dim.dim[0]) ) ;
        assert( (j>=0) && (j<dim.dim[1]) ) ;
        assert( (k>=0) && (k<dim.dim[2]) ) ;
        return t[dim.dim[1]*dim.dim[0]*k + dim.dim[0]*j + i] ;
    };

    double operator()(int k, int j, int i) const {
        assert(etat != ETATNONDEF) ;
        assert( dim.ndim == 3 ) ;
        assert( (i>=0) && (i<dim.dim[0]) ) ;
        assert( (j>=0) && (j<dim.dim[1]) ) ;
        assert( (k>=0) && (k<dim.dim[2]) ) ;
        if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
        }
        else return t[dim.dim[1]*dim.dim[0]*k + dim.dim[0]*j + i] ;
    };

    double& set(const Itbl place) {
        int n = place.get_dim(0) ;
        assert (n == dim.ndim) ;
        for (int i=0 ; i<n ; i++)
            assert( (place(i)>=0) && (place(i)<dim.dim[0]) ) ;
        int pos = 0 ;
        for (int d=n-1 ; d>=0 ; d--) {
             pos*=dim.dim[d] ;
         pos += place(d) ;
        }
        return t[pos] ;
    };

    double operator()(const Itbl place) const {
        assert(etat != ETATNONDEF) ;
        int n = place.get_dim(0) ;
        assert (n == dim.ndim) ;
        for (int i=0 ; i<n ; i++)
            assert( (place(i)>=0) && (place(i)<dim.dim[0]) ) ;
        if (etat == ETATZERO) {
        double zero = 0. ;
        return zero ; 
        }
        else {
            int pos = 0 ;
            for (int d=n-1 ; d>=0 ; d--) {
                pos*=dim.dim[d] ;
            pos += place(d) ;
            }
            return t[pos] ;
        }
    };

    // Extraction of information
    // -------------------------
    int get_etat() const { return etat ; }; 

    int get_taille() const { return dim.taille ; };

    int get_ndim() const { return dim.ndim ; };
    
    int get_dim(int i) const {  
        assert( (i>=0) && (i<dim.ndim) ) ;
        return dim.dim[i] ;
    };
    
    // Outputs
    // -------
    public:
    void sauve(FILE* ) const ;  

    void affiche_seuil(ostream& ostr, int precision = 4, 
               double threshold = 1.e-7) const ;
    friend ostream& operator<<(ostream& , const Tbl& ) ;    

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

} ;
ostream& operator<<(ostream& , const Tbl& ) ;   


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

Tbl sin(const Tbl& ) ;      
Tbl cos(const Tbl& ) ;      
Tbl tan(const Tbl& ) ;      
Tbl asin(const Tbl& ) ;     
Tbl acos(const Tbl& ) ;     
Tbl atan(const Tbl& ) ;     
Tbl exp(const Tbl& ) ;      
Tbl Heaviside(const Tbl& ) ;        
Tbl log(const Tbl& ) ;      
Tbl log10(const Tbl& ) ;    
Tbl sqrt(const Tbl& ) ;     
Tbl racine_cubique (const Tbl&) ; 
Tbl pow(const Tbl& , int ) ;  
Tbl pow(const Tbl& , double ) ; 
Tbl abs(const Tbl& ) ;      
double max(const Tbl& ) ;   
double min(const Tbl& ) ;   

double norme(const Tbl& ) ;   

double diffrel(const Tbl& a, const Tbl& b) ; 

double diffrelmax(const Tbl& a, const Tbl& b) ; 

}
#endif