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

Provides a wrapper for multiple constraints. More...

#include <ROL_ConstraintAssembler.hpp>

Public Member Functions

virtual ~ConstraintAssembler ()
 
 ConstraintAssembler (const std::unordered_map< std::string, ConstraintData< Real >> &con, const Ptr< Vector< Real >> &xprim, const Ptr< Vector< Real >> &xdual, const Ptr< BoundConstraint< Real >> &bnd=nullPtr)
 
 ConstraintAssembler (const std::unordered_map< std::string, ConstraintData< Real >> &con, const std::unordered_map< std::string, ConstraintData< Real >> &linear_con, const Ptr< Vector< Real >> &xprim, const Ptr< Vector< Real >> &xdual, const Ptr< BoundConstraint< Real >> &bnd=nullPtr)
 
const Ptr< Constraint< Real > > & getConstraint () const
 
const Ptr< Vector< Real > > & getMultiplier () const
 
const Ptr< Vector< Real > > & getResidual () const
 
const Ptr< Constraint< Real > > & getLinearConstraint () const
 
const Ptr< Vector< Real > > & getLinearMultiplier () const
 
const Ptr< Vector< Real > > & getLinearResidual () const
 
const Ptr< Vector< Real > > & getOptVector () const
 
const Ptr< Vector< Real > > & getDualOptVector () const
 
const Ptr< BoundConstraint
< Real > > & 		getBoundConstraint () const
 
bool isNull () const
 
bool hasInequality () const
 
void resetSlackVariables ()
 

Private Member Functions

void initializeSlackVariable (const Ptr< Constraint< Real >> &con, const Ptr< BoundConstraint< Real >> &cbnd, const Ptr< Vector< Real >> &s, const Ptr< Vector< Real >> &x) const
 
void initialize (const std::unordered_map< std::string, ConstraintData< Real >> &input_con, const Ptr< Vector< Real >> &xprim, const Ptr< Vector< Real >> &xdual, const Ptr< BoundConstraint< Real >> &bnd)
 
void initialize (const std::unordered_map< std::string, ConstraintData< Real >> &input_con, const std::unordered_map< std::string, ConstraintData< Real >> &input_lcon, const Ptr< Vector< Real >> &xprim, const Ptr< Vector< Real >> &xdual, const Ptr< BoundConstraint< Real >> &bnd)
 

Private Attributes

Ptr< Constraint< Real > > con_
 
Ptr< Vector< Real > > mul_
 
Ptr< Vector< Real > > res_
 
Ptr< Constraint< Real > > linear_con_
 
Ptr< Vector< Real > > linear_mul_
 
Ptr< Vector< Real > > linear_res_
 
Ptr< Vector< Real > > xprim_
 
Ptr< Vector< Real > > xdual_
 
Ptr< BoundConstraint< Real > > bnd_
 
std::vector< Ptr< Constraint
< Real > > > 		cvec_
 
std::vector< Ptr< Vector< Real > > > lvec_
 
std::vector< Ptr< Vector< Real > > > rvec_
 
std::vector< Ptr< Constraint
< Real > > > 		lcvec_
 
std::vector< Ptr< Vector< Real > > > llvec_
 
std::vector< Ptr< Vector< Real > > > lrvec_
 
std::vector< Ptr< Vector< Real > > > psvec_
 
std::vector< Ptr< Vector< Real > > > dsvec_
 
std::vector< Ptr
< BoundConstraint< Real > > > 		sbnd_
 
std::vector< bool > isInequality_
 
std::vector< bool > isLinearInequality_
 
bool isNull_
 
bool hasInequality_
 

Detailed Description

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

Provides a wrapper for multiple constraints.

Definition at line 76 of file ROL_ConstraintAssembler.hpp.

Constructor & Destructor Documentation

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

Definition at line 120 of file ROL_ConstraintAssembler.hpp.

template<typename Real >
ROL::ConstraintAssembler< Real >::ConstraintAssembler ( const std::unordered_map< std::string, ConstraintData< Real >> &  con,
const Ptr< Vector< Real >> &  xprim,
const Ptr< Vector< Real >> &  xdual,
const Ptr< BoundConstraint< Real >> &  bnd = nullPtr 
)

Definition at line 283 of file ROL_ConstraintAssembler_Def.hpp.

References ROL::ConstraintAssembler< Real >::initialize().

template<typename Real >
ROL::ConstraintAssembler< Real >::ConstraintAssembler ( const std::unordered_map< std::string, ConstraintData< Real >> &  con,
const std::unordered_map< std::string, ConstraintData< Real >> &  linear_con,
const Ptr< Vector< Real >> &  xprim,
const Ptr< Vector< Real >> &  xdual,
const Ptr< BoundConstraint< Real >> &  bnd = nullPtr 
)

Definition at line 292 of file ROL_ConstraintAssembler_Def.hpp.

References ROL::ConstraintAssembler< Real >::initialize().

Member Function Documentation

template<typename Real >
void ROL::ConstraintAssembler< Real >::initializeSlackVariable ( const Ptr< Constraint< Real >> &  con,
const Ptr< BoundConstraint< Real >> &  cbnd,
const Ptr< Vector< Real >> &  s,
const Ptr< Vector< Real >> &  x 
) const
private

