src/multiSolver/tuple2Lists/tuple2Lists.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Typedef
  25     Foam::tuple2List
  26
  27 Description
  28     List of paired values, with sorting capability
  29
  30 Author
  31     David L. F. Gaden
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef tuple2Lists_H
  36 #define tuple2Lists_H
  37
  38 #include "Tuple2.H"
  39 #include "List.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45     typedef List<Tuple2<label, label> > labelLabelList;
  46     typedef List<Tuple2<label, scalar> > labelScalarList;
  47     typedef List<Tuple2<scalar, label> > scalarLabelList;
  48     typedef List<Tuple2<scalar, scalar> > scalarScalarList;
  49
  50 template<class type1, class type2>
  51 bool lessFirst(Tuple2<type1, type2> t1, Tuple2<type1, type2> t2)
  52 {
  53     return (t1.first() < t2.first());
  54 }
  55
  56 template<class type1, class type2>
  57 bool lessFirstSecond(Tuple2<type1, type2> t1, Tuple2<type1, type2> t2)
  58 {
  59     return
  60     (
  61         (t1.first() < t2.first())
  62      || ((t1.first() == t2.first()) && (t1.second() < t2.second()))
  63     );
  64 }
  65
  66 template<class type1, class type2>
  67 bool lessSecond(Tuple2<type1, type2> t1, Tuple2<type1, type2> t2)
  68 {
  69     return (t1.second() < t2.second());
  70 }
  71
  72 template<class type1, class type2>
  73 bool lessSecondFirst(Tuple2<type1, type2> t1, Tuple2<type1, type2> t2)
  74 {
  75     return
  76     (
  77         (t2.first() < t1.first())
  78      || ((t2.first() == t1.first()) && (t2.second() < t1.second()))
  79     );
  80 }
  81
  82 template<class type1, class type2>
  83 void sortTuple2ListBy1st(List<Tuple2<type1, type2> >& t2l)
  84 {
  85     sort(t2l, lessFirst<type1, type2>);
  86 }
  87
  88 template<class type1, class type2>
  89 void sortTuple2ListBy2nd(List<Tuple2<type1, type2> >& t2l)
  90 {
  91     sort(t2l, lessSecond<type1, type2>);
  92 }
  93
  94 template<class type1, class type2>
  95 void sortTuple2ListBy1stThen2nd(List<Tuple2<type1, type2> >& t2l)
  96 {
  97     sort(t2l, lessFirstSecond<type1, type2>);
  98 }
  99
 100 template<class type1, class type2>
 101 void sortTuple2ListBy2ndThen1st(List<Tuple2<type1, type2> >& t2l)
 102 {
 103     sort(t2l, lessSecondFirst<type1, type2>);
 104 }
 105
 106 } // End namespace Foam
 107
 108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 109
 110 #endif
 111
 112 // ************************************************************************* //