RTOp Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOpPack_ROpNorm2.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_NORM2_HPP
44 #define RTOPPACK_ROP_NORM2_HPP
45 
46 #include "RTOpPack_RTOpTHelpers.hpp"
47 
48 
49 namespace RTOpPack {
50 
51 
53 template<class Scalar>
55 {
56 public:
57  void operator()( const Scalar &v0, Scalar &reduct ) const
58  {
59  reduct += ScalarTraits<Scalar>::conjugate(v0)*v0;
60  }
61 };
62 
63 
67 template<class Scalar>
68 class ROpNorm2
69  : public ROp_1_ScalarReduction<Scalar, Scalar, ROpNorm2EleWiseReduction<Scalar> >
70 {
71 public:
76  {
77  this->setOpNameBase("ROpNorm2");
78  }
80  typename ST::magnitudeType operator()(const ReductTarget& reduct_obj) const
81  {
82  const Scalar sqrt_reduct = ST::squareroot(this->getRawVal(reduct_obj));
83  return ST::magnitude(sqrt_reduct);
84  }
85 };
86 
87 
88 } // namespace RTOpPack
89 
90 
91 #endif // RTOPPACK_ROP_NORM2_HPP
Base class for scalar reduction RTOps with one input vector.
void operator()(const Scalar &v0, Scalar &reduct) const
static T squareroot(T x)
static T conjugate(T a)
ST::magnitudeType operator()(const ReductTarget &reduct_obj) const
Two (Euclidean) norm reduction operator: result = sqrt( sum( conj(v0[i])*v0[i], i=0...n-1 ) ).
Abstract base class for all reduction objects.
void setOpNameBase(const std::string &op_name_base)
Just set the operator name.
static magnitudeType magnitude(T a)
Teuchos::ScalarTraits< Scalar > ST