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

#include <ROL_RiddersProjection.hpp>

Inheritance diagram for ROL::RiddersProjection< Real >:

Public Member Functions

 RiddersProjection (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)
 RiddersProjection (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

void initialize (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)
Real residual (const Vector< Real > &x) const
void update_primal (Vector< Real > &y, const Vector< Real > &x, const Real lam) const
void project_df (Vector< Real > &x, Real &lam, Real &dlam, std::ostream &stream=std::cout) const

Private Attributes

int dim_
Ptr< Vector< Real > > xnew_
Ptr< Vector< Real > > Px_
Real b_
Real mul1_
Real dlam1_
Real cdot_
Real DEFAULT_atol_
Real DEFAULT_rtol_
Real DEFAULT_ltol_
int DEFAULT_maxit_
int DEFAULT_verbosity_
Real atol_
Real rtol_
Real ltol_
int maxit_
int verbosity_
Real ctol_

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

Definition at line 19 of file ROL_RiddersProjection.hpp.

Constructor & Destructor Documentation

◆ RiddersProjection() [1/2]

template<typename Real>
ROL::RiddersProjection< Real >::RiddersProjection ( 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_RiddersProjection_Def.hpp.

References atol_, DEFAULT_atol_, DEFAULT_ltol_, DEFAULT_maxit_, DEFAULT_rtol_, DEFAULT_verbosity_, initialize(), ltol_, maxit_, ROL::PolyhedralProjection< Real >::PolyhedralProjection(), ROL::ROL_EPSILON(), rtol_, and verbosity_.

◆ RiddersProjection() [2/2]

template<typename Real>
ROL::RiddersProjection< Real >::RiddersProjection ( 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 37 of file ROL_RiddersProjection_Def.hpp.

References atol_, DEFAULT_atol_, DEFAULT_ltol_, DEFAULT_maxit_, DEFAULT_rtol_, DEFAULT_verbosity_, initialize(), ltol_, maxit_, ROL::PolyhedralProjection< Real >::PolyhedralProjection(), ROL::ROL_EPSILON(), rtol_, and verbosity_.

Member Function Documentation

◆ initialize()

template<typename Real>
void ROL::RiddersProjection< Real >::initialize ( 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 )
private

Definition at line 64 of file ROL_RiddersProjection_Def.hpp.

References atol_, b_, ROL::PolyhedralProjection< Real >::bnd_, cdot_, ROL::Vector< Real >::clone(), ROL::PolyhedralProjection< Real >::con_, ctol_, dim_, ROL::Vector< Real >::dimension(), dlam1_, mul1_, ROL::PolyhedralProjection< Real >::mul_, Px_, ROL::PolyhedralProjection< Real >::res_, residual(), ROL::ROL_EPSILON(), ROL::ROL_INF(), rtol_, ROL::Temp, ROL::PolyhedralProjection< Real >::xdual_, xnew_, and ROL::PolyhedralProjection< Real >::xprim_.

Referenced by RiddersProjection(), and RiddersProjection().

◆ project()

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

Reimplemented from ROL::PolyhedralProjection< Real >.

Definition at line 100 of file ROL_RiddersProjection_Def.hpp.

References ROL::PolyhedralProjection< Real >::bnd_, cdot_, ROL::PolyhedralProjection< Real >::con_, dlam1_, mul1_, ROL::PolyhedralProjection< Real >::mul_, project_df(), and residual().

◆ residual()

template<typename Real>
Real ROL::RiddersProjection< Real >::residual ( const Vector< Real > & x) const
private

Definition at line 115 of file ROL_RiddersProjection_Def.hpp.

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

Referenced by initialize(), project(), and project_df().

◆ update_primal()

template<typename Real>
void ROL::RiddersProjection< Real >::update_primal ( Vector< Real > & y,
const Vector< Real > & x,
const Real lam ) const
private

Definition at line 120 of file ROL_RiddersProjection_Def.hpp.

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

Referenced by project_df().

◆ project_df()

template<typename Real>
void ROL::RiddersProjection< Real >::project_df ( Vector< Real > & x,
Real & lam,
Real & dlam,
std::ostream & stream = std::cout ) const
private

Definition at line 127 of file ROL_RiddersProjection_Def.hpp.

References ctol_, ltol_, maxit_, residual(), ROL::Vector< Real >::set(), update_primal(), verbosity_, xnew_, and zero.

Referenced by project().

Member Data Documentation

◆ dim_

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

Definition at line 21 of file ROL_RiddersProjection.hpp.

Referenced by initialize().

◆ xnew_

template<typename Real>
Ptr<Vector<Real> > ROL::RiddersProjection< Real >::xnew_
private

Definition at line 22 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), and project_df().

◆ Px_

template<typename Real>
Ptr<Vector<Real> > ROL::RiddersProjection< Real >::Px_
private

Definition at line 22 of file ROL_RiddersProjection.hpp.

Referenced by initialize().

◆ b_

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

Definition at line 23 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), and residual().

◆ mul1_

template<typename Real>
Real ROL::RiddersProjection< Real >::mul1_
private

Definition at line 23 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), and project().

◆ dlam1_

template<typename Real>
Real ROL::RiddersProjection< Real >::dlam1_
private

Definition at line 23 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), and project().

◆ cdot_

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

Definition at line 23 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), and project().

◆ DEFAULT_atol_

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

Definition at line 25 of file ROL_RiddersProjection.hpp.

Referenced by RiddersProjection(), and RiddersProjection().

◆ DEFAULT_rtol_

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

Definition at line 25 of file ROL_RiddersProjection.hpp.

Referenced by RiddersProjection(), and RiddersProjection().

◆ DEFAULT_ltol_

template<typename Real>
Real ROL::RiddersProjection< Real >::DEFAULT_ltol_
private

Definition at line 25 of file ROL_RiddersProjection.hpp.

Referenced by RiddersProjection(), and RiddersProjection().

◆ DEFAULT_maxit_

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

Definition at line 26 of file ROL_RiddersProjection.hpp.

Referenced by RiddersProjection(), and RiddersProjection().

◆ DEFAULT_verbosity_

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

Definition at line 26 of file ROL_RiddersProjection.hpp.

Referenced by RiddersProjection(), and RiddersProjection().

◆ atol_

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

Definition at line 28 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), RiddersProjection(), and RiddersProjection().

◆ rtol_

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

Definition at line 28 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), RiddersProjection(), and RiddersProjection().

◆ ltol_

template<typename Real>
Real ROL::RiddersProjection< Real >::ltol_
private

Definition at line 28 of file ROL_RiddersProjection.hpp.

Referenced by project_df(), RiddersProjection(), and RiddersProjection().

◆ maxit_

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

Definition at line 29 of file ROL_RiddersProjection.hpp.

Referenced by project_df(), RiddersProjection(), and RiddersProjection().

◆ verbosity_

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

Definition at line 29 of file ROL_RiddersProjection.hpp.

Referenced by project_df(), RiddersProjection(), and RiddersProjection().

◆ ctol_

template<typename Real>
Real ROL::RiddersProjection< Real >::ctol_
private

Definition at line 31 of file ROL_RiddersProjection.hpp.

Referenced by initialize(), and project_df().

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