sisl.mixing.History

class sisl.mixing.History(history=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(*args)

Add variables to the history

clear([index])

Clear variables to the history

elements

Number of elements in the history

max_elements

Maximum number of elements stored in the history for each variable
__init__(history=2)[source]
append(*args)[source]

Add variables to the history

Parameters

*args (tuple of object) – each variable will be added to the history of the mixer

clear(index=None)[source]

Clear variables to the history

Parameters

index (int or array_like of int) – which indices of the history we should clear

property elements

Number of elements in the history

property max_elements

Maximum number of elements stored in the history for each variable