Skip to content

Commit

Permalink
small changes to README
Browse files Browse the repository at this point in the history
  • Loading branch information
BelimFaux committed Dec 29, 2024
1 parent f84ba9b commit 8ea2ecb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ It was originally written for the ADS-Course of University of Vienna.

## Setup

To try the Set out, a testprogram is provided (that is heavily influenced by a testprogram from the university course).
To run the Program, compile the file `eh_playground.cpp` using CMake and run it:
To try the Set out, you can use the provided playground program.
To run the Program, compile the file `eh_playground` using CMake and run it:

```bash
mkdir build && cd build
Expand All @@ -33,7 +33,7 @@ For more Information run
--help
```

## Interface
## Commands

The Program launches into a prompt, from there you have multiple commands to modify or inspect the set:

Expand Down Expand Up @@ -62,13 +62,13 @@ After executing commands that alter the set the set will be printed, if the Prog
If the Program isn't run nonverbose, after every change to the Set, it will be printed out (equivalent to running `p`).
The Format for printing is definde by the `dump()` method, and includes every directory, and the bucket that it points to (-> if its the only (or first) Directory pointing to that Bucket, or ~> followed by the first Directory, pointing to that Bucket else) as well as the Elements inside the Buckets and info like size, offset, local/global depth etc.

For example a Set like this:
For example a Set like this:

![https://media.geeksforgeeks.org/wp-content/uploads/20190803222615/hash73.png](https://media.geeksforgeeks.org/wp-content/uploads/20190803222615/hash73.png "Example")

might look like this:
Extendible Hashing <j,4>, d = 2, nD = 4, sz = 9
0 --> [l = 2, offset = 4, arrsz = 3 | 16 4 24 ]
1 --> [l = 1, offset = 2, arrsz = 3 | 31 7 9 ]
2 --> [l = 2, offset = 4, arrsz = 3 | 6 22 10 ]
3 ~~> 1 --> [l = 1, offset = 2, arrsz = 3 | 31 7 9 ]
3 ~~> 1 --> [l = 1, offset = 2, arrsz = 3 | 31 7 9 ]

0 comments on commit 8ea2ecb

Please sign in to comment.