Sha256: b400c17d0353605878caeadf9b341c6899422798d5c554e31d93d19013441bb0

Contents?: true

Size: 1.89 KB

Versions: 53

Compression:

Stored size: 1.89 KB

Contents

# Circular Buffer

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:

    [6][7][8][9][3][4][5]

When the buffer is full an error will be raised, alerting the client
that further writes are blocked until a slot becomes free.

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:

    [6][7][8][9][A][B][5]

Finally, if two elements are now removed then what would be returned is
not 3 & 4 but 5 & 6 because A & B overwrote the 3 & the 4 yielding the
buffer with:

    [ ][7][8][9][A][B][ ]

## Running the tests

To run the tests, run the command `busted .` from within the exercise directory.

## Further information

For more detailed information about the Lua track, including how to get help if
you're having trouble, please visit the exercism.io [Lua language page](http://exercism.io/languages/lua/about).

## Source

Wikipedia [http://en.wikipedia.org/wiki/Circular_buffer](http://en.wikipedia.org/wiki/Circular_buffer)

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

Version data entries

53 entries across 53 versions & 1 rubygems

Version Path
trackler-2.2.1.7 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.6 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.5 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.4 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.3 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.2 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.1 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.1.0 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.0.6 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.0.5 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.0.4 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.0.3 tracks/lua/exercises/circular-buffer/README.md
trackler-2.2.0.2 tracks/lua/exercises/circular-buffer/README.md