Home Reference Source Test Repository 
import AlgorithmResult from 'canvas-graph-creator/src/js/algorithm/algorithm-result.js'
public class | source

AlgorithmResult

Stores the results generated by running an Algorithm. An instance will be stored in each Algorithm object.

Test:

Constructor Summary

Public Constructor
public

constructor(nodeFields: Array<string>, edgeFields: Array<string>)

Constructs an instance of AlgorithmResult.

Member Summary

Public Members
public
public

Method Summary

Public Methods
public

addStep(step: Step)

Add a Step to the AlgorithmResult.
public

Move to the previous step in the timeline.
public

Move to the next step in the timeline.

Public Constructors

public constructor(nodeFields: Array<string>, edgeFields: Array<string>) source

Constructs an instance of AlgorithmResult.

Params:

NameTypeAttributeDescription
nodeFields Array<string>

Array of fields to store changes for in Node objects.
edgeFields Array<string>

Array of fields to store changes for in Edge objects.

Test:

Public Members

public stepIndex: * source

public timeline: * source

Public Methods

public addStep(step: Step) source

Add a Step to the AlgorithmResult.

Params:

NameTypeAttributeDescription
step Step

The step to add.

Test:

public stepBackward() source

Move to the previous step in the timeline. Does nothing if already at the beginning.

Test:

public stepForward() source

Move to the next step in the timeline. Does nothing if already at the end.

Test: