BCP_cg_user.hpp

Go to the documentation of this file.

// Copyright (C) 2000, International Business Machines
// Corporation and others.  All Rights Reserved.
#ifndef _BCP_CG_USER_H
#define _BCP_CG_USER_H

// This file is fully docified.

#include "BCP_math.hpp"
#include "BCP_vector.hpp"
#include "BCP_cg_param.hpp"
#include "BCP_string.hpp"
#include "BCP_USER.hpp"

class BCP_cg_prob;
class BCP_buffer;
class BCP_var;
class BCP_var_algo;
class BCP_cut;
class BCP_cut_algo;

class BCP_cg_user : public BCP_user_class {
private:
  BCP_cg_prob * p;
public:
    void setCgProblemPointer(BCP_cg_prob * ptr) { p = ptr; }
    BCP_cg_prob * getCgProblemPointer() { return p; }
    double upper_bound() const;
    int current_phase() const;
    int current_level() const;
    int current_index() const;
    int current_iteration() const;
    char              get_param(const BCP_cg_par::chr_params key) const;
    int               get_param(const BCP_cg_par::int_params key) const;
    double            get_param(const BCP_cg_par::dbl_params key) const;
    const BCP_string& get_param(const BCP_cg_par::str_params key) const;

    void set_param(const BCP_cg_par::chr_params key, const bool val);
    void set_param(const BCP_cg_par::chr_params key, const char val);
    void set_param(const BCP_cg_par::int_params key, const int val);
    void set_param(const BCP_cg_par::dbl_params key, const double val);
    void set_param(const BCP_cg_par::str_params key, const char * val);
  void send_cut(const BCP_cut& cut);

  //===========================================================================
    BCP_cg_user() : p(0) {}
    virtual ~BCP_cg_user() {}
  //===========================================================================
  // Here are the user defined functions. For each of them a default is given
  // which can be overridden when the concrete user class is defined.
  //===========================================================================
  virtual void
  unpack_module_data(BCP_buffer & buf);

  //---------------------------------------------------------------------------
  virtual void
  unpack_primal_solution(BCP_buffer& buf);
   
  //---------------------------------------------------------------------------
  virtual void
  generate_cuts(BCP_vec<BCP_var*>& vars, BCP_vec<double>& x);
};

#endif