ROL
ROL_ShiftedProxObjective.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_SHIFTEDPROXOBJECTIVE_HPP
45#define ROL_SHIFTEDPROXOBJECTIVE_HPP
46
47#include "ROL_ProxObjective.hpp"
48
49namespace ROL {
50
51template<typename Real>
52class ShiftedProxObjective : public ProxObjective<Real> {
53private:
54 const Ptr<ProxObjective<Real>> prox_;
55 const Ptr<Vector<Real>> x_, xtmp_;
56
57public:
59 : prox_(prox), x_(x->clone()), xtmp_(x->clone()) {}
60
61 void setX(const Vector<Real> &x) {
62 x_->set(x);
63 }
64
65 Real value(const Vector<Real> x, Real &tol) override {
66 xtmp_->set(*x_); xtmp_->plus(x);
67 return prox_->(*xtmp_,tol);
68 }
69
70 void gradient(Vector<Real> &g, const Vector<Real> &x, Real &tol) override {
71 xtmp_->set(*x_); xtmp_->plus(x);
72 prox_->gradient(g,*xtmp_,tol);
73 }
74
75 void prox(Vector<Real> &x, Real gamma) override {
76 x.plus(*x_);
77 prox_->prox(x,gamma);
78 x.axpy(static_cast<Real>(-1),*x_);
79 }
80
81};
82
83}
84
85#endif
const Ptr< Vector< Real > > x_
const Ptr< Vector< Real > > xtmp_
void prox(Vector< Real > &x, Real gamma) override
const Ptr< ProxObjective< Real > > prox_
Real value(const Vector< Real > x, Real &tol) override
void setX(const Vector< Real > &x)
ShiftedProxObjective(const Ptr< ProxObjective< Real > > &prox, const Ptr< Vector< Real > > &x)
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol) override
Compute gradient.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:84
virtual void plus(const Vector &x)=0
Compute , where .
virtual void axpy(const Real alpha, const Vector &x)
Compute where .
Definition: ROL_Vector.hpp:153