Types.h

Go to the documentation of this file.

//
// File Types
//
// Copyright (c) 2010 - 2013, Yves Ineichen, ETH Zürich
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Toward massively parallel multi-objective optimization with application to
// particle accelerators" (https://doi.org/10.3929/ethz-a-009792359)
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef __TYPES_H__
#define __TYPES_H__

#include <map>
#include <utility>
#include <vector>

#include "boost/tuple/tuple.hpp"

#include "Expression/Expression.h"

//FIXME: add namespaces

enum Role_t {WORKER, OPTIMIZER, POLLER, UNASSIGNED};


// Variables

// information the optimizer can request: either wants a derivative or a
// function evaluation.
enum InfoType_t {EVALUATE, DERIVATE};
enum Position_t {TIME, POSITION};

typedef std::pair<std::string, double> namedVariable_t;
typedef std::map<std::string, double>  namedVariableCollection_t;

typedef namedVariableCollection_t Param_t;
typedef namedVariableCollection_t variableDictionary_t;

//typedef boost::variant< double, boost::tuple<double, double, double> >
    //reqVarValue_t;

//FIXME: do we need InfoType_t ?
typedef struct reqVarInfo {
    InfoType_t          type;
    std::vector<double> value;
    bool                is_valid;

    template<class Archive>
    void serialize(Archive & ar, const unsigned int /*version*/) {
        ar & type;
        ar & value;
        ar & is_valid;
    }
} reqVarInfo_t;

typedef std::pair<std::string, reqVarInfo_t> namedReqVar_t;
typedef std::map<std::string, reqVarInfo_t> reqVarContainer_t;



typedef boost::tuple<std::string, double, double> DVar_t;
enum DVar_tIdx {
    VAR_NAME,
    LOWER_BOUND,
    UPPER_BOUND
};

typedef std::pair<std::string, DVar_t> namedDVar_t;
typedef std::map<std::string, DVar_t> DVarContainer_t;

#endif