RTOp Package Browser (Single Doxygen Collection) Version of the Day
RTOpPack_ROpNorm2.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
00005 //       Operations
00006 //                Copyright (2006) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00039 // 
00040 // ***********************************************************************
00041 // @HEADER
00042 
00043 #ifndef RTOPPACK_ROP_NORM2_HPP
00044 #define RTOPPACK_ROP_NORM2_HPP
00045 
00046 #include "RTOpPack_RTOpTHelpers.hpp"
00047 
00048 
00049 namespace RTOpPack {
00050 
00051 
00053 template<class Scalar>
00054 class ROpNorm2EleWiseReduction
00055 {
00056 public:
00057   void operator()( const Scalar &v0, Scalar &reduct ) const
00058     {
00059       reduct += ScalarTraits<Scalar>::conjugate(v0)*v0;
00060     }
00061 };
00062 
00063 
00067 template<class Scalar>
00068 class ROpNorm2
00069   : public ROp_1_ScalarReduction<Scalar, Scalar, ROpNorm2EleWiseReduction<Scalar> >
00070 {
00071 public:
00073   typedef Teuchos::ScalarTraits<Scalar> ST;
00075   ROpNorm2()
00076     {
00077       this->setOpNameBase("ROpNorm2");
00078     }
00080   typename ST::magnitudeType operator()(const ReductTarget& reduct_obj) const
00081     {
00082       const Scalar sqrt_reduct = ST::squareroot(this->getRawVal(reduct_obj));
00083       return ST::magnitude(sqrt_reduct);
00084     }
00085 };
00086 
00087 
00088 } // namespace RTOpPack
00089 
00090 
00091 #endif // RTOPPACK_ROP_NORM2_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines