ExternalEvaluation.h

/*  
    Copyright (c) 2017 Institute Jožef Stefan, Jamova cesta 39, SI-1000, Ljubljana, Slovenija

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.

    Please cite the following works (bibtex source below):
        - DepolliAvbeljTrobec2008 for the simulator and simulation-based optimization
        - DepolliTrobecFilipic2013 for the AMS-DEMO optimizer
        - TrobecDepolliAvbelj2009 for the simulator

    @article{DepolliAvbeljTrobec2008,
        author = {Depolli, Matjaž and Avbelj, Viktor and Trobec, Roman},
        title = {Computer-Simulated Alternative Modes of {U}-Wave Genesis},
        journal = {Journal of Cardiovascular Electrophysiology},
        volume = {19},
        number = {1},
        publisher = {Blackwell Publishing Inc},
        issn = {1540-8167},
        url = {http://dx.doi.org/10.1111/j.1540-8167.2007.00978.x},
        doi = {10.1111/j.1540-8167.2007.00978.x},
        pages = {84--89},
        keywords = {U wave, ECG, action potential, repolarization, myocardium, computer simulation},
        year = {2008}
    }

    @article{DepolliTrobecFilipic2013,
        author = {Depolli, Matjaž and Trobec, Roman and Filipič, Bogdan},
        title = {Asynchronous master-slave parallelization of differential evolution for multiobjective optimization},
        journal = {Evolutionary Computation},
        volume = {21},
        number = {2},
        pages = {261-291},
        doi = {10.1162/EVCO_a_00076},
        issn = {1063-6560},
        url = {http://www.mitpressjournals.org/doi/abs/10.1162/EVCO_a_00076},
        year = {2013}
    }

    @inproceedings{TrobecDepolliAvbelj2009,
        title           = {Simulation of {ECG} repolarization phase with improved model of cell action potentials},
        author          = {Trobec, Roman and Depolli, Matja{\v{z}} and Avbelj, Viktor},
        booktitle       = {International Joint Conference on Biomedical Engineering Systems and Technologies},
        pages           = {325--332},
        year            = {2009},
        organization    = {Springer}
    }
*/

#ifndef EXTERNALEVALUATION_H_INCLUDED
#define EXTERNALEVALUATION_H_INCLUDED


#include <stdexcept>
#include <cstdlib>
#include <fstream>
#include <sstream>
#include "TypeWrapper.h"
#include <limits>



template<class In>
struct DummyNormalization {inline void normalize(In&) const {}};


/// +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
/// 
/// 
template<class In, class Out, class Param, class Norm = DummyNormalization<In> >
struct ExternalEvaluation : public Norm {
	// simulator's (external process) input is optimizer's (this program) output and
	// vice-versa
	std::string inFname, outFname;
	std::string homeDir, executableCommand;
	typedef Out Value;
	typedef In Input;
	enum {geneBounds = false};
	
	void operator() (const Input& solution, Value& result, double& violation, Param& parameters) const {
		writeIn(solution);
		int outRes = system( (executableCommand + " " + homeDir).c_str());
		if (outRes != 0)
			throw std::runtime_error(std::string("Failed to run ")+executableCommand + " " + homeDir);
//		std::cout << (executableCommand + " " + homeDir) << "\n";
		readOut(result, violation, parameters);
	}
	
	// void normalize(Input& in) const is inherited from class Norm
	
	void writeIn(const Input& solution) const {
        std::string fileName = (homeDir != "" ? (homeDir + "/" + inFname) : inFname);
		std::ofstream file(fileName.c_str());
		if (file) {
			file << "# file generated by ExternalEvaluation class\n";
			for (size_t i = 0; i < solution.size(); ++i)
				file << solution[i] << "\n";
		}
		if (!file) 
			throw std::runtime_error("ExternalEvaluation: writing to file "+fileName+" failed");
	}
	
	template<class Value>
	void readOut(Value& out, double& violation, Param& parameters) const {
		std::ifstream file((homeDir != "" ? (homeDir + "/" + outFname).c_str() : outFname.c_str()));
		
		violation = 0.0;
		for (size_t i = 0; i < TypeWrapper::size(out) + TypeWrapper::size(parameters); ) {
			if (file.peek() == '#') {
				file.ignore(1);
				std::string line;
				std::getline(file, line);
				std::istringstream lineStream(line);
				std::string comment;
				lineStream >> comment;
				if (comment == "violation") {
					lineStream >> violation;
				}
			} else  {
				if (!file) {
					violation = std::numeric_limits<double>::infinity();
					// throw std::runtime_error("ExternalEvaluation: error while reading file");
					if (i < TypeWrapper::size(out))
						out[i] = std::numeric_limits<double>::infinity();
					else
						parameters[i - TypeWrapper::size(out)] = std::numeric_limits<double>::infinity();
				} else {				
					if (i < TypeWrapper::size(out))
						file >> out[i];
					else
						file >> parameters[i - TypeWrapper::size(out)];
				}
				++i;
			}
		}
	}
};


#endif // EXTERNALEVALUATION_H_INCLUDED