BlisPseudo.h

Go to the documentation of this file.

/*===========================================================================*
 * This file is part of the BiCePS Linear Integer Solver (BLIS).             *
 *                                                                           *
 * BLIS is distributed under the Eclipse Public License as part of the       *
 * COIN-OR repository (http://www.coin-or.org).                              *
 *                                                                           *
 * Authors:                                                                  *
 *                                                                           *
 *          Yan Xu, Lehigh University                                        *
 *          Ted Ralphs, Lehigh University                                    *
 *                                                                           *
 * Conceptual Design:                                                        *
 *                                                                           *
 *          Yan Xu, Lehigh University                                        *
 *          Ted Ralphs, Lehigh University                                    *
 *          Laszlo Ladanyi, IBM T.J. Watson Research Center                  *
 *          Matthew Saltzman, Clemson University                             *
 *                                                                           * 
 *                                                                           *
 * Copyright (C) 2001-2013, Lehigh University, Yan Xu, and Ted Ralphs.       *
 * All Rights Reserved.                                                      *
 *===========================================================================*/

#ifndef BlisPseudo_h_
#define BlisPseudo_h_

#include "CoinError.hpp"
#include "AlpsKnowledge.h"

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

class BlisPseudocost : public AlpsKnowledge
{
private:
    double weight_;
    
    double upCost_;
    
    int upCount_;
    
    double downCost_;
    
    int downCount_;
    
    double score_;
    
public:
    BlisPseudocost() : 
        weight_(1.0),
        upCost_(0.0), 
        upCount_(0),
        downCost_(0.0),
        downCount_(0), 
        score_(0.0)
        {}
        
        BlisPseudocost(double uc, 
                       int un,
                       double dc, 
                   int dn,
                   double s)
        :
        weight_(1.0),
        upCost_(uc), 
        upCount_(un),
        downCost_(dc),
        downCount_(dn),
        score_(s) 
        {}
        
        BlisPseudocost(const BlisPseudocost& cost) {
            weight_ = cost.weight_;
            upCost_ = cost.upCost_;
            upCount_ = cost.upCount_;
            downCost_ = cost.downCost_;
            downCount_ = cost.downCount_;
            score_ = cost.score_;
        }
        
        BlisPseudocost& operator=(const BlisPseudocost& cost) {
            weight_ = cost.weight_;
            upCost_ = cost.upCost_;
            upCount_ = cost.upCount_;
            downCost_ = cost.downCost_;
            downCount_ = cost.downCount_;
            score_ = cost.score_;
            return *this;
        }
        
    void setWeight(double w) { 
        if (w < 0.0 || w > 1.0) {   
            throw CoinError("weight is not in range [0,1]", "setWeight", 
                            "BlisPseudo");
        }
        weight_= w; 
    }

    void update(const int dir,
                const double parentObjValue,
                const double objValue,
                const double solValue);

    void update(const int dir,
                const double objDiff,
                const double solValue);

    void update(double upCost,
                int upCount,
                double downCost,
                int downCount);
    
    int getUpCount() { return upCount_; }

    double getUpCost() { return upCost_; }
    
    int getDownCount() { return downCount_; }
    
    double getDownCost() { return downCost_; } 

    double getScore() { return score_; }

    void setScore(double s) { score_ = s; }

    AlpsReturnStatus encodeTo(AlpsEncoded *encoded) const;
    
    AlpsReturnStatus decodeFrom(AlpsEncoded &encoded);

    using AlpsKnowledge::encode ;
    virtual AlpsEncoded* encode() const;

    virtual AlpsKnowledge* decode(AlpsEncoded&) const;
};

#endif