EnergyOptimizatorOfRoboticCells/Solution_8h_source.html

 /*

         This file is part of the EnergyOptimizatorOfRoboticCells program.


         EnergyOptimizatorOfRoboticCells 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.


         EnergyOptimizatorOfRoboticCells is distributed in the hope that it will be useful,

         but WITHOUT ANY WARRANTY; without even the implied warranty of

         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

         GNU General Public License for more details.


         You should have received a copy of the GNU General Public License

         along with EnergyOptimizatorOfRoboticCells. If not, see <http://www.gnu.org/licenses/>.

 */


 #ifndef HLIDAC_PES_SOLUTION_H

 #define HLIDAC_PES_SOLUTION_H


 #include <iostream>

 #include <map>

 #include <utility>

 #include "ILPModel/SolverInterface.h"


 struct PrecalculatedMapping;


 enum State {

         OPTIMAL, FEASIBLE, INFEASIBLE, UNKNOWN

 };


 State convert(const Status& ilpStatus);


 struct Solution {

         Solution() : status(UNKNOWN), totalEnergy(0.0), lowerBound(0.0), runTime(-1.0), memUsage(-1.0) { }


         State status;

         double totalEnergy;

         double lowerBound;

         double runTime;

         double memUsage;

         std::map<uint32_t, std::pair<double, double> > startTimeAndDuration;

         std::map<uint32_t, std::pair<uint32_t, uint32_t> > pointAndPowerMode;


 };


 std::ostream& operator<<(std::ostream& out, const Solution& s);

 std::ostream& operator<<(std::ostream& out, const State& st);


 void writeBriefResultToStream(std::ostream& OUT, const std::string& instanceName, const Solution& s);

 void writeBriefResultToCsvFile(const std::string& instanceName, const std::string& pathToFile, const Solution& s);

 void writeSolutionToCsvFile(const std::string& file, const Solution& s, const PrecalculatedMapping& mapper);


 #endif


Solution::Solution
Solution()
It constructs an empty solution.
Definition: Solution.h:52

Solution::totalEnergy
double totalEnergy
The amount of energy required per robot cycle.
Definition: Solution.h:57

Solution
The structure representing a solution found by an algorithm.
Definition: Solution.h:50

Solution::runTime
double runTime
Run time (seconds) of the optimization algorithm required for obtaining this solution.
Definition: Solution.h:61

convert
State convert(const Status &ilpStatus)
Conversion between the ILP solver status and the solution state.
Definition: Solution.cpp:29

operator<<
std::ostream & operator<<(std::ostream &out, const Solution &s)
It prints the solution to the output stream.
Definition: Solution.cpp:48

Solution::pointAndPowerMode
std::map< uint32_t, std::pair< uint32_t, uint32_t > > pointAndPowerMode
It maps the identification of a static activity to its assigned coordinate and used power saving mode...
Definition: Solution.h:67

SolverInterface.h
Solver-independent interface for solving Integer Linear Programming problems.

Solution::status
State status
Enum specifying whether the solution is optimal, feasible, or infeasible...
Definition: Solution.h:55

writeBriefResultToCsvFile
void writeBriefResultToCsvFile(const std::string &instanceName, const std::string &pathToFile, const Solution &s)
It writes the solution to the file in the same format as writeBriefResultToStream function...
Definition: Solution.cpp:164

Status
Status
Constants specifying whether a solution is optimal, feasible, infeasible, unbounded, or undefined, respectively.
Definition: SolverInterface.h:41

Solution::memUsage
double memUsage
Memory usage (bytes) of the optimization algorithm, currently not used due to implementation issues...
Definition: Solution.h:63

writeSolutionToCsvFile
void writeSolutionToCsvFile(const std::string &file, const Solution &s, const PrecalculatedMapping &mapper)
It writes the solution to a csv file, the header is 'activity id, start time, duration, type, point, power saving mode, movement, energy'.
Definition: Solution.cpp:109

State
State
Enum declares constants specifying whether a found solution is optimal, feasible, infeasible...
Definition: Solution.h:38

Solution::lowerBound
double lowerBound
Lower bound on energy, i.e. there is not a solution consuming less energy than this number...
Definition: Solution.h:59

writeBriefResultToStream
void writeBriefResultToStream(std::ostream &OUT, const std::string &instanceName, const Solution &s)
It prints the solution as follows: 'instance name (state, runtime s): energy'.
Definition: Solution.cpp:152

PrecalculatedMapping
The structure contains the maps for fast searching in the robotic cell.
Definition: PrecalculatedMapping.h:76

Solution::startTimeAndDuration
std::map< uint32_t, std::pair< double, double > > startTimeAndDuration
Mapping of the activity identification to its start time and duration.
Definition: Solution.h:65