NOMAD Source  Version 4.0.0 Beta
StatsInfo Class Reference

Information for stats format (parameters DISPLAY_STATS and STATS_FILE). More...

#include <StatsInfo.hpp>

Collaboration diagram for StatsInfo:

Public Member Functions

 StatsInfo ()
 

Success type for this evaluation

More...
 
void setObj (const Double &obj)
 
void setConsH (const Double consH)
 
void setHMax (const Double hMax)
 
void setBBE (const size_t bbe)
 
void setFeasBBE (const size_t feasBBE)
 
void setInfBBE (const size_t infBBE)
 
void setAlgoBBE (const size_t bbe)
 
void setBlkEva (const size_t blkEva)
 
void setBlkSize (const size_t blkSize)
 
void setBBO (const std::string &bbo)
 
void setEval (const size_t eval)
 
void setNbRelativeSuccess (const size_t nbRelSuccess)
 
void setPhaseOneSuccess (const size_t phaseOneSuccess)
 
void setCacheHits (const size_t cacheHits)
 
void setCacheSize (const size_t cacheSize)
 
void setIterNum (const size_t iterNum)
 
void setTime (const size_t time)
 
void setMeshIndex (const ArrayOfDouble meshIndex)
 
void setMeshSize (const ArrayOfDouble meshSize)
 
void setFrameSize (const ArrayOfDouble frameSize)
 
void setLap (const size_t lap)
 
void setSgte (const size_t sgte)
 
void setTotalSgte (const size_t totalSgte)
 
void setSol (const Point sol)
 
void setThreadAlgo (const int threadAlgoNum)
 
void setThreadNum (const int threadNum)
 
void setRelativeSuccess (bool relativeSuccess)
 
void setComment (const std::string &comment)
 
void setGenStep (const std::string &genStep)
 
void setSuccessType (const SuccessType &success)
 
bool alwaysDisplay (const bool displayInfeasible, const bool displayUnsuccessful) const
 
std::string displayHeader (const DisplayStatsTypeList &format, const ArrayOfDouble &solFormat=ArrayOfDouble(), const size_t objWidth=0) const
 Display header. More...
 
std::string display (const DisplayStatsTypeList &format, const ArrayOfDouble &solFormat=ArrayOfDouble(), const size_t objWidth=0, const size_t hWidth=0, const bool starSuccess=false, const bool appendComment=true) const
 

Static Public Member Functions

static DisplayStatsType stringToDisplayStatsType (const std::string &inputString, std::string &format)
 
static std::string displayStatsTypeToString (const DisplayStatsType &displayStatsType)
 

Private Attributes

Double _obj
 
Double _consH
 
Double _hMax
 
size_t _bbe
 
size_t _feasBBE
 
size_t _infBBE
 
size_t _nbRelativeSuccess
 
size_t _PhaseOneSuccess
 
size_t _algoBBE
 
size_t _blkEva
 
size_t _blkSize
 
std::string _bbo
 
size_t _eval
 
size_t _cacheHits
 
size_t _cacheSize
 
size_t _iterNum
 
size_t _time
 
ArrayOfDouble _meshIndex
 
ArrayOfDouble _meshSize
 
ArrayOfDouble _frameSize
 
size_t _lap
 
size_t _sgte
 
size_t _totalSgte
 
Point _sol
 
int _threadAlgoNum
 
int _threadNum
 
bool _relativeSuccess
 
std::string _comment
 

Used for priting star, or when DISPLAY_ALL_EVAL is false.

More...
 
std::string _genStep
 

General comment, ex. Algorithm from where this point was generated.

More...
 
SuccessType _success
 

Step in which this point was generated

More...
 

Detailed Description

Information for stats format (parameters DISPLAY_STATS and STATS_FILE).

Also holds information about stats file.

Definition at line 119 of file StatsInfo.hpp.

Constructor & Destructor Documentation

◆ StatsInfo()

StatsInfo::StatsInfo ( )
explicit

Success type for this evaluation

Constructor

Member Function Documentation

◆ alwaysDisplay()

bool StatsInfo::alwaysDisplay ( const bool  displayInfeasible,
const bool  displayUnsuccessful 
) const

◆ display()

std::string StatsInfo::display ( const DisplayStatsTypeList format,
const ArrayOfDouble solFormat = ArrayOfDouble(),
const size_t  objWidth = 0,
const size_t  hWidth = 0,
const bool  starSuccess = false,
const bool  appendComment = true 
) const

Display with an empty format will output BBE OBJ

◆ displayHeader()

