Optimization functions are used exclusively from Optimization Algorithm scripts in order to control their execution.


Read more: Optimization Algorithm Scripts


Sections


Functions

Function Details


Functions


Name

Description

int OptimizationParameterCount()

Gets the number of parameters in each optimization vector.

double OptimizationParameterHigh(int)

Gets the high value of the parameter at a specified parameter index.

double OptimizationParameterLow(int)

Gets the low value of the parameter at a specified parameter index.

double OptimizationParameterStep(int)

Gets the step value of the parameter at a specified parameter index.

int OptimizationProcessedVectorsCount()

Gets the number of processed vectors.

int OptimizationProcessorCount()

Gets the number of processors available.

OptimizationSetSortValue(int, double)

Sets a sort value for a specified vector.

int[] OptimizationSortVectors()

Sorts the optimization vectors in ascending order and returns the sorted vectors indexes. (Sorting is done using the values set by the OptimizationSetSortValue function)

int OptimizationVectorCount()

Gets the number of optimization vectors.

bool OptimizationVectorIsProcessed(int)

Determines whether a specified optimization vector has been processed.

double OptimizationVectorScore(int)

Gets the score of a specified optimization vector.

double[] OptimizationVectorValues(int)

Gets the parameter values of a specified optimization vector.


Function Details


int OptimizationParameterCount()

Gets the number of parameters in each optimization vector.


Returns


The number of parameters in each optimization vector.


Scripts


OptimizationAlgorithm


double OptimizationParameterHigh(int parameterIndex)

Gets the high value of the parameter at a specified parameter index.


Returns


The high value of the parameter at the specified parameter index.


Parameters


Type

Identifier

Description

int

parameterIndex

The parameter index


Scripts


OptimizationAlgorithm


double OptimizationParameterLow(int parameterIndex)

Gets the low value of the parameter at a specified parameter index.


Returns


The low value of the parameter at the specified parameter index.


Parameters


Type

Identifier

Description

int

parameterIndex

The parameter index


Scripts


OptimizationAlgorithm


double OptimizationParameterStep(int parameterIndex)

Gets the step value of the parameter at a specified parameter index.


Returns


The step value of the parameter at the specified parameter index.


Parameters


Type

Identifier

Description

int

parameterIndex

The parameter index


Scripts


OptimizationAlgorithm


int OptimizationProcessedVectorsCount()

Gets the number of processed vectors.


Returns


The number of processed vectors.


Scripts


OptimizationAlgorithm


int OptimizationProcessorCount()

Gets the number of processors available.


Returns


The number of processors available.


Parameters


Type

Identifier

Description

TEXT

TEXT

TEXT


Scripts


OptimizationAlgorithm


OptimizationSetSortValue(int vectorIndex, double sortValue)

Sets a sort value for a specified vector.


Parameters


Type

Identifier

Description

int

vectorIndex

The vector index

double

sortValue

The sort value on which sorting will be done


Scripts


OptimizationAlgorithm


int[] OptimizationSortVectors()

Sorts the optimization vectors in ascending order and returns the sorted vectors indexes. (Sorting is done using the values set by the OptimizationSetSortValue function)


Returns


The vector indexes sorted by the sort value that was set for each vector.


Scripts


OptimizationAlgorithm


int OptimizationVectorCount()

Gets the number of optimization vectors.


Returns


The number of optimization vectors.


Scripts


OptimizationAlgorithm


bool OptimizationVectorIsProcessed(int vectorIndex)

Determines whether a specified optimization vector has been processed.


Returns


True if the specified optimization vector has been processed, false otherwise.


Parameters


Type

Identifier

Description

int

vectorIndex

The vector index


Scripts


OptimizationAlgorithm


double OptimizationVectorScore(int vectorIndex)

Gets the score of a specified optimization vector.


Returns


The score of the specified optimization vector.


Parameters


Type

Identifier

Description

int

vectorIndex

The vector index


Scripts


OptimizationAlgorithm


double[] OptimizationVectorValues(int vectorIndex)

Gets the parameter values of a specified optimization vector.


Returns


The parameter values of the specified optimization vector.


Parameters


Type

Identifier

Description

int

vectorIndex

The vector index


Scripts


OptimizationAlgorithm