doc/doxygen/fakesources/MEDCouplingMemArray.C

   1 // This file contains some code used for
   2 // 1) generation of documentation for inline methods of array classes
   3 // 2) grouping all methods into 3 lists" "Basic API", "Advanced API" and "Others..."
   4
   5 /* class ParaMEDMEM::DataArray
   6  * @defgroup basic_api Basic API
   7  * @defgroup adv_api   Advanced API
   8  */
   9
  10 namespace ParaMEDMEM
  11 {
  12 /*!
  13  * Returns the attribute \a _name of \a this array.
  14  * See \ref MEDCouplingArrayBasicsName "DataArrays infos" for more information.
  15  *  \return std::string - array name
  16  */
  17 std::string DataArray::getName() const {}
  18
  19 /*!
  20  * Returns number of components of \a this array.
  21  * See \ref MEDCouplingArrayBasicsTuplesAndCompo "DataArrays infos" for more information.
  22  *  \return int - number of components
  23  */
  24 int DataArray::getNumberOfComponents() const {}
  25
  26 /*!
  27  * Returns number of tuples of \a this array.
  28  * See \ref MEDCouplingArrayBasicsName "DataArrays infos" for more information.
  29  *  \return int - number of tuples
  30  */
  31 int DataArray::getNumberOfTuples() const {}
  32
  33 /*!
  34  * Returns number of elements of \a this array.
  35  * See \ref MEDCouplingArrayBasicsName "DataArrays infos" for more information.
  36  *  \return int - number of elements == <em> this->getNumberOfTuples() *
  37  *          this->getNumberOfComponents() </em>
  38  */
  39 int DataArray::getNbOfElems() const {}
  40
  41 /*!
  42  * Throws an exception if number of elements in \a this array differs from a given one.
  43  * See \ref MEDCouplingArrayBasicsName "DataArrays infos" for more information.
  44  *  \param [in] nbOfElems - expected array size.
  45  *  \param [in] msg - message to return within the thrown exception.
  46  *  \throw if <em> this->getNbOfElems() != nbOfElems</em>.
  47  */
  48 void DataArray::checkNbOfElems(int nbOfElems, const char *msg) const {}
  49
  50 /*!
  51  * Returns values of a specified tuple.
  52  *  \param [in] tupleId - index of the tuple of interest.
  53  *  \param [out] res - C array returning values of the \a tupleId-th tuple. The \a res
  54  *         must be allocated by the caller and be of size not less than \a
  55  *         this->getNumberOfComponents().
  56  */
  57 void DataArrayDouble::getTuple(int tupleId, double *res) const {}
  58
  59 /*!
  60  * Returns a value of a specified element of \a this array.
  61  *  \param [in] tupleId - index of the tuple of interest.
  62  *  \param [in] compoId - index of the component of interest.
  63  *  \return double - the value of \a compoId-th component of \a tupleId-th tuple.
  64  */
  65 double DataArrayDouble::getIJ(int tupleId, int compoId) const {}
  66
  67 /*!
  68  * Returns a pointer to the first element of the raw data of \a this array.
  69  *  \return double* - the pointer to the value of 0-th tuple and 0-th component.
  70  */
  71 double * DataArrayDouble::getPointer() {}
  72
  73 /*!
  74  * Returns a const pointer to the first element of the raw data of \a this array.
  75  *  \return const double* - the pointer to the value of 0-th tuple and 0-th component.
  76  */
  77 const double * DataArrayDouble::getConstPointer() const {}
  78
  79 /*!
  80  * Assigns a given value to a specified element of \a this array.
  81  *  \param [in] tupleId - index of the tuple to modify.
  82  *  \param [in] compoId - index of the component to modify.
  83  *  \param [in] newVal - the value to assign to the value at \a compoId-th component
  84  *              of \a tupleId-th tuple.
  85  */
  86 void DataArrayDouble::setIJ(int tupleId, int compoId, double newVal) {}
  87
  88 /*!
  89  * Assigns a given value to a specified element of \a this array which is not marked
  90  * as changed.
  91  *  \param [in] tupleId - index of the tuple to modify.
  92  *  \param [in] compoId - index of the component to modify.
  93  *  \param [in] newVal - the value to assign to the value at \a compoId-th component
  94  *              of \a tupleId-th tuple.
  95  */
  96 void DataArrayDouble::setIJSilent(int tupleId, int compoId, double newVal) {}
  97
  98 /*!
  99  * Copies values from another array starting from a specified element of \a this.
 100  *  \param [in] id - index of element to assign the value \a element0 to.
 101  *  \param [in] element0 - value to assign to the \a id-th element of \a this.
 102  *  \param [in] others - values to assign to elements following the \a id-th
 103  *         element of \a this.
 104  *  \param [in] sizeOfOthers - number of values to copy from \a others.
 105  */
 106 void DataArrayDouble::writeOnPlace(int id, double element0, const double *others, int sizeOfOthers) {}
 107
 108 /*!
 109  * Does nothing because this class does not aggregate any TimeLabel instance.
 110  */
 111 void DataArrayDouble::updateTime() const {}
 112
 113 /*!
 114  * Returns values of a specified tuple.
 115  *  \param [in] tupleId - index of the tuple of interest.
 116  *  \param [out] res - C array returning values of the \a tupleId-th tuple. The \a res
 117  *         must be allocated by the caller and be of size not less than \a
 118  *         this->getNumberOfComponents().
 119  *
 120  *  \ref py_mcdataarrayint_getTuple "Here is a Python example".
 121  */
 122 void DataArrayInt::getTuple(int tupleId, int *res) const {}
 123
 124 /*!
 125  * Returns a value of a specified element of \a this array.
 126  *  \param [in] tupleId - index of the tuple of interest.
 127  *  \param [in] compoId - index of the component of interest.
 128  *  \return int - the value of \a compoId-th component of \a tupleId-th tuple.
 129  */
 130 int DataArrayInt::getIJ(int tupleId, int compoId) const {}
 131
 132
 133 /*!
 134  * Assigns a given value to a specified element of \a this array.
 135  *  \param [in] tupleId - index of the tuple to modify.
 136  *  \param [in] compoId - index of the component to modify.
 137  *  \param [in] newVal - the value to assign to the value at \a compoId-th component
 138  *              of \a tupleId-th tuple.
 139  * \warning As this method declares \a this array as modified, it is more optimal to use
 140  *          setIJSilent() for modification of muliple values of array and to call
 141  *          declareAsNew() after the modification is done.
 142  */
 143 void DataArrayInt::setIJ(int tupleId, int compoId, int newVal) {}
 144
 145
 146 /*!
 147  * Assigns a given value to a specified element of \a this array which is \b not marked
 148  * as changed.
 149  *  \param [in] tupleId - index of the tuple to modify.
 150  *  \param [in] compoId - index of the component to modify.
 151  *  \param [in] newVal - the value to assign to the value at \a compoId-th component
 152  *              of \a tupleId-th tuple.
 153  */
 154 void DataArrayInt::setIJSilent(int tupleId, int compoId, int newVal) {}
 155
 156 /*!
 157  * Returns a pointer to the first element of the raw data of \a this array.
 158  *  \return int* - the pointer to the value of 0-th tuple and 0-th component.
 159  */
 160 int * DataArrayInt::getPointer() {}
 161
 162 /*!
 163  * Returns a const pointer to the first element of the raw data of \a this array.
 164  *  \return const int* - the pointer to the value of 0-th tuple and 0-th component.
 165  */
 166 const int * DataArrayInt::getConstPointer() const {}
 167
 168 /*!
 169  * Copies values from another array starting from a given element of \a this.
 170  *  \param [in] id - index of element to assign the value \a element0 to.
 171  *  \param [in] element0 - value to assign to the \a id-th element of \a this.
 172  *  \param [in] others - values to assign to elements following the \a id-th
 173  *         element of \a this.
 174  *  \param [in] sizeOfOthers - number of values to copy from \a others.
 175  */
 176 void DataArrayInt::writeOnPlace(int id, int element0, const int *others, int sizeOfOthers) {}
 177
 178 }
 179
 180 namespace ParaMEDMEM
 181 {
 182 //================================================================================
 183 /////////////////////// DataArray GROUPPING //////////////////////////////////////
 184 //================================================================================
 185
 186 /*! \name Basic API   */
 187 ///@{
 188 DataArray::setName(const char *name);
 189 DataArray::copyStringInfoFrom(const DataArray& other);
 190 DataArray::areInfoEquals(const DataArray& other) const;
 191 DataArray::getName() const;
 192 DataArray::setInfoOnComponents(const std::vector<std::string>& info);
 193 DataArray::getVarOnComponent(int i) const;
 194 DataArray::getUnitOnComponent(int i) const;
 195 DataArray::setInfoOnComponent(int i, const char *info);
 196 DataArray::getNumberOfComponents() const;
 197 DataArray::getNumberOfTuples() const;
 198 DataArray::getNbOfElems() const;
 199 DataArray::checkNbOfElems(int nbOfElems, const char *msg) const;
 200 DataArray::GetVarNameFromInfo(const std::string& info);
 201 DataArray::GetUnitFromInfo(const std::string& info);
 202 ///@}
 203
 204 /*! \name Others... */
 205 ///@{
 206 DataArray::getHeapMemorySize() const;
 207 DataArray::copyPartOfStringInfoFrom(const DataArray& other, const std::vector<int>& compoIds);
 208 DataArray::copyPartOfStringInfoFrom2(const std::vector<int>& compoIds, const DataArray& other);
 209 DataArray::areInfoEqualsIfNotWhy(const DataArray& other, std::string& reason) const;
 210 DataArray::reprWithoutNameStream(std::ostream& stream) const;
 211 DataArray::cppRepr(const char *varName) const;
 212 DataArray::getInfoOnComponents() const;
 213 DataArray::getInfoOnComponents();
 214 DataArray::getVarsOnComponent() const;
 215 DataArray::getUnitsOnComponent() const;
 216 DataArray::getInfoOnComponent(int i) const;
 217 DataArray::checkNbOfTuples(int nbOfTuples, const char *msg) const;
 218 DataArray::checkNbOfComps(int nbOfCompo, const char *msg) const;
 219 DataArray::checkNbOfTuplesAndComp(const DataArray& other, const char *msg) const throw(INTERP_KERNEL::Exception);
 220 DataArray::checkNbOfTuplesAndComp(int nbOfTuples, int nbOfCompo, const char *msg) const throw(INTERP_KERNEL::Exception);
 221 DataArray::GetNumberOfItemGivenBES(int begin, int end, int step, const char *msg);
 222 DataArray::GetNumberOfItemGivenBESRelative(int begin, int end, int step, const char *msg);
 223 DataArray::GetPosOfItemGivenBESRelativeNoThrow(int value, int begin, int end, int step);
 224 DataArray::reprCppStream(const char *varName, std::ostream& stream) const;
 225 DataArray::DataArray();
 226 DataArray::CheckValueInRange(int ref, int value, const char *msg);
 227 DataArray::CheckValueInRangeEx(int value, int start, int end, const char *msg);
 228 DataArray::CheckClosingParInRange(int ref, int value, const char *msg);
 229 std::string              DataArray::_name;
 230 std::vector<std::string> DataArray::_info_on_compo;
 231 ///@}
 232
 233 //================================================================================
 234 /////////////////////// DataArrayDouble GROUPPING ////////////////////////////////
 235 //================================================================================
 236
 237 /*! \name Basic API   */
 238 ///@{
 239 DataArrayDouble::isAllocated() const;
 240 DataArrayDouble::setInfoAndChangeNbOfCompo(const std::vector<std::string>& info);
 241 DataArrayDouble::doubleValue() const;
 242 DataArrayDouble::empty() const;
 243 DataArrayDouble::deepCpy() const;
 244 DataArrayDouble::performCpy(bool deepCpy) const;
 245 DataArrayDouble::cpyFrom(const DataArrayDouble& other);
 246 DataArrayDouble::alloc(int nbOfTuple, int nbOfCompo);
 247 DataArrayDouble::allocIfNecessary(int nbOfTuple, int nbOfCompo);
 248 DataArrayDouble::fillWithZero();
 249 DataArrayDouble::fillWithValue(double val);
 250 DataArrayDouble::iota(double init=0.);
 251 DataArrayDouble::isUniform(double val, double eps) const;
 252 DataArrayDouble::sort(bool asc=true);
 253 DataArrayDouble::reverse();
 254 DataArrayDouble::checkMonotonic(bool increasing, double eps) const;
 255 DataArrayDouble::isMonotonic(bool increasing, double eps) const;
 256 DataArrayDouble::repr() const;
 257 DataArrayDouble::isEqual(const DataArrayDouble& other, double prec) const;
 258 DataArrayDouble::isEqualWithoutConsideringStr(const DataArrayDouble& other, double prec) const;
 259 DataArrayDouble::reAlloc(int nbOfTuples);
 260 DataArrayDouble::convertToIntArr() const;
 261 DataArrayDouble::fromNoInterlace() const;
 262 DataArrayDouble::toNoInterlace() const;
 263 DataArrayDouble::renumberInPlace(const int* old2New);
 264 DataArrayDouble::renumberInPlaceR(const int* new2Old);
 265 DataArrayDouble::renumber(const int* old2New) const;
 266 DataArrayDouble::renumberR(const int* new2Old) const;
 267 DataArrayDouble::renumberAndReduce(const int* old2New, int newNbOfTuple) const;
 268 DataArrayDouble::selectByTupleId(const int* new2OldBg, const int* new2OldEnd) const;
 269 DataArrayDouble::selectByTupleIdSafe(const int* new2OldBg, const int* new2OldEnd) const;
 270 DataArrayDouble::selectByTupleId2(int bg, int end2, int step) const;
 271 DataArrayDouble::selectByTupleRanges(const std::vector<std::pair<int,int> >& ranges) const;
 272 DataArrayDouble::substr(int tupleIdBg, int tupleIdEnd=-1) const;
 273 DataArrayDouble::rearrange(int newNbOfCompo);
 274 DataArrayDouble::transpose();
 275 DataArrayDouble::changeNbOfComponents(int newNbOfComp, double dftValue) const;
 276 DataArrayDouble::keepSelectedComponents(const std::vector<int>& compoIds) const;
 277 DataArrayDouble::meldWith(const DataArrayDouble* other);
 278 DataArrayDouble::findCommonTuples(double prec, int limitTupleId, DataArrayInt *&comm, DataArrayInt *&commIndex) const;
 279 DataArrayDouble::getDifferentValues(double prec, int limitTupleId=-1) const;
 280 DataArrayDouble::setSelectedComponents(const DataArrayDouble* a, const std::vector<int>& compoIds);
 281 DataArrayDouble::setPartOfValues1(const DataArrayDouble* a, int bgTuples, int endTuples, int stepTuples, int bgComp, int endComp, int stepComp, bool strictCompoCompare=true);
 282 DataArrayDouble::setPartOfValuesSimple1(double a, int bgTuples, int endTuples, int stepTuples, int bgComp, int endComp, int stepComp);
 283 DataArrayDouble::setPartOfValues2(const DataArrayDouble* a, const int* bgTuples, const int* endTuples, const int* bgComp, const int* endComp, bool strictCompoCompare=true);
 284 DataArrayDouble::setPartOfValuesSimple2(double a, const int* bgTuples, const int* endTuples, const int* bgComp, const int* endComp);
 285 DataArrayDouble::setPartOfValues3(const DataArrayDouble* a, const int* bgTuples, const int* endTuples, int bgComp, int endComp, int stepComp, bool strictCompoCompare=true);
 286 DataArrayDouble::setPartOfValuesSimple3(double a, const int* bgTuples, const int* endTuples, int bgComp, int endComp, int stepComp);
 287 DataArrayDouble::getTuple(int tupleId, double* res) const;
 288 DataArrayDouble::getIJ(int tupleId, int compoId) const;
 289 DataArrayDouble::back() const;
 290 DataArrayDouble::getIJSafe(int tupleId, int compoId) const;
 291 DataArrayDouble::setIJ(int tupleId, int compoId, double newVal);
 292 DataArrayDouble::setIJSilent(int tupleId, int compoId, double newVal);
 293 DataArrayDouble::useExternalArrayWithRWAccess(const double* array, int nbOfTuple, int nbOfCompo);
 294 DataArrayDouble::writeOnPlace(int id, double element0, const double* others, int sizeOfOthers);
 295 DataArrayDouble::checkNoNullValues() const;
 296 DataArrayDouble::getMinMaxPerComponent(double* bounds) const;
 297 DataArrayDouble::getMaxValue(int& tupleId) const;
 298 DataArrayDouble::getMaxValueInArray() const;
 299 DataArrayDouble::getMinValue(int& tupleId) const;
 300 DataArrayDouble::getMinValueInArray() const;
 301 DataArrayDouble::getMaxValue2(DataArrayInt*& tupleIds) const;
 302 DataArrayDouble::getMinValue2(DataArrayInt*& tupleIds) const;
 303 DataArrayDouble::getAverageValue() const;
 304 DataArrayDouble::norm2() const;
 305 DataArrayDouble::normMax() const;
 306 DataArrayDouble::accumulate(double* res) const;
 307 DataArrayDouble::accumulate(int compId) const;
 308 DataArrayDouble::fromPolarToCart() const;
 309 DataArrayDouble::fromCylToCart() const;
 310 DataArrayDouble::fromSpherToCart() const;
 311 DataArrayDouble::doublyContractedProduct() const;
 312 DataArrayDouble::determinant() const;
 313 DataArrayDouble::eigenValues() const;
 314 DataArrayDouble::eigenVectors() const;
 315 DataArrayDouble::inverse() const;
 316 DataArrayDouble::trace() const;
 317 DataArrayDouble::deviator() const;
 318 DataArrayDouble::magnitude() const;
 319 DataArrayDouble::maxPerTuple() const;
 320 DataArrayDouble::sortPerTuple(bool asc);
 321 DataArrayDouble::abs();
 322 DataArrayDouble::applyLin(double a, double b, int compoId);
 323 DataArrayDouble::applyLin(double a, double b);
 324 DataArrayDouble::applyInv(double numerator);
 325 DataArrayDouble::negate() const;
 326 DataArrayDouble::applyFunc(int nbOfComp, const char* func) const;
 327 DataArrayDouble::applyFunc(const char* func) const;
 328 DataArrayDouble::applyFunc2(int nbOfComp, const char* func) const;
 329 DataArrayDouble::applyFunc3(int nbOfComp, const std::vector<std::string>& varsOrder, const char* func) const;
 330 DataArrayDouble::getIdsInRange(double vmin, double vmax) const;
 331 DataArrayDouble::addEqual(const DataArrayDouble* other);
 332 DataArrayDouble::substractEqual(const DataArrayDouble* other);
 333 DataArrayDouble::multiplyEqual(const DataArrayDouble* other);
 334 DataArrayDouble::divideEqual(const DataArrayDouble* other);
 335 DataArrayDouble::updateTime() const;
 336 DataArrayDouble::New();
 337 DataArrayDouble::Aggregate(const DataArrayDouble* a1, const DataArrayDouble* a2);
 338 DataArrayDouble::Aggregate(const std::vector<const DataArrayDouble *>& arr);
 339 DataArrayDouble::Meld(const DataArrayDouble* a1, const DataArrayDouble* a2);
 340 DataArrayDouble::Meld(const std::vector<const DataArrayDouble *>& arr);
 341 DataArrayDouble::Dot(const DataArrayDouble* a1, const DataArrayDouble* a2);
 342 DataArrayDouble::CrossProduct(const DataArrayDouble* a1, const DataArrayDouble* a2);
 343 DataArrayDouble::Max(const DataArrayDouble* a1, const DataArrayDouble* a2);
 344 DataArrayDouble::Min(const DataArrayDouble* a1, const DataArrayDouble* a2);
 345 DataArrayDouble::Add(const DataArrayDouble* a1, const DataArrayDouble* a2);
 346 DataArrayDouble::Substract(const DataArrayDouble* a1, const DataArrayDouble* a2);
 347 DataArrayDouble::Multiply(const DataArrayDouble* a1, const DataArrayDouble* a2);
 348 DataArrayDouble::Divide(const DataArrayDouble* a1, const DataArrayDouble* a2);
 349 ///@}
 350
 351 /*! \name   Advanced API   */
 352 ///@{
 353 DataArrayDouble::checkAllocated() const;
 354 DataArrayDouble::setPartOfValuesAdv(const DataArrayDouble* a, const DataArrayInt* tuplesSelec);
 355 DataArrayDouble::setContigPartOfSelectedValues(int tupleIdStart, const DataArrayDouble* a, const DataArrayInt* tuplesSelec);
 356 DataArrayDouble::setContigPartOfSelectedValues2(int tupleIdStart, const DataArrayDouble* a, int bg, int end2, int step);
 357 DataArrayDouble::applyFunc(int nbOfComp, FunctionToEvaluate func) const;
 358 ///@}
 359
 360 /*! \name Others... */
 361 ///@{
 362 DataArrayDouble::getNumberOfTuples() const;
 363 DataArrayDouble::getNbOfElems() const;
 364 DataArrayDouble::getHeapMemorySize() const;
 365 DataArrayDouble::reserve(int nbOfElems);
 366 DataArrayDouble::pushBackSilent(double val);
 367 DataArrayDouble::popBackSilent();
 368 DataArrayDouble::pack() const;
 369 DataArrayDouble::getNbOfElemAllocated() const;
 370 DataArrayDouble::reprZip() const;
 371 DataArrayDouble::writeVTK(std::ostream& ofs, int indent, const char* nameInFile) const;
 372 DataArrayDouble::reprStream(std::ostream& stream) const;
 373 DataArrayDouble::reprZipStream(std::ostream& stream) const;
 374 DataArrayDouble::reprWithoutNameStream(std::ostream& stream) const;
 375 DataArrayDouble::reprZipWithoutNameStream(std::ostream& stream) const;
 376 DataArrayDouble::reprCppStream(const char* varName, std::ostream& stream) const;
 377 DataArrayDouble::isEqualIfNotWhy(const DataArrayDouble& other, double prec, std::string& reason) const;
 378 DataArrayDouble::duplicateEachTupleNTimes(int nbTimes) const;
 379 DataArrayDouble::setPartOfValues4(const DataArrayDouble* a, int bgTuples, int endTuples, int stepTuples, const int* bgComp, const int* endComp, bool strictCompoCompare=true);
 380 DataArrayDouble::setPartOfValuesSimple4(double a, int bgTuples, int endTuples, int stepTuples, const int* bgComp, const int* endComp);
 381 DataArrayDouble::getPointer();
 382 DataArrayDouble::SetArrayIn(DataArrayDouble* newArray, DataArrayDouble* &arrayToSet);
 383 DataArrayDouble::iterator();
 384 DataArrayDouble::getConstPointer() const;
 385 DataArrayDouble::begin() const;
 386 DataArrayDouble::end() const;
 387 DataArrayDouble::useArray(const double* array, bool ownership, DeallocType type, int nbOfTuple, int nbOfCompo);
 388 DataArrayDouble::insertAtTheEnd(InputIterator first, InputIterator last);
 389 DataArrayDouble::computeBBoxPerTuple(double epsilon=0.0) const;
 390 DataArrayDouble::computeTupleIdsNearTuples(const DataArrayDouble* other, double eps, DataArrayInt *& c, DataArrayInt *& cI) const;
 391 DataArrayDouble::recenterForMaxPrecision(double eps);
 392 DataArrayDouble::distanceToTuple(const double* tupleBg, const double* tupleEnd, int& tupleId) const;
 393 DataArrayDouble::buildEuclidianDistanceDenseMatrix() const;
 394 DataArrayDouble::buildEuclidianDistanceDenseMatrixWith(const DataArrayDouble* other) const;
 395 DataArrayDouble::applyFuncFast32(const char* func);
 396 DataArrayDouble::applyFuncFast64(const char* func);
 397 DataArrayDouble::getTinySerializationIntInformation(std::vector<int>& tinyInfo) const;
 398 DataArrayDouble::getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const;
 399 DataArrayDouble::resizeForUnserialization(const std::vector<int>& tinyInfoI);
 400 DataArrayDouble::finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<std::string>& tinyInfoS);
 401
 402 DataArrayDouble::findCommonTuplesAlg(const double* bbox, int nbNodes, int limitNodeId, double prec, DataArrayInt* c, DataArrayInt* cI) const;
 403
 404 DataArrayDouble::FindTupleIdsNearTuplesAlg(const BBTree<SPACEDIM,int>& myTree, const double* pos, int nbOfTuples, double eps, DataArrayInt* c, DataArrayInt* cI);
 405 DataArrayDouble::DataArrayDouble();
 406 MemArray<double> DataArrayDouble::_mem;
 407 ///@}
 408
 409 //================================================================================
 410 /////////////////////// DataArrayInt GROUPPING ///////////////////////////////////
 411 //================================================================================
 412
 413 /*! \name Advanced API  */
 414 ///@{
 415 DataArrayInt::checkAllocated() const;
 416 DataArrayInt::getHashCode() const;
 417 DataArrayInt::buildPermutationArr(const DataArrayInt& other) const;
 418 DataArrayInt::transformWithIndArr(const int* indArrBg, const int* indArrEnd);
 419 DataArrayInt::transformWithIndArrR(const int* indArrBg, const int* indArrEnd) const;
 420 DataArrayInt::splitByValueRange(const int* arrBg, const int* arrEnd,DataArrayInt *& castArr, DataArrayInt *& rankInsideCast, DataArrayInt *& castsPresent) const;
 421 DataArrayInt::setPartOfValuesAdv(const DataArrayInt* a, const DataArrayInt* tuplesSelec);
 422 DataArrayInt::setContigPartOfSelectedValues(int tupleIdStart, const DataArrayInt*a, const DataArrayInt* tuplesSelec);
 423 DataArrayInt::setContigPartOfSelectedValues2(int tupleIdStart, const DataArrayInt* a, int bg, int end2, int step);
 424 DataArrayInt::SetArrayIn(DataArrayInt* newArray, DataArrayInt* &arrayToSet);
 425 ///@}
 426
 427 /*! \name Basic API   */
 428 ///@{
 429 DataArrayInt::isAllocated() const;
 430 DataArrayInt::setInfoAndChangeNbOfCompo(const std::vector<std::string>& info);
 431 DataArrayInt::intValue() const;
 432 DataArrayInt::empty() const;
 433 DataArrayInt::deepCpy() const;
 434 DataArrayInt::performCpy(bool deepCpy) const;
 435 DataArrayInt::cpyFrom(const DataArrayInt& other);
 436 DataArrayInt::alloc(int nbOfTuple, int nbOfCompo);
 437 DataArrayInt::allocIfNecessary(int nbOfTuple, int nbOfCompo);
 438 DataArrayInt::isEqual(const DataArrayInt& other) const;
 439 DataArrayInt::isEqualWithoutConsideringStr(const DataArrayInt& other) const;
 440 DataArrayInt::isEqualWithoutConsideringStrAndOrder(const DataArrayInt& other) const;
 441 DataArrayInt::sort(bool asc=true);
 442 DataArrayInt::reverse();
 443 DataArrayInt::fillWithZero();
 444 DataArrayInt::fillWithValue(int val);
 445 DataArrayInt::iota(int init=0);
 446 DataArrayInt::repr() const;
 447 DataArrayInt::invertArrayO2N2N2O(int newNbOfElem) const;
 448 DataArrayInt::invertArrayN2O2O2N(int oldNbOfElem) const;
 449 DataArrayInt::reAlloc(int nbOfTuples);
 450 DataArrayInt::convertToDblArr() const;
 451 DataArrayInt::fromNoInterlace() const;
 452 DataArrayInt::toNoInterlace() const;
 453 DataArrayInt::renumberInPlace(const int* old2New);
 454 DataArrayInt::renumberInPlaceR(const int* new2Old);
 455 DataArrayInt::renumber(const int* old2New) const;
 456 DataArrayInt::renumberR(const int* new2Old) const;
 457 DataArrayInt::renumberAndReduce(const int* old2NewBg, int newNbOfTuple) const;
 458 DataArrayInt::selectByTupleId(const int* new2OldBg, const int* new2OldEnd) const;
 459 DataArrayInt::selectByTupleIdSafe(const int* new2OldBg, const int* new2OldEnd) const;
 460 DataArrayInt::selectByTupleId2(int bg, int end, int step) const;
 461 DataArrayInt::selectByTupleRanges(const std::vector<std::pair<int,int> >& ranges) const;
 462 DataArrayInt::checkAndPreparePermutation() const;
 463 DataArrayInt::changeSurjectiveFormat(int targetNb, DataArrayInt *&arr, DataArrayInt *&arrI) const;
 464 DataArrayInt::buildPermArrPerLevel() const;
 465 DataArrayInt::isIdentity() const;
 466 DataArrayInt::isUniform(int val) const;
 467 DataArrayInt::substr(int tupleIdBg, int tupleIdEnd=-1) const;
 468 DataArrayInt::rearrange(int newNbOfCompo);
 469 DataArrayInt::transpose();
 470 DataArrayInt::changeNbOfComponents(int newNbOfComp, int dftValue) const;
 471 DataArrayInt::keepSelectedComponents(const std::vector<int>& compoIds) const;
 472 DataArrayInt::meldWith(const DataArrayInt* other);
 473 DataArrayInt::setSelectedComponents(const DataArrayInt* a, const std::vector<int>& compoIds);
 474 DataArrayInt::setPartOfValues1(const DataArrayInt* a, int bgTuples, int endTuples, int stepTuples, int bgComp, int endComp, int stepComp, bool strictCompoCompare=true);
 475 DataArrayInt::setPartOfValuesSimple1(int a, int bgTuples, int endTuples, int stepTuples, int bgComp, int endComp, int stepComp);
 476 DataArrayInt::setPartOfValues2(const DataArrayInt* a, const int* bgTuples, const int* endTuples, const int* bgComp, const int* endComp, bool strictCompoCompare=true);
 477 DataArrayInt::setPartOfValuesSimple2(int a, const int* bgTuples, const int* endTuples, const int* bgComp, const int* endComp);
 478 DataArrayInt::setPartOfValues3(const DataArrayInt* a, const int* bgTuples, const int* endTuples, int bgComp, int endComp, int stepComp, bool strictCompoCompare=true);
 479 DataArrayInt::setPartOfValuesSimple3(int a, const int* bgTuples, const int* endTuples, int bgComp, int endComp, int stepComp);
 480 DataArrayInt::getTuple(int tupleId, int* res) const;
 481 DataArrayInt::getIJ(int tupleId, int compoId) const;
 482 DataArrayInt::getIJSafe(int tupleId, int compoId) const;
 483 DataArrayInt::back() const;
 484 DataArrayInt::setIJ(int tupleId, int compoId, int newVal);
 485 DataArrayInt::setIJSilent(int tupleId, int compoId, int newVal);
 486 DataArrayInt::getPointer();
 487 DataArrayInt::getConstPointer() const;
 488 DataArrayInt::getIdsEqual(int val) const;
 489 DataArrayInt::getIdsNotEqual(int val) const;
 490 DataArrayInt::getIdsEqualList(const int* valsBg, const int* valsEnd) const;
 491 DataArrayInt::getIdsNotEqualList(const int* valsBg, const int* valsEnd) const;
 492 DataArrayInt::changeValue(int oldValue, int newValue);
 493 DataArrayInt::presenceOfValue(int value) const;
 494 DataArrayInt::presenceOfValue(const std::vector<int>& vals) const;
 495 DataArrayInt::getMaxValue(int& tupleId) const;
 496 DataArrayInt::getMaxValueInArray() const;
 497 DataArrayInt::getMinValue(int& tupleId) const;
 498 DataArrayInt::getMinValueInArray() const;
 499 DataArrayInt::abs();
 500 DataArrayInt::applyLin(int a, int b, int compoId);
 501 DataArrayInt::applyLin(int a, int b);
 502 DataArrayInt::applyInv(int numerator);
 503 DataArrayInt::negate() const;
 504 DataArrayInt::applyDivideBy(int val);
 505 DataArrayInt::applyModulus(int val);
 506 DataArrayInt::applyRModulus(int val);
 507 DataArrayInt::buildComplement(int nbOfElement) const;
 508 DataArrayInt::buildSubstraction(const DataArrayInt* other) const;
 509 DataArrayInt::buildUnion(const DataArrayInt* other) const;
 510 DataArrayInt::buildIntersection(const DataArrayInt* other) const;
 511 DataArrayInt::deltaShiftIndex() const;
 512 DataArrayInt::computeOffsets();
 513 DataArrayInt::computeOffsets2();
 514 DataArrayInt::buildExplicitArrByRanges(const DataArrayInt* offsets) const;
 515 DataArrayInt::useArray(const int* array, bool ownership, DeallocType type, int nbOfTuple, int nbOfCompo);
 516 DataArrayInt::writeOnPlace(int id, int element0, const int* others, int sizeOfOthers);
 517 DataArrayInt::addEqual(const DataArrayInt* other);
 518 DataArrayInt::substractEqual(const DataArrayInt* other);
 519 DataArrayInt::multiplyEqual(const DataArrayInt* other);
 520 DataArrayInt::divideEqual(const DataArrayInt* other);
 521 DataArrayInt::modulusEqual(const DataArrayInt* other);
 522 DataArrayInt::updateTime() const;
 523 DataArrayInt::New();
 524 DataArrayInt::BuildOld2NewArrayFromSurjectiveFormat2(int nbOfOldTuples, const int* arr, const int* arrIBg, const int* arrIEnd, int &newNbOfTuples);
 525 DataArrayInt::Aggregate(const DataArrayInt* a1, const DataArrayInt* a2, int offsetA2);
 526 DataArrayInt::Aggregate(const std::vector<const DataArrayInt *>& arr);
 527 DataArrayInt::Meld(const DataArrayInt* a1, const DataArrayInt* a2);
 528 DataArrayInt::Meld(const std::vector<const DataArrayInt *>& arr);
 529 DataArrayInt::MakePartition(const std::vector<const DataArrayInt *>& groups, int newNb, std::vector< std::vector<int> >& fidsOfGroups);
 530 DataArrayInt::BuildUnion(const std::vector<const DataArrayInt *>& arr);
 531 DataArrayInt::BuildIntersection(const std::vector<const DataArrayInt *>& arr);
 532 DataArrayInt::Add(const DataArrayInt* a1, const DataArrayInt* a2);
 533 DataArrayInt::Substract(const DataArrayInt* a1, const DataArrayInt* a2);
 534 DataArrayInt::Multiply(const DataArrayInt* a1, const DataArrayInt* a2);
 535 DataArrayInt::Divide(const DataArrayInt* a1, const DataArrayInt* a2);
 536 DataArrayInt::Modulus(const DataArrayInt* a1, const DataArrayInt* a2);
 537 DataArrayInt::CheckAndPreparePermutation(const int* start, const int* end);
 538 DataArrayInt::Range(int begin, int end, int step);
 539 ///@}
 540
 541 /*! \name Others... */
 542 ///@{
 543 DataArrayInt::getNumberOfTuples() const;
 544 DataArrayInt::getNbOfElems() const;
 545 DataArrayInt::getHeapMemorySize() const;
 546 DataArrayInt::reserve(int nbOfElems);
 547 DataArrayInt::pushBackSilent(int val);
 548 DataArrayInt::popBackSilent();
 549 DataArrayInt::pack() const;
 550 DataArrayInt::getNbOfElemAllocated() const;
 551 DataArrayInt::isEqualIfNotWhy(const DataArrayInt& other, std::string& reason) const;
 552 DataArrayInt::checkMonotonic(bool increasing) const;
 553 DataArrayInt::isMonotonic(bool increasing) const;
 554 DataArrayInt::checkStrictlyMonotonic(bool increasing) const;
 555 DataArrayInt::isStrictlyMonotonic(bool increasing) const;
 556 DataArrayInt::reprZip() const;
 557 DataArrayInt::writeVTK(std::ostream& ofs, int indent, const char* type, const char* nameInFile) const;
 558 DataArrayInt::reprStream(std::ostream& stream) const;
 559 DataArrayInt::reprZipStream(std::ostream& stream) const;
 560 DataArrayInt::reprWithoutNameStream(std::ostream& stream) const;
 561 DataArrayInt::reprZipWithoutNameStream(std::ostream& stream) const;
 562 DataArrayInt::reprCppStream(const char* varName, std::ostream& stream) const;
 563 DataArrayInt::invertArrayO2N2N2OBis(int newNbOfElem) const;
 564 DataArrayInt::setPartOfValues4(const DataArrayInt* a, int bgTuples, int endTuples, int stepTuples, const int* bgComp, const int* endComp, bool strictCompoCompare=true);
 565 DataArrayInt::setPartOfValuesSimple4(int a, int bgTuples, int endTuples, int stepTuples, const int* bgComp, const int* endComp);
 566 DataArrayInt::iterator();
 567 DataArrayInt::begin() const;
 568 DataArrayInt::end() const;
 569 DataArrayInt::locateTuple(const std::vector<int>& tupl) const;
 570 DataArrayInt::locateValue(int value) const;
 571 DataArrayInt::locateValue(const std::vector<int>& vals) const;
 572 DataArrayInt::search(const std::vector<int>& vals) const;
 573 DataArrayInt::presenceOfTuple(const std::vector<int>& tupl) const;
 574 DataArrayInt::accumulate(int* res) const;
 575 DataArrayInt::accumulate(int compId) const;
 576 DataArrayInt::getIdsInRange(int vmin, int vmax) const;
 577 DataArrayInt::buildSubstractionOptimized(const DataArrayInt* other) const;
 578 DataArrayInt::buildUnique() const;
 579 DataArrayInt::findRangeIdForEachTuple(const DataArrayInt* ranges) const;
 580 DataArrayInt::findIdInRangeForEachTuple(const DataArrayInt* ranges) const;
 581 DataArrayInt::duplicateEachTupleNTimes(int nbTimes) const;
 582 DataArrayInt::getDifferentValues() const;
 583 > DataArrayInt::partitionByDifferentValues(std::vector<int>& differentIds) const;
 584 DataArrayInt::useExternalArrayWithRWAccess(const int* array, int nbOfTuple, int nbOfCompo);
 585 tor>
 586 DataArrayInt::insertAtTheEnd(InputIterator first, InputIterator last);
 587 DataArrayInt::getTinySerializationIntInformation(std::vector<int>& tinyInfo) const;
 588 DataArrayInt::getTinySerializationStrInformation(std::vector<std::string>& tinyInfo) const;
 589 DataArrayInt::resizeForUnserialization(const std::vector<int>& tinyInfoI);
 590 DataArrayInt::finishUnserialization(const std::vector<int>& tinyInfoI, const std::vector<std::string>& tinyInfoS);
 591 DataArrayInt::DataArrayInt();
 592 MemArray<int> DataArrayInt::_mem;
 593 ///@}
 594
 595 }