MoochoPack_MoochoTrackerConsoleStd.cpp

// @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 <iomanip>

#include "MoochoPack_MoochoTrackerConsoleStd.hpp"
#include "MoochoPack_NLPAlgoState.hpp"
#include "MoochoPack_moocho_algo_conversion.hpp"
#include "NLPInterfacePack_NLPFirstOrder.hpp"
#include "AbstractLinAlgPack_Vector.hpp"
#include "Teuchos_dyn_cast.hpp"

namespace MoochoPack {

using std::endl;
using std::setw;
using std::left;
using std::right;
using std::setprecision;

// Static members
int   MoochoTrackerConsoleStd::w_i2_     = 2;
char  MoochoTrackerConsoleStd::ul_i2_[]  = "--";
int   MoochoTrackerConsoleStd::w_i4_     = 4;
char  MoochoTrackerConsoleStd::ul_i4_[]  = "----";
int   MoochoTrackerConsoleStd::p2_       = 1;
int   MoochoTrackerConsoleStd::w_p2_     = 8;
char  MoochoTrackerConsoleStd::ul_p2_[]  = "--------";
int   MoochoTrackerConsoleStd::p3_       = 2;
int   MoochoTrackerConsoleStd::w_p3_     = 9;
char  MoochoTrackerConsoleStd::ul_p3_[]  = "---------";

MoochoTrackerConsoleStd::MoochoTrackerConsoleStd(
  const ostream_ptr_t&   o
  ,const ostream_ptr_t&  journal_out
  )
  :AlgorithmTracker(journal_out)
  ,o_(o)
  ,printed_lines_(NUM_PRINT_LINES)
{}

void MoochoTrackerConsoleStd::set_output_stream(const ostream_ptr_t& o)
{
  o_ = o;
}

const MoochoTrackerConsoleStd::ostream_ptr_t&
MoochoTrackerConsoleStd::get_output_stream() const
{
  return o_;
}

void MoochoTrackerConsoleStd::initialize()
{
  timer_.reset();
  timer_.start();
}

void MoochoTrackerConsoleStd::output_iteration(const Algorithm& p_algo) const
{
  const NLPAlgo      &algo = rsqp_algo(p_algo);
  const NLPAlgoState &s    = algo.rsqp_state();
  const NLP          &nlp  = algo.nlp(); 
  
  const size_type
    m = nlp.m();

  const int
    nb = nlp.num_bounded_x();

  if(s.k() == 0) {
    print_top_header(s,algo);
    printed_lines_ = NUM_PRINT_LINES;
  }
  
  // Output the table's header
  if(printed_lines_ == NUM_PRINT_LINES) {
    printed_lines_ = 0;
    print_header(s,algo);
  }

  // ///////////////////////////////
  // Output a row for the iteration
  
  // Get a Quasi-Newton statistics.
  const QuasiNewtonStats  *quasi_newt_stats =
    ( quasi_newton_stats_.exists_in(s) && quasi_newton_stats_(s).updated_k(0)
      ? &quasi_newton_stats_(s).get_k(0)
      : NULL );

  std::ostream& o = this->o();

  // k
  o << " " << right << setw(w_i4_) << s.k();
  // f
  if( s.f().updated_k(0) )
    o << " " << setprecision(p3_) << right << setw(w_p3_) << s.f().get_k(0);
  else
    o << " " << right << setw(w_p3_) << "-";
  // ||c||s
  if( m && s.feas_kkt_err().updated_k(0) )
    o << " " << setprecision(p3_) << right << setw(w_p3_) << s.feas_kkt_err().get_k(0);
  else
    o << " " << right << setw(w_p3_) << "-";
  // ||rGL||s
  if( s.opt_kkt_err().updated_k(0) )
    o << " " << setprecision(p3_) << right << setw(w_p3_) << s.opt_kkt_err().get_k(0);
  else
    o << " " << right << setw(w_p3_) << "-";
  // QN
  if( quasi_newt_stats ) {
    o << " " << right << setw(w_i2_);
    switch( quasi_newt_stats->updated() ) {
      case QuasiNewtonStats::UNKNOWN:
        o << "-";
        break;
      case QuasiNewtonStats:: REINITIALIZED:
        o << "IN";
        break;
      case QuasiNewtonStats::DAMPENED_UPDATED:
        o << "DU";
        break;
      case QuasiNewtonStats::UPDATED:
        o << "UP";
        break;
      case QuasiNewtonStats::SKIPED:
        o << "SK";
        break;
      case QuasiNewtonStats::INDEF_SKIPED:
        o << "IS";
        break;
      default:
        TEUCHOS_TEST_FOR_EXCEPT(true);
    }
  }
  else {
    o << " " << right << setw(w_i2_) << "-";
  }
  // #act
  if(nb) {
    if( s.nu().updated_k(0) )
      o << " " << right << setw(w_i4_) << s.nu().get_k(0).nz();
    else
      o  << " " << right << setw(w_i4_) << "-";
  }
  // ||Ypy||2
  if( m && s.Ypy().updated_k(0) )
    o << " "<< setprecision(p2_)  << right << setw(w_p2_) << s.Ypy().get_k(0).norm_2();
  else
    o << " " << right << setw(w_p2_) << "-";
  // ||Zpz||2
  if( s.Zpz().updated_k(0) )
    o << " " << setprecision(p2_) << right << setw(w_p2_) << s.Zpz().get_k(0).norm_2();
  else
    o << " " << right << setw(w_p2_) << "-";
  // ||d||inf
  if( s.d().updated_k(0) )
    o << " " << setprecision(p2_) << right << setw(w_p2_) << s.d().get_k(0).norm_inf();
  else
    o << " " << right << setw(w_p2_) << "-";
  // alpha
  if( s.alpha().updated_k(0) )
    o << " " << setprecision(p2_) << right << setw(w_p2_) << s.alpha().get_k(0);
  else
    o << " " << right << setw(w_p2_) << "-";
  // time(sec)
  o << " " << setprecision(7) << right << setw(w_p3_) << timer_.read();

  o << std::endl;

  ++printed_lines_;
}

void MoochoTrackerConsoleStd::output_final( const Algorithm& p_algo
  , EAlgoReturn algo_return ) const
{
  using Teuchos::dyn_cast;

  const NLPAlgo        &algo    = rsqp_algo(p_algo);
  const NLPAlgoState   &s       = algo.rsqp_state();
  const NLPObjGrad     &nlp     = dyn_cast<const NLPObjGrad>(algo.nlp()); 
  const NLPFirstOrder  *nlp_foi = dynamic_cast<const NLPFirstOrder*>(&nlp); 
  
  const size_type
    m = nlp.m();

  const int
    nb = nlp.num_bounded_x();

  std::ostream& o = this->o();

  // Output the table's header for the first iteration
  if(s.k() == 0) {
    print_top_header(s,algo);
    print_header(s,algo);
  }
  else {
    o
      << " " << right << ul_i4_    // "k"
      << " " << right << ul_p3_    // "f"
      << " " << right << ul_p3_    // "||c||s"
      << " " << right << ul_p3_    // "||rGL||s"
      << " " << right << ul_i2_    // "QN"
      ;
    if(nb)
      o << " " << right << ul_i4_; // "#act"
    o << endl;
  }

  // //////////////////////////////////////////
  // Output a row for the final iteration
  
  // Get a Quasi-Newton statistics.
  const QuasiNewtonStats  *quasi_newt_stats =
    ( quasi_newton_stats_.exists_in(s) && quasi_newton_stats_(s).updated_k(0)
      ? &quasi_newton_stats_(s).get_k(0)
      : NULL );

  // k
  o << " " << right << setw(w_i4_) << s.k();
  // f
  if( s.f().updated_k(0) )
    o << " " << setprecision(p3_) << right << setw(w_p3_) << s.f().get_k(0);
  else
    o << " " << right << setw(w_p3_) << "-";
  // ||c||s
  if( m && s.feas_kkt_err().updated_k(0) )
    o << " " << setprecision(p3_) << right << setw(w_p3_) << s.feas_kkt_err().get_k(0);
  else
    o << " " << right << setw(w_p3_) << "-";
  // ||rGL||s
  if( s.opt_kkt_err().updated_k(0) )
    o << " " << setprecision(p3_) << right << setw(w_p3_) << s.opt_kkt_err().get_k(0);
  else
    o << " " << right << setw(w_p3_) << "-";
  // QN
  if( quasi_newt_stats ) {
    o << " " << right << setw(w_i2_);
    switch( quasi_newt_stats->updated() ) {
      case QuasiNewtonStats::UNKNOWN:
        o << "-";
        break;
      case QuasiNewtonStats:: REINITIALIZED:
        o << "IN";
        break;
      case QuasiNewtonStats::DAMPENED_UPDATED:
        o << "DU";
        break;
      case QuasiNewtonStats::UPDATED:
        o << "UP";
        break;
      case QuasiNewtonStats::SKIPED:
        o << "SK";
        break;
      case QuasiNewtonStats::INDEF_SKIPED:
        o << "IS";
        break;
      default:
        TEUCHOS_TEST_FOR_EXCEPT(true);
    }
  }
  else {
    o << " " << right << setw(w_i2_) << "-";
  }
  // #act
  if(nb) {
    if( s.nu().updated_k(0) )
      o << " " << right << setw(w_i4_) << s.nu().get_k(0).nz();
    else
      o  << " " << right << setw(w_i4_) << "-";
  }
  // ||Ypy||2
  if( m && s.Ypy().updated_k(0) )
    o << " "<< setprecision(p2_)  << right << setw(w_p2_) << s.Ypy().get_k(0).norm_2();
  else
    o << " " << right << setw(w_p2_) << "-";
  // ||Zpz||2
  if( s.Zpz().updated_k(0) )
    o << " " << setprecision(p2_) << right << setw(w_p2_) << s.Zpz().get_k(0).norm_2();
  else
    o << " " << right << setw(w_p2_) << "-";
  // ||d||inf
  if( s.d().updated_k(0) )
    o << " " << setprecision(p2_) << right << setw(w_p2_) << s.d().get_k(0).norm_inf();
  else
    o << " " << right << setw(w_p2_) << "-";
  // alpha
  if( s.alpha().updated_k(0) )
    o << " " << setprecision(p2_) << right << setw(w_p2_) << s.alpha().get_k(0);
  else
    o << " " << right << setw(w_p2_) << "-";
  // time(sec)
  o << " " << setprecision(7) << right << setw(w_p3_) << timer_.read();

  o << endl;

  // Print total time
  o << setprecision(5) << "\nTotal time = " << timer_.read() << " sec\n";

  switch( algo_return ) {
    case IterationPack::TERMINATE_TRUE:
      o << "\nJackpot! You have found the solution!!!!!!\n";
      break;
    case IterationPack::TERMINATE_FALSE:
      o << "\nOops!  Not the solution.  Some error has occured!\n";
      break;
    case IterationPack::MAX_ITER_EXCEEDED:
      o << "\nOops!  Not the solution.  Maximum number of SQP iteration exceeded!\n";
      break;
    case IterationPack::MAX_RUN_TIME_EXCEEDED:
      o << "\nOops!  Not the solution.  Maximum runtime exceeded!\n";
      break;
    case IterationPack::INTERRUPTED_TERMINATE_TRUE:
      o << "\nJackpot? The user terminated the algorithm but said to return optimal!!!!!!\n";
      break;
    case IterationPack::INTERRUPTED_TERMINATE_FALSE:
      o << "\nOops!  Not the solution.  The user terminated the algorithm and said to return non-optimal!\n";
      break;
    default:
      TEUCHOS_TEST_FOR_EXCEPT(true);
  }

  o  << "\nNumber of function evaluations:\n"
    <<     "-------------------------------\n"
    << "f(x)  : " << nlp.num_f_evals() << endl
    << "c(x)  : " << ( m ? nlp.num_c_evals() : 0 ) << endl
    << "Gf(x) : " << nlp.num_Gf_evals() << endl
    << "Gc(x) : ";
  if(m){
    if( nlp_foi )
      o << nlp_foi->num_Gc_evals();
    else
      o << "?";
  }
  else {
    o << 0;
  }
  o << endl;
}

void MoochoTrackerConsoleStd::print_top_header(const NLPAlgoState &s
  , const NLPAlgo &algo) const
{
  std::ostream& o = this->o();

  NLPAlgoState::space_c_ptr_t
    space_c = s.get_space_c();

  o  << "\n\n********************************\n"
    << "*** Start of rSQP Iterations ***\n"
    << "n = " << s.space_x().dim()
    << ", m = " << ( space_c.get() ? space_c->dim() : 0 )
    << ", nz = ";
  try {
    if(space_c.get()) {
      if( s.Gc().updated_k(0) )
        o  << s.Gc().get_k(0).nz() << endl;
      else
        o  << "?\n";
    }
    else {
      o  << 0 << endl;
    }
  }
  catch( const AlgorithmState::DoesNotExist& ) {
      o  << "?\n";
  }
  if( algo.nlp().scale_f() != 1.0 ) {
    o  << "f(x) is scaled by : " << algo.nlp().scale_f() << endl;
  }
}

void MoochoTrackerConsoleStd::print_header(const NLPAlgoState &s
  , const NLPAlgo &algo) const
{
  std::ostream& o = this->o();

  const NLP  &nlp = algo.nlp(); 

  const int
    nb = nlp.num_bounded_x();

  o
    << endl
    << " " << left << setw(w_i4_) << "k"
    << " " << left << setw(w_p3_) << "f"
    << " " << left << setw(w_p3_) << "||c||s"
    << " " << left << setw(w_p3_) << "||rGL||s"
    << " " << left << setw(w_i2_) << "QN";
  if(nb)
    o << " " << left << setw(w_i4_) << "#act";
  o
    << " " << left << setw(w_p2_) << "||Ypy||2"
    << " " << left << setw(w_p2_) << "||Zpz||2"
    << " " << left << setw(w_p2_) << "||d||inf"
    << " " << left << setw(w_p2_) << "alpha"
    << " " << left << setw(w_p3_) << "time(sec)"
    << endl
    << " " << right << ul_i4_    // "k"
    << " " << right << ul_p3_    // "f"
    << " " << right << ul_p3_    // "||c||s"
    << " " << right << ul_p3_    // "||rGL||s"
    << " " << right << ul_i2_;   // "QN"
    if(nb)
      o << " " << right << ul_i4_; // "#act"
  o
    << " " << right << ul_p2_    // "||Ypy||2"
    << " " << right << ul_p2_    // "||Zpz||2"
    << " " << right << ul_p2_    // "||d||inf"
    << " " << right << ul_p2_    // "alpha"
    << " " << right << ul_p3_    // "time(s)"
    << endl;
}

} // end namespace MoochoPack