1 <!DOCTYPE html
><html class=
"default" lang=
"en"><head><meta charSet=
"utf-8"/><meta http-equiv=
"x-ua-compatible" content=
"IE=edge"/><title>FixedPriorityQueue | poolifier - v4.0
.15</title><meta name=
"description" content=
"Documentation for poolifier"/><meta name=
"viewport" content=
"width=device-width, initial-scale=1"/><link rel=
"stylesheet" href=
"../assets/style.css"/><link rel=
"stylesheet" href=
"../assets/highlight.css"/><script defer
src=
"../assets/main.js"></script><script async
src=
"../assets/icons.js" id=
"tsd-icons-script"></script><script async
src=
"../assets/search.js" id=
"tsd-search-script"></script><script async
src=
"../assets/navigation.js" id=
"tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem(
"tsd-theme") ||
"os";document.body.style.
display=
"none";setTimeout(() =
> app?app.showPage():document.body.style.removeProperty(
"display"),
500)
</script><header class=
"tsd-page-toolbar"><div class=
"tsd-toolbar-contents container"><div class=
"table-cell" id=
"tsd-search" data-base=
".."><div class=
"field"><label for=
"tsd-search-field" class=
"tsd-widget tsd-toolbar-icon search no-caption"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-search"></use></svg></label><input type=
"text" id=
"tsd-search-field" aria-label=
"Search"/></div><div class=
"field"><div id=
"tsd-toolbar-links"></div></div><ul class=
"results"><li class=
"state loading">Preparing search index...
</li><li class=
"state failure">The search index is not available
</li></ul><a href=
"../index.html" class=
"title">poolifier - v4.0
.15</a></div><div class=
"table-cell" id=
"tsd-widgets"><a href=
"#" class=
"tsd-widget tsd-toolbar-icon menu no-caption" data-toggle=
"menu" aria-label=
"Menu"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class=
"container container-main"><div class=
"col-content"><div class=
"tsd-page-title"><ul class=
"tsd-breadcrumb"><li><a href=
"../index.html">poolifier
</a></li><li><a href=
"FixedPriorityQueue.html">FixedPriorityQueue
</a></li></ul><h1>Class FixedPriorityQueue
<T
><code class=
"tsd-tag ts-flagInternal">Internal
</code> </h1></div><section class=
"tsd-panel tsd-comment"><div class=
"tsd-comment tsd-typography"><p>Fixed priority queue.
</p>
2 </div><div class=
"tsd-comment tsd-typography"></div></section> <section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"T" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span><div class=
"tsd-comment tsd-typography"><p>Type of fixed priority queue data.
</p>
3 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></section> <section class=
"tsd-panel tsd-hierarchy"><h4>Hierarchy (
<a class=
"link" href=
"../hierarchy.html#FixedPriorityQueue">view full
</a>)
</h4><ul class=
"tsd-hierarchy"><li><span class=
"target">FixedPriorityQueue
</span><ul class=
"tsd-hierarchy"><li><a href=
"../interfaces/PriorityQueueNode.html" class=
"tsd-signature-type tsd-kind-interface">PriorityQueueNode
</a></li></ul></li></ul></section><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L21">src/fixed-priority-queue.ts:
21</a></li></ul></aside><section class=
"tsd-panel-group tsd-index-group"><section class=
"tsd-panel tsd-index-panel"><details class=
"tsd-index-content tsd-index-accordion" open
><summary class=
"tsd-accordion-summary tsd-index-summary"><h5 class=
"tsd-index-heading uppercase" role=
"button" aria-expanded=
"false" tabIndex=
"0"><svg width=
"16" height=
"16" viewBox=
"0 0 16 16" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronSmall"></use></svg> Index
</h5></summary><div class=
"tsd-accordion-details"><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Constructors
</h3><div class=
"tsd-index-list"><a href=
"FixedPriorityQueue.html#constructor" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-512"></use></svg><span>constructor
</span></a>
4 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Properties
</h3><div class=
"tsd-index-list"><a href=
"FixedPriorityQueue.html#capacity" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>capacity
</span></a>
5 <a href=
"FixedPriorityQueue.html#enablePriority" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>enable
<wbr/>Priority
</span></a>
6 <a href=
"FixedPriorityQueue.html#nodeArray" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>node
<wbr/>Array
</span></a>
7 <a href=
"FixedPriorityQueue.html#size" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>size
</span></a>
8 <a href=
"FixedPriorityQueue.html#start" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>start
</span></a>
9 </div></section><section class=
"tsd-index-section"><h3 class=
"tsd-index-heading">Methods
</h3><div class=
"tsd-index-list"><a href=
"FixedPriorityQueue.html#_iterator_" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>[iterator]
</span></a>
10 <a href=
"FixedPriorityQueue.html#checkSize" class=
"tsd-index-link tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Size
</span></a>
11 <a href=
"FixedPriorityQueue.html#clear" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>clear
</span></a>
12 <a href=
"FixedPriorityQueue.html#dequeue" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>dequeue
</span></a>
13 <a href=
"FixedPriorityQueue.html#empty" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>empty
</span></a>
14 <a href=
"FixedPriorityQueue.html#enqueue" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>enqueue
</span></a>
15 <a href=
"FixedPriorityQueue.html#full" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>full
</span></a>
16 <a href=
"FixedPriorityQueue.html#get" class=
"tsd-index-link"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>get
</span></a>
17 </div></section></div></details></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Constructors
</h2><section class=
"tsd-panel tsd-member"><a id=
"constructor" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>constructor
</span><a href=
"#constructor" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"constructor.new_FixedPriorityQueue" class=
"tsd-anchor"></a><span class=
"tsd-kind-constructor-signature">new
<wbr/>Fixed
<wbr/>Priority
<wbr/>Queue
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">size
</span><span class=
"tsd-signature-symbol">?
</span>,
<span class=
"tsd-kind-parameter">enablePriority
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><a href=
"FixedPriorityQueue.html" class=
"tsd-signature-type tsd-kind-class">FixedPriorityQueue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><span class=
"tsd-signature-symbol">></span><a href=
"#constructor.new_FixedPriorityQueue" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Constructs a fixed priority queue.
</p>
18 </div><section class=
"tsd-panel"><h4>Type Parameters
</h4><ul class=
"tsd-type-parameter-list"><li><span><a id=
"constructor.new_FixedPriorityQueue.T-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-type-parameter">T
</span></span></li></ul></section><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">size
</span>:
<span class=
"tsd-signature-type">number
</span><span class=
"tsd-signature-symbol"> = defaultQueueSize
</span></span><div class=
"tsd-comment tsd-typography"><p>Fixed priority queue size.
</p>
19 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><span class=
"tsd-kind-parameter">enablePriority
</span>:
<span class=
"tsd-signature-type">boolean
</span><span class=
"tsd-signature-symbol"> = false
</span></span><div class=
"tsd-comment tsd-typography"><p>Whether to enable priority.
</p>
20 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<a href=
"FixedPriorityQueue.html" class=
"tsd-signature-type tsd-kind-class">FixedPriorityQueue
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><span class=
"tsd-signature-symbol">></span></h4><p>FixedPriorityQueue.
</p>
21 <div class=
"tsd-comment tsd-typography"><h4>Default Value
</h4><pre><code class=
"language-ts"><span class=
"hl-1">defaultQueueSize
</span>
22 </code><button>Copy
</button></pre>
23 <h4>Default Value
</h4><pre><code class=
"language-ts"><span class=
"hl-0">false
</span>
24 </code><button>Copy
</button></pre>
25 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L37">src/fixed-priority-queue.ts:
37</a></li></ul></aside></li></ul></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Properties
</h2><section class=
"tsd-panel tsd-member"><a id=
"capacity" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>capacity
</span><a href=
"#capacity" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">capacity
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">number
</span></div><div class=
"tsd-comment tsd-typography"><p>The fixed priority queue capacity.
</p>
26 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L25">src/fixed-priority-queue.ts:
25</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"enablePriority" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>enable
<wbr/>Priority
</span><a href=
"#enablePriority" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">enable
<wbr/>Priority
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">boolean
</span></div><div class=
"tsd-comment tsd-typography"><p>Whether to enable priority.
</p>
27 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L29">src/fixed-priority-queue.ts:
29</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"nodeArray" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <code class=
"tsd-tag ts-flagReadonly">Readonly
</code> <span>node
<wbr/>Array
</span><a href=
"#nodeArray" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">node
<wbr/>Array
</span><span class=
"tsd-signature-symbol">:
</span> <a href=
"../interfaces/FixedPriorityQueueNode.html" class=
"tsd-signature-type tsd-kind-interface">FixedPriorityQueueNode
</a><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><span class=
"tsd-signature-symbol">></span><span class=
"tsd-signature-symbol">[]
</span></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L23">src/fixed-priority-queue.ts:
23</a></li></ul></aside></section><section class=
"tsd-panel tsd-member"><a id=
"size" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>size
</span><a href=
"#size" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">size
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">number
</span></div><div class=
"tsd-comment tsd-typography"><p>The fixed priority queue size.
</p>
28 </div><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L27">src/fixed-priority-queue.ts:
27</a></li></ul></aside></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"start" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>start
</span><a href=
"#start" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class=
"tsd-signature"><span class=
"tsd-kind-property">start
</span><span class=
"tsd-signature-symbol">:
</span> <span class=
"tsd-signature-type">number
</span></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L22">src/fixed-priority-queue.ts:
22</a></li></ul></aside></section></section><section class=
"tsd-panel-group tsd-member-group"><h2>Methods
</h2><section class=
"tsd-panel tsd-member"><a id=
"_iterator_" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>[iterator]
</span><a href=
"#_iterator_" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"_iterator_._iterator_-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">[iterator]
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">Iterator
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">any
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol">></span><a href=
"#_iterator_._iterator_-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Returns an iterator for the fixed priority queue.
</p>
29 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">Iterator
</span><span class=
"tsd-signature-symbol"><</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">any
</span><span class=
"tsd-signature-symbol">,
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol">></span></h4><p>An iterator for the fixed priority queue.
</p>
30 <div class=
"tsd-comment tsd-typography"><h4>See
</h4><p><a href=
"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
</a></p>
31 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L145">src/fixed-priority-queue.ts:
145</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member tsd-is-private"><a id=
"checkSize" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><code class=
"tsd-tag ts-flagPrivate">Private
</code> <span>check
<wbr/>Size
</span><a href=
"#checkSize" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures tsd-is-private"><li class=
"tsd-signature tsd-anchor-link"><a id=
"checkSize.checkSize-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">check
<wbr/>Size
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">size
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#checkSize.checkSize-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Checks the queue size.
</p>
32 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">size
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>Queue size.
</p>
33 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L174">src/fixed-priority-queue.ts:
174</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"clear" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>clear
</span><a href=
"#clear" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"clear.clear-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">clear
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">void
</span><a href=
"#clear.clear-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Clears the fixed priority queue.
</p>
34 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">void
</span></h4><div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L135">src/fixed-priority-queue.ts:
135</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"dequeue" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>dequeue
</span><a href=
"#dequeue" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"dequeue.dequeue-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">dequeue
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><a href=
"#dequeue.dequeue-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Dequeue data from the fixed priority queue.
</p>
35 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a></h4><p>The dequeued data or
<code>undefined
</code> if the priority queue is empty.
</p>
36 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L119">src/fixed-priority-queue.ts:
119</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"empty" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>empty
</span><a href=
"#empty" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"empty.empty-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">empty
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#empty.empty-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Checks if the fixed priority queue is empty.
</p>
37 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><p><code>true
</code> if the fixed priority queue is empty,
<code>false
</code> otherwise.
</p>
38 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L49">src/fixed-priority-queue.ts:
49</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"enqueue" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>enqueue
</span><a href=
"#enqueue" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"enqueue.enqueue-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">enqueue
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">data
</span>,
<span class=
"tsd-kind-parameter">priority
</span><span class=
"tsd-signature-symbol">?
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">number
</span><a href=
"#enqueue.enqueue-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Enqueue data into the fixed priority queue.
</p>
39 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">data
</span>:
<a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a></span><div class=
"tsd-comment tsd-typography"><p>Data to enqueue.
</p>
40 </div><div class=
"tsd-comment tsd-typography"></div></li><li><span><code class=
"tsd-tag ts-flagOptional">Optional
</code> <span class=
"tsd-kind-parameter">priority
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>Priority of the data. Lower values have higher priority.
</p>
41 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">number
</span></h4><p>The new size of the priority queue.
</p>
42 <div class=
"tsd-comment tsd-typography"><h4>Throws
</h4><p>If the fixed priority queue is full.
</p>
43 </div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L68">src/fixed-priority-queue.ts:
68</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"full" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>full
</span><a href=
"#full" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"full.full-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">full
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">boolean
</span><a href=
"#full.full-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Checks if the fixed priority queue is full.
</p>
44 </div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">boolean
</span></h4><p><code>true
</code> if the fixed priority queue is full,
<code>false
</code> otherwise.
</p>
45 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L57">src/fixed-priority-queue.ts:
57</a></li></ul></aside></li></ul></section><section class=
"tsd-panel tsd-member"><a id=
"get" class=
"tsd-anchor"></a><h3 class=
"tsd-anchor-link"><span>get
</span><a href=
"#get" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class=
"tsd-signatures"><li class=
"tsd-signature tsd-anchor-link"><a id=
"get.get-1" class=
"tsd-anchor"></a><span class=
"tsd-kind-call-signature">get
</span><span class=
"tsd-signature-symbol">(
</span><span class=
"tsd-kind-parameter">index
</span><span class=
"tsd-signature-symbol">)
</span><span class=
"tsd-signature-symbol">:
</span><span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a><a href=
"#get.get-1" aria-label=
"Permalink" class=
"tsd-anchor-icon"><svg viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-anchor"></use></svg></a></li><li class=
"tsd-description"><div class=
"tsd-comment tsd-typography"><p>Gets data from the fixed priority queue.
</p>
46 </div><div class=
"tsd-parameters"><h4 class=
"tsd-parameters-title">Parameters
</h4><ul class=
"tsd-parameter-list"><li><span><span class=
"tsd-kind-parameter">index
</span>:
<span class=
"tsd-signature-type">number
</span></span><div class=
"tsd-comment tsd-typography"><p>The index of the data to get.
</p>
47 </div><div class=
"tsd-comment tsd-typography"></div></li></ul></div><h4 class=
"tsd-returns-title">Returns
<span class=
"tsd-signature-type">undefined
</span><span class=
"tsd-signature-symbol"> |
</span><a class=
"tsd-signature-type tsd-kind-type-parameter" href=
"FixedPriorityQueue.html#constructor.new_FixedPriorityQueue.T-1">T
</a></h4><p>The data at the index or
<code>undefined
</code> if the fixed priority queue is empty or the index is out of bounds.
</p>
48 <div class=
"tsd-comment tsd-typography"></div><aside class=
"tsd-sources"><ul><li>Defined in
<a href=
"https://github.com/poolifier/poolifier/blob/e8701e36c0374bf5a5be45264296575a6615c63d/src/fixed-priority-queue.ts#L104">src/fixed-priority-queue.ts:
104</a></li></ul></aside></li></ul></section></section></div><div class=
"col-sidebar"><div class=
"page-menu"><div class=
"tsd-navigation settings"><details class=
"tsd-index-accordion"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>Settings
</h3></summary><div class=
"tsd-accordion-details"><div class=
"tsd-filter-visibility"><h4 class=
"uppercase">Member Visibility
</h4><form><ul id=
"tsd-filter-options"><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-protected" name=
"protected"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Protected
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-private" name=
"private"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Private
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-inherited" name=
"inherited" checked
/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>Inherited
</span></label></li><li class=
"tsd-filter-item"><label class=
"tsd-filter-input"><input type=
"checkbox" id=
"tsd-filter-external" name=
"external"/><svg width=
"32" height=
"32" viewBox=
"0 0 32 32" aria-hidden=
"true"><rect class=
"tsd-checkbox-background" width=
"30" height=
"30" x=
"1" y=
"1" rx=
"6" fill=
"none"></rect><path class=
"tsd-checkbox-checkmark" d=
"M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke=
"none" stroke-width=
"3.5" stroke-linejoin=
"round" fill=
"none"></path></svg><span>External
</span></label></li></ul></form></div><div class=
"tsd-theme-toggle"><h4 class=
"uppercase">Theme
</h4><select id=
"tsd-theme"><option value=
"os">OS
</option><option value=
"light">Light
</option><option value=
"dark">Dark
</option></select></div></div></details></div><details open
class=
"tsd-index-accordion tsd-page-navigation"><summary class=
"tsd-accordion-summary"><h3><svg width=
"20" height=
"20" viewBox=
"0 0 24 24" fill=
"none"><use href=
"../assets/icons.svg#icon-chevronDown"></use></svg>On This Page
</h3></summary><div class=
"tsd-accordion-details"><a href=
"#constructor" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-512"></use></svg><span>constructor
</span></a><a href=
"#capacity" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>capacity
</span></a><a href=
"#enablePriority" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>enable
<wbr/>Priority
</span></a><a href=
"#nodeArray" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>node
<wbr/>Array
</span></a><a href=
"#size" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>size
</span></a><a href=
"#start" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1024"></use></svg><span>start
</span></a><a href=
"#_iterator_" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>[iterator]
</span></a><a href=
"#checkSize" class=
"tsd-is-private"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>check
<wbr/>Size
</span></a><a href=
"#clear" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>clear
</span></a><a href=
"#dequeue" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>dequeue
</span></a><a href=
"#empty" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>empty
</span></a><a href=
"#enqueue" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>enqueue
</span></a><a href=
"#full" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>full
</span></a><a href=
"#get" class=
""><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-2048"></use></svg><span>get
</span></a></div></details></div><div class=
"site-menu"><nav class=
"tsd-navigation"><a href=
"../index.html"><svg class=
"tsd-kind-icon" viewBox=
"0 0 24 24"><use href=
"../assets/icons.svg#icon-1"></use></svg><span>poolifier - v4.0
.15</span></a><ul class=
"tsd-small-nested-navigation" id=
"tsd-nav-container" data-base=
".."><li>Loading...
</li></ul></nav></div></div></div><footer><p class=
"tsd-generator">Generated using
<a href=
"https://typedoc.org/" target=
"_blank">TypeDoc
</a></p></footer><div class=
"overlay"></div></body></html>
repositories / poolifier.git / blob