fix: clarify that `condition` should have a boolean dtype in `where` · Saransh-cpp/array-api@f7d16ff · GitHub

Saransh-cpp / array-api Public

forked from data-apis/array-api

• Notifications You must be signed in to change notification settings
• Fork 0
• Star 0

• Code
• Pull requests
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit f7d16ff

Browse filesBrowse the repository at this point in the historyBrowse files

lucascolley

and

kgryte

authored

fix: clarify that condition should have a boolean dtype in where

PR-URL: data-apis#868 Ref: data-apis#116 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Ralf Gommers <ralf.gommers@gmail.com>

1 parent c492972 commit f7d16ff
Copy full SHA for f7d16ff

4 files changed

+4-4Lines changed: 4 additions & 4 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• src/array_api_stubs
  • _2021_12
    • searching_functions.py
  • _2022_12
    • searching_functions.py
  • _2023_12
    • searching_functions.py
  • _draft
    • searching_functions.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎src/array_api_stubs/_2021_12/searching_functions.py‎

Copy file name to clipboardExpand all lines: src/array_api_stubs/_2021_12/searching_functions.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -69,7 +69,7 @@ def where(condition: array, x1: array, x2: array, /) -> array:
69	69	Parameters
70	70	----------
71	71	condition: array
72		- when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
	72	+ when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Should have a boolean data type. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
73	73	x1: array
74	74	first input array. Must be compatible with ``condition`` and ``x2`` (see :ref:`broadcasting`).
75	75	x2: array

Collapse file

‎src/array_api_stubs/_2022_12/searching_functions.py‎

Copy file name to clipboardExpand all lines: src/array_api_stubs/_2022_12/searching_functions.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -91,7 +91,7 @@ def where(condition: array, x1: array, x2: array, /) -> array:
91	91	Parameters
92	92	----------
93	93	condition: array
94		- when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
	94	+ when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Should have a boolean data type. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
95	95	x1: array
96	96	first input array. Must be compatible with ``condition`` and ``x2`` (see :ref:`broadcasting`).
97	97	x2: array

Collapse file

‎src/array_api_stubs/_2023_12/searching_functions.py‎

Copy file name to clipboardExpand all lines: src/array_api_stubs/_2023_12/searching_functions.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -146,7 +146,7 @@ def where(condition: array, x1: array, x2: array, /) -> array:
146	146	Parameters
147	147	----------
148	148	condition: array
149		- when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
	149	+ when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Should have a boolean data type. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
150	150	x1: array
151	151	first input array. Must be compatible with ``condition`` and ``x2`` (see :ref:`broadcasting`).
152	152	x2: array

Collapse file

‎src/array_api_stubs/_draft/searching_functions.py‎

Copy file name to clipboardExpand all lines: src/array_api_stubs/_draft/searching_functions.py

+1-1Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -175,7 +175,7 @@ def where(condition: array, x1: array, x2: array, /) -> array:
175	175	Parameters
176	176	----------
177	177	condition: array
178		- when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
	178	+ when ``True``, yield ``x1_i``; otherwise, yield ``x2_i``. Should have a boolean data type. Must be compatible with ``x1`` and ``x2`` (see :ref:`broadcasting`).
179	179	x1: array
180	180	first input array. Must be compatible with ``condition`` and ``x2`` (see :ref:`broadcasting`).
181	181	x2: array

0 commit comments

Comments

0 (0)