isrow - matarrs/isrow.ts - Ubique documentation

function isrow



isrow(x: unknown): x is matrix

Checks if the input is a row vector.

Returns true if the input matrix is a row vector, meaning it has exactly one row and more than one column.

Examples

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

assertEquals(isrow([[2, 2]]), true);

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

assertEquals(isrow([[2], [2]]), false);

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

assertEquals(isrow([[1, 2, 3]]), true);

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

assertEquals(isrow([[1, 2], [3, 4]]), false);

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

assertEquals(isrow([[1]]), true);

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

assertThrows(() => isrow(5), "Input must be a non-empty matrix");

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

assertThrows(() => isrow([]), "Input must be a non-empty matrix");



x: unknown

The input matrix to check.

x is matrix

Returns true if x is a row vector, otherwise false.

If the input is not a valid matrix or if no argument is provided.