ROL::ConstraintManager< Real > Class Template Reference

Provides a wrapper for multiple constraints. More...

#include <ROL_ConstraintManager.hpp>

Public Member Functions
virtual	~ConstraintManager (void)
	ConstraintManager (const std::vector< ROL::Ptr< Constraint< Real > > > &cvec, const std::vector< ROL::Ptr< Vector< Real > > > &lvec, const std::vector< ROL::Ptr< BoundConstraint< Real > > > &bvec, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< BoundConstraint< Real > > &bnd=ROL::nullPtr)
	ConstraintManager (const std::vector< ROL::Ptr< Constraint< Real > > > &cvec, const std::vector< ROL::Ptr< Vector< Real > > > &lvec, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< BoundConstraint< Real > > &bnd=ROL::nullPtr)
	ConstraintManager (const ROL::Ptr< Constraint< Real > > &con, const ROL::Ptr< Vector< Real > > &l, const ROL::Ptr< BoundConstraint< Real > > &cbnd, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< BoundConstraint< Real > > &bnd=ROL::nullPtr)
	ConstraintManager (const ROL::Ptr< Constraint< Real > > &con, const ROL::Ptr< Vector< Real > > &l, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< BoundConstraint< Real > > &bnd=ROL::nullPtr)
const ROL::Ptr< Constraint < Real > >	getConstraint (void) const
const ROL::Ptr< Vector< Real > >	getMultiplier (void) const
const ROL::Ptr< Vector< Real > >	getOptVector (void) const
const ROL::Ptr < BoundConstraint< Real > >	getBoundConstraint (void) const
bool	isNull (void) const
bool	hasInequality (void) const
void	resetSlackVariables (void)

Private Member Functions
void	initializeSlackVariable (const ROL::Ptr< Constraint< Real > > &con, const ROL::Ptr< BoundConstraint< Real > > &cbnd, const ROL::Ptr< Vector< Real > > &s, const ROL::Ptr< Vector< Real > > &x) const
void	initialize (const std::vector< ROL::Ptr< Constraint< Real > > > &cvec, const std::vector< ROL::Ptr< Vector< Real > > > &lvec, const std::vector< ROL::Ptr< BoundConstraint< Real > > > &bvec, const ROL::Ptr< Vector< Real > > &x, const ROL::Ptr< BoundConstraint< Real > > &bnd)

Private Attributes
ROL::Ptr< Constraint< Real > >	con_
ROL::Ptr< Vector< Real > >	l_
ROL::Ptr< Vector< Real > >	x_
ROL::Ptr< BoundConstraint< Real > >	bnd_
std::vector< ROL::Ptr < Constraint< Real > > >	cvec_
std::vector< ROL::Ptr< Vector < Real > > >	lvec_
std::vector< ROL::Ptr< Vector < Real > > >	svec_
std::vector< ROL::Ptr < BoundConstraint< Real > > >	sbnd_
std::vector< bool >	isInequality_
bool	isNull_
bool	hasInequality_

Detailed Description

template<class Real>
class ROL::ConstraintManager< Real >

Provides a wrapper for multiple constraints.

---

Definition at line 27 of file ROL_ConstraintManager.hpp.

Constructor & Destructor Documentation

template<class Real >

virtual ROL::ConstraintManager< Real >::~ConstraintManager ( void  )

inlinevirtual

Definition at line 140 of file ROL_ConstraintManager.hpp.

template<class Real >

ROL::ConstraintManager< Real >::ConstraintManager ( const std::vector< ROL::Ptr< Constraint< Real > > > &  cvec, const std::vector< ROL::Ptr< Vector< Real > > > &  lvec, const std::vector< ROL::Ptr< BoundConstraint< Real > > > &  bvec, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< BoundConstraint< Real > > &  bnd = ROL::nullPtr  )

inline

Definition at line 142 of file ROL_ConstraintManager.hpp.

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

template<class Real >

ROL::ConstraintManager< Real >::ConstraintManager ( const std::vector< ROL::Ptr< Constraint< Real > > > &  cvec, const std::vector< ROL::Ptr< Vector< Real > > > &  lvec, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< BoundConstraint< Real > > &  bnd = ROL::nullPtr  )

inline

Definition at line 151 of file ROL_ConstraintManager.hpp.

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

template<class Real >

ROL::ConstraintManager< Real >::ConstraintManager ( const ROL::Ptr< Constraint< Real > > &  con, const ROL::Ptr< Vector< Real > > &  l, const ROL::Ptr< BoundConstraint< Real > > &  cbnd, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< BoundConstraint< Real > > &  bnd = ROL::nullPtr  )

inline

Definition at line 160 of file ROL_ConstraintManager.hpp.

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

template<class Real >

ROL::ConstraintManager< Real >::ConstraintManager ( const ROL::Ptr< Constraint< Real > > &  con, const ROL::Ptr< Vector< Real > > &  l, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< BoundConstraint< Real > > &  bnd = ROL::nullPtr  )

inline

