MoochoPack_NLPSolverClientInterfaceSetOptions.cpp

Go to the documentation of this file.

// @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 <math.h>

#include "MoochoPack_NLPSolverClientInterfaceSetOptions.hpp"
#include "OptionsFromStreamPack_StringToBool.hpp"

// Define the options
namespace {

const int local_num_options = 13;

enum local_EOptions {
  MAX_ITER,
  MAX_RUN_TIME,
  OPT_TOL,
  FEAS_TOL,
  COMP_TOL,
  STEP_TOL,
  JOURNAL_OUTPUT_LEVEL,
  NULL_SPACE_JOURNAL_OUTPUT_LEVEL,
  JOURNAL_PRINT_DIGITS,
  CHECK_RESULTS,
  CALC_CONDITIONING,
  CALC_MATRIX_NORMS,
  CALC_MATRIX_INFO_NULL_SPACE_ONLY
};

const char* local_SOptions[local_num_options] = {
  ("max_iter"),
  ("max_run_time"),
  ("opt_tol"),
  ("feas_tol"),
  ("comp_tol"),
  ("step_tol"),
  ("journal_output_level"),
  ("null_space_journal_output_level"),
  ("journal_print_digits"),
  ("check_results"),
  ("calc_conditioning"),
  ("calc_matrix_norms"),
  ("calc_matrix_info_null_space_only")
};

}

namespace MoochoPack {

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

void NLPSolverClientInterfaceSetOptions::setOption(
  int option_num, const std::string& option_value )
{
  namespace ofsp = OptionsFromStreamPack;
  using ofsp::StringToBool;

  typedef NLPSolverClientInterface target_t;
  switch( (local_EOptions)option_num ) {
    case MAX_ITER:
      target().max_iter(std::abs(std::atoi(option_value.c_str())));
      break;
    case MAX_RUN_TIME:
      target().max_run_time(std::fabs(std::atof(option_value.c_str())));
      break;
    case OPT_TOL:
      target().opt_tol(std::fabs(std::atof(option_value.c_str())));
      break;
    case FEAS_TOL:
      target().feas_tol(std::fabs(std::atof(option_value.c_str())));
      break;
    case COMP_TOL:
      target().comp_tol(std::fabs(std::atof(option_value.c_str())));
      break;
    case STEP_TOL:
      target().step_tol(std::fabs(std::atof(option_value.c_str())));
      break;
    case JOURNAL_OUTPUT_LEVEL:
    {
      if( option_value == "PRINT_NOTHING" )
        target().journal_output_level(PRINT_NOTHING);
      else if( option_value == "PRINT_BASIC_ALGORITHM_INFO" )
        target().journal_output_level(PRINT_BASIC_ALGORITHM_INFO);
      else if( option_value == "PRINT_ALGORITHM_STEPS" )
        target().journal_output_level(PRINT_ALGORITHM_STEPS);
      else if( option_value == "PRINT_ACTIVE_SET" )
        target().journal_output_level(PRINT_ACTIVE_SET);
      else if( option_value == "PRINT_VECTORS" )
        target().journal_output_level(PRINT_VECTORS);
      else if( option_value == "PRINT_ITERATION_QUANTITIES" )
        target().journal_output_level(PRINT_ITERATION_QUANTITIES);
      else
        TEUCHOS_TEST_FOR_EXCEPTION(
          true,std::invalid_argument
          ,"NLPSolverClientInterfaceSetOptions::setOption(...) : "
          "Error, incorrect value \""<<option_value<<"\" for \"journal_output_level\"." );
      if((int)target().null_space_journal_output_level() <= (int)PRINT_ALGORITHM_STEPS)
        target().null_space_journal_output_level(target().journal_output_level());
      break;
    }
    case NULL_SPACE_JOURNAL_OUTPUT_LEVEL:
    {
      if( option_value == "DEFAULT" )
        target().null_space_journal_output_level(target().journal_output_level());
      else if( option_value == "PRINT_ACTIVE_SET" )
        target().null_space_journal_output_level(PRINT_ACTIVE_SET);
      else if( option_value == "PRINT_VECTORS" )
        target().null_space_journal_output_level(PRINT_VECTORS);
      else if( option_value == "PRINT_ITERATION_QUANTITIES" )
        target().null_space_journal_output_level(PRINT_ITERATION_QUANTITIES);
      else
        TEUCHOS_TEST_FOR_EXCEPTION(
          true,std::invalid_argument
          ,"NLPSolverClientInterfaceSetOptions::setOption(...) : "
          "Error, incorrect value \""<<option_value<<"\" for \"null_space_journal_output_level\"." );
      break;
    }
    case JOURNAL_PRINT_DIGITS:
      target().journal_print_digits(std::abs(std::atoi(option_value.c_str())));
      break;
    case CHECK_RESULTS:
      target().check_results(
        StringToBool( "check_results", option_value.c_str() )
        );
      break;
    case CALC_CONDITIONING:
      target().calc_conditioning(
        StringToBool( "calc_conditioning", option_value.c_str() )
        );
      break;
    case CALC_MATRIX_NORMS:
      target().calc_matrix_norms(
        StringToBool( "calc_matrix_norms", option_value.c_str() )
        );
      break;
    case CALC_MATRIX_INFO_NULL_SPACE_ONLY:
      target().calc_matrix_info_null_space_only(
        StringToBool( "calc_matrix_info_null_space_only", option_value.c_str() )
        );
      break;
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);  // Local error only?
  }
}

} // end namespace MoochoPack