Result Class Reference

The class for defining an optimization result. More...

Inheritance diagram for Result:

Public Member Functions
function	report (in obj, in settings, in style, in resultFilename, in saveSeparatly)
	Matlab function to create graphical and textual report from a result.
function	Result (in problem, in solver)
	Default constructor setting default Result object.
function	save (in obj, in filename)
	Function to save the Result object.
function	setResult (in obj, in X, in converged, in info)
	Function to set the results after solving.

Public Attributes
Property	comment
	String: Personal comment this result.
Property	filename
	String: Filename with path, without extension.

Private Attributes
Property	computerName
	String: Name of the computer.
Property	converged
	Bool: True if optimal solution was found (default: false)
Property	creationTime
	Datetime: Creation date with 'dd-MMM-yyyy HH:mm:ss'.
Property	gitHashString
	String: Git hash of the current commit.
Property	gitURL
	String: Url of git repository.
Property	info
	Struct: Further information of the solver.
Property	problem
	Object of the class Problem.
Property	solver
	Object of the class Solver.
Property	userName
	String: User name of the computer.
Property	X
	Double array: Solution of the problem.

Detailed Description

The class for defining an optimization result.

This class was implemented to ensure a consistent data structure to save results.

This class contains methods which are generally applicable to evaluate results (e.g. writeMovie()). Project specific evaluation methods should be saved in our personal scripts folder!

Constructor & Destructor Documentation

Result()

function Result	(	in	problem,
		in	solver
	)

Default constructor setting default Result object.

Parameters

problem	Object of the class Problem
solver	Object of the class Solver

Return values

obj	Result class object

Member Function Documentation

report()

function report	(	in	obj,
		in	settings,
		in	style,
		in	resultFilename,
		in	saveSeparatly
	)

Matlab function to create graphical and textual report from a result.

Please note that no PDF is generated, if no resultFilename is given as input argument!

Parameters

obj	Result object
settings	(optional) Struct: Settings defining what to report. It combines the fields specified in Collocation.extractData() and Collocation.report(). (use empty to skip)
style	(optional) Struct: Settings defining the style for reporting. See plotVarType() for details. (use empty to skip)
resultFilename	(optional) String: Filename to save the report in a LaTeX document. If the filename is an empty string, the result.filename will be used to save the LaTeX document. If there is no input for the filename at all, the report will be printed in the console and nothing will be saved.
saveSeparatly	(optional) Boolean: If true, save the solver report will be saved in a separate .tex and all figures will be saved as .fig and tikz standalone. Figures will be saved as .fig and tikz standalone. (default: 0)

Return values

simVarTable

Table: Summarizing all data which was reported (see Collocation.extractData() for details)

save()

function save	(	in	obj,
		in	filename
	)

Function to save the Result object.

The Result object will be saved in a variable called 'result' and saved using the given filename.

Parameters

obj	Result class object
filename	(optional) String: Filename with path, without extension (default: Used Result.filename)

setResult()

function setResult	(	in	obj,
		in	X,
		in	converged,
		in	info
	)

Function to set the results after solving.

Parameters

obj	Result class object
X	Double array: Solution of the problem
converged	Bool: True if optimal solution was found
info	(optional) Struct: Further information

Member Data Documentation

comment

Property comment

String: Personal comment this result.

computerName

Property computerName

private

String: Name of the computer.

converged

Property converged

private

Bool: True if optimal solution was found (default: false)

creationTime

Property creationTime

private

Datetime: Creation date with 'dd-MMM-yyyy HH:mm:ss'.

filename

Property filename

String: Filename with path, without extension.

gitHashString

Property gitHashString

private

String: Git hash of the current commit.

gitURL

Property gitURL

private

String: Url of git repository.

info

Property info

private

Struct: Further information of the solver.

problem

Property problem

private

Object of the class Problem.

solver

Property solver

private

Object of the class Solver.

userName

Property userName

private

String: User name of the computer.

X

Property X

private

Double array: Solution of the problem.

---

The documentation for this class was generated from the following file:

• BioMAC-Sim-Toolbox/src/result/@Result/Result.m