/usr/include/openturns/TensorImplementation.hxx is in libopenturns-dev 0.15-2.
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 | // -*- C++ -*-
/**
* @file TensorImplementation.hxx
* @brief TensorImplementation implements the Tensor classes
*
* (C) Copyright 2005-2011 EDF-EADS-Phimeca
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: TensorImplementation.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_TENSORIMPLEMENTATION_HXX
#define OPENTURNS_TENSORIMPLEMENTATION_HXX
#include "PersistentCollection.hxx"
#include "NumericalPoint.hxx"
#include "Exception.hxx"
#include "Matrix.hxx"
#include "SymmetricMatrix.hxx"
namespace OpenTURNS
{
namespace Base
{
namespace Type
{
/**
* @class TensorImplementation
*
* TensorImplementation implements the Tensor classes
*/
class TensorImplementation
: public PersistentCollection<NumericalScalar>
{
CLASSNAME;
public:
typedef Common::InvalidDimensionException InvalidDimensionException ;
typedef Common::InvalidArgumentException InvalidArgumentException ;
/** Default constructor */
TensorImplementation();
/** Constructor with size (rowDim, colDim, sheetDim) */
TensorImplementation(const UnsignedLong rowDim,
const UnsignedLong colDim,
const UnsignedLong sheetDim);
/** Constructor from range of external collection */
template <class InputIterator>
TensorImplementation(const UnsignedLong rowDim,
const UnsignedLong colDim,
const UnsignedLong sheetDim,
InputIterator first,
InputIterator last);
/** Constructor from external collection */
/** If the dimensions don't correspond with the size of the collection, */
/** the collection is either truncated or completed with zeros*/
TensorImplementation(const UnsignedLong rowDim,
const UnsignedLong colDim,
const UnsignedLong sheetDim,
const Collection<NumericalScalar> & elementsValues);
/** Virtual constructor */
virtual TensorImplementation * clone() const;
/** String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Operator () gives access to the elements of the tensor (to modify these elements) */
/** The element of the tensor is designated by its row number i, its column number j and its sheet number k */
NumericalScalar & operator () (const UnsignedLong i,
const UnsignedLong j,
const UnsignedLong k) /* throw(InvalidDimensionException) */;
/** Operator () gives access to the elements of the tensor (read only) */
/** The element of the tensor is designated by its row number i, its column number j and its sheet number k */
const NumericalScalar & operator () (const UnsignedLong i,
const UnsignedLong j,
const UnsignedLong k) const /* throw(InvalidDimensionException) */;
/** getSheet returns the sheet specified by its sheet number k */
Matrix getSheet(const UnsignedLong k) const /* throw(InvalidDimensionException) */;
/** setSheet sets matrix m as the sheet specified by its sheet number k */
void setSheet(const UnsignedLong k,
const Matrix & m) /* throw(InvalidDimensionException) */;
/** getSheetSym returns the symmetric sheet specified by its sheet number k */
SymmetricMatrix getSheetSym(const UnsignedLong k) const /* throw(InvalidDimensionException) */;
/** setSheetSym sets symmetric matrix m as the sheet specified by its sheet number k */
void setSheetSym(const UnsignedLong k,
const SymmetricMatrix & m) /* throw(InvalidDimensionException, InvalidArgumentException) */;
/** Get the dimensions of the tensor */
/** Number of rows */
const UnsignedLong getNbRows() const ;
/** Number of columns */
const UnsignedLong getNbColumns() const ;
/** Number of sheets */
const UnsignedLong getNbSheets() const ;
/** Symmetrize TensorImplementation in case it is a symmetric tensor (stored as a set of triangular matrix sheets) */
void symmetrize() const;
/** Comparison operators */
Bool operator == (const TensorImplementation & rhs) const ;
/** Empty returns true if there is no element in the tensor */
const Bool isEmpty() const ;
/** Method save() stores the object through the StorageManager */
void save(StorageManager::Advocate & adv) const;
/** Method load() reloads the object from the StorageManager */
void load(StorageManager::Advocate & adv);
protected:
/** TensorImplementation Dimensions */
UnsignedLong nbRows_;
UnsignedLong nbColumns_;
UnsignedLong nbSheets_;
/** Position conversion function : the indices i & j are used to compute the actual position of the element in the collection */
inline UnsignedLong convertPosition (const UnsignedLong i,
const UnsignedLong j,
const UnsignedLong k) const ;
}; /* class TensorImplementation */
/** Constructor from range of external collection */
template <class InputIterator>
TensorImplementation::TensorImplementation(const UnsignedLong rowDim,
const UnsignedLong colDim,
const UnsignedLong sheetDim,
InputIterator first,
InputIterator last)
: PersistentCollection<NumericalScalar>(rowDim * colDim * sheetDim),
nbRows_(rowDim),
nbColumns_(colDim),
nbSheets_(sheetDim)
{
this->assign(first, last);
}
/** Inline functions */
inline UnsignedLong TensorImplementation::convertPosition (const UnsignedLong i,
const UnsignedLong j,
const UnsignedLong k) const
{
return i + nbRows_ * (j + nbColumns_ * k) ;
}
} /* namespace Common */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_TENSORIMPLEMENTATION_HXX */
|