1414 </ script >
1515
1616 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
17- < title > dpnp.dpnp_iface_histograms — Data Parallel Extension for NumPy 0.17.0dev5+35.g38ae39152c4 documentation</ title >
17+ < title > dpnp.dpnp_iface_histograms — Data Parallel Extension for NumPy 0.17.0rc1+8.g45e89266b40 documentation</ title >
1818 < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=03e43079 " />
1919 < link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=e59714d7 " />
2020
2121
2222 < script src ="../../_static/jquery.js?v=5d32c60e "> </ script >
2323 < script src ="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
24- < script src ="../../_static/documentation_options.js?v=921c25b4 "> </ script >
24+ < script src ="../../_static/documentation_options.js?v=77d536e3 "> </ script >
2525 < script src ="../../_static/doctools.js?v=9bcbadda "> </ script >
2626 < script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
2727 < script src ="../../_static/js/theme.js "> </ script >
@@ -310,17 +310,23 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
310310
311311
312312< span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> _bincount_validate</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n "> weights</ span > < span class ="p "> ,</ span > < span class ="n "> minlength</ span > < span class ="p "> ):</ span >
313+ < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> check_supported_arrays_type</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> )</ span >
313314 < span class ="k "> if</ span > < span class ="n "> x</ span > < span class ="o "> .</ span > < span class ="n "> ndim</ span > < span class ="o "> ></ span > < span class ="mi "> 1</ span > < span class ="p "> :</ span >
314315 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "object too deep for desired array"</ span > < span class ="p "> )</ span >
316+
315317 < span class ="k "> if</ span > < span class ="n "> x</ span > < span class ="o "> .</ span > < span class ="n "> ndim</ span > < span class ="o "> <</ span > < span class ="mi "> 1</ span > < span class ="p "> :</ span >
316318 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "object of too small depth for desired array"</ span > < span class ="p "> )</ span >
319+
317320 < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> issubdtype</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> integer</ span > < span class ="p "> )</ span > < span class ="ow "> and</ span > < span class ="ow "> not</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> issubdtype</ span > < span class ="p "> (</ span >
318321 < span class ="n "> x</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> bool</ span >
319322 < span class ="p "> ):</ span >
320323 < span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span > < span class ="s2 "> "x must be an integer array"</ span > < span class ="p "> )</ span >
324+
321325 < span class ="k "> if</ span > < span class ="n "> weights</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
326+ < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> check_supported_arrays_type</ span > < span class ="p "> (</ span > < span class ="n "> weights</ span > < span class ="p "> )</ span >
322327 < span class ="k "> if</ span > < span class ="n "> x</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span > < span class ="o "> !=</ span > < span class ="n "> weights</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span > < span class ="p "> :</ span >
323328 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "The weights and x don't have the same length."</ span > < span class ="p "> )</ span >
329+
324330 < span class ="k "> if</ span > < span class ="ow "> not</ span > < span class ="p "> (</ span >
325331 < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> issubdtype</ span > < span class ="p "> (</ span > < span class ="n "> weights</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> integer</ span > < span class ="p "> )</ span >
326332 < span class ="ow "> or</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> issubdtype</ span > < span class ="p "> (</ span > < span class ="n "> weights</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="p "> ,</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> floating</ span > < span class ="p "> )</ span >
@@ -330,10 +336,12 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
330336 < span class ="sa "> f</ span > < span class ="s2 "> "Weights must be integer or float. Got </ span > < span class ="si "> {</ span > < span class ="n "> weights</ span > < span class ="o "> .</ span > < span class ="n "> dtype</ span > < span class ="si "> }</ span > < span class ="s2 "> "</ span >
331337 < span class ="p "> )</ span >
332338
333- < span class ="k "> if</ span > < span class ="n "> minlength</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
334- < span class ="n "> minlength</ span > < span class ="o "> =</ span > < span class ="nb "> int</ span > < span class ="p "> (</ span > < span class ="n "> minlength</ span > < span class ="p "> )</ span >
335- < span class ="k "> if</ span > < span class ="n "> minlength</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="p "> :</ span >
336- < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "minlength must be non-negative"</ span > < span class ="p "> )</ span >
339+ < span class ="k "> if</ span > < span class ="n "> minlength</ span > < span class ="ow "> is</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
340+ < span class ="k "> raise</ span > < span class ="ne "> TypeError</ span > < span class ="p "> (</ span > < span class ="s2 "> "use 0 instead of None for minlength"</ span > < span class ="p "> )</ span >
341+
342+ < span class ="n "> minlength</ span > < span class ="o "> =</ span > < span class ="nb "> int</ span > < span class ="p "> (</ span > < span class ="n "> minlength</ span > < span class ="p "> )</ span >
343+ < span class ="k "> if</ span > < span class ="n "> minlength</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="p "> :</ span >
344+ < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "minlength must be non-negative"</ span > < span class ="p "> )</ span >
337345
338346
339347< span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> _bincount_run_native</ span > < span class ="p "> (</ span >
@@ -347,9 +355,7 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
347355 < span class ="k "> if</ span > < span class ="n "> min_v</ span > < span class ="o "> <</ span > < span class ="mi "> 0</ span > < span class ="p "> :</ span >
348356 < span class ="k "> raise</ span > < span class ="ne "> ValueError</ span > < span class ="p "> (</ span > < span class ="s2 "> "x argument must have no negative arguments"</ span > < span class ="p "> )</ span >
349357
350- < span class ="n "> size</ span > < span class ="o "> =</ span > < span class ="nb "> int</ span > < span class ="p "> (</ span > < span class ="n "> dpnp</ span > < span class ="o "> .</ span > < span class ="n "> max</ span > < span class ="p "> (</ span > < span class ="n "> max_v</ span > < span class ="p "> ))</ span > < span class ="o "> +</ span > < span class ="mi "> 1</ span >
351- < span class ="k "> if</ span > < span class ="n "> minlength</ span > < span class ="ow "> is</ span > < span class ="ow "> not</ span > < span class ="kc "> None</ span > < span class ="p "> :</ span >
352- < span class ="n "> size</ span > < span class ="o "> =</ span > < span class ="nb "> max</ span > < span class ="p "> (</ span > < span class ="n "> size</ span > < span class ="p "> ,</ span > < span class ="n "> minlength</ span > < span class ="p "> )</ span >
358+ < span class ="n "> size</ span > < span class ="o "> =</ span > < span class ="nb "> max</ span > < span class ="p "> (</ span > < span class ="nb "> int</ span > < span class ="p "> (</ span > < span class ="n "> max_v</ span > < span class ="p "> )</ span > < span class ="o "> +</ span > < span class ="mi "> 1</ span > < span class ="p "> ,</ span > < span class ="n "> minlength</ span > < span class ="p "> )</ span >
353359
354360 < span class ="c1 "> # bincount implementation uses atomics, but atomics doesn't work with</ span >
355361 < span class ="c1 "> # host usm memory</ span >
@@ -386,9 +392,9 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
386392
387393< div class ="viewcode-block " id ="bincount ">
388394< a class ="viewcode-back " href ="../../reference/generated/dpnp.bincount.html#dpnp.bincount "> [docs]</ a >
389- < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> bincount</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n "> weights</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> minlength</ span > < span class ="o "> =</ span > < span class ="kc " > None </ span > < span class ="p "> ):</ span >
395+ < span class ="k "> def</ span > < span class ="w "> </ span > < span class ="nf "> bincount</ span > < span class ="p "> (</ span > < span class ="n "> x</ span > < span class ="p "> ,</ span > < span class ="n "> weights</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span > < span class ="n "> minlength</ span > < span class ="o "> =</ span > < span class ="mi " > 0 </ span > < span class ="p "> ):</ span >
390396< span class ="w "> </ span > < span class ="sd "> """</ span >
391- < span class ="sd "> bincount(x, /, weights=None, minlength=None )</ span >
397+ < span class ="sd "> bincount(x, /, weights=None, minlength=0 )</ span >
392398
393399< span class ="sd "> Count number of occurrences of each value in array of non-negative ints.</ span >
394400
@@ -400,10 +406,12 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
400406< span class ="sd "> Input 1-dimensional array with non-negative integer values.</ span >
401407< span class ="sd "> weights : {None, dpnp.ndarray, usm_ndarray}, optional</ span >
402408< span class ="sd "> Weights, array of the same shape as `x`.</ span >
409+
403410< span class ="sd "> Default: ``None``</ span >
404- < span class ="sd "> minlength : {None, int} , optional</ span >
411+ < span class ="sd "> minlength : int, optional</ span >
405412< span class ="sd "> A minimum number of bins for the output array.</ span >
406- < span class ="sd "> Default: ``None``</ span >
413+
414+ < span class ="sd "> Default: ``0``</ span >
407415
408416< span class ="sd "> Returns</ span >
409417< span class ="sd "> -------</ span >
@@ -506,6 +514,7 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
506514< span class ="sd "> increasing or decreasing.</ span >
507515< span class ="sd "> right : bool, optional</ span >
508516< span class ="sd "> Indicates whether the intervals include the right or the left bin edge.</ span >
517+
509518< span class ="sd "> Default: ``False``.</ span >
510519
511520< span class ="sd "> Returns</ span >
@@ -771,6 +780,7 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
771780< span class ="sd "> given range.</ span >
772781< span class ="sd "> If `bins` is a sequence, it defines the bin edges, including the</ span >
773782< span class ="sd "> rightmost edge, allowing for non-uniform bin widths.</ span >
783+
774784< span class ="sd "> Default: ``10``.</ span >
775785< span class ="sd "> range : {None, 2-tuple of float}, optional</ span >
776786< span class ="sd "> The lower and upper range of the bins. If not provided, range is simply</ span >
@@ -779,12 +789,14 @@ <h1>Source code for dpnp.dpnp_iface_histograms</h1><div class="highlight"><pre>
779789< span class ="sd "> affects the automatic bin computation as well. While bin width is</ span >
780790< span class ="sd "> computed to be optimal based on the actual data within `range`, the bin</ span >
781791< span class ="sd "> count will fill the entire range including portions containing no data.</ span >
792+
782793< span class ="sd "> Default: ``None``.</ span >
783794< span class ="sd "> weights : {None, dpnp.ndarray, usm_ndarray}, optional</ span >
784795< span class ="sd "> An array of weights, of the same shape as `a`. Each value in `a` only</ span >
785796< span class ="sd "> contributes its associated weight towards the bin count (instead of 1).</ span >
786797< span class ="sd "> This is currently not used by any of the bin estimators, but may be in</ span >
787798< span class ="sd "> the future.</ span >
799+
788800< span class ="sd "> Default: ``None``.</ span >
789801
790802< span class ="sd "> Returns</ span >
0 commit comments