fixed-size-circular-array

Circular Array

Fixed size circular array datastructure

• How to use
  • circularIndex
  • CircularArray
    • Availlable properties
    • Availlable methods
• How to install
• License

This data structure give an fixed size array, who reuse slots by overwriting existing items and allow to move first and last indexes

How to use

circularIndex

Function who returns the bounded index

./src/circularIndex.mjs

./browser/circularIndex.js

const boundedindex = circularIndex.circularIndex(index, length)

CircularArray

./src/CircularArray.mjs

./browser/CircularArray.js

const array = ['zero', 'one', 'two', 'three', 'four']
const circularArray = CircularArray.CircularArray.fromArray(array)

circularArray.firstIndex = 2

circularArray.getItem(3) // 'zero'

circularArray.selectPrevious() // first index is now set to 1 and last index to 0

circularArray.getItem(3) // 'four'

Availlable properties

• firstIndex
• firstItem
• lastIndex
• lastItem

Availlable methods

• static fromArray(array)
• indexToVirtualIndex(index)
• getItem(index)
• setItem(index, value)
• selectPrevious()
• selectNext()

Overwritten methods:

• unshift(...itemList)
• push(...itemList)
• shift()
• pop()

And all methods of Array.prototype with untested result

How to install

With Yarn

yarn add fixed-size-circular-array

or with NPM

npm install --save fixed-size-circular-array

License

MIT