josiann.Result

class josiann.Result(message, success, trace, parameters)[source]

Object for storing the results of a run.

Parameters:

  • message (str) – the exit message.

  • success (bool) – boolean indicating if the SA algorithm did converge to a solution.

  • trace (Trace) – a Trace object with the history of the run.

  • parameters (SAParameters) – parameters used to run the SA algorithm.

Method generated by attrs for class Result.

Attributes

Result.message

the exit message.

Result.success

boolean indicating if the SA algorithm did converge to a solution.

Result.trace

a Trace object with the history of the run.

Result.parameters

parameters used to run the SA algorithm.

Result.best

Get the best position vector (with the lowest cost, among all walkers).

Methods

Result.__init__

Method generated by attrs for class Result.

Attributes

Result.message: str

the exit message.

Result.success: bool

boolean indicating if the SA algorithm did converge to a solution.

Result.trace: Trace

a Trace object with the history of the run.

Result.parameters: SAParameters

parameters used to run the SA algorithm.

Result.best

Get the best position vector (with the lowest cost, among all walkers).

Methods

Result.__init__(message, success, trace, parameters)

Method generated by attrs for class Result.

Parameters:

  • message (str) –

  • success (bool) –

  • trace (Trace) –

  • parameters (SAParameters) –

Return type:

None