ucw/doc/index.txt

   1 UCW libraries
   2 =============
   3
   4 The UCW libraries aim to provide some general purpose tools for C
   5 programming language. It contains faster implementations of some
   6 algorithms found in libc (for example, sorting), few commonly used not
   7 available in libc (sha1 hash), several generic data structures (hash
   8 tables, binomial heap) and some less common tools (memory pools).
   9
  10 It is probable you may save yourself some time by using this library.
  11
  12 Please note this documentation is not yet complete. There are lot of
  13 modules not yet described, look into the source code.
  14
  15 You can see list of <<def_index:,definitions>>.
  16
  17 Modules
  18 -------
  19 - <<fastbuf:,Fastbufs>>
  20 - <<basecode:,Base64 and Base224 encoding>>
  21 - <<hash:,Hashing routines>>
  22 - <<conf:,Configuration and command line parser>>
  23 - <<mempool:,Memory pools>>
  24 - <<mainloop:,Mainloop>>
  25
  26 Yet undocumented modules
  27 ------------------------
  28 - Sorting
  29   * `arraysort.h`
  30   * `sorter/`
  31 - Growing buffers
  32   * `gbuf.h`
  33   * `bbuf.h`
  34 - Heaps
  35   * `binheap.h`
  36   * `binheap-node.h`
  37   * `heap.h`
  38 - Binary search
  39   * `binsearch.h`
  40 - Bit manipulation
  41   * `bitarray.h`
  42   * `bitopts.h`
  43   * `bitsig.h`
  44 - Character manipulation
  45   * `char-map.h`
  46   * `chartype.h`
  47   * `unicode.h`
  48 - Link lists
  49   * `clists.h`
  50   * `simple-lists.h`
  51   * `slists.h`
  52 - Fixed-sized allocator
  53   * `eltpool.h`
  54 - Hash tables
  55   * `hashtable.h`
  56 - IP address access lists
  57   * `ipaccess.h`
  58 - String manipulation
  59   * `kmp.h`
  60   * `kmp-search.h`
  61   * `regex.h`
  62   * `stkstring.h`
  63   * `string.h`
  64   * `str-match.h`
  65   * `wildmatch.h`
  66 - File manipulation
  67   * `asio.h`
  68   * `lfs.h`
  69   * `partmap.h`
  70 - Compression
  71   * `lizard.h`
  72 - Prefetching of memory
  73   * `prefetch.h`
  74 - Primes
  75   * `prime.h`
  76 - Profiling support
  77   * `profile.h`
  78 - Caches
  79   * `qache.h`
  80 - Red-black trees
  81   * `redblack.h`
  82 - Threads
  83   * `semaphore.h`
  84   * `threads.h`
  85   * `workqueue.h`
  86 - Trie
  87   * `trie.h`
  88 - Unaligned data
  89   * `unaligned.h`
  90 - URL manipulation
  91   * `url.h`
  92
  93 Other features
  94 --------------
  95 - <<docsys:,Documentation system>>