NotificationsYou must be signed in to change notification settings
Fork54
Star262

Commit1acd41c

committed

feat: addbroadcast_shapes to the specification

1 parent6fd5129 commit1acd41cCopy full SHA for 1acd41c

File tree

2 files changed

+30

-0

lines changed

spec/draft/API_specification
- manipulation_functions.rst
src/array_api_stubs/_draft
- manipulation_functions.py

2 files changed

+30

-0

lines changed

`‎spec/draft/API_specification/manipulation_functions.rst‎`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ Objects in API`
`19`	`19`	`:template: method.rst`
`20`	`20`
`21`	`21`	`broadcast_arrays`
	`22`	`+ broadcast_shapes`
`22`	`23`	`broadcast_to`
`23`	`24`	`concat`
`24`	`25`	`expand_dims`

`‎src/array_api_stubs/_draft/manipulation_functions.py‎`

Lines changed: 29 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,35 @@ def broadcast_arrays(*arrays: array) -> List[array]:`
`35`	`35`	`"""`
`36`	`36`
`37`	`37`
	`38`	`+defbroadcast_shapes(*shapes:Tuple[int, ...])->Tuple[int, ...]:`
	`39`	`+"""`
	`40`	`+ Broadcasts one or more shapes against one another.`
	`41`	`+`
	`42`	`+ Parameters`
	`43`	`+ ----------`
	`44`	`+ shapes: Tuple[int, ...]`
	`45`	`+ an arbitrary number of to-be broadcasted shapes.`
	`46`	`+`
	`47`	`+ Returns`
	`48`	`+ -------`
	`49`	`+ out: Tuple[int, ...]`
	`50`	`+ a broadcasted shape.`
	`51`	`+`
	`52`	`+ Raises`
	`53`	`+ ------`
	`54`	`+ ValueError`
	`55`	+ If provided shapes which are not broadcast compatible (see :ref:`broadcasting`), a ``ValueError`` should be raised.
	`56`	`+`
	`57`	`+ Notes`
	`58`	`+ -----`
	`59`	`+`
	`60`	`+ - If not provided one or more arguments, the function must return an empty tuple.`
	`61`	`+`
	`62`	`+ .. note::`
	`63`	+ Array libraries which build computation graphs (e.g., ndonnx and Dask) commonly support shapes having dimensions of unknown size. If a shape contains a value other than an integer (e.g., ``None`` for a dimension of unknown size), behavior is unspecified and thus implementation-defined. Array-conforming libraries may choose to propagate such values (e.g., if a shape contains a dimension size of ``None``, the returned broadcasted shape also has a corresponding dimension having a size equal to ``None``) or raise an exception.
	`64`	`+ """`
	`65`	`+`
	`66`	`+`
`38`	`67`	`defbroadcast_to(x:array,/,shape:Tuple[int, ...])->array:`
`39`	`68`	`"""`
`40`	`69`	`Broadcasts an array to a specified shape.`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit1acd41c

File tree

2 files changed

2 files changed

`‎spec/draft/API_specification/manipulation_functions.rst‎`

`‎src/array_api_stubs/_draft/manipulation_functions.py‎`

0 commit comments