function zeros
zeros(): matrix

Create an array or matrix of all zeros.

Creates an array or matrix filled with zeros based on the specified dimensions. If no arguments are provided, it defaults to a 1x1 matrix.

Examples

Create a 1x1 matrix of zeros (default behavior)

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

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

Create a 2x2 square matrix of zeros

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

assertEquals(zeros(2, 2), [[0, 0], [0, 0]]);

Create a 2x3 matrix of zeros

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

assertEquals(zeros(2, 3), [[0, 0, 0], [0, 0, 0]]);

Create a 2x1 matrix of zeros using array input

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

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

Return Type

A matrix of zeros with the specified dimensions.

Throws

If invalid input arguments are provided.

zeros(n: number): matrix

Create an array or matrix of all zeros.

Creates an array or matrix filled with zeros based on the specified dimensions. If no arguments are provided, it defaults to a 1x1 matrix.

Examples

Create a 1x1 matrix of zeros (default behavior)

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

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

Create a 2x2 square matrix of zeros

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

assertEquals(zeros(2, 2), [[0, 0], [0, 0]]);

Create a 2x3 matrix of zeros

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

assertEquals(zeros(2, 3), [[0, 0, 0], [0, 0, 0]]);

Create a 2x1 matrix of zeros using array input

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

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

Parameters

n: number

Return Type

A matrix of zeros with the specified dimensions.

Throws

If invalid input arguments are provided.

zeros(dims: array): matrix

Create an array or matrix of all zeros.

Creates an array or matrix filled with zeros based on the specified dimensions. If no arguments are provided, it defaults to a 1x1 matrix.

Examples

Create a 1x1 matrix of zeros (default behavior)

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

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

Create a 2x2 square matrix of zeros

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

assertEquals(zeros(2, 2), [[0, 0], [0, 0]]);

Create a 2x3 matrix of zeros

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

assertEquals(zeros(2, 3), [[0, 0, 0], [0, 0, 0]]);

Create a 2x1 matrix of zeros using array input

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

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

Parameters

dims: array

Return Type

A matrix of zeros with the specified dimensions.

Throws

If invalid input arguments are provided.

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

Create an array or matrix of all zeros.

Creates an array or matrix filled with zeros based on the specified dimensions. If no arguments are provided, it defaults to a 1x1 matrix.

Examples

Create a 1x1 matrix of zeros (default behavior)

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

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

Create a 2x2 square matrix of zeros

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

assertEquals(zeros(2, 2), [[0, 0], [0, 0]]);

Create a 2x3 matrix of zeros

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

assertEquals(zeros(2, 3), [[0, 0, 0], [0, 0, 0]]);

Create a 2x1 matrix of zeros using array input

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

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

Parameters

nrows: number
ncols: number

The number of columns (optional if the first argument is an array). Defaults to 1.

Return Type

A matrix of zeros with the specified dimensions.

Throws

If invalid input arguments are provided.

Usage

import zeros from "matarrs/zeros.ts";