std::string StatsInfo::displayHeader ( const DisplayStatsTypeList format,
const ArrayOfDouble solFormat = ArrayOfDouble(),
const size_t  objWidth = 0 
) const

Display header.

◆ displayStatsTypeToString()

static std::string StatsInfo::displayStatsTypeToString ( const DisplayStatsType displayStatsType)
static

◆ setAlgoBBE()

void StatsInfo::setAlgoBBE ( const size_t  bbe)
inline

Definition at line 175 of file StatsInfo.hpp.

175 { _algoBBE = bbe; }

◆ setBBE()

void StatsInfo::setBBE ( const size_t  bbe)
inline

Definition at line 172 of file StatsInfo.hpp.

172 { _bbe = bbe; }

◆ setBBO()

void StatsInfo::setBBO ( const std::string &  bbo)
inline

Definition at line 178 of file StatsInfo.hpp.

178 { _bbo = bbo; }

◆ setBlkEva()

void StatsInfo::setBlkEva ( const size_t  blkEva)
inline

Definition at line 176 of file StatsInfo.hpp.

176 { _blkEva = blkEva; }

◆ setBlkSize()

void StatsInfo::setBlkSize ( const size_t  blkSize)
inline

Definition at line 177 of file StatsInfo.hpp.

177 { _blkSize = blkSize; }

◆ setCacheHits()

void StatsInfo::setCacheHits ( const size_t  cacheHits)
inline

Definition at line 182 of file StatsInfo.hpp.

182 { _cacheHits = cacheHits; }

◆ setCacheSize()

void StatsInfo::setCacheSize ( const size_t  cacheSize)
inline

Definition at line 183 of file StatsInfo.hpp.

183 { _cacheSize = cacheSize; }

◆ setComment()

void StatsInfo::setComment ( const std::string &  comment)
inline

Definition at line 196 of file StatsInfo.hpp.

196 { _comment = comment; }

◆ setConsH()

void StatsInfo::setConsH ( const Double  consH)
inline

Definition at line 170 of file StatsInfo.hpp.

170 { _consH = consH; }

◆ setEval()

void StatsInfo::setEval ( const size_t  eval)
inline

Definition at line 179 of file StatsInfo.hpp.

179 { _eval = eval; }

◆ setFeasBBE()

void StatsInfo::setFeasBBE ( const size_t  feasBBE)
inline

Definition at line 173 of file StatsInfo.hpp.

173 { _feasBBE = feasBBE; }

◆ setFrameSize()

void StatsInfo::setFrameSize ( const ArrayOfDouble  frameSize)
inline

Definition at line 188 of file StatsInfo.hpp.

188 { _frameSize = frameSize; }

◆ setGenStep()

void StatsInfo::setGenStep ( const std::string &  genStep)
inline

Definition at line 197 of file StatsInfo.hpp.

197 { _genStep = genStep; }

◆ setHMax()

void StatsInfo::setHMax ( const Double  hMax)
inline

Definition at line 171 of file StatsInfo.hpp.

171 { _hMax = hMax; }

◆ setInfBBE()

void StatsInfo::setInfBBE ( const size_t  infBBE)
inline

Definition at line 174 of file StatsInfo.hpp.

174 { _infBBE = infBBE; }

◆ setIterNum()

void StatsInfo::setIterNum ( const size_t  iterNum)
inline

Definition at line 184 of file StatsInfo.hpp.

184 { _iterNum = iterNum; }

◆ setLap()

void StatsInfo::setLap ( const size_t  lap)
inline

Definition at line 189 of file StatsInfo.hpp.

189 { _lap = lap; }

◆ setMeshIndex()

void StatsInfo::setMeshIndex ( const ArrayOfDouble  meshIndex)
inline

Definition at line 186 of file StatsInfo.hpp.

186 { _meshIndex = meshIndex; }

◆ setMeshSize()

void StatsInfo::setMeshSize ( const ArrayOfDouble  meshSize)
inline

Definition at line 187 of file StatsInfo.hpp.

187 { _meshSize = meshSize; }

◆ setNbRelativeSuccess()

void StatsInfo::setNbRelativeSuccess ( const size_t  nbRelSuccess)
inline

Definition at line 180 of file StatsInfo.hpp.

180 { _nbRelativeSuccess = nbRelSuccess; }

◆ setObj()

void StatsInfo::setObj ( const Double obj)
inline

Definition at line 169 of file StatsInfo.hpp.

169 { _obj = obj; }

◆ setPhaseOneSuccess()

