firecrown.updatable

firecrown.updatable#

Parameters that can be updated, and collections of them.

Abstract class Updatable is the base class from which any class in Firecrown that supports updating from a ParamsMap should inherit. Such classes are expected to change state only in through their implementation of _update() (including any other private methods used to implement _update()). Other functions should not change the data of Updatable objects.

UpdatableCollection is a subclass of the built-in list. It implements the Updatable interface by calling update() on each element it contains. The append() method is overridden to make sure that only objects which are of a type that implements Updatable can be appended to the list.

Classes

Updatable

Abstract class Updatable is the base class for Updatable objects in Firecrown.

UpdatableCollection

Class that represents a collection of updatable objects.

Exceptions

MissingSamplerParameterError(parameter)

Error for when a required parameter is missing.