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

#include <ROL_PolyhedralProjection.hpp>

Inheritance diagram for ROL::PolyhedralProjection< Real >:

Public Member Functions

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)
virtual void project (Vector< Real > &x, std::ostream &stream=std::cout)
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

Protected Attributes

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::PolyhedralProjection< Real >

Definition at line 20 of file ROL_PolyhedralProjection.hpp.

Constructor & Destructor Documentation

◆ ~PolyhedralProjection()

template<typename Real>
virtual ROL::PolyhedralProjection< Real >::~PolyhedralProjection ( )
inlinevirtual

Definition at line 27 of file ROL_PolyhedralProjection.hpp.

◆ PolyhedralProjection() [1/2]

template<typename Real>
ROL::PolyhedralProjection< Real >::PolyhedralProjection ( const Ptr< BoundConstraint< Real > > & bnd)

Definition at line 16 of file ROL_PolyhedralProjection_Def.hpp.

References bnd_, and con_.

Referenced by ROL::BrentsProjection< Real >::BrentsProjection(), ROL::BrentsProjection< Real >::BrentsProjection(), ROL::DaiFletcherProjection< Real >::DaiFletcherProjection(), ROL::DaiFletcherProjection< Real >::DaiFletcherProjection(), ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), ROL::RiddersProjection< Real >::RiddersProjection(), ROL::RiddersProjection< Real >::RiddersProjection(), ROL::SemismoothNewtonProjection< Real >::SemismoothNewtonProjection(), and ROL::SemismoothNewtonProjection< Real >::SemismoothNewtonProjection().

◆ PolyhedralProjection() [2/2]

template<typename Real>
ROL::PolyhedralProjection< Real >::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 )

Definition at line 20 of file ROL_PolyhedralProjection_Def.hpp.

References bnd_, ROL::Vector< Real >::clone(), con_, mul_, res_, xdual_, and xprim_.

Member Function Documentation

◆ project()

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

Reimplemented in ROL::BrentsProjection< Real >, ROL::DaiFletcherProjection< Real >, ROL::DouglasRachfordProjection< Real >, ROL::DykstraProjection< Real >, ROL::RiddersProjection< Real >, and ROL::SemismoothNewtonProjection< Real >.

Definition at line 34 of file ROL_PolyhedralProjection_Def.hpp.

References bnd_, and con_.

◆ getLinearConstraint()

template<typename Real>
const Ptr< Constraint< Real > > ROL::PolyhedralProjection< Real >::getLinearConstraint ( void ) const

Definition at line 44 of file ROL_PolyhedralProjection_Def.hpp.

References con_.

◆ getBoundConstraint()

template<typename Real>
const Ptr< BoundConstraint< Real > > ROL::PolyhedralProjection< Real >::getBoundConstraint ( void ) const

Definition at line 49 of file ROL_PolyhedralProjection_Def.hpp.

References bnd_.

◆ getMultiplier()

template<typename Real>
const Ptr< Vector< Real > > ROL::PolyhedralProjection< Real >::getMultiplier ( void ) const

Definition at line 54 of file ROL_PolyhedralProjection_Def.hpp.

References mul_.

◆ getResidual()

template<typename Real>
const Ptr< Vector< Real > > ROL::PolyhedralProjection< Real >::getResidual ( void ) const

Definition at line 59 of file ROL_PolyhedralProjection_Def.hpp.

References res_.

Member Data Documentation

◆ bnd_

template<typename Real>
const Ptr<BoundConstraint<Real> > ROL::PolyhedralProjection< Real >::bnd_
protected

Definition at line 22 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::SemismoothNewtonProjection< Real >::compute_tolerance(), getBoundConstraint(), ROL::BrentsProjection< Real >::initialize(), ROL::DaiFletcherProjection< Real >::initialize(), ROL::RiddersProjection< Real >::initialize(), PolyhedralProjection(), PolyhedralProjection(), ROL::BrentsProjection< Real >::project(), ROL::DaiFletcherProjection< Real >::project(), ROL::DouglasRachfordProjection< Real >::project(), ROL::DykstraProjection< Real >::project(), project(), ROL::RiddersProjection< Real >::project(), ROL::SemismoothNewtonProjection< Real >::project(), ROL::DouglasRachfordProjection< Real >::project_bnd(), ROL::DykstraProjection< Real >::project_bnd(), ROL::SemismoothNewtonProjection< Real >::solve_newton_system(), ROL::BrentsProjection< Real >::update_primal(), ROL::DaiFletcherProjection< Real >::update_primal(), ROL::RiddersProjection< Real >::update_primal(), and ROL::SemismoothNewtonProjection< Real >::update_primal().