void StatsInfo::setPhaseOneSuccess ( const size_t  phaseOneSuccess)
inline

Definition at line 181 of file StatsInfo.hpp.

181 { _PhaseOneSuccess = phaseOneSuccess; }

◆ setRelativeSuccess()

void StatsInfo::setRelativeSuccess ( bool  relativeSuccess)
inline

Definition at line 195 of file StatsInfo.hpp.

195 { _relativeSuccess = relativeSuccess; }

◆ setSgte()

void StatsInfo::setSgte ( const size_t  sgte)
inline

Definition at line 190 of file StatsInfo.hpp.

190 { _sgte = sgte; }

◆ setSol()

void StatsInfo::setSol ( const Point  sol)
inline

Definition at line 192 of file StatsInfo.hpp.

192 { _sol = sol; }

◆ setSuccessType()

void StatsInfo::setSuccessType ( const SuccessType success)
inline

Definition at line 198 of file StatsInfo.hpp.

198 { _success = success; }

◆ setThreadAlgo()

void StatsInfo::setThreadAlgo ( const int  threadAlgoNum)
inline

Definition at line 193 of file StatsInfo.hpp.

193 { _threadAlgoNum = threadAlgoNum; }

◆ setThreadNum()

void StatsInfo::setThreadNum ( const int  threadNum)
inline

Definition at line 194 of file StatsInfo.hpp.

194 { _threadNum = threadNum; }

◆ setTime()

void StatsInfo::setTime ( const size_t  time)
inline

Definition at line 185 of file StatsInfo.hpp.

185 { _time = time; }

◆ setTotalSgte()

void StatsInfo::setTotalSgte ( const size_t  totalSgte)
inline

Definition at line 191 of file StatsInfo.hpp.

191 { _totalSgte = totalSgte; }

◆ stringToDisplayStatsType()

static DisplayStatsType StatsInfo::stringToDisplayStatsType ( const std::string &  inputString,
std::string &  format 
)
static

Member Data Documentation

◆ _algoBBE

size_t StatsInfo::_algoBBE
private

Definition at line 131 of file StatsInfo.hpp.

◆ _bbe

size_t StatsInfo::_bbe
private

Definition at line 126 of file StatsInfo.hpp.

◆ _bbo

std::string StatsInfo::_bbo
private

Definition at line 134 of file StatsInfo.hpp.

◆ _blkEva

size_t StatsInfo::_blkEva
private

Definition at line 132 of file StatsInfo.hpp.

◆ _blkSize

size_t StatsInfo::_blkSize
private

Definition at line 133 of file StatsInfo.hpp.

◆ _cacheHits

size_t StatsInfo::_cacheHits
private

Definition at line 136 of file StatsInfo.hpp.

◆ _cacheSize

size_t StatsInfo::_cacheSize
private

Definition at line 137 of file StatsInfo.hpp.

◆ _comment

std::string StatsInfo::_comment
private

Used for priting star, or when DISPLAY_ALL_EVAL is false.

Definition at line 150 of file StatsInfo.hpp.

◆ _consH

Double StatsInfo::_consH
private

Definition at line 124 of file StatsInfo.hpp.

◆ _eval

size_t StatsInfo::_eval
private

Definition at line 135 of file StatsInfo.hpp.

◆ _feasBBE

size_t StatsInfo::_feasBBE
private

Definition at line 127 of file StatsInfo.hpp.

◆ _frameSize

ArrayOfDouble StatsInfo::_frameSize
private

Definition at line 142 of file StatsInfo.hpp.

◆ _genStep

std::string StatsInfo::_genStep
private

General comment, ex. Algorithm from where this point was generated.

Definition at line 151 of file StatsInfo.hpp.

◆ _hMax

Double StatsInfo::_hMax
private

Definition at line 125 of file StatsInfo.hpp.

◆ _infBBE

size_t StatsInfo::_infBBE
private

Definition at line 128 of file StatsInfo.hpp.

◆ _iterNum

size_t StatsInfo::_iterNum
private

Definition at line 138 of file StatsInfo.hpp.

◆ _lap

size_t StatsInfo::_lap
private

Definition at line 143 of file StatsInfo.hpp.

◆ _meshIndex

ArrayOfDouble StatsInfo::_meshIndex
private

Definition at line 140 of file StatsInfo.hpp.

◆ _meshSize

ArrayOfDouble StatsInfo::_meshSize
private

Definition at line 141 of file StatsInfo.hpp.

◆ _nbRelativeSuccess

size_t StatsInfo::_nbRelativeSuccess
private

