NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs Version of the Day
NLPInterfacePack_NLPObjGrad.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_NLPObjGrad.hpp"
00043 #include "AbstractLinAlgPack_VectorMutable.hpp"
00044 
00045 namespace {
00046   const char name_Gf[] = "Gf";
00047 } // end namespace
00048 
00049 namespace NLPInterfacePack {
00050 
00051 // constructors
00052 
00053 NLPObjGrad::NLPObjGrad()
00054   : Gf_(NULL)
00055 {}
00056 
00057 void NLPObjGrad::initialize(bool test_setup) {
00058   num_Gf_evals_ = 0;
00059   NLP::initialize(test_setup);
00060 }
00061 
00062 // Information
00063 
00064 bool NLPObjGrad::supports_Gf() const
00065 {
00066   return true;
00067 }
00068 
00069 bool NLPObjGrad::supports_Gf_prod() const
00070 {
00071   return false;
00072 }
00073 
00074 // <<std aggr>> members for Gf
00075 
00076 void NLPObjGrad::set_Gf(VectorMutable* Gf)
00077 {
00078   Gf_ = Gf;
00079 }
00080 
00081 AbstractLinAlgPack::VectorMutable* NLPObjGrad::get_Gf()
00082 {
00083   return StandardCompositionRelationshipsPack::get_role_name(Gf_, false, name_Gf);
00084 }
00085 
00086 AbstractLinAlgPack::VectorMutable& NLPObjGrad::Gf()
00087 {
00088   return StandardCompositionRelationshipsPack::role_name(Gf_, false, name_Gf);
00089 }
00090 
00091 const AbstractLinAlgPack::Vector& NLPObjGrad::Gf() const
00092 {
00093   return StandardCompositionRelationshipsPack::role_name(Gf_, false, name_Gf);
00094 }
00095 
00096 void NLPObjGrad::unset_quantities()
00097 {
00098   NLP::unset_quantities();
00099   Gf_ = NULL;
00100 }
00101 
00102 // calculations
00103 
00104 void NLPObjGrad::calc_Gf(const Vector& x, bool newx) const
00105 {
00106   StandardCompositionRelationshipsPack::assert_role_name_set(Gf_, "NLP::calc_Gf()", name_Gf);
00107   imp_calc_Gf(x,newx,obj_grad_info());
00108   num_Gf_evals_++;
00109 }
00110 
00111 value_type NLPObjGrad::calc_Gf_prod(const Vector& x, const Vector& d, bool newx) const
00112 {
00113   TEUCHOS_TEST_FOR_EXCEPTION(
00114     true,std::logic_error
00115     ,"Error, the function calc_Gf_prod(...) is not implemented for the class "
00116     << typeName(*this) << "!"
00117     );
00118 
00119   //execution should never reach this point, but compilers expect a non-void
00120   //function to return something. So we'll create a dummy value to use in a
00121   //return statement.
00122   //(a better design would not require function bodies for unimplemented
00123   //functions like this...)
00124   value_type* dummy = NULL;
00125   return(*dummy);
00126 }
00127 
00128 size_type NLPObjGrad::num_Gf_evals() const
00129 {
00130   return num_Gf_evals_;
00131 }
00132 
00133 } // end namespace NLPInterfacePack 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends