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 <iomanip>
#include <istream>
#include <limits>
#include <map>
#include <ostream>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
#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 std::variant< double, std::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;
 
    void writeState(std::ostream& os) const {
        os << std::setprecision(std::numeric_limits<double>::max_digits10);
        os << static_cast<int>(type) << ' ' << value.size();
        for (double v : value) os << ' ' << v;
        os << ' ' << is_valid;
    }
 
    void readState(std::istream& is) {
        int t = 0;
        is >> t;
        type = static_cast<InfoType_t>(t);
        std::size_t n = 0;
        is >> n;
        value.resize(n);
        for (double& v : value) is >> v;
        is >> is_valid;
    }
} reqVarInfo_t;
 
typedef std::pair<std::string, reqVarInfo_t> namedReqVar_t;
typedef std::map<std::string, reqVarInfo_t> reqVarContainer_t;
 
typedef std::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