NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs Version of the Day
NLPInterfacePack_NLPDirect.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef NLP_FIRST_ORDER_DIRECT_H
00043 #define NLP_FIRST_ORDER_DIRECT_H
00044 
00045 #include "NLPInterfacePack_NLPObjGrad.hpp"
00046 #include "Teuchos_AbstractFactory.hpp"
00047 
00048 namespace NLPInterfacePack {
00049 
00111 class NLPDirect : virtual public NLPObjGrad
00112 {
00113 public:
00114 
00116   typedef Teuchos::RCP<
00117     const Teuchos::AbstractFactory<MatrixOp> >               mat_fcty_ptr_t;
00119   typedef Teuchos::RCP<
00120     const Teuchos::AbstractFactory<MatrixSymOp> >            mat_sym_fcty_ptr_t;
00122   typedef Teuchos::RCP<
00123     const Teuchos::AbstractFactory<MatrixSymOpNonsing> > mat_sym_nonsing_fcty_ptr_t;
00124 
00132   void set_factories(
00133     const mat_sym_fcty_ptr_t             &factory_transDtD
00134     ,const mat_sym_nonsing_fcty_ptr_t    &factory_S
00135     );
00136 
00139 
00149   virtual size_type r() const;
00150 
00152 
00156 
00165   virtual Range1D var_dep() const;
00174   virtual Range1D var_indep() const;
00183   virtual Range1D con_decomp() const;
00192   virtual Range1D con_undecomp() const;
00193 
00195 
00198   
00213   virtual const mat_fcty_ptr_t factory_GcU() const;
00220   virtual const mat_fcty_ptr_t factory_D() const = 0;
00232   virtual const mat_fcty_ptr_t factory_Uz() const;
00245   virtual const mat_fcty_ptr_t factory_GcUD() const;
00246 
00251   virtual const mat_sym_fcty_ptr_t factory_transDtD() const;
00252   
00257   virtual const mat_sym_nonsing_fcty_ptr_t factory_S() const;
00258 
00260 
00263 
00315   virtual void calc_point(
00316     const Vector     &x
00317     ,value_type      *f
00318     ,VectorMutable   *c
00319     ,bool            recalc_c
00320     ,VectorMutable   *Gf
00321     ,VectorMutable   *py
00322     ,VectorMutable   *rGf
00323     ,MatrixOp        *GcU
00324     ,MatrixOp        *D
00325     ,MatrixOp        *Uz
00326     ) const = 0;
00327 
00355   virtual void calc_semi_newton_step(
00356     const Vector    &x
00357     ,VectorMutable  *c
00358     ,bool           recalc_c
00359     ,VectorMutable  *py
00360     ) const = 0;
00361 
00363 
00366 
00377   void initialize(bool test_setup);
00378 
00380 
00381 private:
00382   mat_sym_fcty_ptr_t             factory_transDtD_;
00383   mat_sym_nonsing_fcty_ptr_t     factory_S_;
00384 
00385 };  // end class NLPDirect
00386 
00387 } // end namespace NLPInterfacePack
00388 
00389 #endif   // NLP_FIRST_ORDER_DIRECT_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends