X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FCircularBuffer.html;h=578f6b8f275faa3f6aa5e7155b88e606c8abbce6;hb=8b7aa4204c27efd1dc699f7baea65b5262bd26b3;hp=996c19459f3cfcc741567ae4dd5938cf561f3d95;hpb=fcb83cac5406186d9646362d0f3f97db339012d9;p=poolifier.git diff --git a/docs/classes/CircularBuffer.html b/docs/classes/CircularBuffer.html index 996c1945..578f6b8f 100644 --- a/docs/classes/CircularBuffer.html +++ b/docs/classes/CircularBuffer.html @@ -1,30 +1,24 @@ -CircularBuffer | poolifier - v4.0.13

Class CircularBuffer`Internal`

Circular buffer designed for positive numbers.

-

Index

Constructors

Properties

items -maxArrayIdx -readIdx -size -writeIdx -

Methods

checkSize -empty +CircularBuffer | poolifier - v4.0.15

Class CircularBuffer`Internal`

Circular buffer designed for positive numbers.

+

Index

Constructors

Properties

Methods

empty full get put toArray -

Constructors

constructor

new CircularBuffer(size?): CircularBuffer
Parameters
- size: number = defaultBufferSize
  Buffer size.
  +

Constructors

constructor

new CircularBuffer(size?): CircularBuffer
Parameters
- size: number = defaultBufferSize
  Buffer size.
Returns CircularBuffer
CircularBuffer.
-
Default Value
```
defaultBufferSize
-
```
-
- Defined in src/circular-buffer.ts:22

Properties

`Private` `Readonly` items

items: Float32Array

`Private` `Readonly` maxArrayIdx

maxArrayIdx: number

`Private` readIdx

readIdx: number

size

size: number

`Private` writeIdx

writeIdx: number

Methods

`Private` checkSize

checkSize(size): void
Checks the buffer size.
-
Parameters
- size: number
  Buffer size.
  -
Returns void
- Defined in src/circular-buffer.ts:92

empty

empty(): boolean
Checks whether the buffer is empty.
+
Default Value
```
defaultBufferSize
+
```
+ +
- Defined in src/circular-buffer.ts:21

Properties

size

size: number

Methods

empty

empty(): boolean
Checks whether the buffer is empty.

Returns boolean
Whether the buffer is empty.
-
- Defined in src/circular-buffer.ts:36

full

full(): boolean
Checks whether the buffer is full.
+
- Defined in src/circular-buffer.ts:34

full

full(): boolean
Checks whether the buffer is full.

Returns boolean
Whether the buffer is full.
-
- Defined in src/circular-buffer.ts:45

get

get(): undefined | number
Gets number from buffer.
+
- Defined in src/circular-buffer.ts:42

get

get(): undefined | number
Gets number from buffer.

Returns undefined | number
Number from buffer.
-
- Defined in src/circular-buffer.ts:67

put

put(number): void
Puts number into buffer.
+
- Defined in src/circular-buffer.ts:62

put

put(number): void
Puts number into buffer.
Parameters
- number: number
  Number to put into buffer.
  -
Returns void
- Defined in src/circular-buffer.ts:54

toArray

toArray(): number[]
Returns buffer as numbers' array.
-
Returns number[]
Numbers' array.
-
- Defined in src/circular-buffer.ts:83

\ No newline at end of file +

Returns void

toArray

toArray(): number[]
Returns buffer as numbers' array.
+
Returns number[]
Numbers' array.
+
- Defined in src/circular-buffer.ts:77

\ No newline at end of file