BcpsTreeNode.h

Go to the documentation of this file.

/*===========================================================================*
 * This file is part of the Branch, Constrain and Price Software (BiCePS)    *
 *                                                                           *
 * BiCePS 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 BcpsTreeNode_h_
#define BcpsTreeNode_h_

#include "BcpsNodeDesc.h"

#include <vector>

#include "AlpsTreeNode.h"
#include "AlpsNodeDesc.h"

#include "BcpsBranchObject.h"
#include "BcpsObjectPool.h"

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

class BcpsTreeNode : public AlpsTreeNode {

 protected:

    BcpsBranchObject *branchObject_;

 protected:

    virtual int generateConstraints(BcpsModel *model, 
                                    BcpsConstraintPool *conPool) {
        AlpsReturnStatus status = AlpsReturnStatusOk;
        return status;
    }

    virtual int generateVariables(BcpsModel *model, 
                                  BcpsVariablePool *varPool) {
        AlpsReturnStatus status = AlpsReturnStatusOk;
        return status;
    }

    virtual int chooseBranchingObject(BcpsModel *model) = 0;

    virtual int installSubProblem(BcpsModel *model) = 0;

    virtual int handleBoundingStatus(int status, bool &keepOn, bool &fathomed){
        // Default do nothing.
        return BcpsReturnStatusOk;
    }
    
 public:

    BcpsTreeNode() : branchObject_(NULL) { }

    virtual ~BcpsTreeNode(){ delete branchObject_; }

    virtual int process(bool isRoot = false, bool rampUp = false);

    virtual int bound(BcpsModel *model) = 0;
    
    virtual std::vector< CoinTriple<AlpsNodeDesc*, AlpsNodeStatus, double> > 
        branch() = 0;
    
    const BcpsBranchObject * branchObject() const { return branchObject_; }

    void setBranchObject(BcpsBranchObject * b) { branchObject_ = b; }

 protected:

    AlpsReturnStatus encodeBcps(AlpsEncoded *encoded) const {
        AlpsReturnStatus status = AlpsReturnStatusOk;
        int type = 0;
        if (branchObject_) {
            type = branchObject_->getType();
            encoded->writeRep(type);
            status = branchObject_->encode(encoded);
        }
        else {
            encoded->writeRep(type);
        }
        return status;
    }

#if 0 // Can't docode a down(blis) branching object here.

    AlpsReturnStatus decodeBcps(AlpsEncoded &encoded) {
        AlpsReturnStatus status = AlpsReturnStatusOk;
        int mark;
        encoded.readRep(mark);
        
        if (mark == 1) {
            // branchObject_ is not NULL.
            status = branchObject_->encode(encoded);
        }

        return status;
    }
#endif
    
};

#endif