MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_BFGSUpdate_StrategySetOptions.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 <assert.h>
00043 #include <math.h>
00044 
00045 #include "MoochoPack_BFGSUpdate_StrategySetOptions.hpp"
00046 #include "OptionsFromStreamPack_StringToBool.hpp"
00047 
00048 // Define the options
00049 namespace {
00050 
00051   const int local_num_options = 5;
00052 
00053   enum local_EOptions {
00054     RESCALE_INIT_IDENTITY
00055     ,USE_DAMPENING
00056     ,SECANT_TESTING
00057     ,SECANT_WARNING_TOL
00058     ,SECANT_ERROR_TOL
00059   };
00060 
00061   const char* local_SOptions[local_num_options] = {
00062     "rescale_init_identity"
00063       ,"use_dampening"
00064     ,"secant_testing"
00065     ,"secant_warning_tol"
00066       ,"secant_error_tol"
00067   };
00068 
00069 }
00070 
00071 namespace MoochoPack {
00072 
00073 BFGSUpdate_StrategySetOptions::BFGSUpdate_StrategySetOptions(
00074         BFGSUpdate_Strategy* target
00075       , const char opt_grp_name[] )
00076   : OptionsFromStreamPack::SetOptionsFromStreamNode(
00077         opt_grp_name, local_num_options, local_SOptions )
00078     , OptionsFromStreamPack::SetOptionsToTargetBase<
00079       BFGSUpdate_Strategy >( target )
00080 {}
00081 
00082 void BFGSUpdate_StrategySetOptions::setOption(
00083   int option_num, const std::string& option_value )
00084 {
00085   using OptionsFromStreamPack::StringToBool;
00086   typedef BFGSUpdate_Strategy target_t;
00087   switch( (local_EOptions)option_num ) {
00088       case RESCALE_INIT_IDENTITY:
00089       target().rescale_init_identity(
00090         StringToBool( "rescale_init_identity", option_value.c_str() ));
00091       break;
00092       case USE_DAMPENING:
00093       target().use_dampening(
00094         StringToBool( "use_dampening", option_value.c_str() ));
00095       break;
00096       case SECANT_TESTING:
00097     {
00098       const std::string &option = option_value.c_str();
00099       if( option == "DEFAULT" )
00100         target().secant_testing( target_t::SECANT_TEST_DEFAULT );
00101       else if( option == "TEST" )
00102         target().secant_testing( target_t::SECANT_TEST_ALWAYS );
00103       else if( option == "NO_TEST" )
00104         target().secant_testing( target_t::SECANT_NO_TEST );
00105       else
00106         throw std::invalid_argument( "Error, incorrect value for "
00107           "\"secant_testing\"." );
00108       break;
00109     }
00110       case SECANT_WARNING_TOL:
00111       target().secant_warning_tol(std::fabs(std::atof(option_value.c_str())));
00112       break;
00113       case SECANT_ERROR_TOL:
00114       target().secant_error_tol(std::fabs(std::atof(option_value.c_str())));
00115       break;
00116     default:
00117       TEUCHOS_TEST_FOR_EXCEPT(true);  // Local error only?
00118   }
00119 }
00120 
00121 } // end namespace MoochoPack 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends