indigoX
IXLocalOptimisation::Settings Struct Reference

#include <indigox/algorithm/electron_assignment/local_optimisation.hpp>

Static Public Attributes

static utils::Option OPTIMISE_LEVEL
 Amount of optimisation to perform. More...
 
static uint32_t TIMEOUT
 Time limit for the optimisation, in milliseconds. More...
 
static utils::Option USE_CACHE
 Amount of cache to use. More...
 

Member Data Documentation

◆ OPTIMISE_LEVEL

utils::Option OPTIMISE_LEVEL
static

Amount of optimisation to perform.

At each round to optimisation, how many of the current minimum score assignments should be optimised down. Valis options are All, Some and Default. Default is equivalent to Some. With All, all of the minimum score assignments are optimised from. With Some, only the first minimum score assignment is optimised down.

◆ TIMEOUT

uint32_t TIMEOUT
static

Time limit for the optimisation, in milliseconds.

If the optimisation takes longer than this amount of time, it is halted and whatever the current minimum score is is set as the optimised score. If set to 0, no timeout is applied. Default value is

◆ USE_CACHE

utils::Option USE_CACHE
static

Amount of cache to use.

Cache the scores of seen assignments so that they do not need to be recalculated as they reoccur. Valid options are All, Some, None, and Default. Default is equivalent to Some. With All, all seen assignments are cached. With Some, only those assignments that are not infinite scores are cached. With None, no caching occurs.


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