SpiNNFrontEndCommon 7.3.1
Common support code for user-facing front end systems.
Loading...
Searching...
No Matches
Functions
minimise.h File Reference

API for routing table minimisation. More...

Go to the source code of this file.

Functions

bool minimise_run (int target_length, bool *failed_by_malloc, volatile bool *stop_compressing)
 Apply the ordered covering algorithm to a routing table.
 
bool standalone (void)
 Whether this is a standalone compressor.
 

Detailed Description

API for routing table minimisation.

Definition in file minimise.h.

Function Documentation

◆ minimise_run()

bool minimise_run ( int  target_length,
bool failed_by_malloc,
volatile bool stop_compressing 
)

Apply the ordered covering algorithm to a routing table.

Minimise the table until either the table is shorter than the target length or no more merges are possible.

Parameters
[in]target_lengthThe length to reach
[out]failed_by_mallocFlag stating that it failed due to malloc
[out]stop_compressingVariable saying if the compressor should stop and return false; set by interrupt DURING the run of this method!
Returns
Whether successful or not.

Apply the ordered covering algorithm to a routing table.

Parameters
[in]target_lengthignored
[out]failed_by_mallocNever changed but required by api
[in]stop_compressingVariable saying if the compressor should stop and return false; set by interrupt DURING the run of this method!
Returns
Whether minimisation succeeded

Definition at line 378 of file pair_minimize.h.

◆ standalone()

bool standalone ( void  )

Whether this is a standalone compressor.

Mainly used to change logging

Returns
Whether this is a standalone compressor
Always true

Definition at line 97 of file simple_compressor.c.