X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.collectionz.rst;h=0b0123797f7cfa159ea5b0f58aebed67830a3347;hb=6e7ee87b17b87abb3b598d39da6b4eed2c8e7697;hp=e0632afdbc3be35fc16657532065ed07646b57f4;hpb=84f53cd94d18a8d239216704a6a33c7dbf2fc6b9;p=pyutils.git diff --git a/docs/pyutils.collectionz.rst b/docs/pyutils.collectionz.rst index e0632af..0b01237 100644 --- a/docs/pyutils.collectionz.rst +++ b/docs/pyutils.collectionz.rst @@ -1,18 +1,18 @@ pyutils.collectionz package =========================== +This subpackage contains some homegrown collections that try to emulate +:mod:`collections` included in the Python standard library. It ends +with a 'z' so as not to collide with the standard library package. + Submodules ---------- pyutils.collectionz.bidict module --------------------------------- -The bidict.BiDict class is a bidirectional dictionary. It maps each -key to a value in constant time and each value back to the one or more -keys it is associated with in constant time. It does this by simply -storing the data twice. - .. automodule:: pyutils.collectionz.bidict + :imported-members: :members: :undoc-members: :show-inheritance: @@ -20,8 +20,6 @@ storing the data twice. pyutils.collectionz.bst module ------------------------------ -The bst.BinarySearchTree class is a binary search tree container. - .. automodule:: pyutils.collectionz.bst :members: :undoc-members: @@ -46,13 +44,6 @@ size. pyutils.collectionz.trie module ------------------------------- -The trie.Trie class is a Trie or prefix tree. It can be used with -arbitrary sequences as keys and stores its values in a tree with paths -determined by the sequence determined by each key. Thus, it can -determine whether a value is contained in the tree via a simple -traversal in linear time and can also check whether a key-prefix is -present in the tree in linear time. - .. automodule:: pyutils.collectionz.trie :members: :undoc-members: