/usr/include/lorene/C++/Include/itbl.h is in liblorene-dev 0.0.0~cvs20161116+dfsg-1ubuntu4.
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 | /*
* Definition of Lorene class Itbl
*
*/
/*
* 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 __ITBL_H_
#define __ITBL_H_
/*
* Classe de tableaux d'entiers de dimension determinee (actuellement 1, 2 et 3)
*
*/
/*
* $Id: itbl.h,v 1.9 2014/10/13 08:52:35 j_novak Exp $
* $Log: itbl.h,v $
* Revision 1.9 2014/10/13 08:52:35 j_novak
* Lorene classes and functions now belong to the namespace Lorene.
*
* Revision 1.8 2014/10/06 15:09:39 j_novak
* Modified #include directives to use c++ syntax.
*
* Revision 1.7 2004/03/24 14:53:39 j_novak
* Double declarations suppressed
*
* Revision 1.6 2004/03/22 13:12:41 j_novak
* Modification of comments to use doxygen instead of doc++
*
* Revision 1.5 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.4 2003/10/11 16:43:05 e_gourgoulhon
*
* IMPORTANT CHANGE: the standard constructors sets now the logical state
* to ETATQCQ, and no longer to ETATNONDEF.
*
* Revision 1.3 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.2 2002/06/17 14:05:16 j_novak
* friend functions are now also declared outside the class definition
*
* Revision 1.1.1.1 2001/11/20 15:19:27 e_gourgoulhon
* LORENE
*
* Revision 2.2 1999/11/23 13:16:12 eric
* Le constructeur Itbl::Itbl(const Dim_tbl ) devient desormais
* Itbl::Itbl(const Dim_tbl& ).
* Modif commentaires (taille 0 autorisee).
*
* Revision 2.1 1999/11/19 12:02:17 phil
* /
*
* Revision 2.0 1999/11/17 16:04:27 phil
* *** empty log message ***
*
* Revision 1.1 1999/11/17 16:03:06 phil
* Initial revision
*
*
* $Header: /cvsroot/Lorene/C++/Include/itbl.h,v 1.9 2014/10/13 08:52:35 j_novak Exp $
*
*/
// Fichiers includes
#include <cassert>
#include <cstdlib>
#include "type_parite.h"
#include "dim_tbl.h"
namespace Lorene {
/**
* Basic integer array class.
*
* This class is essentially an \c int array class. The elements of the
* array are stored continuously using the C convention.
*
* The general logical state of an initialized
* \c Itbl is \c ETATQCQ ; it is the only state for which the memory
* allocation is performed for the \c int array \c t .
* The value zero is treated as a special logical state (\c ETATZERO ),
* without any memory allocation.
*
* Contrary to a \c Tbl , an \c Itbl is initialy created in a
* logical state \c ETATQCQ (i.e. ordinary state, with memory allocated
* for the array \c t ).
*
* Arithmetic operations are provided with the usual meaning (see
* below).
*
* A 1D Itbl can be of dimension 0 (size 0). Its logical state is then
* \c ETATZERO (by convention).
*
* \ingroup (util)
*/
class Itbl {
// Data :
// -----
private:
/// logical state (\c ETATNONDEF , \c ETATQCQ or \c ETATZERO ).
int etat ;
public:
Dim_tbl dim ; ///< Number of dimensions, size,...
int* t ; ///< The array of \c int 's
// Constructors - Destructor
// -------------------------
public:
/**
* 1D constructor.
* This constructor sets the \c Itbl in the logical state \c ETATQCQ ,
* so that it is ready for initialization via the method \c set(int ) .
*
* @param size0 [input] Number of elements of the array \c t .
* Will be assigned to \c dim.dim[0] .
* The size 0 is allowed (the corresponding
* logical state will be then ETATZERO).
*/
explicit Itbl(int size0) ;
/**
* 2D constructor.
* This constructor sets the \c Itbl in the logical state \c ETATQCQ ,
* so that it is ready for initialization via the method
* \c set(int, int ) .
*
* @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] .
*/
Itbl(int size1, int size0) ;
/**
* 3D constructor
* This constructor sets the \c Itbl in the logical state \c ETATQCQ ,
* so that it is ready for initialization via the method
* \c set(int, int, int ) .
*
* @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] .
*/
Itbl(int size2, int size1, int size0) ;
/** Constructor from a \c Dim_tbl .
* This constructor sets the \c Itbl in the logical state \c ETATQCQ ,
* so that it is ready for initialization via the method
* \c set .
*/
explicit Itbl(const Dim_tbl& ) ;
/// Constructor from a file (see \c sauve(FILE* ) )
explicit Itbl(FILE* ) ;
Itbl(const Itbl& ) ; ///< Copy constructor
~Itbl() ; ///< Destructor
// Assignement
// -----------
void operator=(const Itbl& ) ; ///< Assignment to another \c Itbl
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 int array \c t .
*/
void set_etat_nondef() ;
/**
* Sets the logical state to \c ETATZERO (zero).
* Deallocates the memory occupied by the \c int 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 int array \c t .
*/
void set_etat_qcq() ;
/**
* Sets the \c Itbl 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 int 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)
int& set(int i) {
assert (etat == ETATQCQ) ;
assert( dim.ndim == 1 ) ;
assert( i >= 0 ) ;
assert( i < dim.dim[0] ) ;
return t[i] ;
} ;
/// Read-only of a particular element (index \c i ) (1D case)
int operator()(int i) const {
assert(etat != ETATNONDEF) ;
assert( dim.ndim == 1 ) ;
assert( i >= 0 ) ;
assert( i < dim.dim[0] ) ;
if (etat == ETATZERO) {
int zero = 0 ;
return zero ;
}
else return t[i] ;
};
/// Read/write of a particular element (index \c (j,i) ) (2D case)
int& 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)
int 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) {
int 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)
int& 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)
int 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) {
int zero = 0 ;
return zero ;
}
else return t[dim.dim[1]*dim.dim[0]*k + dim.dim[0]*j + i] ;
};
// 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 \c i th dimension (ie {tt 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
/// Display
friend ostream& operator<<(ostream& , const Itbl& ) ;
// Member arithmetics
// ------------------
public:
void operator+=(const Itbl &) ; ///< Addition of a \c Itbl to \c this
void operator+=(int) ; ///< Addition of a \c int to \c this
void operator-=(const Itbl &) ; ///< Subtraction of a \c Itbl to \c this
void operator-=(int) ; ///< Subtraction of a \c int to \c this
void operator*=(const Itbl &) ; ///< Multiplication of \c this by a \c Itbl
void operator*=(int) ; ///< Multiplication of \c this by a \c int
} ;
ostream& operator<<(ostream& , const Itbl& ) ;
/**
* \defgroup itb_mat Itbl Mathematics
* \ingroup (util)
*
* @{
*/
Itbl operator+(const Itbl&) ; ///< + Ibl
Itbl operator-(const Itbl&) ; ///< - Itbl
Itbl operator+(const Itbl&, const Itbl&) ; ///< Itbl + Itbl
Itbl operator+(const Itbl&, int) ; ///< Itbl + int
Itbl operator+(int a, const Itbl& b) ; ///< int + Itbl
Itbl operator-(const Itbl&, const Itbl&) ; ///< Itbl - Itbl
Itbl operator-(const Itbl&, int) ; ///< Itbl - int
Itbl operator-(int, const Itbl&) ; ///< int - Itbl
Itbl operator*(const Itbl&, const Itbl&) ; ///< Itbl * Itbl
Itbl operator*(const Itbl&, int) ; ///< Itbl * int
Itbl operator*(int, const Itbl&) ; ///< int * Itbl
Itbl abs(const Itbl& ) ; ///< Absolute value
int max(const Itbl& ) ; ///< Maximum value of the \c Itbl elements
int min(const Itbl& ) ; ///< Minimum value of the \c Itbl elements
/// Sum of the absolute values of all the \c Itbl elements
int norme(const Itbl& ) ;
/**
* Relative difference between two \c Itbl (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 Itbl& a, const Itbl& b) ;
/**
* Relative difference between two \c Itbl (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 Itbl& a, const Itbl& b) ;
/** @}*/
}
#endif
|