vertical-radix

vertical-radix

The derived algorithm from Radix trie with up-and-down relationship.

API

export interface INodeStringified {
    n: string;
    c: INodeStringified[];
}
export declare class Node {
    n: string;
    c: Node[];
    constructor(key?: string, structure?: INodeStringified);
    insert(x: string): void;
    delete(x: string): void;
    add(child: Node): void;
    remove(key: string): Node;
    is(x: string): boolean;
    find(x: string): {
        readonly found: false;
        readonly node: any;
        readonly parent: Node;
        readonly x: string;
        readonly offset: number;
    } | {
        readonly found: true;
        readonly node: Node;
        readonly parent: Node;
        readonly x: string;
        readonly offset: number;
    };
    overlap(x: string): {
        node: Node;
        size: number;
    }[];
    stringify(beautify?: boolean): string;
    flatten(prefix?: string): {
        prefix: string;
        node: Node;
    }[];
}
interface ILookupIntermediateElement {
    node: Node;
    prefix: string;
    offset: number;
}
export declare const lookup: (root: Node, x: string) => ILookupIntermediateElement[];

Node.prototype.n: string

The name of the node. This does not include parent name, or prefix.

Node.prototype.c: Node[]

This children of the node.

Node.prototype.constructor(key?: string, structure?: INodeStringified)

Creates new trie. You can strictly specify empty string for root node.

const root = new Node();

To load from stringified structure using JSON.stringify, you may attach stringified object to second parameter.

const root = new Node('', {
  key: '',
  children: [],
});

Node.prototype.insert(x: string): void

Insert entry to the trie assuming the Node is the root entry.

(() => {
	const root = new Node();

	root.insert('alpine');
	console.log(root.stringify(true));
})();
/*
{
  "c": [
    {
      "c": [],
      "n": "alpine"
    }
  ],
  "n": ""
}
*/

Node.prototype.delete(x: string): void

Delete entry from the trie. If you specify the parent entry, all sub-entries will be removed at the time.

(() => {
	const root = new Node();

	root.insert('alpine');
	root.insert('alpha');

	root.delete('alpine');

	console.log(root.stringify(true));
})();
/*
{
  "c": [
    {
      "c": [
        {
          "c": [],
          "n": "ha"
        }
      ],
      "n": "alp"
    }
  ],
  "n": ""
}
*/

Node.prototype.add(child: Node): void

Use Node.prototype.insert to build the tree.

Add node to this node.

(() => {
	const root = new Node();

	root.add(new Node('alpine'));

	console.log(root.stringify(true));
})();
/*
{
  "c": [
    {
      "c": [],
      "n": "alpine"
    }
  ],
  "n": ""
}
*/

Node.prototype.remove(key: string): void

Use Node.prototype.delete to clear sub-node inside the tree.

Remove node from this node.

(() => {
	const root = new Node();

	root.add(new Node('alpine'));
	root.remove('alpine');

	console.log(root.stringify(true));
})();
/*
{
  "c": [],
  "n": ""
}
*/

Node.prototype.is(x: string): boolean

Perform strict check with Node.prototype.key property.

(() => {
	const node = new Node('alpine');

	console.log(node.is('alpine'));
})();
/*
true
*/

Node.prototype.find(x: string): {found: boolean; parent: Node; node: Node; x: string;}

Find entry if exists returning the last accessed node and substring of initial x. The parent property refers to parent node that we found node.

(() => {
	const root = new Node();

	root.insert('alpine');
	root.insert('alpha');

	console.log(root.find('alpha'));
})();
/*
{ found: true, at: Node { c: [ [Node], [Node] ], n: 'alp' }, x: 'ha' }
*/

overlap(x: string): {node: Node; size: number;}[]

Find all overlapping entries with its overlap size of the node name or key.

(() => {
	const root = new Node();

	root.insert('alpine');

	console.log(root.overlap('alpha'));
})();
/*
[ { node: Node { c: [], n: 'alpine' }, size: 3 } ]
*/

Node.prototype.stringify(beautify?: boolean): string

Stringify the tree assuming the Node is the root entry.

Node.prototype.flatten(prefix?: string): {prefix: string; node: Node;}[]

Flatten all children names with prefix. You can jump the root node by checking the prefix property or bypassing the first node.

(() => {
	const root = new Node();

	root.insert('alpine');
	root.insert('alpha');

	console.log(root.flatten());
})();
/*
[
  { prefix: '', node: Node { c: [Array], n: 'alp' } },
  { prefix: 'alp', node: Node { c: [], n: 'ha' } },
  { prefix: 'alp', node: Node { c: [], n: 'ine' } }
]
*/

Experimental unoptimized lookup: (root: Node, x: string) => ILookupIntermediateElement[]

Find by pattern with asterick character. Note that functions requiring backward search like intermediate token or trailing token are not optimized. You need to use Node.prototype.find and loop them for performance reason. Internally, more iteration would be caused for now.

(() => {
	const root = new Node();

	root.insert('alpine');
	root.insert('alpha');

	console.log(lookup(root, 'al*'));
})();
/*
[
  { node: Node { c: [], n: 'ha' }, prefix: 'alp', offset: 2 },
  { node: Node { c: [], n: 'ine' }, prefix: 'alp', offset: 2 }
]
*/

Changelog

1.4.0 (2022-11-05)

Features

• support offset in prototype.find (0b718d1)