clone

Explicitly copies a known matrix: a new outer object and new row arrays, keys ascending, with cell references preserved.

import { Matrix } from "@teakit/matrix";

const input = { b: [1, 2], a: [3] };
const copy = Matrix.clone(input);
// { a: [3], b: [1, 2] }  (keys ascending)
copy !== input; // true
copy.a !== input.a; // true (rows are new arrays)

// Cell values are not deep-copied.
const cell = { v: 1 };
Matrix.clone({ a: [cell] }).a[0] === cell; // true

API Reference

Signature

Matrix.clone<T, TKey extends string>(
  matrix: Matrix<T, TKey>,
): Matrix<T, TKey>;

Parameters

Parameter	Type	Required	Notes
`matrix`	`Matrix<T, TKey>`	Yes	A value already known to be a matrix.

Returns

A new matrix with keys ascending and each row copied; cell values share references.

Throws

Does not throw.

Agent Contract

Field	Value
Kind	static helper
Canonical name	`clone`
Aliases	None
Mutates inputs	No
Returns	`Matrix<T, TKey>`

Agent Notes

Use clone for a value you already trust is a matrix; for unknown/external input use from, which validates first.

#clone

#API Reference

#Signature

#Parameters

#Returns

#Throws

#Agent Contract

#Agent Notes