numz 0.4.0 → 0.5.0

package/docs/astro.config.mjs

@@ -6,8 +6,9 @@ import starlightThemeObsidian from 'starlight-theme-obsidian'
 
 
 const referenceModules = [
+	'typed-matrix',
 	'functions', 
-	'matrix',
+	// 'matrix',
 	'complex',
 	'signal', 
 	'stats',
@@ -36,12 +37,12 @@ export default defineConfig({
 					href: 'https://github.com/zakarialaoui10/numz.git' 
 				}],
 			sidebar: [
-				{
-					label: 'Guides',
-					items: [
-						{ label: 'Example Guide', slug: 'guides/example' },
-					],
-				},
+				// {
+				// 	label: 'Guides',
+				// 	items: [
+				// 		{ label: 'Example Guide', slug: 'guides/example' },
+				// 	],
+				// },
 				{
 					label : 'philosophy',
 					slug : 'philosophy'

package/docs/src/content/docs/index.mdx

@@ -5,9 +5,9 @@ template: splash # Remove or comment out this line to display the site sidebar o
 hero:
   tagline: Scientific computation with zikojs
   image:
-    file: ../../assets/houston.webp
+    file: ../../assets/logo.png
   actions:
-    - text: Example Guide
+    - text: Read the docs
       link: /guides/example/
       icon: right-arrow
     - text: Read Zikojs docs
@@ -18,23 +18,49 @@ hero:
 
 import { Card, CardGrid } from '@astrojs/starlight/components';
 
-## Next steps
+## Features overview
 
 <CardGrid stagger>
-	<Card title="Update content" icon="pencil">
-		Edit `src/content/docs/index.mdx` to see this page change.
+	<Card title="Extended Array Programming">
+		Numz brings NumPy-like array programming to JavaScript with native, flexible data structures.
+		- Preserves original structure and types
+		- No manual loops or recursion required
 	</Card>
-	<Card title="Change page layout" icon="document">
-		Delete `template: splash` in `src/content/docs/index.mdx` to display a
-		sidebar on this page.
+	<Card title="Built on the top of zikojs">
+	    Numz fully supports and extends core **ZikoJS data types**.
+		- Extend mathematical utilities and functions
+		- Supoorts : 
+			- Complex numbers
+			- Matrices
+			- ...
 	</Card>
-	<Card title="Add new content" icon="add-document">
-		Add Markdown or MDX files to `src/content/docs` to create new pages.
+	<Card title="Typed Matrices">
+		High-performance matrix types backed by TypedArrays.
+		- Arithmetic operations 
+		- Reshape
+		- Serialization / deserialization
+		- ...
 	</Card>
-	<Card title="Configure your site" icon="setting">
-		Edit your `sidebar` and other config in `astro.config.mjs`.
+	<Card title="Signal Processing">
+	Built-in tools for discrete signals and DSP :
+	- Sequences
+	- Pulses
+	- Windows
+	- Convolution
+	- FFT
+	- ...
 	</Card>
-	<Card title="Read the docs" icon="open-book">
-		Learn more in [the Starlight Docs](https://starlight.astro.build/).
+	  <Card title="Advanced Statistics Utilities">
+    A comprehensive statistics toolbox designed for large datasets and numerical analysis.
+
+    - Descriptive statistics (mean, median, mode, variance, std)  
+    - Reductions (min, max, sum, product)  
+    - Percentiles and quantiles  
+    - Covariance and correlation  
+	- Distributions
+  </Card>
+	<Card title="Modular & Composable">
+	- Tree-shakable modules
+	- Easy integration with other libraries
 	</Card>
 </CardGrid>

package/docs/src/content/docs/philosophy.md

@@ -11,5 +11,3 @@ It is inspired by:
 - **MATLAB**
 
 Numz guarantees a **layered, shape-safe, function-first numerical computing model**, designed to scale naturally from scalars to tensors while preserving mathematical correctness and clarity.
-
-<!-- Numz is a layered, shape-safe, function-first numerical computing library that brings true array programming and scientific mathematics to JavaScript, built on the top of [Zikojs](). -->

package/docs/src/content/docs/reference/typed-matrix/0-intro.md

@@ -0,0 +1,74 @@
+---
+title: Introduction
+description: Typed matrices overview
+tableOfContents: false
+---
+
+**Typed Matrices** in **Numz** are an extension of **Zikojs Matrix**, designed to provide
+**high-performance**, **memory-efficient**, and **type-safe** matrix operations.
+
+Unlike regular matrices that rely on standard JavaScript arrays, Typed Matrices are
+backed by **TypedArray** structures, enabling contiguous memory layout and faster
+numerical computation.
+
+---
+
+## TypedMatrix Variants
+
+Numz provides multiple TypedMatrix classes, each mapped to a specific
+JavaScript `TypedArray` implementation.
+
+### Floating-Point Matrices
+
+| Class       | Backing Type  | Precision | Use case |
+|-------------|---------------|-----------|----------|
+| `F16Matrix` | `Float16Array`| 16-bit    | ML, GPU-style data |
+| `F32Matrix` | `Float32Array`| 32-bit    | GPU, graphics, signals |
+| `F64Matrix` | `Float64Array`| 64-bit    | Scientific computing |
+
+### Integer Matrices
+
+| Class       | Backing Type       | Range | Use case |
+|-------------|--------------------|-------|----------|
+| `I8Matrix`  | `Int8Array`        | −128 → 127 | Compact data |
+| `U8Matrix`  | `Uint8Array`       | 0 → 255 | Images, buffers |
+| `I16Matrix` | `Int16Array`       | −32K → 32K | DSP, audio |
+| `U16Matrix` | `Uint16Array`      | 0 → 65K | Indexing |
+| `I32Matrix` | `Int32Array`       | 32-bit | General integers |
+| `U32Matrix` | `Uint32Array`      | 32-bit | Large indices |
+
+### Big Integer Matrices
+
+| Class         | Backing Type         | Notes |
+|--------------|----------------------|-------|
+| `BI64Matrix`  | `BigInt64Array`      | Requires `BigInt` |
+| `BU64Matrix`  | `BigUint64Array`     | Large integer arithmetic |
+
+---
+
+## Example
+
+```js
+import { F64Matrix } from 'numz';
+
+const A = new F64Matrix(2, 2, [
+  1, 2,
+  3, 4
+]);
+
+A.add(2).mul(3);
+
+```
+
+
+### Note
+> During the construction phase, the provided data is accepted as a regular
+JavaScript array only as a temporary input.
+Internally, Numz copies the values into a TypedArray (``Float64Array`` in this case),
+and the original array is discarded and no longer used.
+
+> This guarantees:
+- contiguous memory layout
+- predictable numeric type
+- better performance for subsequent operations
+

package/docs/src/content/docs/reference/typed-matrix/1-declaration.mdx

@@ -0,0 +1,65 @@
+---
+title: declaration
+description: about
+tableOfContents: false
+---
+
+import { Tabs, TabItem } from '@astrojs/starlight/components';
+
+## Matrix Constructor
+
+<Tabs>
+  <TabItem label="Class Constructor">
+    - `new [Type]Matrix(r, c, arr: (number)[])` : Creates an `r × c` matrix using the provided **array of numbers**.
+    - `new [Type]Matrix(m : [Type]Matrix)` :  Creates a **copy** of an existing `[Type]Matrix`.
+    - `new [Type]Matrix(arr : (number)[][])` : Creates a matrix from a **2-dimensional array**. The number of rows and columns
+      is inferred from the array shape.
+    ### Example
+    ```js
+    const M1 = new I8Matrix(3, 3, [1, 2, 3, -4, -5, 6, 7, 8, 9])
+    const M2 = new I8Matrix(M1)
+    const M3 = new F32Matrix([
+                  [1.3, 1.2], 
+                  [-3.7, 2.75]
+                ])
+    ```
+  </TabItem>
+  <TabItem label="Functional Constructors">
+    - `matrix_[type](r, c, arr: (number)[])` : Functional version of the constructor that creates an `r × c` matrix from a flat array.
+
+    - `matrix_[type](m : [Type]Matrix)` : Functional copy of an existing `[Type]Matrix`.
+    - `matrix_[type](arr : (number)[])` : Functional constructor that creates a matrix from a **2-dimensional array**.
+    ### Example
+    ```js
+    const M1 = matrix_i8(3, 3, [1, 2, 3, -4, -5, 6, 7, 8, 9])
+    const M2 = matrix_i8(M1)
+    const M3 = matrix_f32([
+                  [1.3, 1.2], 
+                  [-3.7, 2.75]
+                ])
+    ```
+  </TabItem>
+</Tabs>
+
+## Static Factory Methods
+
+All TypedMatrix classes (`F16Matrix`, `F32Matrix`, `F64Matrix`, `I8Matrix`, etc.) provide
+the following **static factory methods** for convenient construction:
+
+- `[Type]Matrix.zeros(r, c)` : Creates an `r × c` matrix filled with zeros.
+- `[Type]Matrix.ones(r, c)` : Creates an `r × c` matrix filled with ones.
+- `[Type]Matrix.eye(n)` : Creates an `n × n` identity matrix (ones on the diagonal, zeros elsewhere).  
+- `[Type]Matrix.nums(r, c, num : number)` : Creates an r × c matrix filled with the specified value num
+- `Matrix.random.int(min, max)`
+- `Matrix.random.float(min, max)`
+
+### Example
+
+```js
+ const M1 = F64Matrix.zeros(2,7)
+ const M2 = U32Matrix.ones(4,5)
+ const M3 = I32Matrix.eye(4)
+ const M4 = F32Matrix.nums(3, 3, -1.25)
+ const M5 = I16Matrix.random.int(-7, 7)
+ const M6 = F32Matrix.random.float(-7, 7)
+```

package/docs/src/content/docs/reference/typed-matrix/accessors.md

@@ -0,0 +1,5 @@
+---
+title: accessors 
+description: about
+tableOfContents: false
+---

package/docs/src/content/docs/reference/typed-matrix/arithmetic.md

@@ -0,0 +1,12 @@
+---
+title: arithmetic 
+description: about
+tableOfContents: false
+---
+
+- `.add(...m: (Matrix | number)[])` : Element-wise addition with one or more matrices or scalars.
+- `.sub(...m: (Matrix | number)[])` : Element-wise subtraction with one or more matrices or scalars.
+- `.mul(...m: (Matrix | number)[])` : Element-wise multiplication with one or more matrices or scalars.
+- `.div(...m: (Matrix | number)[])` : Element-wise division with one or more matrices or scalars.
+- `.modulo(...m: (Matrix | number)[])` : Element-wise modulo operation with one or more matrices or scalars.
+- `.dot(m: Matrix)` : Matrix multiplication (linear algebra dot product).

package/docs/src/content/docs/reference/typed-matrix/checkers.md

@@ -0,0 +1,11 @@
+---
+title: checkers
+description: checkers
+# sidebar:
+#     order : 0
+tableOfContents: false
+---
+
+Hello world;
+
+My name is Zakaria ELALAOUI, There’s nothing impressive here, just skip this part and go straight to the documentation.

package/docs/src/content/docs/reference/typed-matrix/float-only.md

@@ -0,0 +1,5 @@
+---
+title: float only 
+description: about
+tableOfContents: false
+---

package/docs/src/content/docs/reference/typed-matrix/rehsape.md

@@ -0,0 +1,12 @@
+---
+title: reshape
+description: reshape
+tableOfContents: false
+---
+
+- `.reshape(r, c)` : Reshapes the matrix to `(r × c)` without changing the total number of elements.
+- `.reshape(r0, c0, r1, c1)` : 
+- `.hstack(...matrices: Matrix[])` : Horizontally stacks matrices by columns (same number of rows required).
+- `.vstack(...matrices: Matrix[])` : Vertically stacks matrices by rows (same number of columns required).
+- `.hqueue(...matrices: Matrix[])` : Appends matrices horizontally, preserving row order (row-wise concatenation).
+- `.vqueue(...matrices: Matrix[])` : Appends matrices vertically, preserving column order (column-wise concatenation).

package/docs/src/styles/custom.css

@@ -2,13 +2,20 @@
   --sl-content-width: 50rem;
   --sl-text-5xl: 3.5rem;
 }
-
 h1{
-    color : darkblue;
-    /* text-decoration: 2px underline blueviolet;
-    text-decoration-skip-ink: auto; */
-    /* border-bottom: 1px red solid; */
+    color : var(--sl-color-accent-high);
+}
+h2{
+    color : var(--slsg-node-color-7);
+}
+h3{
+    color : var(--slsg-node-color-8);  
+
 }
+
+/* a, summary span{
+    color: var(--sl-color-accent-lows);
+} */
 p a{
     color: blueviolet;
     text-decoration: none;
@@ -16,6 +23,10 @@ p a{
         text-decoration: underline;
     }
 }
-/* strong{
-    color: blueviolet;
+strong{
+    color: var(--slsg-node-color-8);
+}
+
+/* #starlight__sidebar li, .group-label span{
+    color: gray;
 } */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "numz",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "scientific computing with zikojs",
   "main": "index.js",
   "type": "module",
@@ -18,17 +18,17 @@
   "author": "zakaria elalaoui",
   "keywords": [
     "zikojs",
-    "zikojs-addons"
+    "math"
   ],
   "license": "MIT",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.0",
-    "@rollup/plugin-node-resolve": "^15.3.0",
-    "@rollup/plugin-terser": "^0.4.4",
-    "cross-env": "^7.0.3",
-    "rollup": "^4.24.0"
+    "@rollup/plugin-commonjs": "^29.0.3",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^1.0.0",
+    "cross-env": "^10.1.0",
+    "rollup": "^4.62.5"
   },
   "dependencies": {
-    "ziko": "^0.57.0"
+    "ziko": "^1.8.0"
   }
 }