SparseMatrix #

Sparse Matrix implementation. This type implements a Compressed Column Storage format for sparse matrices.

• 实例
  • .storage() ⇒ string
  • .datatype() ⇒ string
  • .create(data, [datatype])
  • .density() ⇒ number
  • .subset(index, [replacement], [defaultValue])
  • .get(index) ⇒ \*
  • .set(index, value, [defaultValue]) ⇒ [SparseMatrix](#SparseMatrix)
  • .resize(size, [defaultValue], [copy]) ⇒ Matrix
  • .clone() ⇒ [SparseMatrix](#SparseMatrix)
  • .size() ⇒ Array.<number>
  • .map(callback, [skipZeros]) ⇒ [SparseMatrix](#SparseMatrix)
  • .forEach(callback, [skipZeros])
  • .toArray() ⇒ Array
  • .valueOf() ⇒ Array
  • .format([options]) ⇒ string
  • .toString() ⇒ string
  • .toJSON() ⇒ Object
  • .diagonal([k]) ⇒ Matrix
  • .swapRows(i, j) ⇒ Matrix
• 静态
  • .fromJSON(json) ⇒ [SparseMatrix](#SparseMatrix)
  • .diagonal(size, value, [k], [datatype]) ⇒ [SparseMatrix](#SparseMatrix)

sparseMatrix.storage() ⇒ string #

获取矩阵使用的存储格式。

用法

const format = matrix.storage()  // retrieve storage format

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: string - The storage format.

sparseMatrix.datatype() ⇒ string #

获取矩阵中存储的数据的类型。

用法

const format = matrix.datatype()  // retrieve matrix datatype

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: string - The datatype.

sparseMatrix.create(data, [datatype]) #

创建一个新的 SparseMatrix

Kind: instance method of [SparseMatrix](#SparseMatrix)

sparseMatrix.density() ⇒ number #

获取矩阵的密度。

用法

const density = matrix.density()  // retrieve matrix density

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: number - The matrix density.

sparseMatrix.subset(index, [replacement], [defaultValue]) #

获取矩阵的子集，或替换矩阵的子集。

用法

const subset = matrix.subset(index)               // retrieve subset
const value = matrix.subset(index, replacement)   // replace subset

Kind: instance method of [SparseMatrix](#SparseMatrix)

sparseMatrix.get(index) ⇒ \* #

从矩阵中获取单个元素。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: \* - value

sparseMatrix.set(index, value, [defaultValue]) ⇒ [SparseMatrix](#SparseMatrix) #

替换矩阵中的单个元素。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: [SparseMatrix](#SparseMatrix) - self

sparseMatrix.resize(size, [defaultValue], [copy]) ⇒ Matrix #

将矩阵调整为给定大小。当 copy=true 时，返回矩阵的副本，否则返回矩阵本身（原地调整大小）。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: Matrix - The resized matrix

sparseMatrix.clone() ⇒ [SparseMatrix](#SparseMatrix) #

创建矩阵的克隆

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: [SparseMatrix](#SparseMatrix) - clone

sparseMatrix.size() ⇒ Array.<number> #

检索矩阵的大小。

Kind: instance method of [SparseMatrix](#SparseMatrix)
返回: Array.<number> - 大小

sparseMatrix.map(callback, [skipZeros]) ⇒ [SparseMatrix](#SparseMatrix) #

创建一个新矩阵，其中包含在矩阵的每个条目上执行回调函数的结果。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: [SparseMatrix](#SparseMatrix) - matrix

sparseMatrix.forEach(callback, [skipZeros]) #

在矩阵的每个条目上执行回调函数。

Kind: instance method of [SparseMatrix](#SparseMatrix)

sparseMatrix.toArray() ⇒ Array #

创建一个包含 SparseMatrix 数据副本的 Array

Kind: instance method of [SparseMatrix](#SparseMatrix)
返回: Array - 数组

sparseMatrix.valueOf() ⇒ Array #

获取 SparseMatrix 的原始值：一个二维数组

Kind: instance method of [SparseMatrix](#SparseMatrix)
返回: Array - 数组

sparseMatrix.format([options]) ⇒ string #

获取矩阵的字符串表示形式，带可选的格式化选项。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: string - str

sparseMatrix.toString() ⇒ string #

获取矩阵的字符串表示形式

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: string - str

sparseMatrix.toJSON() ⇒ Object #

获取矩阵的 JSON 表示形式

Kind: instance method of [SparseMatrix](#SparseMatrix)

sparseMatrix.diagonal([k]) ⇒ Matrix #

获取第 k 个 Matrix 对角线。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: Matrix - 包含对角线值的矩阵向量。

sparseMatrix.swapRows(i, j) ⇒ Matrix #

在 Matrix 中交换行 i 和 j。

Kind: instance method of [SparseMatrix](#SparseMatrix)
Returns: Matrix - The matrix reference

SparseMatrix.fromJSON(json) ⇒ [SparseMatrix](#SparseMatrix) #

从 JSON 对象生成矩阵

Kind: static method of [SparseMatrix](#SparseMatrix)

SparseMatrix.diagonal(size, value, [k], [datatype]) ⇒ [SparseMatrix](#SparseMatrix) #

创建一个对角矩阵。

Kind: static method of [SparseMatrix](#SparseMatrix)