QPModelBlockObject.hxx

Go to the documentation of this file.

#ifndef CONICBUNDLE_QPMODELBLOCKOBJECT_HXX
#define CONICBUNDLE_QPMODELBLOCKOBJECT_HXX

#include "symmat.hxx"

namespace ConicBundle {



class QPModelBlockObject
{
public:
 
  virtual ~QPModelBlockObject();

  virtual QPModelBlockObject* clone()=0;

  virtual void recursive_delete_and_clear()=0;

  virtual int recursive_copy_data_of(QPModelBlockObject*)=0;

  virtual CH_Matrix_Classes::Integer dim_model()=0;

  virtual CH_Matrix_Classes::Integer dim_constraints()=0;

  virtual CH_Matrix_Classes::Real globalx_cost(const CH_Matrix_Classes::Matrix& globalx)=0;

  virtual CH_Matrix_Classes::Real constraints_cost()=0;

  virtual int add_Bt_modelx(CH_Matrix_Classes::Real& val,
                            CH_Matrix_Classes::Matrix& vec)=0;

    
    
  virtual CH_Matrix_Classes::Matrix& B_times(const CH_Matrix_Classes::Matrix& A,
                                          CH_Matrix_Classes::Matrix& C,
                                          CH_Matrix_Classes::Real alpha=1.,
                                          CH_Matrix_Classes::Real beta=0.,
                                          int Btrans=0,
                                          int Atrans=0) =0;

   virtual CH_Matrix_Classes::Matrix& times_B(const CH_Matrix_Classes::Matrix& A,
                                           CH_Matrix_Classes::Matrix& C,
                                           CH_Matrix_Classes::Real alpha=1.,
                                           CH_Matrix_Classes::Real beta=0.,
                                           int Atrans=0,
                                           int Btrans=0) =0;
   
  virtual CH_Matrix_Classes::Symmatrix& add_BDBt(const CH_Matrix_Classes::Matrix& diagvec,
                                                 CH_Matrix_Classes::Symmatrix& S,
                                                 bool minus=false,
                                                 CH_Matrix_Classes::Integer startindex=0) =0;

  virtual CH_Matrix_Classes::Matrix& get_Bt(CH_Matrix_Classes::Matrix& Bt,
                                            CH_Matrix_Classes::Integer start_col=0)=0;

  
  virtual int reset_starting_point(const CH_Matrix_Classes::Matrix& firsty,CH_Matrix_Classes::Real mu)=0;

  virtual CH_Matrix_Classes::Real primalviol_2normsqr()=0;

  virtual CH_Matrix_Classes::Real dualviol_2normsqr()=0;

  virtual int get_mu_info(CH_Matrix_Classes::Integer& mudim,
                          CH_Matrix_Classes::Real& tr_xz,
                          CH_Matrix_Classes::Real& tr_xdzpdxz,
                          CH_Matrix_Classes::Real& tr_dxdz,
                          CH_Matrix_Classes::Real& min_xz,
                          CH_Matrix_Classes::Real& max_xz) const=0;

  virtual int get_nbh_info(CH_Matrix_Classes::Integer mudim,
                           CH_Matrix_Classes::Real tr_xz,
                           CH_Matrix_Classes::Real tr_xdzpdxz,
                           CH_Matrix_Classes::Real tr_dxdz,
                           CH_Matrix_Classes::Real nbh_ubnd,
                           CH_Matrix_Classes::Real& alpha,
                           CH_Matrix_Classes::Real& max_nbh,
                           CH_Matrix_Classes::Real& nrmsqr_xz,
                           CH_Matrix_Classes::Real& nrmsqr_xdzpdxz,
                           CH_Matrix_Classes::Real& nrmsqr_dxdz,
                           CH_Matrix_Classes::Real& ip_xz_xdzpdxz,
                           CH_Matrix_Classes::Real& ip_xz_dxdz,
                           CH_Matrix_Classes::Real& ip_dxdz_xdzpdxz) const=0;

