Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Zoltan2_Sort.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // Zoltan2: A package of combinatorial algorithms for scientific computing
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Karen Devine (kddevin@sandia.gov)
39 // Erik Boman (egboman@sandia.gov)
40 // Siva Rajamanickam (srajama@sandia.gov)
41 //
42 // ***********************************************************************
43 //
44 // @HEADER
45 #ifndef _ZOLTAN2_SORT_HPP_
46 #define _ZOLTAN2_SORT_HPP_
47 
48 #include <Teuchos_Array.hpp>
49 #include <algorithm>
50 
51 
56 
57 // TODO: This is a generic utility class; should move this source file.
58 // We could perhaps use Sort2 from Tpetra, but that uses a custom sort not std::sort
59 
60 namespace Zoltan2{
61 
62 namespace Details {
63 
64  // These helper functions can't be class members, so put in Details namespace.
65  template<class KeyType, class ValueType>
66  bool SortInc (const std::pair<KeyType, ValueType>& a, const std::pair<KeyType, ValueType>& b)
67  {
68  return a.second < b.second;
69  }
70 
71  template<class KeyType, class ValueType>
72  bool SortDec (const std::pair<KeyType, ValueType>& a, const std::pair<KeyType, ValueType>& b)
73  {
74  return a.second > b.second;
75  }
76 
77 } // namespace Details
78 
79 template <typename key_t, typename value_t>
80 class SortPairs
81 {
82  public:
84  {
85  }
86 
87  public:
88  void sort(Teuchos::Array<std::pair<key_t,value_t> > &listofPairs, bool inc=true)
89  {
90  // Sort in increasing (default) or decreasing order of value
91  if (inc)
92  std::sort (listofPairs.begin(), listofPairs.end(), Details::SortInc<key_t, value_t>);
93  else
94  std::sort (listofPairs.begin(), listofPairs.end(), Details::SortDec<key_t, value_t>);
95  }
96 
97 };
98 }
99 #endif
bool SortDec(const std::pair< KeyType, ValueType > &a, const std::pair< KeyType, ValueType > &b)
void sort(Teuchos::Array< std::pair< key_t, value_t > > &listofPairs, bool inc=true)
bool SortInc(const std::pair< KeyType, ValueType > &a, const std::pair< KeyType, ValueType > &b)