Skip to content

Commit

Permalink
v1.0.9, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
erayd committed Sep 29, 2016
1 parent 83c9f94 commit cfacdd5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Spique - A Spiral Double-Ended Queue
====================================

Spique is a deque implemented as a doubly-linked list of circular buffers. This
structure allows for both high performance and unlimited dynamic growth of the
queue. All operations are O(1) (constant time).
Spique is an extremely fast deque implemented as a doubly-linked list of circular
buffers. This structure allows for both high performance and unlimited dynamic
growth of the queue. All operations are O(1) (constant time).

Spique does not require an initial or maximum size (although you can define a
maximum if you wish), and will both grow and shrink dynamically as items are
Expand Down Expand Up @@ -38,6 +38,16 @@ for(myValue of s) {
}
```

### A Note On Performance
The higher the number of items per ring, the faster Spique will run. In most cases,
this doesn't matter, and you can just use the default ring size - this is more than
fast enough for most scenarios, and any performance gain will be negligible.

However, if you are using Spique in a situation where it needs to handle a very high
flow rate (e.g. many millions of items per second), it's advisable to increase the
ring size accordingly. If it's not essential to wring every last possible scrap of
performance out of your hardware, this advice may be freely ignored.

### .push(), .enqueue()
```javascript
s.push(myValue...);
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "spique",
"version": "1.0.8",
"version": "1.0.9",
"description": "A spiral deque - high performance and dynamic queue size",
"main": "spique.js",
"scripts": {
Expand Down

0 comments on commit cfacdd5

Please sign in to comment.