MoochoPack_CheckConvergenceStd_AddedStepSetOptions.cpp

Go to the documentation of this file.

#if 0

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#include <assert.h>

#include "MoochoPack_CheckConvergenceStd_AddedStepSetOptions.hpp"
#include "OptionsFromStreamPack_StringToBool.hpp"

// Define the options
namespace {

  const int local_num_options = 2;

  enum local_EOptions {
    SCALE_KKT_ERROR_BY,
    SCALE_OPT_ERROR_BY_GF
  };

  const char* local_SOptions[local_num_options] = {
    "scale_kkt_error_by",
    "scale_opt_error_by_Gf",
  };

}

namespace MoochoPack {

CheckConvergenceStd_AddedStepSetOptions::CheckConvergenceStd_AddedStepSetOptions(
        CheckConvergenceStd_AddedStep* target
      , const char opt_grp_name[] )
  : OptionsFromStreamPack::SetOptionsFromStreamNode(
        opt_grp_name, local_num_options, local_SOptions )
    , OptionsFromStreamPack::SetOptionsToTargetBase<
      CheckConvergenceStd_AddedStep >( target )
{}

void CheckConvergenceStd_AddedStepSetOptions::setOption(
  int option_num, const std::string& option_value )
{
  using OptionsFromStreamPack::StringToBool;

  typedef CheckConvergenceStd_AddedStep target_t;
  switch( (local_EOptions)option_num ) {
      case SCALE_KKT_ERROR_BY:
    {
      const std::string &option = option_value.c_str();
      if( option == "SCALE_BY_ONE" )
        target().scale_kkt_error_by( target_t::SCALE_BY_ONE );
      else if( option == "SCALE_BY_NORM_2_X" )
        target().scale_kkt_error_by( target_t::SCALE_BY_NORM_2_X );
      else if( option == "SCALE_BY_NORM_INF_X" )
        target().scale_kkt_error_by( target_t::SCALE_BY_NORM_INF_X );
      else
        throw std::invalid_argument( "Error, incorrect value for "
          "\"scale_kkt_error_by\".  Only the options "
          "SCALE_BY_ONE, SCALE_BY_NORM_2_X, and SCALE_BY_NORM_INF_X "
          "are available" );
      break;
    }
    case SCALE_OPT_ERROR_BY_GF: {
      target().scale_opt_error_by_Gf(
        StringToBool( "scale_opt_error_by_Gf", option_value.c_str() ) );
      break;
    }
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);  // Local error only?
  }
}

} // end namespace MoochoPack 

#endif // 0