iscolumn - matarrs/iscolumn.ts - Ubique documentation

function iscolumn



iscolumn(x: unknown): x is matrix

Checks if the input is a column vector.

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

Examples

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

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

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

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

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

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

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

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

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

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

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

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

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

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



x: unknown

The input matrix to check.

x is matrix

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

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