Class: TreeSet

• Inheritance
• Description
• Class protocol
  • instance creation
• Instance protocol
  • initialize-release
  • plugs
  • private
  • public
  • testing

Inheritance:

   Object
   |
   +--Collection
      |
      +--TreeSet

Package:

stx:libbasic2

Category:

Collections-Ordered-Trees

Version:

rev: 1.8 date: 2024/01/22 14:44:58

user: cg

file: TreeSet.st directory: libbasic2

module: stx stc-classLibrary: libbasic2

Author:

Avi Bryant

Description:

BTree and TSTree

A bunch of collection classes that are useful for building large indices of things.
It's especially geared towards people using OODBs like GOODS, but can be used it in the image too:
the BTree class is great for when you need to select numeric keys by range,
and TSTree makes a solid basis for full-text search.
TreeSet has an interesting optimized #intersection: that lets you compare two collections without
looking at every item of either.
I'm also going to be rolling some code in here from Benjamin Pollack specifically aimed at indexing
by date ranges, which lets you do quick queries of all the events that overlap with a specific week,
for instance.


[license:]
    Dual licensed under both SqueakL and MIT.
    This enables both base Squeak inclusion and 100% reuse.

Class protocol:

 keys: aBtreeKeys sortSelector: aSymbol

 new

(comment from inherited method)
return an instance of myself without indexed variables

 sortBy: aSymbol

Instance protocol:

 initializeWithKeys: aBtreeKeys sortSelector: aSymbol

Modified (format): / 22-01-2024 / 15:36:49 / cg

 keyForValue: anObject

 value: anObject matches: otherObject

 bucket: anArray includes: anObject

 tree

 add: anObject

Modified (format): / 22-01-2024 / 15:36:40 / cg

 do: aBlock

(comment from inherited method)
evaluate the argument, aBlock for each element.
Return the receiver
(subclasses should care to also return the receiver,
in case do: is used in a chain of messages.)

 includes: anObject

Modified (format): / 22-01-2024 / 15:36:43 / cg

 intersect: aCollection

(comment from inherited method)
return a new set containing all elements of the receiver,
which are also contained in the argument collection.
For large collections you better use a Set for aCollection

 remove: anObject

remove all occurrences of anObject
Warning:
This is inconsistent with the inherited collection>>remove:,
which only remove the first occurrence.
Should this be fixed?

 sortSelector

 isFixedSize

return true if the receiver cannot grow