BundleModel.hxx

Go to the documentation of this file.

#ifndef CONICBUNDLE_BUNDLEMODEL_HXX
#define CONICBUNDLE_BUNDLEMODEL_HXX


#include "QPModelDataObject.hxx"
#include "BundleProxObject.hxx"
#include "GroundsetModification.hxx"
#include "FunctionObjectModification.hxx"

namespace ConicBundle {


  class BundleModel:public VariableMetricModel
{

public:
  
  BundleModel(CBout* cb=0,int cbinc=-1); 
  virtual ~BundleModel(); 

  enum ModelUpdate {
    new_subgradient, 
    descent_step, 
    null_step 
  };

  
  virtual int eval_function(CH_Matrix_Classes::Integer& ub_fid, 
                            CH_Matrix_Classes::Real& ub,
                            CH_Matrix_Classes::Integer y_id,
                            const CH_Matrix_Classes::Matrix& y,
                            CH_Matrix_Classes::Real nullstep_bound,
                            CH_Matrix_Classes::Real relprec) =0;

     
  virtual int eval_model(CH_Matrix_Classes::Real& lb, 
                         CH_Matrix_Classes::Integer y_id,
                         const CH_Matrix_Classes::Matrix& y,
                         CH_Matrix_Classes::Real relprec)=0;

 


  virtual int start_augmodel(QPModelDataPointer& blockp,
                             CH_Matrix_Classes::Integer cand_id,
                             const CH_Matrix_Classes::Matrix& cand_y,
                             const CH_Matrix_Classes::Indexmatrix* indices=0)=0;


  virtual int make_model_aggregate(bool& penalty_parameter_increased,bool keep_penalty_fixed)=0; 


  virtual int get_model_aggregate(CH_Matrix_Classes::Integer& model_aggregate_id,
                                  MinorantPointer& model_aggregate) =0;


  virtual int update_model(ModelUpdate model_update,
                           CH_Matrix_Classes::Integer center_id,
                           const CH_Matrix_Classes::Matrix& center_y,
                           CH_Matrix_Classes::Integer cand_id,
                           const CH_Matrix_Classes::Matrix& cand_y,
                           CH_Matrix_Classes::Real model_maxviol,
                           BundleProxObject& H) =0;


  virtual int synchronize_ids(CH_Matrix_Classes::Integer& new_center_ub_fid, 
                              CH_Matrix_Classes::Integer new_center_id,
                              CH_Matrix_Classes::Integer old_center_id,
                              CH_Matrix_Classes::Integer& new_cand_ub_fid, 
                              CH_Matrix_Classes::Integer new_cand_id,
                              CH_Matrix_Classes::Integer old_cand_id,
                              CH_Matrix_Classes::Integer& new_aggregate_id)=0;

  virtual bool center_modified(CH_Matrix_Classes::Integer& function_modification_id, 
                              CH_Matrix_Classes::Integer center_id)=0;


  virtual int recompute_center(CH_Matrix_Classes::Integer& new_center_ub_fid, 
                               CH_Matrix_Classes::Real& new_center_ub,
                               CH_Matrix_Classes::Integer center_id,
                               const CH_Matrix_Classes::Matrix& center_y,
                               bool accept_only_higher_values=false,
                               CH_Matrix_Classes::Real relprec=-1.)=0;


  virtual bool model_aggregate_modified(CH_Matrix_Classes::Integer old_model_aggregate_id)=0;



  virtual int provide_model_aggregate(CH_Matrix_Classes::Integer y_id,
                                      const CH_Matrix_Classes::Matrix& y)=0;



  virtual int apply_modification(bool& no_changes,
                                 const GroundsetModification& gsmdf,
                                 const FunObjModMap& funmdfmap,
                                 CH_Matrix_Classes::Integer new_center_id,
                                 const CH_Matrix_Classes::Matrix& new_center,
                                 CH_Matrix_Classes::Integer old_center_id,
                                 const CH_Matrix_Classes::Matrix& old_center)=0;


  virtual int check_center_validity_by_candidate(bool& cand_minorant_is_below,
                                                 CH_Matrix_Classes::Integer center_id,
                                                 const CH_Matrix_Classes::Matrix& center_y)=0;

  virtual int get_function_minorant(CH_Matrix_Classes::Integer& function_modification_id,MinorantPointer& minorant) =0;

  virtual int get_center_minorant(CH_Matrix_Classes::Integer& function_modification_id,MinorantPointer& minorant) =0;


  virtual BundleModel* transform() {return this;} 

  VariableMetricModel* variable_metric_transform() 
  {return transform();} 
  
};




}

#endif