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

#ifndef OsiWarmStartBasis_H
#define OsiWarmStartBasis_H

#include "CoinHelperFunctions.hpp"
#include "OsiWarmStart.hpp"

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

/** WarmStart information that contains the basic status of each variable
    (structural and artificial) */

class OsiWarmStartBasis : public OsiWarmStart {
public:
  enum Status {
    isFree = 0x00,
    basic = 0x01,
    atUpperBound = 0x02,
    atLowerBound = 0x03
  };
private:
  OsiWarmStartBasis& operator=(const OsiWarmStartBasis&);

public:
  /// return the number of structural variables
  int getNumStructural() const { return numStructural_; }
  /// return the number of artificial variables
  int getNumArtificial() const { return numArtificial_; }

  /** return the basic status of the structural variables (4 variable per
      byte, 2 bits for each variable) */
  const char * getStructuralStatus() const { return structuralStatus_; }
  /** return the basic status of the artificial variables (4 variable per
      byte, 2 bits for each variable) */
  const char * getArtificialStatus() const { return artificialStatus_; }

  void setSize(int ns, int na) {
    delete[] structuralStatus_;
    delete[] artificialStatus_;
    structuralStatus_ = new char[(ns + 3) / 4];
    artificialStatus_ = new char[(na + 3) / 4];
    CoinFillN(structuralStatus_, (ns + 3) / 4, (char)0);
    CoinFillN(artificialStatus_, (na + 3) / 4, (char)0);
  }

  Status getStructStatus(int i) const {
    const int st = (structuralStatus_[i>>2] >> ((i&3)<<1)) & 3;
    return static_cast<OsiWarmStartBasis::Status>(st);
  }
  Status getArtifStatus(int i) const {
    const int st = (artificialStatus_[i>>2] >> ((i&3)<<1)) & 3;
    return static_cast<OsiWarmStartBasis::Status>(st);
  }
  void setStructStatus(int i, Status st) {
    char& st_byte = structuralStatus_[i>>2];
    st_byte &= ~(3 << (i&3));
    st_byte |= (st << (i&3));
  }
  void setArtifStatus(int i, Status st) {
    char& st_byte = artificialStatus_[i>>2];
    st_byte &= ~(3 << ((i&3)<<1));
    st_byte |= st << ((i&3)<<1);
  }

  /** Assign the status vectors to be the warmstart information. In this
      method the object assumes ownership of the pointers and upon return
      the argument pointers will be a NULL pointers. If copying is desirable
      use the constructor. <br>
      <strong>NOTE 1:</strong> The pointers passed to this method will be
      freed using delete[], so they must be created using new[].
      <strong>NOTE 2:</strong> The status vectors must contain 4 basis
      information per byte. The location of the basis information of the i-th
      variable is in byte <code>(sStat[i>>2]</code>, bits 0,1 if i%4 == 0,
      bits 2,3 if i%4 == 1, etc.
  */
  void assignBasisStatus(int ns, int na, char*& sStat, char*& aStat) {
    delete[] structuralStatus_;
    delete[] artificialStatus_;
    numStructural_ = ns;
    numArtificial_ = na;
    structuralStatus_ = sStat;
    artificialStatus_ = aStat;
    sStat = 0;
    aStat = 0;
  }

  OsiWarmStartBasis() :
    numStructural_(0), numArtificial_(0),
    structuralStatus_(0), artificialStatus_(0) {}

  OsiWarmStartBasis(int ns, int na, const char* sStat, const char* aStat) :
    numStructural_(ns), numArtificial_(na),
    structuralStatus_(0), artificialStatus_(0) {
    structuralStatus_ = new char[(ns + 3) / 4];
    artificialStatus_ = new char[(na + 3) / 4];
    CoinDisjointCopyN(sStat, (ns + 3) / 4, structuralStatus_);
    CoinDisjointCopyN(aStat, (na + 3) / 4, artificialStatus_);
  }
  OsiWarmStartBasis(const OsiWarmStartBasis& ws) :
    numStructural_(ws.numStructural_), numArtificial_(ws.numArtificial_),
    structuralStatus_(0), artificialStatus_(0) {
    structuralStatus_ = new char[(numStructural_ + 3) / 4];
    artificialStatus_ = new char[(numArtificial_ + 3) / 4];
    CoinDisjointCopyN(ws.structuralStatus_, (numStructural_ + 3) / 4,
		      structuralStatus_);
    CoinDisjointCopyN(ws.artificialStatus_, (numArtificial_ + 3) / 4,
		      artificialStatus_);
  }

  virtual ~OsiWarmStartBasis() {
    delete[] structuralStatus_;
    delete[] artificialStatus_;
  }

private:
  ///@name Private data members
  //@{
    /// the number of structural variables
    int numStructural_;
    /// the number of artificial variables
    int numArtificial_;
    /** the basic status of the structural variables (4 variable per byte, 2
	bits for each variable) */
    char * structuralStatus_;
    /** the basic status of the artificial variables (4 variable per byte, 2
	bits for each variable) */
    char * artificialStatus_;
  //@}
};

#endif