ROL
ROL_VectorNorms.hpp
Go to the documentation of this file.
1// @HEADER
2// ************************************************************************
3//
4// Rapid Optimization Library (ROL) Package
5// Copyright (2014) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact lead developers:
38// Drew Kouri (dpkouri@sandia.gov) and
39// Denis Ridzal (dridzal@sandia.gov)
40//
41// ************************************************************************
42// @HEADER
43
44#ifndef ROL_VECTORNORMS_H
45#define ROL_VECTORNORMS_H
46
47#include "ROL_Vector.hpp"
48
49namespace ROL {
50
51template<class Real>
52Real normL1( const Vector<Real> &x ) {
53
54 ROL::Ptr<Vector<Real> > xabs = x.clone();
55 xabs->set(x);
56
57 xabs->applyUnary(Elementwise::AbsoluteValue<Real>());
58 return xabs->reduce(Elementwise::ReductionSum<Real>());
59}
60
61template<class Real, class Exponent>
62Real normLp( const Vector<Real> &x, Exponent p ) {
63
64 ROL::Ptr<Vector<Real> > xabsp = x.clone();
65 xabsp->set(x);
66 xabsp->applyUnary(Elementwise::AbsoluteValue<Real>());
67 xabsp->applyUnary(Elementwise::Power<Real>(p));
68 Real sum = xabsp->reduce(Elementwise::ReductionSum<Real>());
69 return std::pow(sum,1.0/p);
70}
71
72template<class Real>
73Real normLinf( const Vector<Real> &x ) {
74
75 ROL::Ptr<Vector<Real> > xabs = x.clone();
76 xabs->set(x);
77
78 xabs->applyUnary(Elementwise::AbsoluteValue<Real>());
79 return xabs->reduce(Elementwise::ReductionMax<Real>());
80}
81
82
83
84} // namespace ROL
85
86#endif // ROL_VECTORNORMS_H
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
Real normL1(const Vector< Real > &x)
Real normLp(const Vector< Real > &x, Exponent p)
Real normLinf(const Vector< Real > &x)