sisl.mixing.History

class sisl.mixing.History(history: int = 2)

Bases: object

A history class for retaining a set of history elements

A history class may contain several different variables in a collections.deque list allowing easy managing of the length of the history.

history_max

maximum number of history elements

Type:

int or tuple of int

Parameters:

history (int, optional) – number of maximum history elements stored

Methods

append(*variables)	Add variables to the history
clear([index])	Clear variables to the history

Attributes

elements	Number of elements in the history
max_elements	Maximum number of elements stored in the history for each variable

append(*variables: Any) → None

Add variables to the history

Internally, the list of variables will be added to the queue, it is up to the implementation to use the appended values.

Parameters:

*variables – each variable will be added to the history of the mixer

clear(index: int | Sequence[int] | None = None) → None

Clear variables to the history

Parameters:

index – which indices of the history we should clear

property elements: int

Number of elements in the history

property max_elements: int

Maximum number of elements stored in the history for each variable