Definition at line 50 of file ROL_ConstraintAssembler_Def.hpp.

template<typename Real >
void ROL::ConstraintAssembler< Real >::initialize ( const std::unordered_map< std::string, ConstraintData< Real >> &  input_con,
const Ptr< Vector< Real >> &  xprim,
const Ptr< Vector< Real >> &  xdual,
const Ptr< BoundConstraint< Real >> &  bnd 
)
private

Definition at line 61 of file ROL_ConstraintAssembler_Def.hpp.

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

template<typename Real >
void ROL::ConstraintAssembler< Real >::initialize ( const std::unordered_map< std::string, ConstraintData< Real >> &  input_con,
const std::unordered_map< std::string, ConstraintData< Real >> &  input_lcon,
const Ptr< Vector< Real >> &  xprim,
const Ptr< Vector< Real >> &  xdual,
const Ptr< BoundConstraint< Real >> &  bnd 
)
private

Definition at line 148 of file ROL_ConstraintAssembler_Def.hpp.

template<typename Real >
const Ptr< Constraint< Real > > & ROL::ConstraintAssembler< Real >::getConstraint ( ) const

Definition at line 302 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

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

Definition at line 307 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

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

Definition at line 312 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

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

Definition at line 317 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

template<typename Real >
const Ptr< Vector< Real > > & ROL::ConstraintAssembler< Real >::getLinearMultiplier ( ) const

Definition at line 322 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

template<typename Real >
const Ptr< Vector< Real > > & ROL::ConstraintAssembler< Real >::getLinearResidual ( ) const

Definition at line 327 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

template<typename Real >
const Ptr< Vector< Real > > & ROL::ConstraintAssembler< Real >::getOptVector ( ) const

Definition at line 332 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

template<typename Real >
const Ptr< Vector< Real > > & ROL::ConstraintAssembler< Real >::getDualOptVector ( ) const

Definition at line 337 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

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

Definition at line 342 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

template<typename Real >
bool ROL::ConstraintAssembler< Real >::isNull ( ) const

Definition at line 347 of file ROL_ConstraintAssembler_Def.hpp.

template<typename Real >
bool ROL::ConstraintAssembler< Real >::hasInequality ( ) const

Definition at line 352 of file ROL_ConstraintAssembler_Def.hpp.

Referenced by ROL::Problem< Real >::finalize().

template<typename Real >
void ROL::ConstraintAssembler< Real >::resetSlackVariables ( )

Definition at line 357 of file ROL_ConstraintAssembler_Def.hpp.

Member Data Documentation

template<typename Real>
Ptr<Constraint<Real> > ROL::ConstraintAssembler< Real >::con_
private

Definition at line 78 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Vector<Real> > ROL::ConstraintAssembler< Real >::mul_
private

Definition at line 79 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Vector<Real> > ROL::ConstraintAssembler< Real >::res_
private

Definition at line 80 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Constraint<Real> > ROL::ConstraintAssembler< Real >::linear_con_
private

Definition at line 81 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Vector<Real> > ROL::ConstraintAssembler< Real >::linear_mul_
private

Definition at line 82 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Vector<Real> > ROL::ConstraintAssembler< Real >::linear_res_
private

Definition at line 83 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Vector<Real> > ROL::ConstraintAssembler< Real >::xprim_
private

Definition at line 84 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<Vector<Real> > ROL::ConstraintAssembler< Real >::xdual_
private

Definition at line 85 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
Ptr<BoundConstraint<Real> > ROL::ConstraintAssembler< Real >::bnd_
private

Definition at line 86 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Constraint<Real> > > ROL::ConstraintAssembler< Real >::cvec_
private

Definition at line 88 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Vector<Real> > > ROL::ConstraintAssembler< Real >::lvec_
private

Definition at line 89 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Vector<Real> > > ROL::ConstraintAssembler< Real >::rvec_
private

Definition at line 90 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Constraint<Real> > > ROL::ConstraintAssembler< Real >::lcvec_
private

Definition at line 91 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Vector<Real> > > ROL::ConstraintAssembler< Real >::llvec_
private

Definition at line 92 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Vector<Real> > > ROL::ConstraintAssembler< Real >::lrvec_
private

Definition at line 93 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Vector<Real> > > ROL::ConstraintAssembler< Real >::psvec_
private

Definition at line 94 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<Vector<Real> > > ROL::ConstraintAssembler< Real >::dsvec_
private

Definition at line 95 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<Ptr<BoundConstraint<Real> > > ROL::ConstraintAssembler< Real >::sbnd_
private

Definition at line 96 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<bool> ROL::ConstraintAssembler< Real >::isInequality_
private

Definition at line 98 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
std::vector<bool> ROL::ConstraintAssembler< Real >::isLinearInequality_
private

Definition at line 98 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
bool ROL::ConstraintAssembler< Real >::isNull_
private

Definition at line 100 of file ROL_ConstraintAssembler.hpp.

template<typename Real>
bool ROL::ConstraintAssembler< Real >::hasInequality_
private

Definition at line 101 of file ROL_ConstraintAssembler.hpp.

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