Class MF_memo

The model-free memo class.

Not quite a momento so a memo.

Instance Methods

__init__(self, model_free=None, model_type=None, spin=None, sim_index=None, scaling=None, scaling_matrix=None)
Initialise the model-free memo class.

Inherited from multi.memo.Memo: memo_id

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

Inherited from object: __class__

Method Details

__init__(self, model_free=None, model_type=None, spin=None, sim_index=None, scaling=None, scaling_matrix=None)
(Constructor)

Initialise the model-free memo class.

This memo stores the model-free class instance so that the _disassemble_result() method can be called to store the optimisation results. The other args are those required by this method but not generated through optimisation.

Parameters:

• model_free (specific_fns.model_free.Model_free instance) - The model-free class instance.
• spin (SpinContainer instance) - The spin data container. If this argument is supplied, then the spin_id argument will be ignored.
• sim_index (int) - The optional MC simulation index.
• scaling (bool) - If True, diagonal scaling is enabled.
• scaling_matrix (numpy diagonal matrix) - The diagonal, square scaling matrix.

Overrides: object.__init__