[joss-reviews#2974] Checkpoints used inconsistently

[sjvrijn]

Related: openjournals/joss-reviews#2974 and #15

See e.g. the difference between

framework/moead_framework/algorithm/abstract_moead.py

Lines 103 to 104 in 659cb04

	if checkpoint is not None:
	checkpoint()

and

framework/moead_framework/algorithm/combinatorial/moead_dra.py

Lines 69 to 70 in 659cb04

	if checkpoint is not None:
	checkpoint(self.current_eval)

[sjvrijn]

Instead of the externally referenced version given in the tutorial section, it is probably better to have a checkpoint function always accept the MOEAD algorithm object as only argument. This would allow for a generic checkpoint function to be written without it being tied to a single MOEAD instance. I.e.

def checkpoint(moead_algorithm: AbstractMoead):
    ....  # perform checkpoint actions here

with the call then becoming

if checkpoint: 
    checkpoint(self)

A simple checkpoint function could then for example be added to the tools submodule as an example.

[geoffreyp]

The documentation and the code are updated in the PR #55 (commit 4717ec3)

[sjvrijn]

This issue can be closed when PR #55 is merged