RTOp Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
RTOpPack_ROpMaxIndexLessThanBound.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_MAX_INDEX_LESS_THAN_BOUND_HPP
44#define RTOPPACK_ROP_MAX_INDEX_LESS_THAN_BOUND_HPP
45
47#include "Teuchos_StandardMemberCompositionMacros.hpp"
48
49
50namespace RTOpPack {
51
52
54template<class Scalar>
56public:
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 }
80private:
81 Scalar bound_;
82};
83
84
94template<class Scalar>
97 Scalar,
98 ScalarIndex<Scalar>,
99 ROpMaxIndexLessThanBoundEleWiseReductionOp<Scalar>,
100 ROpMaxIndexReductObjReductionOp<Scalar> >
101{
102public:
105 const Scalar &bound_in = Teuchos::ScalarTraits<Scalar>::zero()
106 )
107 {
108 this->setOpNameBase("ROpMaxIndexLessThanBound");
109 bound(bound_in);
110 this->initReductObjValue(
111 ScalarIndex<Scalar>(-ScalarTraits<Scalar>::rmax(), -1));
112 }
114 void bound(const Scalar& bound_in)
115 {
118 );
119 }
122 { return this->getRawVal(reduct_obj); }
123};
124
125
126} // namespace RTOpPack
127
128
129#endif // RTOPPACK_ROP_MAX_INDEX_LESS_THAN_BOUND_HPP
void operator()(const index_type i, const Scalar &v0, ScalarIndex< Scalar > &reduct) const
ROpMaxIndexLessThanBoundEleWiseReductionOp(const Scalar &bound=ScalarTraits< Scalar >::zero())
Returns the maximum element less than some bound along with its index: result.scalar = x(k) and resul...
ROpMaxIndexLessThanBound(const Scalar &bound_in=Teuchos::ScalarTraits< Scalar >::zero())
ScalarIndex< Scalar > operator()(const ReductTarget &reduct_obj) const
const ConcreteReductObj & getRawVal(const ReductTarget &reduct_obj) const
Base class for coordinate-variant scalar reduction RTOps with one input vector.
void setOpNameBase(const std::string &op_name_base)
Just set the operator name.
Abstract base class for all reduction objects.
Teuchos_Ordinal index_type
Simple struct for a Scalar and an Ordinal object.