Deflection.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/*--------------------------- File Deflection.h ----------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
/*----------------------------- DEFINITIONS --------------------------------*/
/*--------------------------------------------------------------------------*/
 
#ifndef __Deflection
 #define __Deflection /* self-identification: #endif at the end of the file */
 
/*--------------------------------------------------------------------------*/
/*------------------------------ INCLUDES ----------------------------------*/
/*--------------------------------------------------------------------------*/
 
#include "SubGrad.h"
 
/*--------------------------------------------------------------------------*/
/*----------------------------- NAMESPACE ----------------------------------*/
/*--------------------------------------------------------------------------*/
 
namespace NDO_di_unipi_it
{
 
 class SubGrad;     // forward declaration of class SubGrad
 
/*--------------------------------------------------------------------------*/
/*-------------------------- CLASS Deflection ------------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------- GENERAL NOTES --------------------------------*/
/*--------------------------------------------------------------------------*/
class Deflection
{
/*--------------------------------------------------------------------------*/
/*----------------------- PUBLIC PART OF THE CLASS -------------------------*/
/*--------------------------------------------------------------------------*/
 
 public:
 
/*--------------------------------------------------------------------------*/
/*--------------------- PUBLIC METHODS OF THE CLASS ------------------------*/
/*--------------------------------------------------------------------------*/
/*---------------------------- CONSTRUCTOR ---------------------------------*/
/*--------------------------------------------------------------------------*/
   Deflection( SubGrad *slvr )
   {
    if( ! slvr )
     throw NDOException( "Deflection::Deflection: no subgradient solver " );
    Solver = slvr;
 
    VOLLog = 0;
    VOLLLvl = 0;
 
    }  // end( Deflection::Deflection )
 
/*-------------------------- OTHER INITIALIZATIONS -------------------------*/
/*--------------------------------------------------------------------------*/
   virtual void SetVOLLog( std::ostream *outs = 0 , const char lvl = 0 )
   {
    if( ( VOLLog = outs ) )
     VOLLLvl = lvl;
    else
     VOLLLvl = 0;
    }
 
/*--------------------------------------------------------------------------*/
   virtual void Format( void ) {}
 
/*-------------------- METHODS FOR DEFLECTION COMPUTATION ------------------*/
/*--------------------------------------------------------------------------*/
   virtual void NewDEF( void ) = 0;
 
/*---------------------- METHODS FOR READING RESULTS -----------------------*/
/*--------------------------------------------------------------------------*/
   virtual HpNum GetDFLCoeff( void ) = 0;
 
/*--------------------------------------------------------------------------*/
   virtual bool DoSS( void ) { return( true ); }
 
/*--------------------------------------------------------------------------*/
   virtual HpNum Delta( void ) { return( Inf< HpNum >() ); }
 
/*------------------------------ DESTRUCTOR --------------------------------*/
/*--------------------------------------------------------------------------*/
   virtual ~Deflection() {}
 
/*---------------------- PROTECTED PART OF THE CLASS -----------------------*/
/*--------------------------------------------------------------------------*/
 
 protected:
 
/*--------------------------------------------------------------------------*/
/*-------------------------- PROTECTED METHODS -----------------------------*/
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
   FiOracle* GetOracle( void );
 
/*--------------------------------------------------------------------------*/
   HpNum GetStepsize( void );
 
/*--------------------------------------------------------------------------*/
   HpNum GetGiNorm( void );
 
/*--------------------------------------------------------------------------*/
   HpNum GetDNorm( void );
 
/*--------------------------------------------------------------------------*/
   HpNum GetdGk( void );
 
/*--------------------------------------------------------------------------*/
   HpNum GetSigma( void );
 
/*--------------------------------------------------------------------------*/
   HpNum GetEpsilon( void );
 
/*--------------------------------------------------------------------------*/
   HpNum ReadFVal( void );
 
/*----------------------- PROTECTED DATA STRUCTURES  -----------------------*/
/*--------------------------------------------------------------------------*/
 
  SubGrad *Solver;    
 
  std::ostream *VOLLog;    
 
  char VOLLLvl;       
 
/*--------------------------------------------------------------------------*/
 
 };  // end( class Deflection )
 
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
 
};  // end( namespace NDO_di_unipi_it )
 
/*--------------------------------------------------------------------------*/
/*--------------------------------------------------------------------------*/
 
#endif  /* Deflection.h included */
 
/*--------------------------------------------------------------------------*/
/*------------------------ End File Deflection.h ---------------------------*/
/*--------------------------------------------------------------------------*/