S_f1zUdZddlmZddlZddlZddlZddlmZddl m Z m Z mZ gdZ ejjddZd ed<ejjd d Zeed Zd ZdZdZ d!ddddZdddZdddZdZdZdZ d"dZdZdZ d#dZ d$dZ! d%dZ"dddZ#dZ$d Z%y)&a6Utility functions to use Python Array API compatible libraries. For the context about the Array API see: https://data-apis.org/array-api/latest/purpose_and_scope.html The SciPy use case of the Array API is described on the following page: https://data-apis.org/array-api/latest/use_cases.html#use-case-scipy ) annotationsN)array_api_compat)is_array_api_objsizenumpy)array_namespace_asarrayrSCIPY_ARRAY_APIFz str | bool SCIPY_DEVICEcpu)r r cTtt|D]w}||}t|tjj r t dt|tjr t dt|tjtjfre|j}tj|tjrtj|tjrt d|dt|r tj|}|j}tj|tjs5tj|tjsd|d}t ||||<z|S#t $r t dwxYw)aRaise exceptions on known-bad subclasses. The following subclasses are not supported and raise and error: - `numpy.ma.MaskedArray` - `numpy.matrix` - NumPy arrays which do not have a boolean or numerical dtype - Any array-like which is neither array API compatible nor coercible by NumPy - Any array-like which is coerced by NumPy to an unsupported dtype z8Inputs of type `numpy.ma.MaskedArray` are not supported.z0Inputs of type `numpy.matrix` are not supported.zAn argument has dtype `z3`; only boolean and numerical dtypes are supported.zCAn argument is neither array API compatible nor coercible by NumPy.z1An argument was coerced to an unsupported dtype `)rangelen isinstancenpma MaskedArray TypeErrormatrixndarraygenericdtype issubdtypenumberbool_r asanyarray)arraysiarrayrmessages 5lib/python3.12/site-packages/scipy/_lib/_array_api.pycompliance_scipyr"%sg3v; q  eRUU.. /VW W ryy )NO O ebjj"**5 6KKEMM%3r}}UBHH7U"9%CS!TUU!%( 7 e,KKEMM%3r}}UBHH7UGyQGH ((F1I12 M 7!677 7s FF'cd} |j|j|s t|y#t$r t|wxYw)zCheck for NaNs or Infs.z#array must not contain infs or NaNsN)allisfinite ValueErrorr)rxpmsgs r! _check_finiter)KsI /Cvvbkk%()S/ !* os +0ActdstS|Dcgc]}|| }}t|}tj|Scc}w)a0Get the array API compatible namespace for the arrays xs. Parameters ---------- *arrays : sequence of array_like Arrays used to infer the common namespace. Returns ------- namespace : module Common namespace. Notes ----- Thin wrapper around `array_api_compat.array_namespace`. 1. Check for the global switch: SCIPY_ARRAY_API. This can also be accessed dynamically through ``_GLOBAL_CONFIG['SCIPY_ARRAY_API']``. 2. `compliance_scipy` raise exceptions on known-bad subclasses. See its definition for more details. When the global switch is False, it defaults to the `numpy` namespace. In that case, there is no compliance check. This is a convenience to ease the adoption. Otherwise, arrays must comply with the new rules. r )_GLOBAL_CONFIG np_compatr"rr)rrs r!rrUsK4 + ,!' =5+s??)r' check_finitec| t|}|jdvrG|durtj|||}ntj|||}|j |}n |j |||}|r t |||S#t $r1t|j d}|j |||}YIwxYw)aSciPy-specific replacement for `np.asarray` with `order` and `check_finite`. Memory layout parameter `order` is not exposed in the Array API standard. `order` is only enforced if the input array implementation is NumPy based, otherwise `order` is just silently ignored. `check_finite` is also not a keyword in the array API standard; included here for convenience rather than that having to be a separate function call inside SciPy functions. >r!scipy._lib.array_api_compat.numpyT)orderr)rcopy)r__name__rrasarrayrr))rrr0r1r'r- coerced_xps r!r r zs z U # {{DD 4<HHU%u=EJJuE?E 5! FJJuEJ=E eR L F(A7J&&uE&EE Fs$B7CCr'c| t|}|j|}|j|kr!|j|d}t |||}|S)z9Recursively expand the dimension to have at least `ndim`.raxisndimr')rr4r; expand_dims atleast_nd)xr;r's r!r=r=sN z Q  1 Avv} NN11N % qt + Hc8| t|}t|d|S)a3 Copies an array. Parameters ---------- x : array xp : array_namespace Returns ------- copy : array Copied array Notes ----- This copy function does not offer all the semantics of `np.copy`, i.e. the `subok` and `order` keywords are not used. T)r1r')rr r>r's r!r1r1s"* z Q  ADR ((r?c|jdvS)N)rr/r3r6s r!is_numpyrD ;;H HHr?c|jdvS)N)cupyz scipy._lib.array_api_compat.cupyrCr6s r!is_cupyrHs ;;F FFr?c|jdvS)N)torchz!scipy._lib.array_api_compat.torchrCr6s r!is_torchrKrEr?c*d}|r t|||j|}|r"d}|j|jk(sJ||r/d}|j|jk(sJ|t ||||j ||j}|S)NTzDdtypes do not match. Actual: {actual.dtype} Desired: {desired.dtype}zDShapes do not match. Actual: {actual.shape} Desired: {desired.shape})_assert_matching_namespacer4rshape _check_scalar broadcast_to)actualdesiredr'check_namespace check_dtype check_shape__tracebackhide___msgs r! _strict_checkrXs"673jj!GW||w}},2d2,W||w}},2d2,fgr*oogv||4G Nr?cd}t|tr|n|f}t|}|D]5}t|}d|jd|j}||k(r0J|y)NTz!Namespaces do not match. Actual: z Desired: )rtuplerr3)rQrRrV desired_spacearr arr_spacerWs r!rMrMs{!&%0VviF#G,M0#C( $--./)2235M)/4/) 0r?cd}|jdk7s t|sy|d}dt|dt|}|j|r|j|s*|j|s|j|rJ|yy)NTzTypes do not match: Actual: z Desired: )rNrDtypeisscalar)rQrRr'rVrWs r!rOrOs}}(2,bkG +DL>d7m_ UD KK BKK$8KK' G0DMHLM F0D%9r?c Dd}| t|}t||||||}t|r|jj |||St |r+|dk(rdn|}|jj ||dddd|Stjj |||S)NTrSrTrU)err_msgrFrtolatol equal_nanrTr()rrXrHtestingassert_array_equalrK assert_closer)rQrRrSrTrUrdr'rVs r!xp_assert_equalrm s z V $FGR(3NGr{zz,,VWg,NN ""R-$Wzz&&vwQQRV38g'G G :: ( (' ( JJr?c Ld} | t|}t||||||}t|r |jj |||||St |r+|dk(rdn|}|jj ||||dd|Stjj |||||S)NTrc)rgrhrdreFrf)rrXrHrjassert_allcloserKrlr) rQrRrgrhrSrTrUrdr'rVs r!xp_assert_closerps z V $FGR(3NGr{zz))&'/3W*F F "!R-$Wzz&&vwT155g'W W :: % %fgD+/ & BBr?cd}| t|}t||||||}t|r|jj ||||St |rR|j jdk7r|j}|j jdk7r|j}tjj ||||S)NTrc)rdverboser ) rrXrHrjassert_array_lessrKdevicer`r r) rQrRrSrTrUrdrrr'rVs r!xp_assert_lessru0s z V $FGR(3NGr{zz++FG4;W,N N " ==   &ZZ\F >>  % 'kkmG :: ' '07 ( JJr?cN| t|}t||}|j||j}t |d|}|j ||}|j |d}|jddz }|dkrtjdtd d }||dddfz}|j}|j|jd r|j|}||z}||z}td t!|jD}|j#||S) Nr6r:)rr8rz!Degrees of freedom <= 0 for slice) stacklevelgcomplex floatingc32K|]\}}|dk(s |yw)rxNr_).0r9lengths r! zcov..[sL,$! Ls )rr1 result_typefloat64r=r4meanrNwarningswarnRuntimeWarningTisdtyperconjrZ enumeratesqueeze) r>r'XravgfactX_Tcaxess r!covrCs  z Q  Q2A NN1bjj )E11$A 1E "A ''!!' C 771:>D qy 9$ 4QWA ##C zz#))/0ggcl CAIA L)AGG*<L LD ::ad: ##r?cd|dS)Nz Providing z$ is only supported for numpy arrays.r_)params r!xp_unsupported_param_msgr_s y D EEr?c:|j|jdS)Nrz)rrrAs r! is_complexrcs ::agg1 22r?)NNN)TTT)TTTreN)gHz>rTTTreN)TTTreTN)&__doc__ __future__rosrrr scipy._librscipy._lib.array_api_compatrrr,__all__environgetr __annotations__r r+r"r)rr r=r1rDrHrKrXrMrOrmrprurrrr_r?r!rs# ' 2!jjnn->FFzz~~ne4 '  #L"5L)-#48u#L# )6IGI GK* 0M2HL59K$JNGKB$GKBFJ&$8F3r?