AlpsParameterBase.h

Go to the documentation of this file.

/*===========================================================================*
 * This file is part of the Abstract Library for Parallel Search (ALPS).     *
 *                                                                           *
 * ALPS is distributed under the Eclipse Public License as part of the       *
 * COIN-OR repository (http://www.coin-or.org).                              *
 *                                                                           *
 * Authors:                                                                  *
 *                                                                           *
 *          Yan Xu, Lehigh University                                        *
 *          Aykut Bulut, 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-2023, Lehigh University, Yan Xu, Aykut Bulut, and      *
 *                          Ted Ralphs.                                      *
 * All Rights Reserved.                                                      *
 *===========================================================================*/
 
 
#ifndef AlpsParameterBase_h_
#define AlpsParameterBase_h_
 
//----------------------------------------------------------
// AlpsParameterBase.h is modified from BCP_parameters.hpp
//----------------------------------------------------------
 
#include <algorithm>
#include <cctype>
#include <cstdio>
#include <fstream>
#include <iostream>
#include <string>
#include <utility>          // for 'pair'
#include <vector>
 
#include "CoinError.hpp"
 
#if defined(__GNUC__) && (__GNUC__ >= 3)
#    include <sstream>
#    include <locale>
#    define ALPS_STRINGSTREAM std::istringstream
#else
#    include <strstream>
#    include <cctype>
#    define ALPS_STRINGSTREAM std::istrstream
#endif
 
class AlpsEncoded;
 
//##############################################################################
 
enum AlpsParameterT{
    AlpsNoPar,
    AlpsBoolPar,
    AlpsIntPar,
    AlpsDoublePar,
    AlpsStringPar,
    AlpsStringArrayPar
};
 
//##############################################################################
 
class AlpsParameter {
 
 private:
    AlpsParameterT type_;
    int index_;
 public:
    // default copy constructor and assignment operator are fine
    AlpsParameter() : type_(AlpsNoPar), index_(0) {}
    AlpsParameter(const AlpsParameterT t, const int i) :
        type_(t), index_(i) {}
    ~AlpsParameter() {}
    AlpsParameterT type() const { return type_; }
    int index() const            { return index_; }
};
 
//##############################################################################
 
class AlpsParameterSet {
 protected:
    std::vector< std::pair<std::string, AlpsParameter> > keys_;
 
    std::string prefix_;
   
    std::vector<std::string> obsoleteKeys_;
 
    bool*                bpar_;
 
    int*                 ipar_;
 
    double*              dpar_;
 
    std::string*          spar_;
 
    int numSa_;
    std::vector<std::string>* sapar_;
 
  //---------------------------------------------------------------------------
 
 public:
    virtual void createKeywordList() = 0;
 
    virtual void setDefaultEntries() = 0;
    virtual void pack(AlpsEncoded& buf) {
        throw CoinError("can't call pack()", "pack", " AlpsParameterSet");
    }
 
    virtual void unpack(AlpsEncoded& buf){
        throw CoinError("can't call unpack()", "unpack", " AlpsParameterSet");
    }
 
    //---------------------------------------------------------------------------
 
 public:
 
    // This the one used in readFromStream()
    void setEntry(const AlpsParameter key, const char * val) {
        switch (key.type()){
        case AlpsNoPar: break;
        case AlpsBoolPar:        bpar_ [key.index()] = atoi(val) ? true : false;    break;
        case AlpsIntPar:         ipar_ [key.index()] = atoi(val);    break;
        case AlpsDoublePar:      dpar_ [key.index()] = atof(val);    break;
        case AlpsStringPar:      spar_ [key.index()] = val;          break;
        case AlpsStringArrayPar: sapar_[key.index()].push_back(val); break;
        }
    }
 
    void readFromStream(std::istream& parstream);
 
    void readFromFile(const char * paramfile);
 
    void readFromArglist(const int argnum, const char * const * arglist);
 
    void writeToStream(std::ostream& outstream) const;
 
    AlpsParameterSet(int c, int i, int d, int s, int sa) :
        keys_(),
        prefix_("Alps"),
        bpar_(new bool[c]),
        ipar_(new int[i]),
        dpar_(new double[d]),
        spar_(new std::string[s]),
        sapar_(new std::vector<std::string>[sa])
        {}
 
    virtual ~AlpsParameterSet() {
        keys_.clear();
        obsoleteKeys_.clear();
        delete[] bpar_; bpar_ = 0;
        delete[] ipar_; ipar_ = 0;
        delete[] dpar_; dpar_ = 0;
        delete[] spar_; spar_ = 0;
        delete[] sapar_; sapar_ = 0;
    }
};
 
#endif