BoxData.hxx

Go to the documentation of this file.

#ifndef CONICBUNDLE_BOXDATA_HXX
#define CONICBUNDLE_BOXDATA_HXX


#include "BundleData.hxx"
#include "MatrixCBSolver.hxx"
#include "BoxOracle.hxx"

namespace ConicBundle {


class BoxData:public BundleData
{
private:
  friend class BoxModel;


  //===== 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 or @a function_factor

  //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
  MinorantPointer center_minorant;   
  PrimalMatrix center_boxvec;   

  //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
  MinorantPointer cand_minorant;    
  PrimalMatrix cand_boxvec; 

  //CH_Matrix_Classes::Integer aggregate_id;  ///< if available and ids match, the aggregate need not be recomputed
  //MinorantPointer aggregate; ///< the aggregate linear minorant of the model (including @a function_factor and @a function_task)

  PrimalMatrix aggr_boxvec; 
  CH_Matrix_Classes::Real aggr_scaleval; 

  //SumBundle sumbundle;

  //CH_Matrix_Classes::Integer max_old_minorants; ///< ==0 by default, otherwise it gives the maximum number of the most recent candidate minorants to be stored 
  //MinorantBundle old_minorants;  ///< minorants collected for scaling and no other purposes, holds the at most max_old_minorants most recent candidate minorants

  //CH_Matrix_Classes::Matrix old_lowrank; ///< used by the dynamic scaling low rank heuristic (without function_factor)
  //CH_Matrix_Classes::Matrix old_diagonal; ///< used by the dynamic scaling low rank heuristic (without function_factor)
  //CH_Matrix_Classes::Symmatrix old_sym; ///< used by the dynamic scaling heuristic 
  //CH_Matrix_Classes::Integer minorant_nexti; ///< used by the dynamic scaling low rank heuristic 
 

  //the bundle is initialized if bundle.size()>0 (each subg might be of length 0!) 

  MinorantBundle boxbundle; 
  CH_Matrix_Classes::Matrix boxbundle_coeff;  
  CH_Matrix_Classes::Matrix primal_boxtapia; 

  CH_Matrix_Classes::Indexmatrix boxbundle_coords; 
  CH_Matrix_Classes::Matrix boxbundle_complvalues; 

  MinorantBundle nncbundle;  
  CH_Matrix_Classes::Matrix nncbundle_coeff;  
  CH_Matrix_Classes::Matrix primal_nnctapia; 

  bool outside_bundle; 

  CH_Matrix_Classes::Matrix coord_switching; 


  CH_Matrix_Classes::Integer prex_id; 

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

  BoxData(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 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(bool discard_minorants_only=false);   

  void clear_aggregates();          

  int call_primal_extender(PrimalExtender& prex,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;


};



}

#endif