Does eig return eigenvectors sorted in any way?

Open
#311 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start with the linked ndarray-linalg eig and eigvals API documentation and determine whether returned eigenvalues and eigenvectors have a defined order or normalization. Update the relevant documentation to state the observed guarantees, if any, and clarify what users should expect.

Written by the indexing model from the issue text.

Description

Hello!

I was wondering if eig and eigvals return the eigenvalues / vectors sorted from smallest to biggest or if they're unordered. This might also be a good thing to mention in the documentation. Maybe also say that the eigenvectors are normalized. (if they are but I presumed so)

Dominant language
Rust
Stars
452
Forks
95
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-ndarray/ndarray-linalg

All issues in rust-ndarray/ndarray-linalg

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.