ROL_VectorNorms.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER

#ifndef ROL_VECTORNORMS_H
#define ROL_VECTORNORMS_H

#include "ROL_Vector.hpp"

namespace ROL {

template<class Real>
Real normL1( const Vector<Real> &x ) {
 
  ROL::Ptr<Vector<Real> > xabs = x.clone();
  xabs->set(x);

  xabs->applyUnary(Elementwise::AbsoluteValue<Real>());
  return xabs->reduce(Elementwise::ReductionSum<Real>());
}

template<class Real, class Exponent>
Real normLp( const Vector<Real> &x, Exponent p ) {

  ROL::Ptr<Vector<Real> > xabsp = x.clone();
  xabsp->set(x);
  xabsp->applyUnary(Elementwise::AbsoluteValue<Real>());
  xabsp->applyUnary(Elementwise::Power<Real>(p)); 
  Real sum = xabsp->reduce(Elementwise::ReductionSum<Real>());
  return std::pow(sum,1.0/p);
}

template<class Real>
Real normLinf( const Vector<Real> &x ) {
 
  ROL::Ptr<Vector<Real> > xabs = x.clone();
  xabs->set(x);

  xabs->applyUnary(Elementwise::AbsoluteValue<Real>());
  return xabs->reduce(Elementwise::ReductionMax<Real>());
}



} // namespace ROL

#endif // ROL_VECTORNORMS_H