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

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 54 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 
)

◆ 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 
)

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

◆ 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 135 of file ROL_RiddersProjection_Def.hpp.

◆ residual()

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

Definition at line 150 of file ROL_RiddersProjection_Def.hpp.

◆ update_primal()

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

◆ 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 162 of file ROL_RiddersProjection_Def.hpp.

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

Member Data Documentation

◆ dim_

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

Definition at line 56 of file ROL_RiddersProjection.hpp.

◆ xnew_

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

Definition at line 57 of file ROL_RiddersProjection.hpp.

◆ Px_

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

Definition at line 57 of file ROL_RiddersProjection.hpp.

◆ b_

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

Definition at line 58 of file ROL_RiddersProjection.hpp.

◆ mul1_

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

Definition at line 58 of file ROL_RiddersProjection.hpp.

◆ dlam1_

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

Definition at line 58 of file ROL_RiddersProjection.hpp.

◆ cdot_

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

Definition at line 58 of file ROL_RiddersProjection.hpp.

◆ DEFAULT_atol_

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

◆ DEFAULT_rtol_

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

◆ DEFAULT_ltol_

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

◆ DEFAULT_maxit_

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

◆ DEFAULT_verbosity_

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

◆ atol_

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

◆ rtol_

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

◆ ltol_

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

◆ maxit_

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

◆ verbosity_

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

◆ ctol_

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

Definition at line 66 of file ROL_RiddersProjection.hpp.


The documentation for this class was generated from the following files: