NLPInterfacePack::NLPBarrier Class Reference

Simple wrapper that provides an objective fn with the barrier term included. More...

#include <NLPInterfacePack_NLPBarrier.hpp>

Inheritance diagram for NLPInterfacePack::NLPBarrier:

Inheritance graph
[legend]
List of all members.

Public Methods

void mu (const value_type mu)
 Set the barrier parameter.
value_type barrier_term () const
 Get the barrier term. Must be called after calc_f().
value_type objective_term () const
 Get the true objective term value. Must be called after calc_f().
const Teuchos::RCP< Vectorgrad_barrier_term () const
 Get the value of the gradient of the barrier term. Must be called after calc_Gf().
const Teuchos::RCP< Vectorgrad_objective_term () const
 Get the value of the gradient of the true objective term. Must be called after calc_Gf().

Constructors / initializers

 NLPBarrier ()
 Constructor.
void InitializeFromNLP (Teuchos::RCP< NLP > original_nlp)
 

Overridden public members from NLPObjGrad

void initialize (bool test_setup)
 
bool is_initialized () const
 
void set_Gf (VectorMutable *Gf)
 
VectorMutableget_Gf ()
 
VectorMutableGf ()
 
const VectorGf () const
 
void calc_Gf (const Vector &x, bool newx=true) const
 Overloaded to include barrier term.
size_type num_Gf_evals () const
 

Overridden public members from NLP

void force_xinit_in_bounds (bool force_xinit_in_bounds)
 
bool force_xinit_in_bounds () const
 
size_type n () const
 
size_type m () const
 
vec_space_ptr_t space_x () const
 
vec_space_ptr_t space_c () const
 
size_type num_bounded_x () const
 
const Vectorxl () const
 
const Vectorxu () const
 
value_type max_var_bounds_viol () const
 
const Vectorxinit () const
 
void get_init_lagrange_mult (VectorMutable *lambda, VectorMutable *nu) const
 
void set_f (value_type *f)
 
value_type * get_f ()
 
value_type & f ()
 
const value_type & f () const
 
void set_c (VectorMutable *c)
 
VectorMutableget_c ()
 
VectorMutablec ()
 
const Vectorc () const
 
void scale_f (value_type scale_f)
 
value_type scale_f () const
 
void calc_f (const Vector &x, bool newx=true) const
 Overloaded to include barrier term.
void calc_c (const Vector &x, bool newx=true) const
 
void report_final_solution (const Vector &x, const Vector *lambda, const Vector *nu, bool is_optimal)
 
size_type num_f_evals () const
 
size_type num_c_evals () const
 
size_type ns () const
 
vec_space_ptr_t space_c_breve () const
 
vec_space_ptr_t space_h_breve () const
 
const Vectorhl_breve () const
 
const Vectorhu_breve () const
 
void set_c_breve (VectorMutable *c_breve)
 
VectorMutableget_c_breve ()
 
VectorMutablec_breve ()
 
const Vectorc_breve () const
 
void set_h_breve (VectorMutable *h_breve)
 
VectorMutableget_h_breve ()
 
VectorMutableh_breve ()
 
const Vectorh_breve () const
 
const Permutation & P_var () const
 
const Permutation & P_equ () const
 
void calc_c_breve (const Vector &x, bool newx) const
 
void calc_h_breve (const Vector &x, bool newx) const
 
void imp_calc_f (const Vector &x, bool newx, const ZeroOrderInfo &zero_order_info) const
 
void imp_calc_c (const Vector &x, bool newx, const ZeroOrderInfo &zero_order_info) const
 
void imp_calc_c_breve (const Vector &x, bool newx, const ZeroOrderInfo &zero_order_info_breve) const
 
void imp_calc_h_breve (const Vector &x, bool newx, const ZeroOrderInfo &zero_order_info_breve) const
 
void imp_calc_Gf (const Vector &x, bool newx, const ObjGradInfo &obj_grad_info) const
 

Detailed Description

Simple wrapper that provides an objective fn with the barrier term included.

Definition at line 40 of file NLPInterfacePack_NLPBarrier.hpp.


