The SUMO toolbox  2018a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
TimeMeasure Class Reference

Measure based on the current time. More...

Inheritance diagram for TimeMeasure:
Inheritance graph
[legend]

Public Member Functions

function TimeMeasure (var varargin)
 
function calculateMeasure (var model, var context, var outputIndex)
 Calculates the measure. More...
 
function setErrorFcn (var efun)
 Sets the error function to use. More...
 
function getErrorFcn ()
 Returns the used error function. More...
 
function getFinalTarget ()
 Returns the target (goal) accuracy. More...
 
function getParallelMode ()
 Returns whether we are using parallel computing. More...
 
function getWeight ()
 Returns vector of weights. More...
 
function isEnabled ()
 Returns whether this measures is being used. More...
 
function getTarget ()
 Returns the target (goal) accuracy. More...
 
function processMeasure (var model, var context, var outputIndex)
 Wrapper that calls calculateMeasure. More...
 

Detailed Description

Measure based on the current time.

This measure makes certain that the last model built is always the best model. Usually target is irrelevant and set to -Inf for this measure. The errorFcn attribute is not used at all.

Constructor & Destructor Documentation

function TimeMeasure ( var  varargin)
inline

Member Function Documentation

function calculateMeasure ( var  model,
var  context,
var  outputIndex 
)

Calculates the measure.

Calculates (1 over) the amount of cputime since the start of the toolbox.

Parameters
modelsurrogate model
contextstruct of contextual information (optional)
outputIndexfor which output to calculate the measure
Return values
newModelupdated surrogate model (may happen in some measures)
scorescore of the surrogate model

Only scores new surrogate models, already scored surrogate models retain their score!

function getErrorFcn ( )
inlineinherited

Returns the used error function.

function getFinalTarget ( )
inlineinherited

Returns the target (goal) accuracy.

function getParallelMode ( )
inlineinherited

Returns whether we are using parallel computing.

function getTarget ( )
inlineinherited

Returns the target (goal) accuracy.

function getWeight ( )
inlineinherited

Returns vector of weights.

function isEnabled ( )
inlineinherited

Returns whether this measures is being used.

function processMeasure ( var  model,
var  context,
var  outputIndex 
)
inherited

Wrapper that calls calculateMeasure.

This function calls calculateMeasure and replaces NaN/Inf Values.

Parameters
modelsurrogate model
contextstruct of contextual information (optional)
outputIndexfor which output to calculate the measure
Return values
scorescore of the surrogate model
function setErrorFcn ( var  efun)
inlineinherited

Sets the error function to use.


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