https://github.com/hootanht/circular-buffer-exercism
https://github.com/hootanht/circular-buffer-exercism
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hootanht/circular-buffer-exercism
- Owner: hootanht
- Created: 2022-06-05T13:15:33.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-05T13:17:12.000Z (over 3 years ago)
- Last Synced: 2025-02-03T00:27:31.445Z (8 months ago)
- Language: C#
- Size: 4.88 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Circular Buffer
Welcome to Circular Buffer on Exercism's C# Track.
If you need help running the tests or submitting your code, check out `HELP.md`.
## Instructions
A circular buffer, cyclic buffer or ring buffer is a data structure that
uses a single, fixed-size buffer as if it were connected end-to-end.
A circular buffer first starts empty and of some predefined length. For
example, this is a 7-element buffer:
[ ][ ][ ][ ][ ][ ][ ]
Assume that a 1 is written into the middle of the buffer (exact starting
location does not matter in a circular buffer):
[ ][ ][ ][1][ ][ ][ ]
Then assume that two more elements are added — 2 & 3 — which get
appended after the 1:
[ ][ ][ ][1][2][3][ ]
If two elements are then removed from the buffer, the oldest values
inside the buffer are removed. The two elements removed, in this case,
are 1 & 2, leaving the buffer with just a 3:
[ ][ ][ ][ ][ ][3][ ]
If the buffer has 7 elements then it is completely full:
[5][6][7][8][9][3][4]
When the buffer is full an error will be raised, alerting the client
that further writes are blocked until a slot becomes free.
When the buffer is full, the client can opt to overwrite the oldest
data with a forced write. In this case, two more elements — A & B —
are added and they overwrite the 3 & 4:
[5][6][7][8][9][A][B]
3 & 4 have been replaced by A & B making 5 now the oldest data in the
buffer. Finally, if two elements are removed then what would be
returned is 5 & 6 yielding the buffer:
[ ][ ][7][8][9][A][B]
Because there is space available, if the client again uses overwrite
to store C & D then the space where 5 & 6 were stored previously will
be used not the location of 7 & 8. 7 is still the oldest element and
the buffer is once again full.
[C][D][7][8][9][A][B]
## Source
### Created by
- @ErikSchierboom
### Contributed to by
- @j2jensen
- @robkeim
- @wolf99
### Based on
Wikipedia - http://en.wikipedia.org/wiki/Circular_buffer