◆ con_

template<typename Real>
const Ptr<Constraint<Real> > ROL::PolyhedralProjection< Real >::con_
protected

Definition at line 23 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), getLinearConstraint(), ROL::BrentsProjection< Real >::initialize(), ROL::DaiFletcherProjection< Real >::initialize(), ROL::RiddersProjection< Real >::initialize(), PolyhedralProjection(), PolyhedralProjection(), ROL::BrentsProjection< Real >::project(), ROL::DaiFletcherProjection< Real >::project(), ROL::DouglasRachfordProjection< Real >::project(), ROL::DykstraProjection< Real >::project(), project(), ROL::RiddersProjection< Real >::project(), ROL::SemismoothNewtonProjection< Real >::project(), ROL::DouglasRachfordProjection< Real >::project_con(), ROL::DykstraProjection< Real >::project_con(), ROL::SemismoothNewtonProjection< Real >::residual(), ROL::DouglasRachfordProjection< Real >::residual_nd(), ROL::DykstraProjection< Real >::residual_nd(), ROL::SemismoothNewtonProjection< Real >::solve_newton_system(), and ROL::SemismoothNewtonProjection< Real >::update_primal().

◆ xprim_

template<typename Real>
Ptr<Vector<Real> > ROL::PolyhedralProjection< Real >::xprim_
protected

Definition at line 24 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), ROL::BrentsProjection< Real >::initialize(), ROL::DaiFletcherProjection< Real >::initialize(), ROL::RiddersProjection< Real >::initialize(), PolyhedralProjection(), ROL::DouglasRachfordProjection< Real >::project_con(), ROL::DykstraProjection< Real >::project_con(), ROL::BrentsProjection< Real >::residual(), ROL::DaiFletcherProjection< Real >::residual(), ROL::RiddersProjection< Real >::residual(), ROL::DouglasRachfordProjection< Real >::residual_1d(), ROL::DykstraProjection< Real >::residual_1d(), ROL::SemismoothNewtonProjection< Real >::solve_newton_system(), ROL::BrentsProjection< Real >::update_primal(), ROL::DaiFletcherProjection< Real >::update_primal(), and ROL::RiddersProjection< Real >::update_primal().

◆ xdual_

template<typename Real>
Ptr<Vector<Real> > ROL::PolyhedralProjection< Real >::xdual_
protected

Definition at line 24 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::BrentsProjection< Real >::initialize(), ROL::DaiFletcherProjection< Real >::initialize(), ROL::RiddersProjection< Real >::initialize(), PolyhedralProjection(), ROL::SemismoothNewtonProjection< Real >::solve_newton_system(), and ROL::SemismoothNewtonProjection< Real >::update_primal().

◆ mul_

template<typename Real>
Ptr<Vector<Real> > ROL::PolyhedralProjection< Real >::mul_
protected

Definition at line 24 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), getMultiplier(), ROL::BrentsProjection< Real >::initialize(), ROL::DaiFletcherProjection< Real >::initialize(), ROL::RiddersProjection< Real >::initialize(), PolyhedralProjection(), ROL::BrentsProjection< Real >::project(), ROL::DaiFletcherProjection< Real >::project(), ROL::RiddersProjection< Real >::project(), ROL::SemismoothNewtonProjection< Real >::project(), ROL::DouglasRachfordProjection< Real >::project_con(), and ROL::DykstraProjection< Real >::project_con().

◆ res_

template<typename Real>
Ptr<Vector<Real> > ROL::PolyhedralProjection< Real >::res_
protected

Definition at line 24 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::SemismoothNewtonProjection< Real >::compute_tolerance(), ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), getResidual(), ROL::BrentsProjection< Real >::initialize(), ROL::DaiFletcherProjection< Real >::initialize(), ROL::RiddersProjection< Real >::initialize(), PolyhedralProjection(), ROL::DouglasRachfordProjection< Real >::project_con(), ROL::DykstraProjection< Real >::project_con(), and ROL::SemismoothNewtonProjection< Real >::project_ssn().

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