Skip to content

Commit 0cd4bdf

Browse files
authored
docs: fix reference to eigh/eigvalsh
PR-URL: #838 Reviewed-by: Athan Reines <[email protected]>
1 parent b2e232b commit 0cd4bdf

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

spec/2021.12/extensions/linear_algebra_functions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter
4848

4949
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:
5050

51-
- ``eig``: computing both eigenvalues and eignvectors.
52-
- ``eigvals``: computing only eigenvalues.
51+
- ``eigh``: computing both eigenvalues and eigenvectors.
52+
- ``eigvalsh``: computing only eigenvalues.
5353

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

spec/2022.12/extensions/linear_algebra_functions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter
5151

5252
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:
5353

54-
- ``eig``: computing both eigenvalues and eignvectors.
55-
- ``eigvals``: computing only eigenvalues.
54+
- ``eigh``: computing both eigenvalues and eigenvectors.
55+
- ``eigvalsh``: computing only eigenvalues.
5656

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

spec/2023.12/extensions/linear_algebra_functions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter
5151

5252
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:
5353

54-
- ``eig``: computing both eigenvalues and eignvectors.
55-
- ``eigvals``: computing only eigenvalues.
54+
- ``eigh``: computing both eigenvalues and eigenvectors.
55+
- ``eigvalsh``: computing only eigenvalues.
5656

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

spec/draft/extensions/linear_algebra_functions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Accordingly, the standardization process affords the opportunity to reduce inter
5151

5252
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:
5353

54-
- ``eig``: computing both eigenvalues and eignvectors.
55-
- ``eigvals``: computing only eigenvalues.
54+
- ``eigh``: computing both eigenvalues and eigenvectors.
55+
- ``eigvalsh``: computing only eigenvalues.
5656

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

0 commit comments

Comments
 (0)