Definition at line 129 of file StatsInfo.hpp.

◆ _obj

Double StatsInfo::_obj
private

Definition at line 123 of file StatsInfo.hpp.

◆ _PhaseOneSuccess

size_t StatsInfo::_PhaseOneSuccess
private

Definition at line 130 of file StatsInfo.hpp.

◆ _relativeSuccess

bool StatsInfo::_relativeSuccess
private

Definition at line 149 of file StatsInfo.hpp.

◆ _sgte

size_t StatsInfo::_sgte
private

Definition at line 144 of file StatsInfo.hpp.

◆ _sol

Point StatsInfo::_sol
private

Definition at line 146 of file StatsInfo.hpp.

◆ _success

SuccessType StatsInfo::_success
private

Step in which this point was generated

Definition at line 152 of file StatsInfo.hpp.

◆ _threadAlgoNum

int StatsInfo::_threadAlgoNum
private

Definition at line 147 of file StatsInfo.hpp.

◆ _threadNum

int StatsInfo::_threadNum
private

Definition at line 148 of file StatsInfo.hpp.

◆ _time

size_t StatsInfo::_time
private

Definition at line 139 of file StatsInfo.hpp.

◆ _totalSgte

size_t StatsInfo::_totalSgte
private

Definition at line 145 of file StatsInfo.hpp.


The documentation for this class was generated from the following file:
StatsInfo::_cacheSize
size_t _cacheSize
Definition: StatsInfo.hpp:137
StatsInfo::_meshSize
ArrayOfDouble _meshSize
Definition: StatsInfo.hpp:141
StatsInfo::_obj
Double _obj
Definition: StatsInfo.hpp:123
StatsInfo::_comment
std::string _comment
Used for priting star, or when DISPLAY_ALL_EVAL is false.
Definition: StatsInfo.hpp:150
StatsInfo::_blkSize
size_t _blkSize
Definition: StatsInfo.hpp:133
StatsInfo::_threadAlgoNum
int _threadAlgoNum
Definition: StatsInfo.hpp:147
StatsInfo::_relativeSuccess
bool _relativeSuccess
Definition: StatsInfo.hpp:149
StatsInfo::_time
size_t _time
Definition: StatsInfo.hpp:139
StatsInfo::_genStep
std::string _genStep
General comment, ex. Algorithm from where this point was generated.
Definition: StatsInfo.hpp:151
StatsInfo::_bbo
std::string _bbo
Definition: StatsInfo.hpp:134
StatsInfo::_iterNum
size_t _iterNum
Definition: StatsInfo.hpp:138
StatsInfo::_feasBBE
size_t _feasBBE
Definition: StatsInfo.hpp:127
StatsInfo::_bbe
size_t _bbe
Definition: StatsInfo.hpp:126
StatsInfo::_sol
Point _sol
Definition: StatsInfo.hpp:146
StatsInfo::_infBBE
size_t _infBBE
Definition: StatsInfo.hpp:128
StatsInfo::_nbRelativeSuccess
size_t _nbRelativeSuccess
Definition: StatsInfo.hpp:129
StatsInfo::_cacheHits
size_t _cacheHits
Definition: StatsInfo.hpp:136
StatsInfo::_frameSize
ArrayOfDouble _frameSize
Definition: StatsInfo.hpp:142
StatsInfo::_sgte
size_t _sgte
Definition: StatsInfo.hpp:144
StatsInfo::_algoBBE
size_t _algoBBE
Definition: StatsInfo.hpp:131
StatsInfo::_totalSgte
size_t _totalSgte
Definition: StatsInfo.hpp:145
StatsInfo::_hMax
Double _hMax
Definition: StatsInfo.hpp:125
StatsInfo::_lap
size_t _lap
Definition: StatsInfo.hpp:143
StatsInfo::_PhaseOneSuccess
size_t _PhaseOneSuccess
Definition: StatsInfo.hpp:130
StatsInfo::_success
SuccessType _success
Step in which this point was generated
Definition: StatsInfo.hpp:152
StatsInfo::_blkEva
size_t _blkEva
Definition: StatsInfo.hpp:132
StatsInfo::_eval
size_t _eval
Definition: StatsInfo.hpp:135
StatsInfo::_meshIndex
ArrayOfDouble _meshIndex
Definition: StatsInfo.hpp:140
StatsInfo::_consH
Double _consH
Definition: StatsInfo.hpp:124
StatsInfo::_threadNum
int _threadNum
Definition: StatsInfo.hpp:148