Ifpack2 Templated Preconditioning Package  Version 1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Ifpack2_Heap.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_HEAP_HPP
44 #define IFPACK2_HEAP_HPP
45 
46 #include <algorithm>
47 #include "Teuchos_Array.hpp"
48 #include "Teuchos_ScalarTraits.hpp"
49 
50 namespace Ifpack2 {
51 
52 template<typename Scalar, typename Ordinal>
53 struct greater_indirect {
54  greater_indirect(const Teuchos::Array<Scalar>& vals)
55  : m_vals(vals) {}
56  ~greater_indirect(){}
57 
58  bool operator()(const Ordinal& lhs, const Ordinal& rhs) const
59  { return Teuchos::ScalarTraits<Scalar>::magnitude(m_vals[lhs]) >
61 
62 private:
63  const Teuchos::Array<Scalar>& m_vals;
64 };//struct greater_indirect
65 
66 
69 template<typename Ordinal, typename SizeType>
70 void add_to_heap(const Ordinal& idx, Teuchos::Array<Ordinal>& heap, SizeType& heap_len)
71 {
72  if (heap.size() == heap_len) heap.push_back(idx);
73  else heap[heap_len] = idx;
74  ++heap_len;
75  std::push_heap(heap.begin(), heap.begin()+heap_len, std::greater<Ordinal>());
76 }
77 
81 template<typename Ordinal, typename SizeType, class Compare>
82 void add_to_heap(const Ordinal& idx, Teuchos::Array<Ordinal>& heap, SizeType& heap_len, Compare comp)
83 {
84  if (heap.size() == heap_len) heap.push_back(idx);
85  else heap[heap_len] = idx;
86  ++heap_len;
87  std::push_heap(heap.begin(), heap.begin()+heap_len, comp);
88 }
89 
91 template<typename Ordinal, typename SizeType>
92 void rm_heap_root(Teuchos::Array<Ordinal>& heap, SizeType& heap_len)
93 {
94  std::pop_heap(heap.begin(), heap.begin()+heap_len, std::greater<Ordinal>());
95  --heap_len;
96 }
97 
101 template<typename Ordinal, typename SizeType, class Compare>
102 void rm_heap_root(Teuchos::Array<Ordinal>& heap, SizeType& heap_len, Compare comp)
103 {
104  std::pop_heap(heap.begin(), heap.begin()+heap_len, comp);
105  --heap_len;
106 }
107 
108 }//namespace Ifpack2
109 
110 #endif
111 
void rm_heap_root(Teuchos::Array< Ordinal > &heap, SizeType &heap_len)
Definition: Ifpack2_Heap.hpp:92
static magnitudeType magnitude(T a)
void push_back(const value_type &x)
size_type size() const
void add_to_heap(const Ordinal &idx, Teuchos::Array< Ordinal > &heap, SizeType &heap_len)
Definition: Ifpack2_Heap.hpp:70
iterator begin()