silentbob/silentbob-1.4.1/gclib/doc/API/hash.txt

   1 /*
   2  * (c) Oleg Puchinin 2006
   3  * graycardinalster@gmail.com
   4  *
   5  */
   6
   7 UTF8
   8
   9                 Хэши (DHash / EHash).
  10                 Общие функции.
  11
  12         get / set
  13 Получить / установить значение по ключу.
  14
  15         del
  16 Удалить ключ.
  17
  18         foreach
  19 Выполнить для каждого элемента.
  20
  21         from_file
  22 Прочитать хэш из файла (стандартная конфигурационная разметка).
  23
  24                 Специфика реализаций
  25                 DHash
  26 Реализован как Два массива строк в памяти (ключ/значение).
  27
  28         get_keys / get_values
  29 Вернуть массив ключей / значений.
  30
  31         get_size
  32 Вернуть количество элементов в хэше (в том числе "пустых").
  33
  34                 EHash
  35 Наследует все методы класса EList. Реализован в виде списка с элементами
  36 ключ => значение. Имеет перегруженный оператор []. Получить значение : hash["ключ"]
  37
  38                 HV
  39 Пары ключ/значение упаковываются и сортируются. Осуществляется быстрый поиск по отсортированным ключам и
  40 простой - по новым.
  41
  42         EArray * sortedElements ()
  43 Вернет массив сортированых по ключу элементов.
  44
  45         EArray * dirtyElements ()
  46 Вернет массив несортированных элементов.
  47
  48         dkey_t * unpackItem (char *, dkey_t * data);
  49 Распакует один из элементов в структуру data. Память под структуру должна быть выделена.
  50
  51         int autoSort () / int setAutoSort (int N)
  52 Автоматически сортировать при N "грязных" элементов.
  53
  54         bool autoCheck () / bool setAutoCheck (bool B)
  55 Проверять наличие ключа при установке. Если не включено, то поумолчанию повторная установка ключа
  56 приводит к созданию новой записи (элемента). Использовать либо там, где нет повторяющихся ключей,
  57 либо совместно с autoSort. Параметр для setAutoSort рекомендуется задавать как 10% от N, где N -
  58 текущее количество элементов.
  59