ucw/doc/index.txt

   1 The UCW library
   2 ===============
   3
   4 The UCW library aims to provide a set general purpose tools for programming
   5 in the C language. It contains generic data structures (lists, trees, hash
   6 tables etc.), fast memory allocators optimized for various usage patterns,
   7 abstract I/O streams and optimized implementations of some common algorithms
   8 (e.g., sorting of arrays and files).
   9
  10 Please note that this documentation is not yet complete. Many modules are
  11 not described, so you might need to look into the source code.
  12
  13 You can see the index of <<def_index:,documented definitions>>.
  14
  15 Modules
  16 -------
  17 - <<fastbuf:,Fastbufs>>
  18 - <<basecode:,Base64 and Base224 encoding>>
  19 - <<hash:,Hashing routines>>
  20 - <<conf:,Configuration and command line parser>>
  21 - <<mempool:,Memory pools>>
  22 - <<eltpool:,Fixed-sized allocators>>
  23 - <<mainloop:,Mainloop>>
  24 - <<unaligned:,Unaligned data>>
  25 - <<lists:,Link lists>>
  26 - <<growbuf:,Growing buffers>>
  27 - <<chartype:,Single-byte characters>>
  28 - <<unicode:,Multi-byte characters>>
  29 - <<prime:,Prime numbers>>
  30 - <<binsearch:,Binary search>>
  31 - <<heap:,Binary heaps>>
  32 - <<binheap:,Binomial heaps>>
  33 - <<compress:,Compression>>
  34
  35 Other features
  36 --------------
  37 - <<configure:,Compile time configuration>>
  38 - <<config:,Configuration file syntax>>
  39 - <<docsys:,Documentation system>>
  40 - <<generic:,Macro-generated generics>>
  41
  42 Yet undocumented modules
  43 ------------------------
  44 - Sorting
  45   * `sorter/`
  46 - Hash tables
  47   * `hashtable.h`
  48 - Trie
  49   * `trie.h`
  50 - Red-black trees
  51   * `redblack.h`
  52 - Bit manipulation
  53   * `bitarray.h`
  54   * `bitopts.h`
  55   * `bitsig.h`
  56 - String manipulation
  57   * `kmp.h`
  58   * `kmp-search.h`
  59   * `regex.h`
  60   * `stkstring.h`
  61   * `string.h`
  62   * `str-match.h`
  63   * `wildmatch.h`
  64 - File manipulation
  65   * `asio.h`
  66   * `lfs.h`
  67   * `partmap.h`
  68 - Address manipulation
  69   * `url.h`
  70   * `ipaccess.h`
  71 - Prefetching of memory
  72   * `prefetch.h`
  73 - Caches
  74   * `qache.h`
  75 - Threads
  76   * `semaphore.h`
  77   * `threads.h`
  78   * `workqueue.h`
  79 - Profiling support
  80   * `profile.h`
  81
  82 License
  83 -------
  84 The UCW library is copyrighted by its authors:
  85
  86 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  87 - Martin Mareš <mailto:mj\@ucw.cz[]>
  88 - Robert Špalek <mailto:robert\@ucw.cz[]>
  89 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  90
  91 It can be freely distributed and used according to the terms of
  92 the GNU Lesser General Public License.