summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-06-20 23:05:37 +0200
committerGitHub <[email protected]>2020-06-20 23:05:37 +0200
commit09b79d1dc6ec7188066232376eec0c561ec9bd91 (patch)
treebfa9f9e2f44564297ff8f4bba0f6145116e7d519
parentff299f2de10fc84f089c0e59bd1702ed4b75c87a (diff)
downloadSTC-modified-09b79d1dc6ec7188066232376eec0c561ec9bd91.tar.gz
STC-modified-09b79d1dc6ec7188066232376eec0c561ec9bd91.zip
Update README.md
-rw-r--r--README.md20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.md b/README.md
index 5221d4d8..b3d10d43 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,14 @@ STC - C99 Standard Container Library
Introduction
------------
-An elegant, modern, generic, customizable, typesafe, consistent, user-friendly, and very efficient standard container library for C99. This is a small headers only library with the most used container components:
-- **CString** - Compact and powerful string class
-- **CVector** - Dynamic generic vector class.
-- **CHash** - Unorderd map and set.
-- **CArray** - Multi-dimensional dynamic array
-- **CList** - A circular singly linked list, suited to be used as queue (supports pushBack, pushFront, and popFront).
+An elegant, modern, generic, customizable, typesafe, consistent, user-friendly, and very efficient standard container library for C99. This is a small headers only library with the most used container components, and a few algorithms:
+- **cstring.h** - Compact and powerful string class
+- **cvector.h** - Dynamic generic vector class.
+- **chash.h** - Unordered **map** and **set**.
+- **carray.h** - Multi-dimensional dynamic array
+- **clist.h** - A circular singly linked list, suited to be used as queue (supports pushBack, pushFront, and popFront).
+- **coption.h** - Header-only implementation of getopt_long-like function, to parse command line arguments.
+- **crandom.h** - Header-only collection of efficent modern random number generators **xoroshiro128ss**, **sfc32/64** and **Mersenne Twister**. It also implements the crypto-strong **siphash** algorithm.
The usage is quite similar to c++ standard containers, so it should be easy for those who are familiar with that.
@@ -38,11 +40,15 @@ declare_CHash(ii, map, int, int);
declare_CHash(64, set, int64_t);
...
```
+Performance
+-----------
+
+These are all very efficient containers as they have templated "intrusive" elements. The
Usage by examples
-----------------
-**CString** *demo*
+**CString** demo
```
#include <stc/cstring.h>