summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-05-20 23:43:00 +0200
committerTyge Løvset <[email protected]>2021-05-20 23:43:00 +0200
commit28e5ceaad30cd9b68d6a4276bdc64ea1306f3776 (patch)
tree225e7eeedf7c58dee7db5e6d5a8235b644fa8ea2 /docs
parent188717d9c7ca04e7b0e63e48cea0c55e5db11f05 (diff)
downloadSTC-modified-28e5ceaad30cd9b68d6a4276bdc64ea1306f3776.tar.gz
STC-modified-28e5ceaad30cd9b68d6a4276bdc64ea1306f3776.zip
Updated links to header files in docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md2
-rw-r--r--docs/cbits_api.md2
-rw-r--r--docs/ccommon_api.md2
-rw-r--r--docs/cdeq_api.md2
-rw-r--r--docs/clist_api.md2
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/coption_api.md2
-rw-r--r--docs/cpque_api.md2
-rw-r--r--docs/cqueue_api.md2
-rw-r--r--docs/crandom_api.md2
-rw-r--r--docs/cset_api.md2
-rw-r--r--docs/csmap_api.md2
-rw-r--r--docs/csptr_api.md2
-rw-r--r--docs/csset_api.md2
-rw-r--r--docs/cstack_api.md2
-rw-r--r--docs/cstr_api.md2
-rw-r--r--docs/csview_api.md2
-rw-r--r--docs/cvec_api.md2
18 files changed, 18 insertions, 18 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 836726c2..e8ca7ffc 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -1,4 +1,4 @@
-# STC [carray](../stc/carray.h): Dynamic Multi-dimensional Array
+# STC [carray](../include/stc/carray.h): Dynamic Multi-dimensional Array
![Array](pics/array.jpg)
The **carray** containers provides templates for multidimensional arrays. It supports 2- and
diff --git a/docs/cbits_api.md b/docs/cbits_api.md
index 006ce52a..4d1c6bcf 100644
--- a/docs/cbits_api.md
+++ b/docs/cbits_api.md
@@ -1,4 +1,4 @@
-# STC [cbits](../stc/cbits.h): Bitset
+# STC [cbits](../include/stc/cbits.h): Bitset
![Bitset](pics/bitset.jpg)
A **cbits** represents a set of bits. It provides accesses to the value of individual bits via *cbits_test()* and provides the bitwise operators that one can apply to builtin integers. The number of bits in the set is specified at runtime via a parameter to the constructor *cbits_with_size()* or by *cbits_resize()*. A **cbits** bitset can be manipulated by standard logic operators and converted to and from strings.
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md
index bf79a757..916f9780 100644
--- a/docs/ccommon_api.md
+++ b/docs/ccommon_api.md
@@ -1,4 +1,4 @@
-# STC [ccommon](../stc/ccommon.h): Common definitions and handy macros
+# STC [ccommon](../include/stc/ccommon.h): Common definitions and handy macros
The following handy macros are safe to use, i.e. have no side-effects.
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 35fa8cb3..a6ff97c2 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -1,4 +1,4 @@
-# STC [cdeq](../stc/cdeq.h): Double Ended Queue
+# STC [cdeq](../include/stc/cdeq.h): Double Ended Queue
![Deque](pics/deque.jpg)
A **cdeq** is an indexed sequence container that allows fast insertion and deletion at both its beginning and its end. Note that this container is implemented similar to a vector, but has the same performance profile for both *push_back()* and *push_front()* as *cdeq_X_push_back()*. Iterators may be invalidated after push-operations.
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 86063dbf..3048fa35 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -1,4 +1,4 @@
-# STC [clist](../stc/clist.h): Forward List
+# STC [clist](../include/stc/clist.h): Forward List
![List](pics/list.jpg)
The **clist** container supports fast insertion and removal of elements from anywhere in the container.
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index bbc27e6d..20c90998 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -1,4 +1,4 @@
-# STC [cmap](../stc/cmap.h): Unordered Map
+# STC [cmap](../include/stc/cmap.h): Unordered Map
![Map](pics/map.jpg)
A **cmap** is an associative container that contains key-value pairs with unique keys. Search, insertion, and removal of elements
diff --git a/docs/coption_api.md b/docs/coption_api.md
index b205f449..f7c870bc 100644
--- a/docs/coption_api.md
+++ b/docs/coption_api.md
@@ -1,4 +1,4 @@
-# STC [coption](../stc/coption.h): Command line argument parsing
+# STC [coption](../include/stc/coption.h): Command line argument parsing
This describes the API of the *coption_get()* function for command line argument parsing.
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index 6f7917f5..eaa476c1 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -1,4 +1,4 @@
-# STC [cpque](../stc/cpque.h): Priority Queue
+# STC [cpque](../include/stc/cpque.h): Priority Queue
A priority queue is a container adaptor that provides constant time lookup of the largest (by default) element, at the expense of logarithmic insertion and extraction.
A user-provided argument `<`or `>` must be supplied to set the ordering, e.g. using `>` would cause the smallest element to appear as the top().
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index ab8c752b..8bd9f15e 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -1,4 +1,4 @@
-# STC [cqueue](../stc/cqueue.h): Queue
+# STC [cqueue](../include/stc/cqueue.h): Queue
![Queue](pics/queue.jpg)
The **cqueue** is container adapter that gives the programmer the functionality of a queue - specifically, a FIFO (first-in, first-out) data structure. The class template acts as a wrapper to the underlying container - only a specific set of functions is provided. The queue pushes the elements on the back of the underlying container and pops them from the front.
diff --git a/docs/crandom_api.md b/docs/crandom_api.md
index e7088381..a943f7ea 100644
--- a/docs/crandom_api.md
+++ b/docs/crandom_api.md
@@ -1,4 +1,4 @@
-# STC [crandom](../stc/crandom.h): Pseudo Random Number Generator
+# STC [crandom](../include/stc/crandom.h): Pseudo Random Number Generator
![Random](pics/random.jpg)
This features a *64-bit PRNG* named **stc64**, and can generate bounded uniform and normal
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 6c6e9951..31ff2ac6 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -1,4 +1,4 @@
-# STC [cset](../stc/cmap.h): Unordered Set
+# STC [cset](../include/stc/cmap.h): Unordered Set
![Set](pics/set.jpg)
A **cset** is an associative container that contains a set of unique objects of type Key. Search, insertion, and removal have average constant-time complexity. See the c++ class
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index f8fab7bc..b22e750a 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -1,4 +1,4 @@
-# STC [csmap](../stc/csmap.h): Sorted Map
+# STC [csmap](../include/stc/csmap.h): Sorted Map
![Map](pics/smap.jpg)
A **csmap** is a sorted associative container that contains key-value pairs with unique keys. Keys are sorted by
diff --git a/docs/csptr_api.md b/docs/csptr_api.md
index e1670bb2..0acc8b21 100644
--- a/docs/csptr_api.md
+++ b/docs/csptr_api.md
@@ -1,4 +1,4 @@
-# STC [csptr](../stc/csptr.h): Shared Pointers
+# STC [csptr](../include/stc/csptr.h): Shared Pointers
**csptr** is a smart pointer that retains shared ownership of an object through a pointer.
Several **csptr** objects may own the same object. The object is destroyed and its memory
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 9dd241f4..058ffd8e 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -1,4 +1,4 @@
-# STC [csset](../stc/csmap.h): Sorted Set
+# STC [csset](../include/stc/csmap.h): Sorted Set
![Set](pics/sset.jpg)
A **csset** is an associative container that contains a sorted set of unique objects of type *Key*. Sorting is done using the key comparison function *keyCompare*. Search, removal, and insertion operations have logarithmic complexity. **csset** is implemented as an AA-tree.
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 15975f30..3d9ecd4f 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -1,4 +1,4 @@
-# STC [cstack](../stc/cstack.h): Stack
+# STC [cstack](../include/stc/cstack.h): Stack
![Stack](pics/stack.jpg)
The **cstack** is a container adapter that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The class template acts as a wrapper to the underlying container - only a specific set of functions is provided. The stack pushes and pops the element from the back of the underlying container, known as the top of the stack.
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index 094f41e0..7bebbbfb 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -1,4 +1,4 @@
-# STC [cstr](../stc/cstr.h): String
+# STC [cstr](../include/stc/cstr.h): String
![String](pics/string.jpg)
A **cstr** object represent sequences of characters. It supports an interface similar to that of a standard container of bytes, but adding features specifically designed to operate with strings of single-byte characters, terminated by the null character.
diff --git a/docs/csview_api.md b/docs/csview_api.md
index e605c2bf..5c8eb9f8 100644
--- a/docs/csview_api.md
+++ b/docs/csview_api.md
@@ -1,4 +1,4 @@
-# STC [csview](../stc/csview.h): String View
+# STC [csview](../include/stc/csview.h): String View
![String](pics/string.jpg)
The type **csview** is a string view and can refer to a constant contiguous sequence of char-elements with the first
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index c6be988a..6c050c6c 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -1,4 +1,4 @@
-# STC [cvec](../stc/cvec.h): Vector
+# STC [cvec](../include/stc/cvec.h): Vector
![Vector](pics/vector.jpg)
A **cvec** is a sequence container that encapsulates dynamic size arrays.