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

docs: fix reference to eigh/eigvalsh #838

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions spec/2021.12/extensions/linear_algebra_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter

In general, interfaces should avoid polymorphic return values (e.g., returning an array **or** a namedtuple, dependent on, e.g., an optional keyword argument). Dedicated interfaces for each return value type are preferred, as dedicated interfaces are easier to reason about at both the implementation level and user level. Example interfaces which could be combined into a single overloaded interface, but are not, include:

- ``eig``: computing both eigenvalues and eignvectors.
- ``eigvals``: computing only eigenvalues.
- ``eigh``: computing both eigenvalues and eigenvectors.
- ``eigvalsh``: computing only eigenvalues.

4. **Implementation agnosticism**: a standardized interface should eschew parameterization (including keyword arguments) biased toward particular implementations.

Expand Down
4 changes: 2 additions & 2 deletions spec/2022.12/extensions/linear_algebra_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter

In general, interfaces should avoid polymorphic return values (e.g., returning an array **or** a namedtuple, dependent on, e.g., an optional keyword argument). Dedicated interfaces for each return value type are preferred, as dedicated interfaces are easier to reason about at both the implementation level and user level. Example interfaces which could be combined into a single overloaded interface, but are not, include:

- ``eig``: computing both eigenvalues and eignvectors.
- ``eigvals``: computing only eigenvalues.
- ``eigh``: computing both eigenvalues and eigenvectors.
- ``eigvalsh``: computing only eigenvalues.

4. **Implementation agnosticism**: a standardized interface should eschew parameterization (including keyword arguments) biased toward particular implementations.

Expand Down
4 changes: 2 additions & 2 deletions spec/2023.12/extensions/linear_algebra_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter

In general, interfaces should avoid polymorphic return values (e.g., returning an array **or** a namedtuple, dependent on, e.g., an optional keyword argument). Dedicated interfaces for each return value type are preferred, as dedicated interfaces are easier to reason about at both the implementation level and user level. Example interfaces which could be combined into a single overloaded interface, but are not, include:

- ``eig``: computing both eigenvalues and eignvectors.
- ``eigvals``: computing only eigenvalues.
- ``eigh``: computing both eigenvalues and eigenvectors.
- ``eigvalsh``: computing only eigenvalues.

4. **Implementation agnosticism**: a standardized interface should eschew parameterization (including keyword arguments) biased toward particular implementations.

Expand Down
4 changes: 2 additions & 2 deletions spec/draft/extensions/linear_algebra_functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter

In general, interfaces should avoid polymorphic return values (e.g., returning an array **or** a namedtuple, dependent on, e.g., an optional keyword argument). Dedicated interfaces for each return value type are preferred, as dedicated interfaces are easier to reason about at both the implementation level and user level. Example interfaces which could be combined into a single overloaded interface, but are not, include:

- ``eig``: computing both eigenvalues and eignvectors.
- ``eigvals``: computing only eigenvalues.
- ``eigh``: computing both eigenvalues and eigenvectors.
- ``eigvalsh``: computing only eigenvalues.

4. **Implementation agnosticism**: a standardized interface should eschew parameterization (including keyword arguments) biased toward particular implementations.

Expand Down
Loading