ROL
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ROL::DykstraProjection< Real > Class Template Reference

#include <ROL_DykstraProjection.hpp>

Inheritance diagram for ROL::DykstraProjection< Real >:

Public Member Functions

 DykstraProjection (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res)
 DykstraProjection (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res, ParameterList &list)
void project (Vector< Real > &x, std::ostream &stream=std::cout) override
Public Member Functions inherited from ROL::PolyhedralProjection< Real >
virtual ~PolyhedralProjection ()
 PolyhedralProjection (const Ptr< BoundConstraint< Real > > &bnd)
 PolyhedralProjection (const Vector< Real > &xprim, const Vector< Real > &xdual, const Ptr< BoundConstraint< Real > > &bnd, const Ptr< Constraint< Real > > &con, const Vector< Real > &mul, const Vector< Real > &res)
const Ptr< Constraint< Real > > getLinearConstraint (void) const
const Ptr< BoundConstraint< Real > > getBoundConstraint (void) const
const Ptr< Vector< Real > > getMultiplier (void) const
const Ptr< Vector< Real > > getResidual (void) const

Private Member Functions

Real residual_1d (const Vector< Real > &x) const
void residual_nd (Vector< Real > &r, const Vector< Real > &y) const
void project_bnd (Vector< Real > &x, const Vector< Real > &y) const
void project_con (Vector< Real > &x, const Vector< Real > &y) const
void project_Dykstra (Vector< Real > &x, std::ostream &stream=std::cout) const

Private Attributes

int dim_
Ptr< Vector< Real > > tmp_
Ptr< Vector< Real > > p_
Ptr< Vector< Real > > q_
Ptr< Vector< Real > > y_
Ptr< Vector< Real > > z_
Real b_
Real cdot_
Real DEFAULT_atol_
Real DEFAULT_rtol_
int DEFAULT_maxit_
int DEFAULT_verbosity_
Real atol_
Real rtol_
int maxit_
int verbosity_

Additional Inherited Members

Protected Attributes inherited from ROL::PolyhedralProjection< Real >
const Ptr< BoundConstraint< Real > > bnd_
const Ptr< Constraint< Real > > con_
Ptr< Vector< Real > > xprim_
Ptr< Vector< Real > > xdual_
Ptr< Vector< Real > > mul_
Ptr< Vector< Real > > res_

Detailed Description

template<typename Real>
class ROL::DykstraProjection< Real >

Definition at line 19 of file ROL_DykstraProjection.hpp.

Constructor & Destructor Documentation

◆ DykstraProjection() [1/2]

template<typename Real>
ROL::DykstraProjection< Real >::DykstraProjection ( const Vector< Real > & xprim,
const Vector< Real > & xdual,
const Ptr< BoundConstraint< Real > > & bnd,
const Ptr< Constraint< Real > > & con,
const Vector< Real > & mul,
const Vector< Real > & res )

Definition at line 16 of file ROL_DykstraProjection_Def.hpp.

References atol_, b_, cdot_, ROL::Vector< Real >::clone(), ROL::PolyhedralProjection< Real >::con_, DEFAULT_atol_, DEFAULT_maxit_, DEFAULT_rtol_, DEFAULT_verbosity_, dim_, ROL::Vector< Real >::dimension(), maxit_, ROL::PolyhedralProjection< Real >::mul_, p_, ROL::PolyhedralProjection< Real >::PolyhedralProjection(), q_, ROL::PolyhedralProjection< Real >::res_, ROL::ROL_EPSILON(), rtol_, ROL::Temp, tmp_, verbosity_, ROL::PolyhedralProjection< Real >::xprim_, y_, and z_.

Referenced by DykstraProjection().

◆ DykstraProjection() [2/2]

template<typename Real>
ROL::DykstraProjection< Real >::DykstraProjection ( const Vector< Real > & xprim,
const Vector< Real > & xdual,
const Ptr< BoundConstraint< Real > > & bnd,
const Ptr< Constraint< Real > > & con,
const Vector< Real > & mul,
const Vector< Real > & res,
ParameterList & list )

Definition at line 52 of file ROL_DykstraProjection_Def.hpp.

References atol_, DEFAULT_atol_, DEFAULT_maxit_, DEFAULT_rtol_, DEFAULT_verbosity_, DykstraProjection(), maxit_, rtol_, and verbosity_.

Member Function Documentation

◆ project()

template<typename Real>
void ROL::DykstraProjection< Real >::project ( Vector< Real > & x,
std::ostream & stream = std::cout )
overridevirtual

Reimplemented from ROL::PolyhedralProjection< Real >.

Definition at line 67 of file ROL_DykstraProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::bnd_, ROL::PolyhedralProjection< Real >::con_, and project_Dykstra().

◆ residual_1d()

template<typename Real>
Real ROL::DykstraProjection< Real >::residual_1d ( const Vector< Real > & x) const
private