Constructor & Destructor Documentation

NLPInterfacePack::NLPBarrier::NLPBarrier (  ) 

Constructor.

Definition at line 41 of file NLPInterfacePack_NLPBarrier.cpp.


Member Function Documentation

void NLPInterfacePack::NLPBarrier::mu ( const value_type  mu  ) 

Set the barrier parameter.

Definition at line 69 of file NLPInterfacePack_NLPBarrier.cpp.

value_type NLPInterfacePack::NLPBarrier::barrier_term (  )  const

Get the barrier term. Must be called after calc_f().

Definition at line 74 of file NLPInterfacePack_NLPBarrier.cpp.

value_type NLPInterfacePack::NLPBarrier::objective_term (  )  const

Get the true objective term value. Must be called after calc_f().

Definition at line 79 of file NLPInterfacePack_NLPBarrier.cpp.

const Teuchos::RCP< Vector > NLPInterfacePack::NLPBarrier::grad_barrier_term (  )  const

Get the value of the gradient of the barrier term. Must be called after calc_Gf().

Definition at line 84 of file NLPInterfacePack_NLPBarrier.cpp.

const Teuchos::RCP< Vector > NLPInterfacePack::NLPBarrier::grad_objective_term (  )  const

Get the value of the gradient of the true objective term. Must be called after calc_Gf().

Definition at line 89 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::InitializeFromNLP ( Teuchos::RCP< NLP original_nlp  ) 

