locopt_ret.cc

Go to the documentation of this file.

// Definitions for handling return codes and messages of local optimization IEs  -*- C++ -*-

// $Id: termreason.h 347 2008-02-06 15:20:01Z schilly $
// Copyright (C) 2008 Mihaly Csaba Markot
//
// This file is part of the COCONUT API.  This library
// is free software; you can redistribute it and/or modify it under the
// terms of the Library GNU General Public License as published by the
// Free Software Foundation; either version 2, or (at your option)
// any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// Library GNU General Public License for more details.

// As a special exception, you may use this file as part of a free software
// library without restriction.  Specifically, if other files instantiate
// templates or use macros or inline functions from this file, or you compile
// this file and link it with other files to produce an executable, this
// file does not by itself cause the resulting executable to be covered by
// the Library GNU General Public License.  This exception does not however
// invalidate any other reasons why the executable file might be covered by
// the Library GNU General Public License.

#include <locopt_ret.h>

namespace coco {

// determines IE return weight associated to the solver return value srval
// from the ret_info map 
double get_locopt_weight_from_rval(const locopt_ret& ret_info,
                                   const std::string& iename, const int srval)
{
  locopt_ret::const_iterator it = ret_info.find(srval);
  if (it == ret_info.end())
    throw inference_engine_exception(
                   std::string("COCO-") + iename +
                   std::string(": Unknown solver return code - Contact the "
                               "COCONUT developers for an update of the ")
                   + iename + std::string(" solver interface!"));
  return it->second.get_weight();
}

// determines IE termination reason associated to the solver return value srval
// from the ret_info map 
termination_reason get_locopt_termr_from_rval(const locopt_ret& ret_info,
                                   const std::string& iename, const int srval)
{
  locopt_ret::const_iterator it = ret_info.find(srval);
  if (it == ret_info.end())
    throw inference_engine_exception(
                   std::string("COCO-") + iename +
                   std::string(": Unknown solver return code - Contact the "
                               "COCONUT developers for an update of the ")
                   + iename + std::string(" solver interface!"));

  if (it->second.get_code() == LOPT_SUCCESS)
    return termination_reason();  // generate a uniform message "SUCCESS" and
                                  // a uniform 0 return value
  else
    return it->second.get_termr();
}

} // namespace coco

---