Definition at line 77 of file ROL_DykstraProjection_Def.hpp.

References b_, and ROL::PolyhedralProjection< Real >::xprim_.

Referenced by project_con().

◆ residual_nd()

template<typename Real>
void ROL::DykstraProjection< Real >::residual_nd ( Vector< Real > & r,
const Vector< Real > & y ) const
private

Definition at line 82 of file ROL_DykstraProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::con_, ROL::ROL_EPSILON(), and ROL::Temp.

Referenced by project_con().

◆ project_bnd()

template<typename Real>
void ROL::DykstraProjection< Real >::project_bnd ( Vector< Real > & x,
const Vector< Real > & y ) const
private

Definition at line 89 of file ROL_DykstraProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::bnd_, and ROL::Vector< Real >::set().

Referenced by project_Dykstra().

◆ project_con()

template<typename Real>
void ROL::DykstraProjection< Real >::project_con ( Vector< Real > & x,
const Vector< Real > & y ) const
private

Definition at line 95 of file ROL_DykstraProjection_Def.hpp.

References ROL::Vector< Real >::axpy(), cdot_, ROL::PolyhedralProjection< Real >::con_, dim_, ROL::PolyhedralProjection< Real >::mul_, ROL::Vector< Real >::plus(), ROL::PolyhedralProjection< Real >::res_, residual_1d(), residual_nd(), ROL::ROL_EPSILON(), ROL::Vector< Real >::scale(), ROL::Vector< Real >::set(), ROL::PolyhedralProjection< Real >::xprim_, and z_.

Referenced by project_Dykstra().

◆ project_Dykstra()

template<typename Real>
void ROL::DykstraProjection< Real >::project_Dykstra ( Vector< Real > & x,
std::ostream & stream = std::cout ) const
private

Definition at line 112 of file ROL_DykstraProjection_Def.hpp.

References atol_, maxit_, ROL::Vector< Real >::norm(), p_, project_bnd(), project_con(), q_, rtol_, tmp_, verbosity_, and y_.

Referenced by project().

Member Data Documentation

◆ dim_

template<typename Real>
int ROL::DykstraProjection< Real >::dim_
private

Definition at line 21 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_con().

◆ tmp_

template<typename Real>
Ptr<Vector<Real> > ROL::DykstraProjection< Real >::tmp_
private

Definition at line 22 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_Dykstra().

◆ p_

template<typename Real>
Ptr<Vector<Real> > ROL::DykstraProjection< Real >::p_
private

Definition at line 22 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_Dykstra().

◆ q_

template<typename Real>
Ptr<Vector<Real> > ROL::DykstraProjection< Real >::q_
private

Definition at line 22 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_Dykstra().

◆ y_

template<typename Real>
Ptr<Vector<Real> > ROL::DykstraProjection< Real >::y_
private

Definition at line 22 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_Dykstra().

◆ z_

template<typename Real>
Ptr<Vector<Real> > ROL::DykstraProjection< Real >::z_
private

Definition at line 22 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_con().

◆ b_

template<typename Real>
Real ROL::DykstraProjection< Real >::b_
private

Definition at line 23 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and residual_1d().

◆ cdot_

template<typename Real>
Real ROL::DykstraProjection< Real >::cdot_
private

Definition at line 23 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and project_con().

◆ DEFAULT_atol_

template<typename Real>
Real ROL::DykstraProjection< Real >::DEFAULT_atol_
private

Definition at line 25 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and DykstraProjection().

◆ DEFAULT_rtol_

template<typename Real>
Real ROL::DykstraProjection< Real >::DEFAULT_rtol_
private

Definition at line 25 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and DykstraProjection().

◆ DEFAULT_maxit_

template<typename Real>
int ROL::DykstraProjection< Real >::DEFAULT_maxit_
private

Definition at line 26 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and DykstraProjection().

◆ DEFAULT_verbosity_

template<typename Real>
int ROL::DykstraProjection< Real >::DEFAULT_verbosity_
private

Definition at line 26 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), and DykstraProjection().

◆ atol_

template<typename Real>
Real ROL::DykstraProjection< Real >::atol_
private

Definition at line 28 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), DykstraProjection(), and project_Dykstra().

◆ rtol_

template<typename Real>
Real ROL::DykstraProjection< Real >::rtol_
private

Definition at line 28 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), DykstraProjection(), and project_Dykstra().

◆ maxit_

template<typename Real>
int ROL::DykstraProjection< Real >::maxit_
private

Definition at line 29 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), DykstraProjection(), and project_Dykstra().

◆ verbosity_

template<typename Real>
int ROL::DykstraProjection< Real >::verbosity_
private

Definition at line 29 of file ROL_DykstraProjection.hpp.

Referenced by DykstraProjection(), DykstraProjection(), and project_Dykstra().

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0