Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ammend documentation for array W #114

Open
talassio opened this issue Jun 4, 2024 · 0 comments
Open

Ammend documentation for array W #114

talassio opened this issue Jun 4, 2024 · 0 comments
Assignees
Labels
docs Documentation fix

Comments

@talassio
Copy link
Collaborator

talassio commented Jun 4, 2024

The documentation for the "weights" array states:

weights (n) [real] :: If present, this holds the square-roots of the diagonal entries of the weighting matrix, {\bm W}. If absent, then the norm in the least squares problem is taken to be the 2-norm, that is, {\bm W} = I.
  1. These weights are not checked for non-negative values, the documentation should reflect this along with informing that the weights array is not preprocessed, e.g. not normalized, etc.
  2. If absent then W=I, it is not clear what values should the user pass to have the same effect as W=I, since w=array(n, 1.0) does not produce the same solution point has w=NULL.
@talassio talassio added the docs Documentation fix label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation fix
Projects
None yet
Development

No branches or pull requests

2 participants