Skip to content

Commit

Permalink
docs: fix reference to eigh/eigvalsh
Browse files Browse the repository at this point in the history
PR-URL: #838
Reviewed-by: Athan Reines <[email protected]>
  • Loading branch information
mdhaber committed Aug 27, 2024
1 parent b2e232b commit 0cd4bdf
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
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

0 comments on commit 0cd4bdf

Please sign in to comment.