simple-squiggle/node_modules/mathjs/lib/esm/function/matrix/column.js

59 lines
1.5 KiB
JavaScript

import { factory } from '../../utils/factory.js';
import { clone } from '../../utils/object.js';
import { validateIndex } from '../../utils/array.js';
var name = 'column';
var dependencies = ['typed', 'Index', 'matrix', 'range'];
export var createColumn = /* #__PURE__ */factory(name, dependencies, _ref => {
var {
typed,
Index,
matrix,
range
} = _ref;
/**
* Return a column from a Matrix.
*
* Syntax:
*
* math.column(value, index)
*
* Example:
*
* // get a column
* const d = [[1, 2], [3, 4]]
* math.column(d, 1) // returns [[2], [4]]
*
* See also:
*
* row
*
* @param {Array | Matrix } value An array or matrix
* @param {number} column The index of the column
* @return {Array | Matrix} The retrieved column
*/
return typed(name, {
'Matrix, number': _column,
'Array, number': function ArrayNumber(value, column) {
return _column(matrix(clone(value)), column).valueOf();
}
});
/**
* Retrieve a column of a matrix
* @param {Matrix } value A matrix
* @param {number} column The index of the column
* @return {Matrix} The retrieved column
*/
function _column(value, column) {
// check dimensions
if (value.size().length !== 2) {
throw new Error('Only two dimensional matrix is supported');
}
validateIndex(column, value.size()[1]);
var rowRange = range(0, value.size()[0]);
var index = new Index(rowRange, column);
return value.subset(index);
}
});