function eye
eye(n: number): matrix

Identity matrix.

Creates an identity matrix with the specified dimensions. If a single number is provided, it creates a square identity matrix.

Examples

Create a 0x0 matrix (empty matrix)

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(0, 0), []);

Create a 1x1 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(1, 1), [[1]]);

Create a 2x2 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(2, 2), [[1, 0], [0, 1]]);

Create a 2x1 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye([2, 1]), [[1], [0]]);

Create a 2x3 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(2, 3), [[1, 0, 0], [0, 1, 0]]);

Parameters

n: number

Return Type

The identity matrix of the specified dimensions.

Throws

If no input arguments are provided.

eye(dims: array): matrix

Identity matrix.

Creates an identity matrix with the specified dimensions. If a single number is provided, it creates a square identity matrix.

Examples

Create a 0x0 matrix (empty matrix)

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(0, 0), []);

Create a 1x1 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(1, 1), [[1]]);

Create a 2x2 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(2, 2), [[1, 0], [0, 1]]);

Create a 2x1 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye([2, 1]), [[1], [0]]);

Create a 2x3 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(2, 3), [[1, 0, 0], [0, 1, 0]]);

Parameters

dims: array

Return Type

The identity matrix of the specified dimensions.

Throws

If no input arguments are provided.

eye(
nrows: number,
ncols: number,
): matrix

Identity matrix.

Creates an identity matrix with the specified dimensions. If a single number is provided, it creates a square identity matrix.

Examples

Create a 0x0 matrix (empty matrix)

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(0, 0), []);

Create a 1x1 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(1, 1), [[1]]);

Create a 2x2 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(2, 2), [[1, 0], [0, 1]]);

Create a 2x1 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye([2, 1]), [[1], [0]]);

Create a 2x3 identity matrix

import { assertEquals } from "jsr:@std/assert";

assertEquals(eye(2, 3), [[1, 0, 0], [0, 1, 0]]);

Parameters

nrows: number
ncols: number

Return Type

The identity matrix of the specified dimensions.

Throws

If no input arguments are provided.

Usage

import eye from "matarrs/eye.ts";