dimforge / dimforge/nalgebra

Misleading docs for CsrMatrix::disassemble

Open
#1,088 0 comments 0 reactions 0 assignees View on GitHub
documentation nalgebra-sparse
Dominant language
Rust
Stars
4.8k
Forks
565
PR merge metrics
No merged PRs in 30d

Description

The docs say:

> If the matrix contains the sole reference to the sparsity pattern, then the data is returned as-is. Otherwise, the sparsity pattern is cloned.

This stems from an earlier design in which the sparsity pattern was stored behind an `Arc`. In the current design, the sparsity pattern is always directly returned without any cloning (since it is not shared).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.