PlasmaCalcs.tools.iterables.Partition

class PlasmaCalcs.tools.iterables.Partition(original, f, *, keys=[])

Bases: DictlikeFromKeysAndGetitem

(ordered) dict of lists partitioned by category.
(assumes python >= 3.7, i.e. dict order is guaranteed to be insertion order)
self assumes it will remain unchanged after originally being created.
self.partition stores {key: list of elements in category}
self.idx stores {key: list of indices of elements in original}
self.flat stores all elements in category order, in a single list.
self.idx_flat concatenates self.idx.values().
self.ridx stores {key: [i such that self.flat[i] == x for x in this category]}
self.ridx_flat stores [i such that self.flat[i] == x for x in original]
iterating through self yields (key, value) pairs.
original: list-like
the original iterable, to be partitioned.
f: callable
maps original elements to category keys. categories must be hashable.
Will call f(x) for x in original, to determine categories.
keys: ordered list of categories
use these as known categories if provided.
__init__(original, f, *, keys=[])

Methods

__init__(original, f, *[, keys])

get(key[, default])

init_all()

init_flat()

init_partition()

init_ridx()

items()

keys()

values()

get(key, default=UNSET)
return self[key]. if default is provided and self[key] doesn’t exist, return default.
init_all()
init all the things, based on self.original, self.f, and self._init_keys
init_flat()
create self.flat and self.idx_flat.
self.flat stores all elements in order of categories, in a single list.
self.idx_flat stores the indices of all elements in self.flat.
init_partition()
creates self.partition and self.idx
init_ridx()
create self.ridx and self.ridx_flat.
self.ridx stores {key: [i such that self.flat[i] == x for x in this category]}
self.ridx_flat stores [i such that self.flat[i] == x for x in original]
items()
return tuple of (key, value) pairs corresponding to self.keys() and self.values().
keys()
return tuple of keys in self.
values()
return tuple of values corresponding to self.keys().