MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_CalcDFromYPYZPZ_Step.cpp
Go to the documentation of this file.
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 <limits>
00043 #include <ostream>
00044 
00045 #include "MoochoPack_CalcDFromYPYZPZ_Step.hpp"
00046 #include "MoochoPack_moocho_algo_conversion.hpp"
00047 #include "IterationPack_print_algorithm_step.hpp"
00048 //#include "ConstrainedOptPack_print_vector_change_stats.hpp"
00049 #include "AbstractLinAlgPack_MatrixOpOut.hpp"
00050 #include "AbstractLinAlgPack_VectorMutable.hpp"
00051 #include "AbstractLinAlgPack_VectorStdOps.hpp"
00052 #include "AbstractLinAlgPack_VectorOut.hpp"
00053 #include "AbstractLinAlgPack_LinAlgOpPack.hpp"
00054 #include "Teuchos_implicit_cast.hpp"
00055 
00056 namespace LinAlgOpPack {
00057   using AbstractLinAlgPack::Vp_StMtV;
00058 }
00059 
00060 bool MoochoPack::CalcDFromYPYZPZ_Step::do_step(Algorithm& _algo
00061   , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
00062 {
00063 
00064   using Teuchos::implicit_cast;
00065   using AbstractLinAlgPack::dot;
00066   using LinAlgOpPack::V_VpV;
00067 
00068   NLPAlgo &algo = rsqp_algo(_algo);
00069   NLPAlgoState &s = algo.rsqp_state();
00070 
00071   EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
00072   EJournalOutputLevel ns_olevel = algo.algo_cntr().null_space_journal_output_level();
00073   std::ostream& out = algo.track().journal_out();
00074 
00075   // print step header.
00076   if( implicit_cast<int>(olevel) >= implicit_cast<int>(PRINT_ALGORITHM_STEPS) ) {
00077     using IterationPack::print_algorithm_step;
00078     print_algorithm_step( algo, step_poss, type, assoc_step_poss, out );
00079   }
00080 
00081   // d = Ypy + Zpz
00082   VectorMutable &d_k = s.d().set_k(0);
00083   const Vector &Ypy_k = s.Ypy().get_k(0);
00084   const Vector &Zpz_k = s.Zpz().get_k(0);
00085   V_VpV( &d_k, Ypy_k, Zpz_k );
00086 
00087   Range1D
00088     var_dep = s.var_dep(),
00089     var_indep = s.var_indep();
00090   
00091   if( implicit_cast<int>(olevel) >= implicit_cast<int>(PRINT_ALGORITHM_STEPS) ) {
00092     const value_type very_small = std::numeric_limits<value_type>::min();
00093     out
00094       << "\n(Ypy_k'*Zpz_k)/(||Ypy_k||2 * ||Zpz_k||2 + eps)\n"
00095       << "  = ("<<dot(Ypy_k,Zpz_k)<<")/("<<Ypy_k.norm_2()<<" * "<<Zpz_k.norm_2()<<" + "<<very_small<<")\n"
00096       << "  = " << dot(Ypy_k,Zpz_k) / ( Ypy_k.norm_2() * Zpz_k.norm_2() + very_small ) << "\n";
00097 /*
00098   ConstrainedOptPack::print_vector_change_stats(
00099   s.x().get_k(0), "x", s.d().get_k(0), "d", out );
00100 */
00101     // ToDo: Replace the above with a reduction operator!
00102   }
00103 
00104   if( implicit_cast<int>(olevel) >= implicit_cast<int>(PRINT_ALGORITHM_STEPS) ) {
00105     out << "\n||d_k||inf            = " << d_k.norm_inf();
00106     if( var_dep.size() )
00107       out << "\n||d(var_dep)_k||inf   = " << d_k.sub_view(var_dep)->norm_inf();
00108     if( var_indep.size() )
00109       out << "\n||d(var_indep)_k||inf = " << d_k.sub_view(var_indep)->norm_inf();
00110     out << std::endl;
00111   }
00112   if( implicit_cast<int>(olevel) >= implicit_cast<int>(PRINT_VECTORS) ) {
00113     out << "\nd_k = \n" << d_k;
00114     if( var_dep.size() )
00115       out << "\nd(var_dep)_k = \n" << *d_k.sub_view(var_dep);
00116   }
00117   if( implicit_cast<int>(ns_olevel) >= implicit_cast<int>(PRINT_VECTORS) ) {
00118     if( var_indep.size() )
00119       out << "\nd(var_indep)_k = \n" << *d_k.sub_view(var_indep);
00120   }
00121   
00122   return true;
00123 
00124 }
00125 
00126 void MoochoPack::CalcDFromYPYZPZ_Step::print_step( const Algorithm& algo
00127   , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
00128   , std::ostream& out, const std::string& L ) const
00129 {
00130   out
00131     << L << "*** Calculates the search direction d from Ypy and Zpz\n"
00132     << L << "d_k = Ypy_k + Zpz_k \n";
00133 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines