RTOp Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOpPack_ROpMinIndexGreaterThanBound.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
5 // Operations
6 // Copyright (2006) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
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 Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 
43 #ifndef RTOPPACK_ROP_MIN_INDEX_GREATER_THAN_BOUND_HPP
44 #define RTOPPACK_ROP_MIN_INDEX_GREATER_THAN_BOUND_HPP
45 
46 #include "RTOpPack_ROpMinIndex.hpp"
48 
49 
50 namespace RTOpPack {
51 
52 
54 template<class Scalar>
56 public:
59  const Scalar &bound = ScalarTraits<Scalar>::zero()
60  )
61  :bound_(bound)
62  {}
64  void operator()(const index_type i, const Scalar &v0,
65  ScalarIndex<Scalar> &reduct) const
66  {
67  if(
68  v0 > bound_
69  &&
70  (
71  v0 < reduct.scalar
72  ||
73  ( v0 == reduct.scalar && i < reduct.index )
74  )
75  )
76  {
77  reduct = ScalarIndex<Scalar>(v0, i);
78  }
79  }
80 private:
81  Scalar bound_;
82 };
83 
84 
94 template<class Scalar>
97  Scalar,
98  ScalarIndex<Scalar>,
99  ROpMinIndexGreaterThanBoundEleWiseReductionOp<Scalar>,
100  ROpMinIndexReductObjReductionOp<Scalar> >
101 {
102 public:
103 
106  const Scalar &bound_in = Teuchos::ScalarTraits<Scalar>::zero()
107  )
108  {
109  this->setOpNameBase("ROpMinIndexGreaterThanBound");
110  bound(bound_in);
111  this->initReductObjValue(
113  }
115  void bound(const Scalar& bound_in)
116  {
117  this->setEleWiseReduction(
119  );
120  }
122  ScalarIndex<Scalar> operator()(const ReductTarget& reduct_obj ) const
123  { return this->getRawVal(reduct_obj); }
124 
125 };
126 
127 
128 } // namespace RTOpPack
129 
130 
131 #endif // RTOPPACK_ROP_MIN_INDEX_GREATER_THAN_BOUND_HPP
Base class for coordinate-variant scalar reduction RTOps with one input vector.
Teuchos_Ordinal index_type
Returns the minimum element greater than some bound along with its index: result.scalar = x(k) and re...
ROpMinIndexGreaterThanBoundEleWiseReductionOp(const Scalar &bound=ScalarTraits< Scalar >::zero())
Simple struct for a Scalar and an Ordinal object.
Abstract base class for all reduction objects.
void setOpNameBase(const std::string &op_name_base)
Just set the operator name.
ROpMinIndexGreaterThanBound(const Scalar &bound_in=Teuchos::ScalarTraits< Scalar >::zero())
void operator()(const index_type i, const Scalar &v0, ScalarIndex< Scalar > &reduct) const
ScalarIndex< Scalar > operator()(const ReductTarget &reduct_obj) const