77
88 <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
99 < title > array_api_extra.at - array-api-extra 0.5.1.dev0 documentation</ title >
10- < link rel ="stylesheet " type ="text/css " href ="../_static/pygments.css?v=a746c00c " />
10+ < link rel ="stylesheet " type ="text/css " href ="../_static/pygments.css?v=8f2a1f02 " />
1111 < link rel ="stylesheet " type ="text/css " href ="../_static/styles/furo.css?v=354aac6f " />
1212 < link rel ="stylesheet " type ="text/css " href ="../_static/copybutton.css?v=76b2166b " />
1313 < link rel ="stylesheet " type ="text/css " href ="../_static/styles/furo-extensions.css?v=302659d7 " />
@@ -274,7 +274,7 @@ <h1>array_api_extra.at<a class="headerlink" href="#array-api-extra-at" title="Li
274274< li > < p > < strong > idx</ strong > (< em > index</ em > < em > , </ em > < em > optional</ em > ) – < p > Only < a class ="reference external " href ="https://data-apis.org/array-api/latest/API_specification/indexing.html "> array API standard compliant indices</ a >
275275are supported.</ p >
276276< p > You may use two alternate syntaxes:</ p >
277- < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class ="nn "> array_api_extra</ span > < span class ="k "> as</ span > < span class ="nn "> xpx</ span >
277+ < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class =" w " > </ span > < span class ="nn "> array_api_extra</ span > < span class =" w " > </ span > < span class ="k "> as</ span > < span class =" w " > </ span > < span class ="nn "> xpx</ span >
278278< span class ="gp "> >>> </ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n "> idx</ span > < span class ="p "> )</ span > < span class ="o "> .</ span > < span class ="n "> set</ span > < span class ="p "> (</ span > < span class ="n "> value</ span > < span class ="p "> )</ span > < span class ="c1 "> # or add(value), etc.</ span >
279279< span class ="gp "> >>> </ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> )[</ span > < span class ="n "> idx</ span > < span class ="p "> ]</ span > < span class ="o "> .</ span > < span class ="n "> set</ span > < span class ="p "> (</ span > < span class ="n "> value</ span > < span class ="p "> )</ span >
280280</ pre > </ div >
@@ -303,7 +303,7 @@ <h1>array_api_extra.at<a class="headerlink" href="#array-api-extra-at" title="Li
303303< p class ="admonition-title "> Warning</ p >
304304< p > (a) When you omit the < code class ="docutils literal notranslate "> < span class ="pre "> copy</ span > </ code > parameter, you should never reuse the parameter
305305array later on; ideally, you should reassign it immediately:</ p >
306- < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class ="nn "> array_api_extra</ span > < span class ="k "> as</ span > < span class ="nn "> xpx</ span >
306+ < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class =" w " > </ span > < span class ="nn "> array_api_extra</ span > < span class =" w " > </ span > < span class ="k "> as</ span > < span class =" w " > </ span > < span class ="nn "> xpx</ span >
307307< span class ="gp "> >>> </ span > < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="mi "> 0</ span > < span class ="p "> )</ span > < span class ="o "> .</ span > < span class ="n "> set</ span > < span class ="p "> (</ span > < span class ="mi "> 2</ span > < span class ="p "> )</ span >
308308</ pre > </ div >
309309</ div >
@@ -338,9 +338,9 @@ <h1>array_api_extra.at<a class="headerlink" href="#array-api-extra-at" title="Li
338338The behaviour of update methods when the index is an array of integers is
339339undefined and will vary between backends; this is particularly true when the
340340index contains multiple occurrences of the same index, e.g.:</ p >
341- < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class ="nn "> numpy</ span > < span class ="k "> as</ span > < span class ="nn "> np</ span >
342- < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class ="nn "> jax.numpy</ span > < span class ="k "> as</ span > < span class ="nn "> jnp</ span >
343- < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class ="nn "> array_api_extra</ span > < span class ="k "> as</ span > < span class ="nn "> xpx</ span >
341+ < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class =" w " > </ span > < span class ="nn "> numpy</ span > < span class =" w " > </ span > < span class ="k "> as</ span > < span class =" w " > </ span > < span class ="nn "> np</ span >
342+ < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class =" w " > </ span > < span class ="nn "> jax.numpy</ span > < span class =" w " > </ span > < span class ="k "> as</ span > < span class =" w " > </ span > < span class ="nn "> jnp</ span >
343+ < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class =" w " > </ span > < span class ="nn "> array_api_extra</ span > < span class =" w " > </ span > < span class ="k "> as</ span > < span class =" w " > </ span > < span class ="nn "> xpx</ span >
344344< span class ="gp "> >>> </ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> ([</ span > < span class ="mi "> 123</ span > < span class ="p "> ]),</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> ([</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span > < span class ="mi "> 0</ span > < span class ="p "> ]))</ span > < span class ="o "> .</ span > < span class ="n "> add</ span > < span class ="p "> (</ span > < span class ="mi "> 1</ span > < span class ="p "> )</ span >
345345< span class ="go "> array([124])</ span >
346346< span class ="gp "> >>> </ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> jnp</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> ([</ span > < span class ="mi "> 123</ span > < span class ="p "> ]),</ span > < span class ="n "> jnp</ span > < span class ="o "> .</ span > < span class ="n "> asarray</ span > < span class ="p "> ([</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span > < span class ="mi "> 0</ span > < span class ="p "> ]))</ span > < span class ="o "> .</ span > < span class ="n "> add</ span > < span class ="p "> (</ span > < span class ="mi "> 1</ span > < span class ="p "> )</ span >
@@ -361,7 +361,7 @@ <h1>array_api_extra.at<a class="headerlink" href="#array-api-extra-at" title="Li
361361methods.</ p >
362362< p class ="rubric "> Examples</ p >
363363< p > Given either of these equivalent expressions:</ p >
364- < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class ="nn "> array_api_extra</ span > < span class ="k "> as</ span > < span class ="nn "> xpx</ span >
364+ < div class ="highlight-default notranslate "> < div class ="highlight "> < pre > < span > </ span > < span class ="gp "> >>> </ span > < span class ="kn "> import</ span > < span class =" w " > </ span > < span class ="nn "> array_api_extra</ span > < span class =" w " > </ span > < span class ="k "> as</ span > < span class =" w " > </ span > < span class ="nn "> xpx</ span >
365365< span class ="gp "> >>> </ span > < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> )[</ span > < span class ="mi "> 1</ span > < span class ="p "> ]</ span > < span class ="o "> .</ span > < span class ="n "> add</ span > < span class ="p "> (</ span > < span class ="mi "> 2</ span > < span class ="p "> )</ span >
366366< span class ="gp "> >>> </ span > < span class ="n "> x</ span > < span class ="o "> =</ span > < span class ="n "> xpx</ span > < span class ="o "> .</ span > < span class ="n "> at</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="mi "> 1</ span > < span class ="p "> )</ span > < span class ="o "> .</ span > < span class ="n "> add</ span > < span class ="p "> (</ span > < span class ="mi "> 2</ span > < span class ="p "> )</ span >
367367</ pre > </ div >
0 commit comments