/home/coin/SVN-release/CoinAll-1.1.0/Bcp/src/include/BCP_tm_user.hpp

Go to the documentation of this file.

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

// This file is fully docified.

#include "BCP_math.hpp"
#include "BCP_enum.hpp"
#include "BCP_enum_process_t.hpp"
#include "BCP_vector.hpp"
#include "BCP_string.hpp"
#include "BCP_buffer.hpp"
#include "BCP_solution.hpp"
#include "BCP_warmstart.hpp"
#include "BCP_var.hpp"
#include "BCP_cut.hpp"
#include "BCP_matrix.hpp"
#include "BCP_tm_param.hpp"
#include "BCP_tm_node.hpp"
#include "BCP_enum_tm.hpp"

class BCP_lp_statistics;

//#############################################################################

class BCP_tm_user {
private:
  BCP_tm_prob * p;
public:

    void setTmProblemPointer(BCP_tm_prob * ptr) { p = ptr; }
    BCP_tm_prob * getTmProblemPointer() { return p; }

    double upper_bound() const;

    char              get_param(const BCP_tm_par::chr_params key) const;
    int               get_param(const BCP_tm_par::int_params key) const;
    double            get_param(const BCP_tm_par::dbl_params key) const;
    const BCP_string& get_param(const BCP_tm_par::str_params key) const;

    void set_param(const BCP_tm_par::chr_params key, const bool val);
    void set_param(const BCP_tm_par::chr_params key, const char val);
    void set_param(const BCP_tm_par::int_params key, const int val);
    void set_param(const BCP_tm_par::dbl_params key, const double val);
    void set_param(const BCP_tm_par::str_params key, const char * val);
  //===========================================================================
    BCP_tm_user() : p(0) {}
    virtual ~BCP_tm_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
    pack_module_data(BCP_buffer& buf, BCP_process_t ptype);

    virtual BCP_solution*
    unpack_feasible_solution(BCP_buffer& buf);

    virtual bool
    replace_solution(const BCP_solution* old_sol, const BCP_solution* new_sol);

      virtual void
      pack_warmstart(const BCP_warmstart* ws, BCP_buffer& buf);
      virtual BCP_warmstart*
      unpack_warmstart(BCP_buffer& buf);
      
      virtual void
      pack_var_algo(const BCP_var_algo* var, BCP_buffer& buf);
      virtual BCP_var_algo*
      unpack_var_algo(BCP_buffer& buf);
      
      virtual void
      pack_cut_algo(const BCP_cut_algo* cut, BCP_buffer& buf);
      virtual BCP_cut_algo*
      unpack_cut_algo(BCP_buffer& buf);

      virtual void
      pack_user_data(const BCP_user_data* ud, BCP_buffer& buf);
      virtual BCP_user_data*
      unpack_user_data(BCP_buffer& buf);

  //--------------------------------------------------------------------------
  const BCP_proc_id* process_id() const;
  void
  send_message(const BCP_proc_id* const target, const BCP_buffer& buf);
  void
  broadcast_message(const BCP_process_t proc_type, const BCP_buffer& buf);
  virtual void
  process_message(BCP_buffer& buf);
  //--------------------------------------------------------------------------
     virtual void
     initialize_core(BCP_vec<BCP_var_core*>& vars,
                     BCP_vec<BCP_cut_core*>& cuts,
                     BCP_lp_relax*& matrix);
    //-------------------------------------------------------------------------
     virtual void
     create_root(BCP_vec<BCP_var*>& added_vars,
                 BCP_vec<BCP_cut*>& added_cuts,
                 BCP_user_data*& user_data,
                 BCP_pricing_status& pricing_status);
  //--------------------------------------------------------------------------
  virtual void
  display_feasible_solution(const BCP_solution* sol);
    
  //--------------------------------------------------------------------------
  virtual void
  display_node_information(BCP_tree& search_tree,
                           const BCP_tm_node& node);
    
  //--------------------------------------------------------------------------
  virtual void
  display_final_information(const BCP_lp_statistics& lp_stat);
    
  //---------------------------------------------------------------------------
    virtual void
    init_new_phase(int phase, BCP_column_generation& colgen);
  //---------------------------------------------------------------------------
    virtual bool compare_tree_nodes(const BCP_tm_node* node0,
                                    const BCP_tm_node* node1);
};

//#############################################################################

#endif

---