NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs Version of the Day
NLPInterfacePack_NLPFirstOrder.cpp
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 #include "NLPInterfacePack_NLPFirstOrder.hpp"
00043 #include "AbstractLinAlgPack_MatrixOp.hpp"
00044 #include "Teuchos_Assert.hpp"
00045 
00046 namespace {
00047   const char name_Gc[] = "Gc";
00048 } // end namespace
00049 
00050 namespace NLPInterfacePack {
00051 
00052 // constructors
00053 
00054 NLPFirstOrder::NLPFirstOrder()
00055   : Gc_(NULL)
00056 {}
00057 
00058 void NLPFirstOrder::initialize(bool test_setup) {
00059   num_Gc_evals_ = 0;
00060   NLPObjGrad::initialize(test_setup);
00061 }
00062 
00063 // BasisSystem
00064 
00065 const NLPFirstOrder::basis_sys_ptr_t
00066 NLPFirstOrder::basis_sys() const
00067 {
00068   return Teuchos::null;
00069 }
00070 
00071 // <<std aggr>> members for Gc
00072 
00073 void NLPFirstOrder::set_Gc(MatrixOp* Gc)
00074 {
00075 #ifdef TEUCHOS_DEBUG
00076   TEUCHOS_TEST_FOR_EXCEPTION( this->m() == 0, std::logic_error, "" );
00077 #endif
00078   Gc_ = Gc;
00079 }
00080 
00081 MatrixOp* NLPFirstOrder::get_Gc()
00082 {
00083 #ifdef TEUCHOS_DEBUG
00084   TEUCHOS_TEST_FOR_EXCEPTION( this->m() == 0, std::logic_error, "" );
00085 #endif
00086   return StandardCompositionRelationshipsPack::get_role_name(Gc_, false, name_Gc);
00087 }
00088 
00089 MatrixOp& NLPFirstOrder::Gc()
00090 {
00091 #ifdef TEUCHOS_DEBUG
00092   TEUCHOS_TEST_FOR_EXCEPTION( this->m() == 0, std::logic_error, "" );
00093 #endif
00094   return StandardCompositionRelationshipsPack::role_name(Gc_, false, name_Gc);
00095 }
00096 
00097 const MatrixOp& NLPFirstOrder::Gc() const
00098 {
00099 #ifdef TEUCHOS_DEBUG
00100   TEUCHOS_TEST_FOR_EXCEPTION( this->m() == 0, std::logic_error, "" );
00101 #endif
00102   return StandardCompositionRelationshipsPack::role_name(Gc_, false, name_Gc);
00103 }
00104 
00105 void NLPFirstOrder::unset_quantities()
00106 {
00107   NLPObjGrad::unset_quantities();
00108   Gc_ = NULL;
00109 }
00110 
00111 // calculations
00112 
00113 void NLPFirstOrder::calc_Gc(const Vector& x, bool newx) const
00114 {
00115 #ifdef TEUCHOS_DEBUG
00116   TEUCHOS_TEST_FOR_EXCEPTION( this->m() == 0, std::logic_error, "" );
00117 #endif
00118   StandardCompositionRelationshipsPack::assert_role_name_set(Gc_, "NLP::calc_Gc()", name_Gc);
00119   imp_calc_Gc(x,newx,first_order_info());
00120   num_Gc_evals_++;
00121 }
00122 
00123 size_type NLPFirstOrder::num_Gc_evals() const
00124 {
00125 #ifdef TEUCHOS_DEBUG
00126   TEUCHOS_TEST_FOR_EXCEPTION( this->m() == 0, std::logic_error, "" );
00127 #endif
00128   return num_Gc_evals_;
00129 }
00130 
00131 } // end namespace NLPInterfacePack 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends