src/OpenFOAM/containers/LinkedLists/linkTypes/DLListBase/DLListBaseI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 #include "error.H"
  28
  29 // * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * * //
  30
  31 inline Foam::DLListBase::link::link()
  32 :
  33     prev_(0),
  34     next_(0)
  35 {}
  36
  37
  38 inline Foam::DLListBase::DLListBase()
  39 :
  40     first_(0),
  41     last_(0),
  42     nElmts_(0)
  43 {}
  44
  45
  46 inline Foam::DLListBase::DLListBase(link* a)
  47 :
  48     first_(a),
  49     last_(a),
  50     nElmts_(1)
  51 {
  52     a->prev_ = a;
  53     a->next_ = a;
  54 }
  55
  56
  57 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  58
  59 inline Foam::DLListBase::~DLListBase()
  60 {}
  61
  62
  63 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  64
  65 inline bool Foam::DLListBase::link::registered() const
  66 {
  67     return prev_ != 0 && next_ != 0;
  68 }
  69
  70
  71 inline void Foam::DLListBase::link::deregister()
  72 {
  73     prev_ = 0;
  74     next_ = 0;
  75 }
  76
  77
  78 inline Foam::label Foam::DLListBase::size() const
  79 {
  80     return nElmts_;
  81 }
  82
  83
  84 inline bool Foam::DLListBase::empty() const
  85 {
  86     return !nElmts_;
  87 }
  88
  89
  90 inline Foam::DLListBase::link*
  91 Foam::DLListBase::first()
  92 {
  93     if (!nElmts_)
  94     {
  95         FatalErrorIn("DLListBase::first()")
  96             << "list is empty"
  97             << abort(FatalError);
  98     }
  99     return first_;
 100 }
 101
 102
 103 inline const Foam::DLListBase::link*
 104 Foam::DLListBase::first() const
 105 {
 106     if (!nElmts_)
 107     {
 108         FatalErrorIn("DLListBase::first() const")
 109             << "list is empty"
 110             << abort(FatalError);
 111     }
 112     return first_;
 113 }
 114
 115
 116 inline Foam::DLListBase::link*
 117 Foam::DLListBase::last()
 118 {
 119     if (!nElmts_)
 120     {
 121         FatalErrorIn("DLListBase::last()")
 122             << "list is empty"
 123             << abort(FatalError);
 124     }
 125     return last_;
 126 }
 127
 128
 129 inline const Foam::DLListBase::link*
 130 Foam::DLListBase::last() const
 131 {
 132     if (!nElmts_)
 133     {
 134         FatalErrorIn("DLListBase::last() const")
 135             << "list is empty"
 136             << abort(FatalError);
 137     }
 138     return last_;
 139 }
 140
 141
 142 inline void Foam::DLListBase::clear()
 143 {
 144     first_ = 0;
 145     last_  = 0;
 146     nElmts_ = 0;
 147 }
 148
 149
 150 inline void Foam::DLListBase::transfer(DLListBase& lst)
 151 {
 152     first_  = lst.first_;
 153     last_   = lst.last_;
 154     nElmts_ = lst.nElmts_;
 155
 156     lst.clear();
 157 }
 158
 159
 160 inline Foam::DLListBase::link*
 161 Foam::DLListBase::remove
 162 (
 163     DLListBase::iterator& it
 164 )
 165 {
 166     return remove(it.curElmt_);
 167 }
 168
 169
 170 inline Foam::DLListBase::link*
 171 Foam::DLListBase::replace
 172 (
 173     DLListBase::iterator& oldIter,
 174     DLListBase::link* newLink
 175 )
 176 {
 177     return replace(oldIter.curElmt_, newLink);
 178 }
 179
 180
 181 // * * * * * * * * * * * * * * * STL iterator  * * * * * * * * * * * * * * * //
 182
 183 inline Foam::DLListBase::iterator::iterator(DLListBase& s, link* elmt)
 184 :
 185     curList_(s),
 186     curElmt_(elmt),
 187     curLink_(*curElmt_)
 188 {}
 189
 190
 191 inline Foam::DLListBase::iterator::iterator(DLListBase& s)
 192 :
 193     curList_(s),
 194     curElmt_(NULL),
 195     curLink_()
 196 {}
 197
 198
 199 inline void Foam::DLListBase::iterator::operator=(const iterator& iter)
 200 {
 201     curElmt_ = iter.curElmt_;
 202     curLink_ = iter.curLink_;
 203 }
 204
 205
 206 inline bool Foam::DLListBase::iterator::operator==(const iterator& iter) const
 207 {
 208     return curElmt_ == iter.curElmt_;
 209 }
 210
 211
 212 inline bool Foam::DLListBase::iterator::operator!=(const iterator& iter) const
 213 {
 214     return curElmt_ != iter.curElmt_;
 215 }
 216
 217
 218 inline Foam::DLListBase::link&
 219 Foam::DLListBase::iterator::operator*()
 220 {
 221     return *curElmt_;
 222 }
 223
 224
 225 inline Foam::DLListBase::iterator&
 226 Foam::DLListBase::iterator::operator++()
 227 {
 228     // Check if the curElmt_ is the last element (if it points to itself)
 229     // or if the list is empty because the last element may have been removed
 230     if (curLink_.next_ == curElmt_ || curList_.last_ == 0)
 231     {
 232         curElmt_ = 0;
 233     }
 234     else
 235     {
 236         curElmt_ = curLink_.next_;
 237         curLink_ = *curElmt_;
 238     }
 239
 240     return *this;
 241 }
 242
 243
 244 inline Foam::DLListBase::iterator
 245 Foam::DLListBase::iterator::operator++(int)
 246 {
 247     iterator tmp = *this;
 248     ++*this;
 249     return tmp;
 250 }
 251
 252
 253 inline Foam::DLListBase::iterator
 254 Foam::DLListBase::begin()
 255 {
 256     if (size())
 257     {
 258         return iterator(*this, first());
 259     }
 260     else
 261     {
 262         return endIter_;
 263     }
 264 }
 265
 266
 267 inline const Foam::DLListBase::iterator& Foam::DLListBase::end()
 268 {
 269     return endIter_;
 270 }
 271
 272
 273 // * * * * * * * * * * * * * * STL const_iterator  * * * * * * * * * * * * * //
 274
 275 inline Foam::DLListBase::const_iterator::const_iterator
 276 (
 277     const DLListBase& s,
 278     const link* elmt
 279 )
 280 :
 281     curList_(s),
 282     curElmt_(elmt)
 283 {}
 284
 285
 286 inline Foam::DLListBase::const_iterator::const_iterator(const iterator& iter)
 287 :
 288     curList_(iter.curList_),
 289     curElmt_(iter.curElmt_)
 290 {}
 291
 292
 293 inline void Foam::DLListBase::const_iterator::operator=
 294 (
 295     const const_iterator& iter
 296 )
 297 {
 298     curElmt_ = iter.curElmt_;
 299 }
 300
 301
 302 inline bool Foam::DLListBase::const_iterator::operator==
 303 (
 304     const const_iterator& iter
 305 ) const
 306 {
 307     return curElmt_ == iter.curElmt_;
 308 }
 309
 310
 311 inline bool Foam::DLListBase::const_iterator::operator!=
 312 (
 313     const const_iterator& iter
 314 ) const
 315 {
 316     return curElmt_ != iter.curElmt_;
 317 }
 318
 319
 320 inline const Foam::DLListBase::link&
 321 Foam::DLListBase::const_iterator::operator*()
 322 {
 323     return *curElmt_;
 324 }
 325
 326
 327 inline Foam::DLListBase::const_iterator&
 328 Foam::DLListBase::const_iterator::operator++()
 329 {
 330     if (curElmt_ == curList_.last_)
 331     {
 332         curElmt_ = 0;
 333     }
 334     else
 335     {
 336         curElmt_ = curElmt_->next_;
 337     }
 338
 339     return *this;
 340 }
 341
 342
 343 inline Foam::DLListBase::const_iterator
 344 Foam::DLListBase::const_iterator::operator++(int)
 345 {
 346     const_iterator tmp = *this;
 347     ++*this;
 348     return tmp;
 349 }
 350
 351
 352 inline Foam::DLListBase::const_iterator
 353 Foam::DLListBase::cbegin() const
 354 {
 355     if (size())
 356     {
 357         return const_iterator(*this, first());
 358     }
 359     else
 360     {
 361         return endConstIter_;
 362     }
 363 }
 364
 365
 366 inline const Foam::DLListBase::const_iterator&
 367 Foam::DLListBase::cend() const
 368 {
 369     return endConstIter_;
 370 }
 371
 372
 373 inline Foam::DLListBase::const_iterator
 374 Foam::DLListBase::begin() const
 375 {
 376     return this->cbegin();
 377 }
 378
 379
 380 inline const Foam::DLListBase::const_iterator&
 381 Foam::DLListBase::end() const
 382 {
 383     return endConstIter_;
 384 }
 385
 386
 387 // ************************************************************************* //