RTOp Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOpPack_TOpPairWiseMaxUpdate.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_TOP_PAIR_WISE_MAX_UPDATE_HPP
44 #define RTOPPACK_TOP_PAIR_WISE_MAX_UPDATE_HPP
45 
46 #include "RTOpPack_RTOpTHelpers.hpp"
47 
48 
49 namespace RTOpPack {
50 
51 
53 template<class Scalar>
55 {
56 public:
58  : alpha_(alpha)
59  {}
60  void operator()( const Scalar &v0, Scalar &z0 ) const
61  {
62  z0 = alpha_ * std::max(z0, v0);
63  }
64 private:
65  Scalar alpha_;
66 };
67 
68 
72 template<class Scalar>
74  : public TOp_1_1_Base<Scalar, TOpPairWiseMaxUpdatePairWiseTransformation<Scalar> >
75 {
76 public:
79  TOpPairWiseMaxUpdate( const Scalar &alpha )
81  {
82  this->setOpNameBase("TOpPairWiseMaxUpdate");
83  }
84 };
85 
86 
87 } // namespace RTOpPack
88 
89 
90 #endif // RTOPPACK_TOP_PAIR_WISE_MAX_UPDATE_HPP
TOp_1_1_Base< Scalar, TOpPairWiseMaxUpdatePairWiseTransformation< Scalar > > base_t
Pair-wise Maximum update transformation operator: z0[i] = alpha*max(z0[i],v0[i]), i=0...
Pair-wise transformation operator for TOpPairWiseMaxUpdate.
Base class for transformations for 1 input and 1 output vector.
void setOpNameBase(const std::string &op_name_base)
Just set the operator name.