data-structure-typed 2.5.0 → 2.5.1

package/docs-site-docusaurus/docs/api/classes/DoublyLinkedListNode.md

@@ -0,0 +1,221 @@
+[**data-structure-typed**](../README.md)
+
+***
+
+[data-structure-typed](../README.md) / DoublyLinkedListNode
+
+# Class: DoublyLinkedListNode\<E\>
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:17](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/linked-list/doubly-linked-list.ts#L17)
+
+Node of a doubly linked list; stores value and prev/next links.
+
+## Remarks
+
+Time O(1), Space O(1)
+
+## Extends
+
+- [`LinkedListNode`](LinkedListNode.md)\<`E`\>
+
+## Type Parameters
+
+### E
+
+`E` = `any`
+
+## Constructors
+
+### Constructor
+
+```ts
+new DoublyLinkedListNode<E>(value): DoublyLinkedListNode<E>;
+```
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:25](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/linked-list/doubly-linked-list.ts#L25)
+
+Create a node.
+
+#### Parameters
+
+##### value
+
+`E`
+
+Element value to store.
+
+#### Returns
+
+`DoublyLinkedListNode`\<`E`\>
+
+New node instance.
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+#### Overrides
+
+[`LinkedListNode`](LinkedListNode.md).[`constructor`](LinkedListNode.md#constructor)
+
+## Accessors
+
+### next
+
+#### Get Signature
+
+```ts
+get next(): DoublyLinkedListNode<E> | undefined;
+```
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:40](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/linked-list/doubly-linked-list.ts#L40)
+
+Get the next node link.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+`DoublyLinkedListNode`\<`E`\> \| `undefined`
+
+Next node or undefined.
+
+#### Set Signature
+
+```ts
+set next(value): void;
+```
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:51](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/linked-list/doubly-linked-list.ts#L51)
+
+Set the next node link.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Parameters
+
+###### value
+
+`DoublyLinkedListNode`\<`E`\> \| `undefined`
+
+Next node or undefined.
+
+##### Returns
+
+`void`
+
+void
+
+#### Overrides
+
+[`LinkedListNode`](LinkedListNode.md).[`next`](LinkedListNode.md#next)
+
+***
+
+### prev
+
+#### Get Signature
+
+```ts
+get prev(): DoublyLinkedListNode<E> | undefined;
+```
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:63](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/linked-list/doubly-linked-list.ts#L63)
+
+Get the previous node link.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+`DoublyLinkedListNode`\<`E`\> \| `undefined`
+
+Previous node or undefined.
+
+#### Set Signature
+
+```ts
+set prev(value): void;
+```
+
+Defined in: [data-structures/linked-list/doubly-linked-list.ts:74](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/linked-list/doubly-linked-list.ts#L74)
+
+Set the previous node link.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Parameters
+
+###### value
+
+`DoublyLinkedListNode`\<`E`\> \| `undefined`
+
+Previous node or undefined.
+
+##### Returns
+
+`void`
+
+void
+
+***
+
+### value
+
+#### Get Signature
+
+```ts
+get value(): E;
+```
+
+Defined in: [data-structures/base/linear-base.ts:27](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/linear-base.ts#L27)
+
+Element payload getter.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+`E`
+
+Element value.
+
+#### Set Signature
+
+```ts
+set value(value): void;
+```
+
+Defined in: [data-structures/base/linear-base.ts:36](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/base/linear-base.ts#L36)
+
+Element payload setter.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Parameters
+
+###### value
+
+`E`
+
+New value.
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[`LinkedListNode`](LinkedListNode.md).[`value`](LinkedListNode.md#value)

package/docs-site-docusaurus/docs/api/classes/FibonacciHeap.md

@@ -0,0 +1,253 @@
+[**data-structure-typed**](../README.md)
+
+***
+
+[data-structure-typed](../README.md) / FibonacciHeap
+
+# Class: FibonacciHeap\<E\>
+
+Defined in: [data-structures/heap/heap.ts:1202](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1202)
+
+Fibonacci heap (min-heap) optimized for fast merges and amortized operations.
+
+## Remarks
+
+Time O(1), Space O(1)
+
+## Example
+
+```ts
+examples will be generated by unit test
+```
+
+## Type Parameters
+
+### E
+
+`E`
+
+## Constructors
+
+### Constructor
+
+```ts
+new FibonacciHeap<E>(comparator?): FibonacciHeap<E>;
+```
+
+Defined in: [data-structures/heap/heap.ts:1210](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1210)
+
+Create a FibonacciHeap.
+
+#### Parameters
+
+##### comparator?
+
+`Comparator`\<`E`\>
+
+Comparator to order elements (min-heap by default).
+
+#### Returns
+
+`FibonacciHeap`\<`E`\>
+
+New FibonacciHeap instance.
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+## Accessors
+
+### min
+
+#### Get Signature
+
+```ts
+get min(): FibonacciHeapNode<E> | undefined;
+```
+
+Defined in: [data-structures/heap/heap.ts:1241](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1241)
+
+Get the current minimum node.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+[`FibonacciHeapNode`](FibonacciHeapNode.md)\<`E`\> \| `undefined`
+
+Min node or undefined.
+
+***
+
+### root
+
+#### Get Signature
+
+```ts
+get root(): FibonacciHeapNode<E> | undefined;
+```
+
+Defined in: [data-structures/heap/heap.ts:1224](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1224)
+
+Get the circular root list head.
+
+##### Remarks
+
+Time O(1), Space O(1)
+
+##### Returns
+
+[`FibonacciHeapNode`](FibonacciHeapNode.md)\<`E`\> \| `undefined`
+
+Root node or undefined.
+
+## Methods
+
+### consumeLinkedList()
+
+```ts
+consumeLinkedList(head?): FibonacciHeapNode<E>[];
+```
+
+Defined in: [data-structures/heap/heap.ts:1290](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1290)
+
+Collect nodes from a circular doubly linked list starting at head.
+
+#### Parameters
+
+##### head?
+
+[`FibonacciHeapNode`](FibonacciHeapNode.md)\<`E`\>
+
+Start node of the circular list.
+
+#### Returns
+
+[`FibonacciHeapNode`](FibonacciHeapNode.md)\<`E`\>[]
+
+Array of nodes from the list.
+
+#### Remarks
+
+Time O(K), Space O(K)
+
+***
+
+### merge()
+
+```ts
+merge(heapToMerge): void;
+```
+
+Defined in: [data-structures/heap/heap.ts:1361](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1361)
+
+Meld another heap into this heap.
+
+#### Parameters
+
+##### heapToMerge
+
+`FibonacciHeap`\<`E`\>
+
+Another FibonacciHeap to meld into this one.
+
+#### Returns
+
+`void`
+
+void
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+***
+
+### mergeWithChild()
+
+```ts
+mergeWithChild(parent, node): void;
+```
+
+Defined in: [data-structures/heap/heap.ts:1312](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1312)
+
+Insert a node into a parent's child list (circular).
+
+#### Parameters
+
+##### parent
+
+[`FibonacciHeapNode`](FibonacciHeapNode.md)\<`E`\>
+
+Parent node.
+
+##### node
+
+[`FibonacciHeapNode`](FibonacciHeapNode.md)\<`E`\>
+
+Child node to insert.
+
+#### Returns
+
+`void`
+
+void
+
+#### Remarks
+
+Time O(1), Space O(1)
+
+***
+
+### pop()
+
+```ts
+pop(): E | undefined;
+```
+
+Defined in: [data-structures/heap/heap.ts:1332](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1332)
+
+Remove and return the minimum element, consolidating the root list.
+
+#### Returns
+
+`E` \| `undefined`
+
+Minimum element or undefined.
+
+#### Remarks
+
+Time O(log N) amortized, Space O(1)
+
+***
+
+### push()
+
+```ts
+push(element): this;
+```
+
+Defined in: [data-structures/heap/heap.ts:1269](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1269)
+
+Push an element into the root list.
+
+#### Parameters
+
+##### element
+
+`E`
+
+Element to insert.
+
+#### Returns
+
+`this`
+
+This heap.
+
+#### Remarks
+
+Time O(1) amortized, Space O(1)

package/docs-site-docusaurus/docs/api/classes/FibonacciHeapNode.md

@@ -0,0 +1,21 @@
+[**data-structure-typed**](../README.md)
+
+***
+
+[data-structure-typed](../README.md) / FibonacciHeapNode
+
+# Class: FibonacciHeapNode\<E\>
+
+Defined in: [data-structures/heap/heap.ts:1180](https://github.com/zrwusa/data-structure-typed/blob/2f6ceb3aee852228efc88b111e19c0809753e805/src/data-structures/heap/heap.ts#L1180)
+
+Node container used by FibonacciHeap.
+
+## Remarks
+
+Time O(1), Space O(1)
+
+## Type Parameters
+
+### E
+
+`E`