Definition at line 172 of file ROL_ConstraintManager.hpp.

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

Member Function Documentation

template<class Real >

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

inlineprivate

Definition at line 44 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::resetSlackVariables().

template<class Real >

void ROL::ConstraintManager< Real >::initialize ( const std::vector< ROL::Ptr< Constraint< Real > > > &  cvec, const std::vector< ROL::Ptr< Vector< Real > > > &  lvec, const std::vector< ROL::Ptr< BoundConstraint< Real > > > &  bvec, const ROL::Ptr< Vector< Real > > &  x, const ROL::Ptr< BoundConstraint< Real > > &  bnd  )

inlineprivate

Definition at line 54 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::bnd_, ROL::ConstraintManager< Real >::con_, ROL::ConstraintManager< Real >::cvec_, ROL::ConstraintManager< Real >::hasInequality_, ROL::ConstraintManager< Real >::initializeSlackVariable(), ROL::ConstraintManager< Real >::isInequality_, ROL::ConstraintManager< Real >::isNull_, ROL::ConstraintManager< Real >::l_, ROL::ConstraintManager< Real >::lvec_, ROL::ConstraintManager< Real >::sbnd_, ROL::ConstraintManager< Real >::svec_, and ROL::ConstraintManager< Real >::x_.

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

template<class Real >

const ROL::Ptr<Constraint<Real> > ROL::ConstraintManager< Real >::getConstraint ( void  ) const

inline

Definition at line 183 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::con_.

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::ConstraintManager< Real >::getMultiplier ( void  ) const

inline

Definition at line 187 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::l_.

template<class Real >

const ROL::Ptr<Vector<Real> > ROL::ConstraintManager< Real >::getOptVector ( void  ) const

inline

Definition at line 191 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::x_.

template<class Real >

const ROL::Ptr<BoundConstraint<Real> > ROL::ConstraintManager< Real >::getBoundConstraint ( void  ) const

inline

Definition at line 195 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::bnd_.

template<class Real >

bool ROL::ConstraintManager< Real >::isNull ( void  ) const

inline

Definition at line 199 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::isNull_.

template<class Real >

bool ROL::ConstraintManager< Real >::hasInequality ( void  ) const

inline

Definition at line 203 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::hasInequality_.

template<class Real >

void ROL::ConstraintManager< Real >::resetSlackVariables ( void  )

inline

Definition at line 207 of file ROL_ConstraintManager.hpp.

References ROL::ConstraintManager< Real >::cvec_, ROL::ConstraintManager< Real >::hasInequality_, ROL::ConstraintManager< Real >::initializeSlackVariable(), ROL::ConstraintManager< Real >::isInequality_, ROL::ConstraintManager< Real >::sbnd_, and ROL::ConstraintManager< Real >::svec_.

Member Data Documentation

template<class Real >

ROL::Ptr<Constraint<Real> > ROL::ConstraintManager< Real >::con_

private

Definition at line 29 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::getConstraint(), and ROL::ConstraintManager< Real >::initialize().

template<class Real >

ROL::Ptr<Vector<Real> > ROL::ConstraintManager< Real >::l_

private

Definition at line 30 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::getMultiplier(), and ROL::ConstraintManager< Real >::initialize().

template<class Real >

ROL::Ptr<Vector<Real> > ROL::ConstraintManager< Real >::x_

private

Definition at line 31 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::getOptVector(), and ROL::ConstraintManager< Real >::initialize().

template<class Real >

ROL::Ptr<BoundConstraint<Real> > ROL::ConstraintManager< Real >::bnd_

private

Definition at line 32 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::getBoundConstraint(), and ROL::ConstraintManager< Real >::initialize().

template<class Real >

std::vector<ROL::Ptr<Constraint<Real> > > ROL::ConstraintManager< Real >::cvec_

private

Definition at line 34 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::resetSlackVariables().

template<class Real >

std::vector<ROL::Ptr<Vector<Real> > > ROL::ConstraintManager< Real >::lvec_

private

Definition at line 35 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize().

template<class Real >

std::vector<ROL::Ptr<Vector<Real> > > ROL::ConstraintManager< Real >::svec_

private

Definition at line 36 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::resetSlackVariables().

template<class Real >

std::vector<ROL::Ptr<BoundConstraint<Real> > > ROL::ConstraintManager< Real >::sbnd_

private

Definition at line 37 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::resetSlackVariables().

template<class Real >

std::vector<bool> ROL::ConstraintManager< Real >::isInequality_

private

Definition at line 39 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::resetSlackVariables().

template<class Real >

bool ROL::ConstraintManager< Real >::isNull_

private

Definition at line 41 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::isNull().

template<class Real >

bool ROL::ConstraintManager< Real >::hasInequality_

private

Definition at line 42 of file ROL_ConstraintManager.hpp.

Referenced by ROL::ConstraintManager< Real >::hasInequality(), ROL::ConstraintManager< Real >::initialize(), and ROL::ConstraintManager< Real >::resetSlackVariables().

---

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

• ROL_ConstraintManager.hpp