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
  30 Other features
  31 --------------
  32 - <<configure:,Compile time configuration>>
  33 - <<config:,Configuration file syntax>>
  34 - <<docsys:,Documentation system>>
  35 - <<generic:,Macro-generated generics>>
  36
  37 Yet undocumented modules
  38 ------------------------
  39 - Sorting
  40   * `sorter/`
  41 - Binary search
  42   * `binsearch.h`
  43 - Primes
  44   * `prime.h`
  45 - Heaps
  46   * `binheap.h`
  47   * `binheap-node.h`
  48   * `heap.h`
  49 - Hash tables
  50   * `hashtable.h`
  51 - Trie
  52   * `trie.h`
  53 - Red-black trees
  54   * `redblack.h`
  55 - Bit manipulation
  56   * `bitarray.h`
  57   * `bitopts.h`
  58   * `bitsig.h`
  59 - String manipulation
  60   * `kmp.h`
  61   * `kmp-search.h`
  62   * `regex.h`
  63   * `stkstring.h`
  64   * `string.h`
  65   * `str-match.h`
  66   * `wildmatch.h`
  67 - File manipulation
  68   * `asio.h`
  69   * `lfs.h`
  70   * `partmap.h`
  71 - Address manipulation
  72   * `url.h`
  73   * `ipaccess.h`
  74 - Fixed-sized allocator
  75   * `eltpool.h`
  76 - Prefetching of memory
  77   * `prefetch.h`
  78 - Compression
  79   * `lizard.h`
  80 - Caches
  81   * `qache.h`
  82 - Threads
  83   * `semaphore.h`
  84   * `threads.h`
  85   * `workqueue.h`
  86 - Profiling support
  87   * `profile.h`
  88
  89 License
  90 -------
  91 The UCW library is copyrighted by its authors:
  92
  93 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  94 - Martin Mareš <mailto:mj\@ucw.cz[]>
  95 - Robert Špalek <mailto:robert\@ucw.cz[]>
  96 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  97
  98 It can be freely distributed and used according to the terms of
  99 the GNU Lesser General Public License.