  virtual int linesearch(CH_Matrix_Classes::Real& alpha) const=0;

  virtual int compute_step(const CH_Matrix_Classes::Matrix& ystep) =0;
  
  virtual int computed_step(const CH_Matrix_Classes::Matrix& modelxstep,
                            const CH_Matrix_Classes::Matrix& modelconstrstep) =0;
  
  virtual int do_step(CH_Matrix_Classes::Real alpha,
                      const CH_Matrix_Classes::Matrix& nexty) =0;
  

  virtual int add_localrhs(CH_Matrix_Classes::Matrix& globalrhs,
                           CH_Matrix_Classes::Real rhsmu,
                           CH_Matrix_Classes::Real rhscorr,
                           CH_Matrix_Classes::Integer startindex_model,
                           CH_Matrix_Classes::Integer startindex_constraints,
                           bool append) =0;

  
  virtual int add_BtinvsysB(CH_Matrix_Classes::Symmatrix& globalsys) =0;

  virtual int add_localsys(CH_Matrix_Classes::Symmatrix& globalsys,
                           CH_Matrix_Classes::Integer startindex_model,
                           CH_Matrix_Classes::Integer startindex_constraints)=0;

  virtual int solve_constrsys(const CH_Matrix_Classes::Symmatrix& ABchol,
                              CH_Matrix_Classes::Matrix& ABCrhs_and_sol,
                              CH_Matrix_Classes::Integer startindex_model,
                              CH_Matrix_Classes::Integer startindex_constraints)=0;

  virtual int localsys_mult(const CH_Matrix_Classes::Matrix& in_vec,
                            CH_Matrix_Classes::Matrix& out_vec,
                            CH_Matrix_Classes::Integer startindex_model,
                            CH_Matrix_Classes::Integer startindex_constraints)=0;
  

  virtual int add_BCSchur_diagonal(CH_Matrix_Classes::Matrix& diagonal)=0;


  virtual int propose_BCSchur_pcsubspace(CH_Matrix_Classes::Matrix& lowrank,
                                         CH_Matrix_Classes::Matrix& sigma_guess,
                                         const CH_Matrix_Classes::Matrix& Diag_inv,
                                         CH_Matrix_Classes::Real minval,
                                         CH_Matrix_Classes::Real diaginvval=-1.)=0;

  virtual int prepare_BCSchur_JLprecond(CH_Matrix_Classes::Matrix& glob_lowrank,
                                        CH_Matrix_Classes::Matrix& subspace,
                                        bool append_globtransp_times_mat_to_subspace=false)=0;

  virtual int add_Schur_rhs(CH_Matrix_Classes::Matrix& glob_rhs,
                            CH_Matrix_Classes::Matrix* local_rhs,
                            CH_Matrix_Classes::Real rhsmu,
                            CH_Matrix_Classes::Real rhscorr)=0;

  virtual int add_Schur_mult(const CH_Matrix_Classes::Matrix& in_Qvec,
                             CH_Matrix_Classes::Matrix& out_Qvec,
                             const CH_Matrix_Classes::Matrix* in_Cvec=0,
                             CH_Matrix_Classes::Matrix* out_Cvec=0)=0;

  virtual int computed_Schur_step(const CH_Matrix_Classes::Matrix& xstep,
                                  const CH_Matrix_Classes::Matrix& local_step)=0;
   
  //-----------  mainly for testing the correctness of the system solution

  virtual CH_Matrix_Classes::Matrix& get_x()=0;
  virtual CH_Matrix_Classes::Matrix& get_dx()=0;
  virtual CH_Matrix_Classes::Matrix& get_dcstr()=0;
  virtual CH_Matrix_Classes::Matrix& get_sysviol_model(const CH_Matrix_Classes::Matrix& dy)=0;
  virtual CH_Matrix_Classes::Matrix& get_sysviol_constraints()=0;


  virtual void display_model_values(const CH_Matrix_Classes::Matrix& y,std::ostream& out)=0;

};




}

#endif