/usr/include/lorene/C++/Include/tbl.h is in liblorene-dev 0.0.0~cvs20161116+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 | /*
* 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.13 2014/10/13 08:52:37 j_novak Exp $
* $Log: tbl.h,v $
* 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.13 2014/10/13 08:52:37 j_novak Exp $
*
*/
// Fichiers includes
#include <cassert>
#include <cstdlib>
#include "type_parite.h"
#include "dim_tbl.h"
#include "itbl.h"
namespace Lorene {
class Grille3d ;
class Matrice ;
/**
* Basic array class.
*
* This class is essentially an \c double array class. The elements of the
* array are stored continuously using the C convention.
* A \c Tbl is initialy created with a \a logical state
* \c ETATNONDEF (i.e. undefined), except by the copy constructor and
* the constructor from a file.
* The general logical state of an initialized
* \c Tbl is \c ETATQCQ; it is the only state for which the memory
* allocation is performed for the \c double} array \c t.
* The value zero is treated as a special logical state (\c ETATZERO),
* without any memory allocation.
* Arithmetic operations are provided with the usual meaning (see
* below).
* \ingroup (util)
*
*/
class Tbl {
friend class Matrice ;
// Data :
// -----
private:
/// logical state (\c ETATNONDEF, \c ETATQCQ or \c ETATZERO).
int etat ;
public:
Dim_tbl dim ; ///< Number of dimensions, size,...
double* t ; ///< The array of \c double
// Constructors - Destructor
// -------------------------
public:
/**
* 1D constructor
* @param size0 [input] Number of elements of the array \c t.
* Will be assigned to \c dim.dim[0].
*/
explicit Tbl(int size0) ;
/**
* 2D constructor
* @param size1 [input] Defines the range [0, size1-1] of the
* outermost index in the storage of the array \c t.
* Will be assigned to \c dim.dim[1].
* @param size0 [input] Defines the range [0, size0-1] of the
* innermost index in the storage of the array \c t.
* Will be assigned to \c dim.dim[0].
*/
Tbl(int size1, int size0) ;
/**
* 3D constructor
* @param size2 [input] Defines the range [0, size2-1] of the
* outermost index in the storage of the array \c t.
* Will be assigned to \c dim.dim[2].
* @param size1 [input] Defines the range [0, size1-1] of the
* intermediate index in the storage of the array \c t.
* Will be assigned to \c dim.dim[1].
* @param size0 [input] Defines the range [0, size0-1] of the
* innermost index in the storage of the array \c t.
* Will be assigned to \c dim.dim[0].
*/
Tbl(int size2, int size1, int size0) ;
/**
* N-dimensional constructor
* @param sizes [input] the sizes of each dimensions
*/
Tbl(Itbl sizes) ;
explicit Tbl(const Grille3d& grid) ; ///< Constructor from a 3D grid
explicit Tbl(const Dim_tbl& dim) ; ///< Constructor from a \c Dim_tbl
/// Constructor from a file (see \c sauve(FILE* ))
explicit Tbl(FILE* ) ;
Tbl(const Tbl& a) ; ///< Copy constructor
/** Constructor from a matrix.
* If the matrix has only one row or one column, the \c Tbl
* is 1D, otherwise it is 2D.
*/
explicit Tbl(const Matrice& mat) ;
~Tbl() ; ///< Destructor
// Assignement
// -----------
void operator=(const Tbl& ) ; ///< Assignment to another \c Tbl
void operator=(double ) ; ///< Assignment to a \c double
void operator=(int ) ; ///< Assignment to a \c int
// Memory management
// -----------------
private:
/** Logical destructor: dellocates the memory occupied by the array
* \c t and sets the logical state to ETATNONDEF.
*/
void del_t() ;
public:
/**
* Sets the logical state to \c ETATNONDEF (undefined).
* Deallocates the memory occupied by the \c double array \c t.
*/
void set_etat_nondef() ;
/**
* Sets the logical state to \c ETATZERO (zero).
* Deallocates the memory occupied by the \c double array \c t.
*/
void set_etat_zero() ;
/**
* Sets the logical state to \c ETATQCQ (ordinary state).
* If the state (member \c etat) is already \c ETATQCQ, this
* function does nothing. Otherwise, it performs the memory allocation
* for the \c double array \c t.
*/
void set_etat_qcq() ;
/**
* Sets the \c Tbl to zero in a hard way.
* 1/ Sets the logical state to \c ETATQCQ, i.e. to an ordinary state.
* 2/ Allocates the memory of the \c double array \c t, and fills it
* with zeros. NB: this function must be used for debugging purposes only.
* For other operations, the function \c set_etat_zero() must
* be perferred.
*/
void annule_hard() ;
// Access to individual elements
// -----------------------------
public:
/// Read/write of a particular element (index \c i) (1D case)
double& set(int i) {
assert (etat == ETATQCQ) ;
assert( dim.ndim == 1 ) ;
assert( i >= 0 ) ;
assert( i < dim.dim[0] ) ;
return t[i] ;
} ;
/// Affectation of a particular element (index \c i) (1D case)
void affecte(int i, double val) {
assert (etat == ETATQCQ) ;
assert( dim.ndim == 1 ) ;
assert( i >= 0 ) ;
assert( i < dim.dim[0] ) ;
t[i] = val ;
} ;
/// Read-only of a particular element (index \c i) (1D case)
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] ;
};
/// Read/write of a particular element (index \c (j,i)) (2D case)
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] ;
};
/// Read-only of a particular element (index \c (j,i)) (2D case)
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] ;
};
/// Read/write of a particular element (index \c (k,j,i)) (3D case)
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] ;
};
/// Read-only of a particular element (index \c (k,j,i)) (3D case)
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] ;
};
/// Read/write of a particular element (multi-dimensional case)
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] ;
};
/// Read-only of a particular element (index \c (k,j,i)) (multi-dimensional case)
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
// -------------------------
/// Gives the logical state
int get_etat() const { return etat ; };
/// Gives the total size (ie \c dim.taille)
int get_taille() const { return dim.taille ; };
/// Gives the number of dimensions (ie \c dim.ndim)
int get_ndim() const { return dim.ndim ; };
/// Gives the i-th dimension (ie \c dim.dim[i])
int get_dim(int i) const {
assert( (i>=0) && (i<dim.ndim) ) ;
return dim.dim[i] ;
};
// Outputs
// -------
public:
void sauve(FILE* ) const ; ///< Save in a file
/** Prints only the values greater than a given threshold.
* @param ostr [input] Output stream used for the printing
* @param precision [input] Number of printed digits (default: 4)
* @param threshold [input] Value above which an array element is printed
* (default: 1.e-7)
*/
void affiche_seuil(ostream& ostr, int precision = 4,
double threshold = 1.e-7) const ;
/// Display
friend ostream& operator<<(ostream& , const Tbl& ) ;
// Member arithmetics
// ------------------
public:
void operator+=(const Tbl &) ; ///< Addition of a \c Tbl to \c this
void operator+=(double) ; ///< Addition of a \c double to \c this
void operator-=(const Tbl &) ; ///< Subtraction of a \c Tbl to \c this
void operator-=(double) ; ///< Subtraction of a \c double to \c this
void operator*=(const Tbl &) ; ///< Multiplication of \c this by a \c Tbl
void operator*=(double) ; ///< Multiplication of \c this by a \c double
void operator/=(const Tbl &) ; ///< Division of \c this by a \c Tbl
void operator/=(double) ; ///< Division of \c this by a \c double
} ;
ostream& operator<<(ostream& , const Tbl& ) ;
/**
* \defgroup tbl_m Tbl Mathematics
* \ingroup (util)
* @{
*/
Tbl operator+(const Tbl&) ; ///< + Tbl
Tbl operator-(const Tbl&) ; ///< \c - Tbl
Tbl operator+(const Tbl&, const Tbl&) ; ///< Tbl + Tbl
Tbl operator+(const Tbl&, double) ; ///< Tbl + double
Tbl operator+(double, const Tbl&) ; ///< double + Tbl
Tbl operator+(const Tbl&, int) ; ///< Tbl + int
Tbl operator+(int, const Tbl&) ; ///< int + Tbl
Tbl operator-(const Tbl&, const Tbl&) ; ///< Tbl - Tbl
Tbl operator-(const Tbl&, double) ; ///< Tbl - double
Tbl operator-(double, const Tbl&) ; ///< double - Tbl
Tbl operator-(const Tbl&, int) ; ///< Tbl - int
Tbl operator-(int, const Tbl&) ; ///< int - Tbl
Tbl operator*(const Tbl&, const Tbl&) ; ///< Tbl * Tbl
Tbl operator*(const Tbl&, double) ; ///< Tbl * double
Tbl operator*(double, const Tbl&) ; ///< double * Tbl
Tbl operator*(const Tbl&, int) ; ///< Tbl * int
Tbl operator*(int, const Tbl&) ; ///< int * Tbl
Tbl operator/(const Tbl&, const Tbl&) ; ///< Tbl / Tbl
Tbl operator/(const Tbl&, double) ; ///< Tbl / double
Tbl operator/(double, const Tbl&) ; ///< double / Tbl
Tbl operator/(const Tbl&, int) ; ///< Tbl / int
Tbl operator/(int, const Tbl&) ; ///< int / Tbl
Tbl sin(const Tbl& ) ; ///< Sine
Tbl cos(const Tbl& ) ; ///< Cosine
Tbl tan(const Tbl& ) ; ///< Tangent
Tbl asin(const Tbl& ) ; ///< Arcsine
Tbl acos(const Tbl& ) ; ///< Arccosine
Tbl atan(const Tbl& ) ; ///< Arctangent
Tbl exp(const Tbl& ) ; ///< Exponential
Tbl Heaviside(const Tbl& ) ; ///< Heaviside function
Tbl log(const Tbl& ) ; ///< Neperian logarithm
Tbl log10(const Tbl& ) ; ///< Basis 10 logarithm
Tbl sqrt(const Tbl& ) ; ///< Square root
Tbl racine_cubique (const Tbl&) ; ///< cube root
Tbl pow(const Tbl& , int ) ; ///< Power \f${\tt Tbl}^{\tt int}\f$
Tbl pow(const Tbl& , double ) ; ///< Power \f${\tt Tbl}^{\tt double}\f$
Tbl abs(const Tbl& ) ; ///< Absolute value
double max(const Tbl& ) ; ///< Maximum value of the \c Tbl elements
double min(const Tbl& ) ; ///< Minimum value of the \c Tbl elements
/// Sum of the absolute values of all the \c Tbl elements
double norme(const Tbl& ) ;
/**
* Relative difference between two \c Tbl (norme version).
* Returns \c norme(a-b)/norme(b) unless \c b=0, in which
* case it returns \c norme(a-b).
*/
double diffrel(const Tbl& a, const Tbl& b) ;
/**
* Relative difference between two \c Tbl (max version).
* Returns \c max(abs(a-b))/max(abs(b)) unless \c b=0, in which
* case it returns \c max(abs(a-b)).
*/
double diffrelmax(const Tbl& a, const Tbl& b) ;
/** @}*/
}
#endif
|