ROL
Loading...
Searching...
No Matches
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)
 
virtual void applyJacobian (Vector< Real > &v, const Vector< Real > &x)
 
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
 
- Public Member Functions inherited from ROL::Projection< Real >
virtual ~Projection ()
 

Protected Attributes

const Ptr< BoundConstraint< Real > > bnd_
 
const Ptr< Constraint< Real > > con_
 
Ptr< ReducedLinearConstraint< Real > > rcon_
 
Ptr< NullSpaceOperator< Real > > ns_
 
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 23 of file ROL_PolyhedralProjection.hpp.

Constructor & Destructor Documentation

◆ ~PolyhedralProjection()

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

Definition at line 32 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.

◆ 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 ROL::Vector< Real >::clone(), ROL::PolyhedralProjection< Real >::con_, ROL::PolyhedralProjection< Real >::mul_, ROL::PolyhedralProjection< Real >::ns_, ROL::PolyhedralProjection< Real >::rcon_, ROL::PolyhedralProjection< Real >::res_, ROL::PolyhedralProjection< Real >::xdual_, and ROL::PolyhedralProjection< Real >::xprim_.

Member Function Documentation

◆ project()

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

Implements ROL::Projection< Real >.

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

Definition at line 38 of file ROL_PolyhedralProjection_Def.hpp.

◆ applyJacobian()

template<typename Real >
void ROL::PolyhedralProjection< Real >::applyJacobian ( Vector< Real > &  v,
const Vector< Real > &  x 
)
virtual

Reimplemented from ROL::Projection< Real >.

Reimplemented in ROL::ZeroProjection< Real >.

Definition at line 48 of file ROL_PolyhedralProjection_Def.hpp.

◆ getLinearConstraint()

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

Definition at line 61 of file ROL_PolyhedralProjection_Def.hpp.

◆ getBoundConstraint()

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

Definition at line 66 of file ROL_PolyhedralProjection_Def.hpp.

◆ getMultiplier()

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

Definition at line 71 of file ROL_PolyhedralProjection_Def.hpp.

◆ getResidual()

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

Definition at line 76 of file ROL_PolyhedralProjection_Def.hpp.

Member Data Documentation

◆ bnd_

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

Definition at line 25 of file ROL_PolyhedralProjection.hpp.

◆ con_

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

Definition at line 26 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), and ROL::PolyhedralProjection< Real >::PolyhedralProjection().

◆ rcon_

template<typename Real >
Ptr<ReducedLinearConstraint<Real> > ROL::PolyhedralProjection< Real >::rcon_
protected

Definition at line 27 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::PolyhedralProjection< Real >::PolyhedralProjection().

◆ ns_

template<typename Real >
Ptr<NullSpaceOperator<Real> > ROL::PolyhedralProjection< Real >::ns_
protected

Definition at line 28 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::PolyhedralProjection< Real >::PolyhedralProjection().

◆ xprim_

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

Definition at line 29 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), and ROL::PolyhedralProjection< Real >::PolyhedralProjection().

◆ xdual_

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

Definition at line 29 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::PolyhedralProjection< Real >::PolyhedralProjection().

◆ mul_

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

Definition at line 29 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), and ROL::PolyhedralProjection< Real >::PolyhedralProjection().

◆ res_

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

Definition at line 29 of file ROL_PolyhedralProjection.hpp.

Referenced by ROL::DouglasRachfordProjection< Real >::DouglasRachfordProjection(), ROL::DykstraProjection< Real >::DykstraProjection(), and ROL::PolyhedralProjection< Real >::PolyhedralProjection().

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