sub2ind - matarrs/sub2ind.ts - Ubique documentation

function sub2ind



sub2ind(size: array,
index: array | matrix,
): number | array

Converts 2D subscripts to linear indices.

Converts 2D coordinates [X, Y] into linear indices based on the given matrix size.

Examples

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

var a = [[5,6,5],[7,8,-1]];

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

assertEquals(sub2ind([2, 3], [1, 2]), 5);

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

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

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

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



size: array

The size of the matrix.



index: array | matrix

X, Y coordinates in the range [0...N-1].

number | array

The computed linear index or an array of indices.

If input arguments are missing or invalid.