Groundset.hxx

Go to the documentation of this file.

#ifndef CONICBUNDLE_GROUNDSET_HXX
#define CONICBUNDLE_GROUNDSET_HXX


#include "BundleProxObject.hxx"
#include "QPSolverObject.hxx"
//#include "clock.hxx"

namespace ConicBundle {


  class Groundset:virtual public VariableMetricModel 
{
  
public:
  virtual void clear( CH_Matrix_Classes::Integer indim=0, CH_Matrix_Classes::Integer in_groundset_id=0) =0;

  virtual ~Groundset();

  virtual CH_Matrix_Classes::Integer get_groundset_id() const =0;

  virtual void set_groundset_id(CH_Matrix_Classes::Integer gsid) =0;

  virtual CH_Matrix_Classes::Integer get_dim() const =0;

  virtual bool constrained() const =0;

  virtual bool is_feasible(CH_Matrix_Classes::Integer& in_groundset_id,
                            const CH_Matrix_Classes::Matrix& y,
                             CH_Matrix_Classes::Real relprec=1e-10)=0;

  virtual int ensure_feasibility(CH_Matrix_Classes::Integer& in_groundset_id,
                                 CH_Matrix_Classes::Matrix& y,
                                 bool& ychanged,
                                 BundleProxObject* Hp=0,
                                 CH_Matrix_Classes::Real relprec=1e-10)=0;

  virtual QPSolverObject* get_qp_solver(bool& solves_model_without_gs,
                                        BundleProxObject* Hp) =0;
  
  virtual int set_qp_solver_parameters(QPSolverParametersObject* in_qpsp) =0;

  virtual const CH_Matrix_Classes::Matrix& get_starting_point() const =0;

  virtual int set_starting_point(const CH_Matrix_Classes::Matrix& vec)=0;

  virtual int candidate(CH_Matrix_Classes::Integer& gs_id,
                        CH_Matrix_Classes::Matrix& newy,
                        CH_Matrix_Classes::Real& cand_gs_val,
                        CH_Matrix_Classes::Real& linval,
                        CH_Matrix_Classes::Real& augval_lb,
                        CH_Matrix_Classes::Real& augval_ub,
                        CH_Matrix_Classes::Real& subgnorm2,
                        const CH_Matrix_Classes::Matrix& center_y,
                        CH_Matrix_Classes::Real center_value,
                        const MinorantPointer& model_minorant,
                        BundleProxObject* Hp,
                        MinorantPointer* delta_groundset_minorant=0,
                        CH_Matrix_Classes::Indexmatrix* delta_index=0,
                        CH_Matrix_Classes::Real relprec=1e-2)=0;

  virtual const MinorantPointer& get_gs_aggregate() const =0;

  virtual const MinorantPointer& get_gs_minorant() const =0;

  virtual const CH_Matrix_Classes::Indexmatrix* get_yfixed() const =0;

  virtual CH_Matrix_Classes::Indexmatrix* set_yfixed() =0;

  virtual bool get_use_yfixing() const =0;

  virtual void set_use_yfixing(bool uyf) =0;

  virtual GroundsetModification* start_modification() =0;

  virtual int apply_modification(const GroundsetModification& mdf) =0;

  virtual int mfile_data(std::ostream& out) const =0;

};




}

#endif