Skip to content

Commit

Permalink
style: improves linting (#517)
Browse files Browse the repository at this point in the history
  • Loading branch information
@micheleriva
micheleriva authored Oct 11, 2023
1 parent 66c54aa commit d4b0b87
Show file tree
Hide file tree
Showing 4 changed files with 114 additions and 125 deletions.
88 changes: 41 additions & 47 deletions packages/orama/src/trees/avl.ts
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Nullable } from '../types.js'
import { safeArrayPush } from '../utils.js'

export type Node<K, V> = {
export interface Node<K, V> {
// Node key
k: K
// Node value
Expand All @@ -19,14 +19,14 @@ const BALANCE_STATE = {
SLIGHTLY_UNBALANCED_RIGHT: -1,
BALANCED: 0,
SLIGHTLY_UNBALANCED_LEFT: 1,
UNBALANCED_LEFT: 2,
UNBALANCED_LEFT: 2
}

function getHeight<K, V>(node: Nullable<Node<K, V>>): number {
return node ? node.h : -1
function getHeight<K, V> (node: Nullable<Node<K, V>>): number {
return (node != null) ? node.h : -1
}

function rotateLeft<K, V>(node: Node<K, V>): Node<K, V> {
function rotateLeft<K, V> (node: Node<K, V>): Node<K, V> {
const right = node.r as Node<K, V>
node.r = right.l
right.l = node
Expand All @@ -35,7 +35,7 @@ function rotateLeft<K, V>(node: Node<K, V>): Node<K, V> {
return right
}

function rotateRight<K, V>(node: Node<K, V>): Node<K, V> {
function rotateRight<K, V> (node: Node<K, V>): Node<K, V> {
const left = node.l as Node<K, V>
node.l = left.r
left.r = node
Expand All @@ -44,11 +44,11 @@ function rotateRight<K, V>(node: Node<K, V>): Node<K, V> {
return left
}

export function contains<K, V>(node: Node<K, V>, key: K): boolean {
export function contains<K, V> (node: Node<K, V>, key: K): boolean {
return !!find(node, key)
}

export function getSize<K, V>(root: Nullable<Node<K, V>>): number {
export function getSize<K, V> (root: Nullable<Node<K, V>>): number {
let size = 0
const queue: Array<Node<K, V>> = []

Expand All @@ -72,10 +72,10 @@ export function getSize<K, V>(root: Nullable<Node<K, V>>): number {
return size
}

export function isBalanced<K, V>(root: Nullable<Node<K, V>>): boolean {
export function isBalanced<K, V> (root: Nullable<Node<K, V>>): boolean {
if (root === null) return true

const stack: Node<K, V>[] = [root]
const stack: Array<Node<K, V>> = [root]

while (stack.length > 0) {
const node = stack.pop()
Expand All @@ -100,16 +100,14 @@ export function isBalanced<K, V>(root: Nullable<Node<K, V>>): boolean {
return true
}

export function rangeSearch<K, V>(node: Node<K, V>, min: K, max: K): V {
export function rangeSearch<K, V> (node: Node<K, V>, min: K, max: K): V {
if (!node) {
return [] as unknown as V
}

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
const result: V[] = []

function traverse(node: Node<K, V>) {
function traverse (node: Node<K, V>) {
if (!node) {
return
}
Expand All @@ -119,7 +117,7 @@ export function rangeSearch<K, V>(node: Node<K, V>, min: K, max: K): V {
}

if (node.k >= min && node.k <= max) {
safeArrayPush(result, node.v as V[]);
safeArrayPush(result, node.v as V[])
}

if (node.k < max) {
Expand All @@ -132,26 +130,24 @@ export function rangeSearch<K, V>(node: Node<K, V>, min: K, max: K): V {
return result as V
}

export function greaterThan<K, V>(node: Node<K, V>, key: K, inclusive = false): V {
export function greaterThan<K, V> (node: Node<K, V>, key: K, inclusive = false): V {
if (!node) {
return [] as unknown as V
}

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
const result: V[] = []

function traverse(node: Node<K, V>) {
function traverse (node: Node<K, V>) {
if (!node) {
return
}

if (inclusive && node.k >= key) {
safeArrayPush(result, node.v as V[]);
safeArrayPush(result, node.v as V[])
}

if (!inclusive && node.k > key) {
safeArrayPush(result, node.v as V[]);
safeArrayPush(result, node.v as V[])
}

traverse(node.l as Node<K, V>)
Expand All @@ -163,26 +159,24 @@ export function greaterThan<K, V>(node: Node<K, V>, key: K, inclusive = false):
return result as V
}

export function lessThan<K, V>(node: Node<K, V>, key: K, inclusive = false): V {
export function lessThan<K, V> (node: Node<K, V>, key: K, inclusive = false): V {
if (!node) {
return [] as unknown as V
}

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
const result: V[] = []

function traverse(node: Node<K, V>) {
function traverse (node: Node<K, V>) {
if (!node) {
return
}

if (inclusive && node.k <= key) {
safeArrayPush(result, node.v as V[]);
safeArrayPush(result, node.v as V[])
}

if (!inclusive && node.k < key) {
safeArrayPush(result, node.v as V[]);
safeArrayPush(result, node.v as V[])
}

traverse(node.l as Node<K, V>)
Expand All @@ -194,7 +188,7 @@ export function lessThan<K, V>(node: Node<K, V>, key: K, inclusive = false): V {
return result as V
}

function getNodeByKey<K, V>(node: Nullable<Node<K, V>>, key: K): Nullable<Node<K, V>> {
function getNodeByKey<K, V> (node: Nullable<Node<K, V>>, key: K): Nullable<Node<K, V>> {
while (node !== null) {
if (key < node.k) {
node = node.l
Expand All @@ -207,17 +201,17 @@ function getNodeByKey<K, V>(node: Nullable<Node<K, V>>, key: K): Nullable<Node<K
return null
}

export function create<K, V>(key: K, value: V): Node<K, V> {
export function create<K, V> (key: K, value: V): Node<K, V> {
return {
k: key,
v: value,
l: null,
r: null,
h: 0,
h: 0
}
}

export function insert<K, V>(root: Node<K, V>, key: K, value: V): Node<K, V> {
export function insert<K, V> (root: Node<K, V>, key: K, value: V): Node<K, V> {
let parent: Nullable<Node<K, V>> = null
let current: Nullable<Node<K, V>> = root

Expand All @@ -229,14 +223,14 @@ export function insert<K, V>(root: Node<K, V>, key: K, value: V): Node<K, V> {
current = current.r
} else {
// assuming value is an array here
(current.v as string[]) = (current.v as string[]).concat(value as string);
(current.v as string[]) = (current.v as string[]).concat(value as string)
return root
}
}

const newNode = create(key, value)

if (!parent) {
if (parent == null) {
root = newNode // tree was empty
} else if (key < parent.k) {
parent.l = newNode
Expand All @@ -246,7 +240,7 @@ export function insert<K, V>(root: Node<K, V>, key: K, value: V): Node<K, V> {

current = newNode

while (parent) {
while (parent != null) {
const balanceFactor = getHeight(parent.l) - getHeight(parent.r)

if (balanceFactor === BALANCE_STATE.UNBALANCED_LEFT) {
Expand Down Expand Up @@ -274,7 +268,7 @@ export function insert<K, V>(root: Node<K, V>, key: K, value: V): Node<K, V> {
return root
}

function getNodeParent<K, V>(root: Node<K, V>, key: K): Nullable<Node<K, V>> {
function getNodeParent<K, V> (root: Node<K, V>, key: K): Nullable<Node<K, V>> {
let current: Nullable<Node<K, V>> = root
let parent: Nullable<Node<K, V>> = null

Expand All @@ -293,19 +287,19 @@ function getNodeParent<K, V>(root: Node<K, V>, key: K): Nullable<Node<K, V>> {
return parent
}

export function find<K, V>(root: Node<K, V>, key: K): V | null {
export function find<K, V> (root: Node<K, V>, key: K): V | null {
const node = getNodeByKey(root, key)
if (!node) {
if (node == null) {
return null
}
return node.v
}

export function remove<K, V>(root: Nullable<Node<K, V>>, key: K): Nullable<Node<K, V>> {
export function remove<K, V> (root: Nullable<Node<K, V>>, key: K): Nullable<Node<K, V>> {
let node = root
let parentNode: Nullable<Node<K, V>> = null

while (node && node.k !== key) {
while ((node != null) && node.k !== key) {
parentNode = node
if (key < node.k) {
node = node.l as Node<K, V>
Expand All @@ -314,12 +308,12 @@ export function remove<K, V>(root: Nullable<Node<K, V>>, key: K): Nullable<Node<
}
}

if (!node) {
if (node == null) {
return null
}

if (!node.l && !node.r) {
if (!parentNode) {
if ((node.l == null) && (node.r == null)) {
if (parentNode == null) {
// Node to be deleted is root
root = null
} else {
Expand All @@ -329,11 +323,11 @@ export function remove<K, V>(root: Nullable<Node<K, V>>, key: K): Nullable<Node<
parentNode.r = null
}
}
} else if (node.l && node.r) {
} else if ((node.l != null) && (node.r != null)) {
let minValueNode = node.r
let minValueParent = node

while (minValueNode.l) {
while (minValueNode.l != null) {
minValueParent = minValueNode
minValueNode = minValueNode.l
}
Expand All @@ -346,9 +340,9 @@ export function remove<K, V>(root: Nullable<Node<K, V>>, key: K): Nullable<Node<
minValueParent.l = minValueNode.r
}
} else {
const childNode = node.l ? node.l : node.r
const childNode = (node.l != null) ? node.l : node.r

if (!parentNode) {
if (parentNode == null) {
root = childNode as Node<K, V>
} else {
if (parentNode.l === node) {
Expand All @@ -362,7 +356,7 @@ export function remove<K, V>(root: Nullable<Node<K, V>>, key: K): Nullable<Node<
return root
}

export function removeDocument<K, V>(root: Node<K, V[]>, id: V, key: K): void {
export function removeDocument<K, V> (root: Node<K, V[]>, id: V, key: K): void {
const node = getNodeByKey(root, key)!

if (!node) {
Expand Down
33 changes: 16 additions & 17 deletions packages/orama/src/trees/flat.ts
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import { InternalDocumentID } from "../components/internal-document-id-store.js"
import { EnumArrComparisonOperator, EnumComparisonOperator, Nullable, ScalarSearchableValue } from "../types.js"
import { intersect, safeArrayPush } from "../utils.js"
import { InternalDocumentID } from '../components/internal-document-id-store.js'
import { EnumArrComparisonOperator, EnumComparisonOperator, Nullable, ScalarSearchableValue } from '../types.js'
import { intersect, safeArrayPush } from '../utils.js'

export interface FlatTree {
numberToDocumentId: Map<ScalarSearchableValue, InternalDocumentID[]>
}

export function create(): FlatTree {
export function create (): FlatTree {
return {
numberToDocumentId: new Map()
}
}

export function insert(root: FlatTree, key: ScalarSearchableValue, value: InternalDocumentID): FlatTree {
export function insert (root: FlatTree, key: ScalarSearchableValue, value: InternalDocumentID): FlatTree {
if (root.numberToDocumentId.has(key)) {
root.numberToDocumentId.get(key)!.push(value)
return root
Expand All @@ -21,36 +21,35 @@ export function insert(root: FlatTree, key: ScalarSearchableValue, value: Intern
return root
}

export function find(root: FlatTree, key: ScalarSearchableValue): Nullable<InternalDocumentID[]> {
export function find (root: FlatTree, key: ScalarSearchableValue): Nullable<InternalDocumentID[]> {
return root.numberToDocumentId.get(key) ?? null
}

export function remove(root: Nullable<FlatTree>, key: ScalarSearchableValue): Nullable<FlatTree> {
if (root) {
export function remove (root: Nullable<FlatTree>, key: ScalarSearchableValue): Nullable<FlatTree> {
if (root != null) {
root.numberToDocumentId.delete(key)
}
return root
}
export function removeDocument(root: FlatTree, id: InternalDocumentID, key: ScalarSearchableValue): void {
export function removeDocument (root: FlatTree, id: InternalDocumentID, key: ScalarSearchableValue): void {
root?.numberToDocumentId.set(key, root?.numberToDocumentId.get(key)?.filter((v) => v !== id) ?? [])
if (root?.numberToDocumentId.get(key)?.length === 0) {
root?.numberToDocumentId.delete(key)
}
}


export function contains(node: FlatTree, key: ScalarSearchableValue): boolean {
return !!find(node, key)
export function contains (node: FlatTree, key: ScalarSearchableValue): boolean {
return !(find(node, key) == null)
}

export function getSize(root: Nullable<FlatTree>): number {
export function getSize (root: Nullable<FlatTree>): number {
let size = 0
for (const [, value] of root?.numberToDocumentId ?? []) {
size += value.length
}
return size
}
export function filter(root: FlatTree, operation: EnumComparisonOperator): InternalDocumentID[] {
export function filter (root: FlatTree, operation: EnumComparisonOperator): InternalDocumentID[] {
const operationKeys = Object.keys(operation)

if (operationKeys.length !== 1) {
Expand All @@ -68,7 +67,7 @@ export function filter(root: FlatTree, operation: EnumComparisonOperator): Inter
const result: InternalDocumentID[] = []
for (const v of value) {
const ids = root.numberToDocumentId.get(v)
if (ids) {
if (ids != null) {
safeArrayPush(result, ids)
}
}
Expand All @@ -84,7 +83,7 @@ export function filter(root: FlatTree, operation: EnumComparisonOperator): Inter
continue
}
const ids = root.numberToDocumentId.get(key)
if (ids) {
if (ids != null) {
safeArrayPush(result, ids)
}
}
Expand All @@ -95,7 +94,7 @@ export function filter(root: FlatTree, operation: EnumComparisonOperator): Inter
throw new Error('Invalid operation')
}

export function filterArr(root: FlatTree, operation: EnumArrComparisonOperator): InternalDocumentID[] {
export function filterArr (root: FlatTree, operation: EnumArrComparisonOperator): InternalDocumentID[] {
const operationKeys = Object.keys(operation)

if (operationKeys.length !== 1) {
Expand Down
Loading

1 comment on commit d4b0b87

@vercel
Copy link

@vercel vercel bot commented on d4b0b87 Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

orama-docs – ./

orama-docs-git-main-oramasearch.vercel.app
orama-docs.vercel.app
docs.oramasearch.com
orama-docs-oramasearch.vercel.app

Please sign in to comment.