UQPModelBlockObject.hxx

Go to the documentation of this file.

#ifndef CONICBUNDLE_UQPMODELBLOCKOBJECT_HXX
#define CONICBUNDLE_UQPMODELBLOCKOBJECT_HXX

#include "symmat.hxx"

namespace ConicBundle {

  
class UQPModelBlockObject
{
private:
  //the Block has to memorize and update its local x,y,z variables 
  //(and all additional ones that are not visible to the outside)
  //in particular it is assumed to keep a copy of the current variables
  //after the calls to the following functions:
  //  starting_x, starting_yz, restart_x, restart_yz, set_point

public:

  virtual ~UQPModelBlockObject();

  virtual CH_Matrix_Classes::Integer xdim() const =0;
  
  virtual CH_Matrix_Classes::Integer ydim() const =0; 
  
  virtual int set_qp_xstart(CH_Matrix_Classes::Integer x_start_index)=0;
  
  virtual int set_qp_ystart(CH_Matrix_Classes::Integer y_start_index)=0;

  virtual int starting_x(CH_Matrix_Classes::Matrix& qp_x)=0;

  virtual int starting_y(CH_Matrix_Classes::Matrix& qp_y,
                         const CH_Matrix_Classes::Matrix& qp_Qx,
                         const CH_Matrix_Classes::Matrix& qp_c)=0;

  virtual CH_Matrix_Classes::Real get_local_primalcost() const=0;

  virtual CH_Matrix_Classes::Real get_local_dualcost() const=0;

  virtual int get_Ab(CH_Matrix_Classes::Matrix& qp_A,CH_Matrix_Classes::Matrix &qp_b) const=0;

  virtual int restart_x(CH_Matrix_Classes::Matrix& qp_x,
                        const CH_Matrix_Classes::Matrix& qp_c,
                        const CH_Matrix_Classes::Matrix& qp_dc)=0;

  virtual int restart_y(CH_Matrix_Classes::Matrix& qp_y,
                        const CH_Matrix_Classes::Matrix& qp_Qx,
                        const CH_Matrix_Classes::Matrix& qp_c,
                        const CH_Matrix_Classes::Matrix& qp_dc)=0;
    
  virtual int add_xinv_kron_z(CH_Matrix_Classes::Symmatrix& barQ)=0;

  virtual int add_local_sys(CH_Matrix_Classes::Symmatrix& sysdy,CH_Matrix_Classes::Matrix& rhs)=0;

  virtual int suggest_mu(CH_Matrix_Classes::Real& ip_xz,
                         CH_Matrix_Classes::Integer& mu_dim,
                         CH_Matrix_Classes::Real& sigma,
                         const CH_Matrix_Classes::Matrix& qp_dx,
                         const CH_Matrix_Classes::Matrix& qp_dy,
                         const CH_Matrix_Classes::Matrix& rhs_residual)=0;

  virtual int get_corr(CH_Matrix_Classes::Matrix& xcorr,
                       CH_Matrix_Classes::Matrix& rhs,
                       CH_Matrix_Classes::Real mu)=0;

  virtual int line_search(CH_Matrix_Classes::Real& alpha,
                          const CH_Matrix_Classes::Matrix& qp_dx,
                          const CH_Matrix_Classes::Matrix& qp_dy,
                          const CH_Matrix_Classes::Matrix& rhs_residual)=0;

  virtual int set_point(const CH_Matrix_Classes::Matrix& qp_x,
                        const CH_Matrix_Classes::Matrix& qp_y,
                        CH_Matrix_Classes::Real alpha)=0;


  //---------------- for debugging purposes

  virtual CH_Matrix_Classes::Matrix& add_Bs(CH_Matrix_Classes::Matrix& qp_vec) const=0;

  virtual CH_Matrix_Classes::Matrix& subtract_z(CH_Matrix_Classes::Matrix& dual_residual,bool with_step=false) const=0;

};




}

#endif