switch to binarySearch

Author: husayt

src/findJuzByAyahId.ts

@@ -1,5 +1,6 @@
 import { JuzList } from "./lists/juzList"
 import { AyahId, Juz } from "./types"
+import { binarySearch } from "./utils"
 import { checkValidAyahId } from "./validation"
 
 /**
@@ -11,6 +12,8 @@ import { checkValidAyahId } from "./validation"
 export function findJuzByAyahId(ayahId: AyahId): Juz {
   checkValidAyahId(ayahId)
 
-  const juz = JuzList.findIndex(x => x > ayahId) - 1
+  // const juz = JuzList.findIndex(x => x > ayahId) - 1
+  const jj = binarySearch(JuzList, ayahId)
+  const juz = jj < 0 ? -jj - 2 : jj
   return juz as Juz
 }

src/findPage.ts

@@ -1,6 +1,7 @@
 import { findAyahIdBySurah } from "./findAyahIdBySurah"
 import { PageList } from "./lists/pageList"
 import { AyahId, AyahNo, Page, Surah } from "./types"
+import { binarySearch } from "./utils"
 import { checkValidSurah } from "./validation"
 
 /**
@@ -14,5 +15,8 @@ export function findPage(surah: Surah, ayah: AyahNo | AyahId): Page {
   checkValidSurah(surah)
   const ayahId: AyahId = findAyahIdBySurah(surah, ayah as AyahNo)
 
-  return PageList.findIndex(x => x > ayahId) - 1 as Page
+  // return PageList.findIndex(x => x > ayahId) - 1 as Page
+  const jj = binarySearch(PageList, ayahId)
+  const page = jj < 0 ? -jj - 2 : jj
+  return page as Page
 }

src/findPagebyAyahId.ts

@@ -1,5 +1,6 @@
 import { PageList } from "./lists/pageList"
 import { AyahId, Page } from "./types"
+import { binarySearch } from "./utils"
 import { checkValidAyahId } from "./validation"
 
 /**
@@ -18,5 +19,8 @@ import { checkValidAyahId } from "./validation"
 export function findPagebyAyahId(ayahId: AyahId): Page {
   checkValidAyahId(ayahId)
 
-  return PageList.findIndex(x => x > ayahId) - 1 as Page
+  // return PageList.findIndex(x => x > ayahId) - 1 as Page
+  const jj = binarySearch(PageList, ayahId)
+  const page = jj < 0 ? -jj - 2 : jj
+  return page as Page
 }

src/findRubAlHizbByAyahId.ts

@@ -1,5 +1,6 @@
 import { HizbQuarterList } from "./lists/hizbQuarterList"
 import { AyahId, RubAlHizbId } from "./types"
+import { binarySearch } from "./utils"
 import { checkValidAyahId } from "./validation"
 
 /**
@@ -11,5 +12,8 @@ import { checkValidAyahId } from "./validation"
 export function findRubAlHizbByAyahId(ayahId: AyahId): RubAlHizbId {
   checkValidAyahId(ayahId)
 
-  return HizbQuarterList.findIndex(x => x > ayahId) - 1 as RubAlHizbId
+  // return HizbQuarterList.findIndex(x => x > ayahId) - 1 as RubAlHizbId
+  const jj = binarySearch(HizbQuarterList, ayahId)
+  const page = jj < 0 ? -jj - 2 : jj
+  return page as RubAlHizbId
 }

src/findSurahAyahByAyahId.ts

@@ -1,18 +1,22 @@
-import { SurahList as findSurahByAyahIdModule } from "./lists/surahList"
+import { SurahList } from "./lists/surahList"
 import { AyahId, AyahNo, Surah, SurahAyah } from "./types"
+import { binarySearch } from "./utils"
 import { checkValidAyahId } from "./validation"
 
 /**
  * Finds the Surah (chapter) and Ayah (verse) numbers that the given Ayah ID belongs to.
  *
- * @param ayaId - The Ayah ID to find the Surah and Ayah numbers for.
+ * @param ayahId - The Ayah ID to find the Surah and Ayah numbers for.
  * @returns An array containing the Surah number and the Ayah number within that Surah.
  */
 
-export function findSurahAyahByAyahId(ayaId: AyahId): SurahAyah {
-  checkValidAyahId(ayaId)
+export function findSurahAyahByAyahId(ayahId: AyahId): SurahAyah {
+  checkValidAyahId(ayahId)
 
-  const suraNum: Surah = (findSurahByAyahIdModule.findIndex(x => x[0] > ayaId) - 1) as Surah
-  const ayahNo = (ayaId - findSurahByAyahIdModule[suraNum][0] + 1) as AyahNo
-  return [suraNum, ayahNo]
+  // const suraNum: Surah = (SurahList.findIndex(x => x[0] > ayahId) - 1) as Surah
+  const ss = binarySearch(SurahList, ayahId, (aya, b) => (aya - b[0]))
+  const suraNum = ss < 0 ? -ss - 2 : ss
+
+  const ayahNo = (ayahId - SurahList[suraNum][0] + 1) as AyahNo
+  return [suraNum as Surah, ayahNo]
 }

src/getAyahMeta.ts

@@ -4,9 +4,11 @@ import { getRubAlHizbMetaByAyahId } from "./getRubAlHizbMetaByAyahId"
 import { HizbQuarterList } from "./lists/hizbQuarterList"
 import { JuzList } from "./lists/juzList"
 import { PageList } from "./lists/pageList"
+import { RukuList } from "./lists/rukuList"
 import { SajdaList } from "./lists/sajdaList"
 import { SurahList } from "./lists/surahList"
 import { AyahId, AyahMeta, Page } from "./types"
+import { binarySearch } from "./utils"
 import { checkValidAyahId } from "./validation"
 
 /**
@@ -25,11 +27,13 @@ export function getAyahMeta(ayahId: AyahId): AyahMeta {
   const isSajdahAyah = SajdaList.some(([sajdaAyahId]) => sajdaAyahId === ayahId)
   const isStartOfSurah = SurahList[surah][0] === ayahId
   const isStartOfPage = PageList[page] === ayahId
+  // const isStartOfRuku = RukuList[page] === ayahId
   const isStartOfJuz = JuzList[quarterData.juz] === ayahId
   const isStartOfQuarter = HizbQuarterList[quarterData.rubAlHizbId] === ayahId
   const isEndOfSurah = SurahList[surah + 1][0] - 1 === ayahId
   const isEndOfPage = PageList[page + 1] - 1 === ayahId
   const isEndOfJuz = JuzList[quarterData.juz + 1] - 1 === ayahId
+  const isEndOfRuku = JuzList[quarterData.juz + 1] - 1 === ayahId
   const isEndOfQuarter = HizbQuarterList[quarterData.rubAlHizbId + 1] - 1 === ayahId
 
   return {

src/utils.ts

@@ -6,10 +6,10 @@
  * @param compare_fn - An optional comparison function to use for the search. Defaults to a simple numeric comparison.
  * @returns The index of the element if found, or a negative value indicating the insertion point if not found.
  */
-export function binarySearch(
-  ar: Array<number>,
-  el: number,
-  compare_fn: (a: number, b: number) => number = (a, b) => a - b
+export function binarySearch<T, X>(
+  ar: Array<T>,
+  el: X,
+  compare_fn: (a: X, b: T) => number = (a, b) => a as number - (b as number)
 ): number | -1 {
   let m = 0
   let n = ar.length - 1