[system-a] tensor/ -- extract assertions

Author: xieyuheng

TODO.md

@@ -1,7 +1,5 @@
 # system-a
 
-[system-a] `tensor/` -- extract `assert`
-
 [system-a] `tensor/` -- `tensorZeros` -- zeros of the same shape
 [system-a] `velocityRepresentation` -- takes `options: { velocityAccumulationFactor }`
 [system-a] `gradientDescentVelocity`

src/system-a/tensor/Scalar.ts

@@ -20,12 +20,6 @@ export function isScalar(x: any): x is Scalar {
   return typeof x === "number" || isDual(x)
 }
 
-export function assertScalar(t: any): asserts t is Scalar {
-  if (!isScalar(t)) {
-    throw new Error(`[assertScalar] ${t}`)
-  }
-}
-
 export function scalarReal(x: Scalar): number {
   if (isDual(x)) {
     return x.real

src/system-a/tensor/Tensor.ts

@@ -1,33 +1,7 @@
 import { isScalar, type Scalar } from "./Scalar.js"
-import { rank } from "./rank.js"
-import { tensorAlmostEqual } from "./tensorAlmostEqual.js"
 
 export type Tensor = Scalar | Array<Tensor>
 
 export function isTensor(x: any): x is Tensor {
   return isScalar(x) || (x instanceof Array && x.every(isTensor))
 }
-
-export function assertTensor1(t: Tensor): asserts t is Array<Scalar> {
-  if (rank(t) !== 1) {
-    throw new Error(`[assertTensor1] ${t}`)
-  }
-}
-
-export function assertTensorArray(x: any): asserts x is Array<Tensor> {
-  if (x instanceof Array && x.every(isTensor)) {
-    return
-  }
-
-  throw new Error(`[assertTensorArray] ${x}`)
-}
-
-export function assertTensorAlmostEqual(
-  x: Tensor,
-  y: Tensor,
-  epsilon: number,
-): void {
-  if (!tensorAlmostEqual(x, y, epsilon)) {
-    throw new Error(`[assertTensorAlmostEqual] [${x}], [${y}], ${epsilon}`)
-  }
-}

src/system-a/tensor/assertions.ts

@@ -0,0 +1,34 @@
+import { isScalar, type Scalar } from "./Scalar.js"
+import { isTensor, type Tensor } from "./Tensor.js"
+import { rank } from "./rank.js"
+import { tensorAlmostEqual } from "./tensorAlmostEqual.js"
+
+export function assertScalar(t: any): asserts t is Scalar {
+  if (!isScalar(t)) {
+    throw new Error(`[assertScalar] ${t}`)
+  }
+}
+
+export function assertTensor1(t: Tensor): asserts t is Array<Scalar> {
+  if (rank(t) !== 1) {
+    throw new Error(`[assertTensor1] ${t}`)
+  }
+}
+
+export function assertTensorArray(x: any): asserts x is Array<Tensor> {
+  if (x instanceof Array && x.every(isTensor)) {
+    return
+  }
+
+  throw new Error(`[assertTensorArray] ${x}`)
+}
+
+export function assertTensorAlmostEqual(
+  x: Tensor,
+  y: Tensor,
+  epsilon: number,
+): void {
+  if (!tensorAlmostEqual(x, y, epsilon)) {
+    throw new Error(`[assertTensorAlmostEqual] [${x}], [${y}], ${epsilon}`)
+  }
+}

src/system-a/tensor/index.ts

@@ -1,5 +1,6 @@
 export * from "./Scalar.js"
 export * from "./Tensor.js"
+export * from "./assertions.js"
 export * from "./rank.js"
 export * from "./shape.js"
 export * from "./tensorAlmostEqual.js"