SOCData.hxx

Go to the documentation of this file.

#ifndef CONICBUNDLE_SOCDATA_HXX
#define CONICBUNDLE_SOCDATA_HXX


#include "BundleData.hxx"

namespace ConicBundle {


class SOCData:public BundleData
{
private:
  friend class SOCModel;

  //===== variables =====
  //CH_Matrix_Classes::Integer dim; ///< the incoming dimension, once it is detected, -1 if not yet clear (some need it, but it is mainly for consistency checks and should be initialized in eval_function, lb_function, recompute_center, and updated in apply_modification)
  //FunctionTask function_task;   
  //CH_Matrix_Classes::Real function_factor;  ///< >0, interpreted according to function_task

  //CH_Matrix_Classes::Integer modification_id; ///< increased on any modification applied to the function

  //CH_Matrix_Classes::Integer center_ub_mid; ///< modification id for which center_ub was computed, <0 if not initialized
  //CH_Matrix_Classes::Real center_ub;     ///< upper bound on function value for modification id center_mid and center with point id center_id
  //CH_Matrix_Classes::Real center_relprec; ///< relative precision used in computing center_ub
  //CH_Matrix_Classes::Integer center_id;  ///< point id of the stored center
  CH_Matrix_Classes::Real center_SOCval; 
  CH_Matrix_Classes::Matrix center_SOCvec; 
  MinorantPointer center_minorant; 


  //CH_Matrix_Classes::Integer cand_ub_mid; ///< modification id for which cand_ub was computed, <0 if not initialized
  //CH_Matrix_Classes::Real cand_ub;     ///< upper bound on function value for modification id cand_mid and candidate with point id cand_id
  //CH_Matrix_Classes::Real cand_relprec; ///< relative precision used in computing cand_ub
  //CH_Matrix_Classes::Integer cand_id;  ///< point id of the stored candidate
  CH_Matrix_Classes::Real cand_SOCval; 
  CH_Matrix_Classes::Matrix cand_SOCvec; 
  MinorantPointer cand_minorant; 

  //CH_Matrix_Classes::Integer aggregate_id;
  //MinorantPointer local_aggregate; ///< the local (possibly empty) aggregate linear minorant of the model handled by this and its descendants (including @a function_factor and @a function_task)
  //MinorantPointer aggregate; ///< the aggregate linear minorant of the model (including @a function_factor and @a function_task)
  CH_Matrix_Classes::Matrix primalvec;  

  //the bundle is initialized if bundlevecs.coldim()>0 (then it must have rowdim>0!) 
  CH_Matrix_Classes::Matrix bundlevecs;   
  

  CH_Matrix_Classes::Matrix SOCvecs; 
  CH_Matrix_Classes::Integer SOCvecs_max; 
  CH_Matrix_Classes::Integer SOCvecs_nexti; 

  //SumBundle sumbundle;


  //--- data needed for generic scaling
  //CH_Matrix_Classes::Integer max_old_minorants; 
  //MinorantBundle old_minorants; 
  //CH_Matrix_Classes::Matrix old_lowrank;
  //CH_Matrix_Classes::Matrix old_diagonal;
  //CH_Matrix_Classes::Symmatrix old_sym; 
  //CH_Matrix_Classes::Integer minorant_nexti; 

public:
  
  //===== methods =====
  ~SOCData();
 
  void clear(CH_Matrix_Classes::Integer start_modification_id=0);  

  SOCData(CH_Matrix_Classes::Real fun_factor=1.,FunctionTask fun_task=ObjectiveFunction);

  int init(const BundleData* bd);

  BundleData* clone() const;
  
  int do_step(CH_Matrix_Classes::Integer point_id);

  //int store_old_minorant(MinorantPointer& minorant);  //as in Bundledata

  virtual int store_SOCvec(const CH_Matrix_Classes::Matrix& SOCvec);

  int form_bundlevecs(CH_Matrix_Classes::Integer max_columns);

  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,
                              CH_Matrix_Classes::Integer new_prex_id=0);

  //int center_modified()            // as in BundleData

  //int model_aggregate_modified()   // as in BundleData

  void clear_model_except_bundlevecs();   

  void clear_model(bool discard_minorants_only=false);   

  void clear_aggregates();

  int call_primal_extender(PrimalExtender&,bool include_candidates=true);

  int apply_modification(const GroundsetModification&,MinorantExtender* mex);

  const PrimalData* get_approximate_primal() const;

  const PrimalData* get_center_primal() const;

  const PrimalData* get_candidate_primal() const;

  virtual int get_latest_minorants(MinorantBundle& latest_minorants,
                                   CH_Matrix_Classes::Integer max_number);

};



}

#endif