andrew
/
Algorithms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

working on readme

This commit is contained in:
Andrew Lalis 2017-05-23 11:10:24 +02:00
parent 68a18e7cf3
commit cd87b4c76f
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -2,14 +2,11 @@
A handy collection of C algorithms compiled into one header file for use anywhere. Feel free to include this file with any C project, as long as you keep the comment at the top with a little copyright notice. A handy collection of C algorithms compiled into one header file for use anywhere. Feel free to include this file with any C project, as long as you keep the comment at the top with a little copyright notice.
##### Table of Contents ##### Table of Contents
[Stacks](#stack) [Stacks](#Stack)
## Functionality ## Stack
<a name="stack"/> ### Functions
### Stack
##### Functions
```c ```c
void new() void new()
void free(Stack *s) void free(Stack *s)
@ -18,7 +15,7 @@ item pop(Stack *s)
void print(Stack s) void print(Stack s)
``` ```
##### Description ### Description
The stack is probably the most basic storage structure, using the 'first-in, The stack is probably the most basic storage structure, using the 'first-in,
first-out' approach. To define a stack, the user must first know what type the stack first-out' approach. To define a stack, the user must first know what type the stack
is, either a primitive type, or a **struct**. To define a stack, you must first define is, either a primitive type, or a **struct**. To define a stack, you must first define
@ -31,7 +28,8 @@ the *handystack* header file.
To define more than one stack, **STACK_TYPE** must first be undefined. To define more than one stack, **STACK_TYPE** must first be undefined.
` #undef STACK_TYPE ` ` #undef STACK_TYPE `
Then you simply define the type, and include the header again. Do not try to define two of the same type, however, as that will give all sorts of nasty errors. Then you simply define the type, and include the header again. Do not try to define two of the same type, however, as that will give all sorts of nasty errors.
##### Example
### Example
The following example creates a stack of doubles, pushes 45.000 onto it, and prints the stack's characteristics. The following example creates a stack of doubles, pushes 45.000 onto it, and prints the stack's characteristics.
```c ```c
#define STACK_TYPE double #define STACK_TYPE double
@ -43,8 +41,9 @@ print_double_stack(myStack);
Notice that the function names are characteristic of the **STACK_TYPE** you've defined earlier? The functions have the following basic format: Notice that the function names are characteristic of the **STACK_TYPE** you've defined earlier? The functions have the following basic format:
``` FUNCTION_ + STACK_TYPE + _stack ``` ``` FUNCTION_ + STACK_TYPE + _stack ```
Where `FUNCTION` is the name of the function. Where `FUNCTION` is the name of the function.
### Queue
### Linked List ## Queue
### Heap (Priority Queue) ## Linked List
## Heap (Priority Queue)