Definition at line 50 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::initialize ( bool  test_setup  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 82 of file NLPInterfacePack_NLPBarrier.hpp.

bool NLPInterfacePack::NLPBarrier::is_initialized (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 85 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::set_Gf ( VectorMutable Gf  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 88 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable* NLPInterfacePack::NLPBarrier::get_Gf (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 91 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable& NLPInterfacePack::NLPBarrier::Gf (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 94 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::Gf (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 97 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::calc_Gf ( const Vector x,
bool  newx = true 
) const [virtual]

Overloaded to include barrier term.

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 106 of file NLPInterfacePack_NLPBarrier.cpp.

size_type NLPInterfacePack::NLPBarrier::num_Gf_evals (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLPObjGrad.

Definition at line 102 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::force_xinit_in_bounds ( bool  force_xinit_in_bounds  )  [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 111 of file NLPInterfacePack_NLPBarrier.hpp.

bool NLPInterfacePack::NLPBarrier::force_xinit_in_bounds (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 114 of file NLPInterfacePack_NLPBarrier.hpp.

size_type NLPInterfacePack::NLPBarrier::n (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 117 of file NLPInterfacePack_NLPBarrier.hpp.

size_type NLPInterfacePack::NLPBarrier::m (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 120 of file NLPInterfacePack_NLPBarrier.hpp.

vec_space_ptr_t NLPInterfacePack::NLPBarrier::space_x (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 123 of file NLPInterfacePack_NLPBarrier.hpp.

vec_space_ptr_t NLPInterfacePack::NLPBarrier::space_c (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 126 of file NLPInterfacePack_NLPBarrier.hpp.

size_type NLPInterfacePack::NLPBarrier::num_bounded_x (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 129 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::xl (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 132 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::xu (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 135 of file NLPInterfacePack_NLPBarrier.hpp.

value_type NLPInterfacePack::NLPBarrier::max_var_bounds_viol (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 138 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::xinit (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 141 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::get_init_lagrange_mult ( VectorMutable lambda,
VectorMutable nu 
) const [inline]

Definition at line 144 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::set_f ( value_type *  f  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 150 of file NLPInterfacePack_NLPBarrier.hpp.

value_type* NLPInterfacePack::NLPBarrier::get_f (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 153 of file NLPInterfacePack_NLPBarrier.hpp.

value_type& NLPInterfacePack::NLPBarrier::f (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 156 of file NLPInterfacePack_NLPBarrier.hpp.

const value_type& NLPInterfacePack::NLPBarrier::f (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 159 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::set_c ( VectorMutable c  )  [inline]

Definition at line 162 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable* NLPInterfacePack::NLPBarrier::get_c (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 165 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable& NLPInterfacePack::NLPBarrier::c (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 168 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::c (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 171 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::scale_f ( value_type  scale_f  )  [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 174 of file NLPInterfacePack_NLPBarrier.hpp.

value_type NLPInterfacePack::NLPBarrier::scale_f (  )  const [inline, virtual]

Implements NLPInterfacePack::NLP.

Definition at line 177 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::calc_f ( const Vector x,
bool  newx = true 
) const

Overloaded to include barrier term.

Definition at line 95 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::calc_c ( const Vector x,
bool  newx = true 
) const [inline]

Definition at line 182 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::report_final_solution ( const Vector x,
const Vector lambda,
const Vector nu,
bool  is_optimal 
) [inline]

Definition at line 185 of file NLPInterfacePack_NLPBarrier.hpp.

size_type NLPInterfacePack::NLPBarrier::num_f_evals (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 196 of file NLPInterfacePack_NLPBarrier.hpp.

size_type NLPInterfacePack::NLPBarrier::num_c_evals (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 199 of file NLPInterfacePack_NLPBarrier.hpp.

size_type NLPInterfacePack::NLPBarrier::ns (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 202 of file NLPInterfacePack_NLPBarrier.hpp.

vec_space_ptr_t NLPInterfacePack::NLPBarrier::space_c_breve (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 205 of file NLPInterfacePack_NLPBarrier.hpp.

vec_space_ptr_t NLPInterfacePack::NLPBarrier::space_h_breve (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 208 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::hl_breve (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 211 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::hu_breve (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 214 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::set_c_breve ( VectorMutable c_breve  )  [inline]

Definition at line 217 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable* NLPInterfacePack::NLPBarrier::get_c_breve (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 220 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable& NLPInterfacePack::NLPBarrier::c_breve (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 223 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::c_breve (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 226 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::set_h_breve ( VectorMutable h_breve  )  [inline]

Definition at line 229 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable* NLPInterfacePack::NLPBarrier::get_h_breve (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 232 of file NLPInterfacePack_NLPBarrier.hpp.

VectorMutable& NLPInterfacePack::NLPBarrier::h_breve (  )  [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 235 of file NLPInterfacePack_NLPBarrier.hpp.

const Vector& NLPInterfacePack::NLPBarrier::h_breve (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 238 of file NLPInterfacePack_NLPBarrier.hpp.

const Permutation& NLPInterfacePack::NLPBarrier::P_var (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 241 of file NLPInterfacePack_NLPBarrier.hpp.

const Permutation& NLPInterfacePack::NLPBarrier::P_equ (  )  const [inline, virtual]

Reimplemented from NLPInterfacePack::NLP.

Definition at line 244 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::calc_c_breve ( const Vector x,
bool  newx 
) const [inline]

Definition at line 247 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::calc_h_breve ( const Vector x,
bool  newx 
) const [inline]

Definition at line 250 of file NLPInterfacePack_NLPBarrier.hpp.

void NLPInterfacePack::NLPBarrier::imp_calc_f ( const Vector x,
bool  newx,
const ZeroOrderInfo &  zero_order_info 
) const [protected]

Definition at line 141 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::imp_calc_c ( const Vector x,
bool  newx,
const ZeroOrderInfo &  zero_order_info 
) const [protected]

Definition at line 150 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::imp_calc_c_breve ( const Vector x,
bool  newx,
const ZeroOrderInfo &  zero_order_info_breve 
) const [protected]

Definition at line 159 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::imp_calc_h_breve ( const Vector x,
bool  newx,
const ZeroOrderInfo &  zero_order_info_breve 
) const [protected]

Definition at line 168 of file NLPInterfacePack_NLPBarrier.cpp.

void NLPInterfacePack::NLPBarrier::imp_calc_Gf ( const Vector x,
bool  newx,
const ObjGradInfo &  obj_grad_info 
) const [protected]

Definition at line 177 of file NLPInterfacePack_NLPBarrier.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Jul 13 09:29:15 2010 for NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs by  doxygen 1.4.7