src/OpenFOAM/containers/Lists/SortableList/SortableList.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 Class
  26     Foam::SortableList
  27
  28 Description
  29     A list that is sorted upon construction or when explicitly requested
  30     with the sort() method.
  31
  32 SourceFiles
  33     SortableList.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef SortableList_H
  38 #define SortableList_H
  39
  40 #include "labelList.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                            Class SortableList Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 template <class Type>
  52 class SortableList
  53 :
  54     public List<Type>
  55 {
  56     // Private data
  57
  58         //- Original indices
  59         labelList indices_;
  60
  61
  62 public:
  63
  64     // Public classes
  65
  66         //- Less function class used by the sort function
  67         class less
  68         {
  69             const UList<Type>& values_;
  70
  71         public:
  72
  73             less(const UList<Type>& values)
  74             :
  75                 values_(values)
  76             {}
  77
  78             bool operator()(const label a, const label b)
  79             {
  80                 return values_[a] < values_[b];
  81             }
  82         };
  83
  84
  85     // Constructors
  86
  87         //- Construct from List, sorting the elements. Starts with indices set
  88         //  to index in argument
  89         explicit SortableList(const List<Type>&);
  90
  91         //- Construct given size. Sort later on.
  92         explicit SortableList(const label size);
  93
  94         //- Construct given size and initial value. Sort later on.
  95         SortableList(const label size, const Type&);
  96
  97         //- Construct as copy.
  98         SortableList(const SortableList<Type>&);
  99
 100
 101     // Member Functions
 102
 103         //- Return the list of sorted indices. Updated every sort.
 104         const labelList& indices() const
 105         {
 106             return indices_;
 107         }
 108
 109         //- Size the list. If grow can cause undefined indices (until next sort)
 110         void setSize(const label);
 111
 112         //- Sort the list (if changed after construction time)
 113         void sort();
 114
 115         //- Sort the list (if changed after construction time)
 116         void stableSort();
 117
 118
 119     // Member Operators
 120
 121         void operator=(const SortableList<Type>&);
 122
 123 };
 124
 125
 126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 127
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #ifdef NoRepository
 133 #   include "SortableList.C"
 134 #endif
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //