docs: refine README.md badges

[poolifier.git] / src / circular-buffer.ts

diff --git a/src/circular-buffer.ts b/src/circular-buffer.ts
index bd59b25cd8377be9d54d183af8947f2244099a22..5015483b290055e1a78e961c248024625800b6d6 100644 (file)
--- a/src/circular-buffer.ts
+++ b/src/circular-buffer.ts
@@ -4,16 +4,15 @@
 export const defaultBufferSize = 2048
 
 /**
- * Circular buffer.
- *
- * @typeParam T - Type of buffer data.
+ * Circular buffer designed for positive numbers.
  * @internal
  */
-export class CircularBuffer<T> {
-  private readonly readIdx: number
+export class CircularBuffer {
+  private readIdx: number
   private writeIdx: number
-  private items: Array<T | undefined>
+  private readonly items: Float32Array
   private readonly maxArrayIdx: number
+  public size: number
 
   /**
    * @param size - Buffer size. @defaultValue defaultBufferSize
@@ -24,36 +23,75 @@ export class CircularBuffer<T> {
     this.readIdx = 0
     this.writeIdx = 0
     this.maxArrayIdx = size - 1
-    this.items = new Array<T | undefined>(size)
+    this.size = 0
+    this.items = new Float32Array(size).fill(-1)
   }
 
   /**
-   * Puts data into buffer.
-   *
-   * @param data - Data to put into buffer.
+   * Checks whether the buffer is empty.
+   * @returns Whether the buffer is empty.
    */
-  public put (data: T): void {
-    this.items[this.writeIdx] = data
+  public empty (): boolean {
+    return this.size === 0
+  }
+
+  /**
+   * Checks whether the buffer is full.
+   * @returns Whether the buffer is full.
+   */
+  public full (): boolean {
+    return this.size === this.items.length
+  }
+
+  /**
+   * Puts number into buffer.
+   * @param number - Number to put into buffer.
+   */
+  public put (number: number): void {
+    this.items[this.writeIdx] = number
     this.writeIdx = this.writeIdx === this.maxArrayIdx ? 0 : this.writeIdx + 1
+    if (this.size < this.items.length) {
+      ++this.size
+    }
   }
 
   /**
-   * Returns buffer as array.
-   *
-   * @returns Array of buffer data.
+   * Gets number from buffer.
+   * @returns Number from buffer.
    */
-  public toArray (): T[] {
-    return this.items.filter(item => item != null) as T[]
+  public get (): number | undefined {
+    const number = this.items[this.readIdx]
+    if (number === -1) {
+      return
+    }
+    this.items[this.readIdx] = -1
+    this.readIdx = this.readIdx === this.maxArrayIdx ? 0 : this.readIdx + 1
+    --this.size
+    return number
+  }
+
+  /**
+   * Returns buffer as numbers' array.
+   * @returns Numbers' array.
+   */
+  public toArray (): number[] {
+    return Array.from(this.items.filter(item => item !== -1))
   }
 
+  /**
+   * Checks the buffer size.
+   * @param size - Buffer size.
+   */
   private checkSize (size: number): void {
     if (!Number.isSafeInteger(size)) {
       throw new TypeError(
-        `Invalid circular buffer size: ${size} is not an integer`
+        `Invalid circular buffer size: '${size.toString()}' is not an integer`
       )
     }
     if (size < 0) {
-      throw new RangeError(`Invalid circular buffer size: ${size} < 0`)
+      throw new RangeError(
+        `Invalid circular buffer size: ${size.toString()} < 0`
+      )
     }
   }
 }