77 < head >
88 < meta charset ="utf-8 " />
99 < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
10- < title > sed.binning.numba_bin — SED 0.1.10a6 documentation</ title >
10+ < title > sed.binning.numba_bin — SED 0.1.10a5 documentation</ title >
1111
1212
1313
3434< link rel ="preload " as ="script " href ="../../../_static/scripts/pydata-sphinx-theme.js?digest=3ee479438cf8b5e0d341 " />
3535 < script src ="../../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=3ee479438cf8b5e0d341 "> </ script >
3636
37- < script src ="../../../_static/documentation_options.js?v=7e069785 "> </ script >
37+ < script src ="../../../_static/documentation_options.js?v=49fe1def "> </ script >
3838 < script src ="../../../_static/doctools.js?v=9a2dae69 "> </ script >
3939 < script src ="../../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
4040 < script crossorigin ="anonymous " integrity ="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA= " src ="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js "> </ script >
4343 < script >
4444 DOCUMENTATION_OPTIONS . theme_version = '0.15.3' ;
4545 DOCUMENTATION_OPTIONS . theme_switcher_json_url = 'https://raw.githubusercontent.com/OpenCOMPES/docs/main/sed/switcher.json' ;
46- DOCUMENTATION_OPTIONS . theme_switcher_version_match = '0.1.10a6 ' ;
46+ DOCUMENTATION_OPTIONS . theme_switcher_version_match = '0.1.10a5 ' ;
4747 DOCUMENTATION_OPTIONS . show_version_warning_banner = true ;
4848 </ script >
4949 < link rel ="index " title ="Index " href ="../../../genindex.html " />
121121
122122
123123
124- < p class ="title logo__title "> SED 0.1.10a6 documentation</ p >
124+ < p class ="title logo__title "> SED 0.1.10a5 documentation</ p >
125125
126126</ a > </ div >
127127
448448 < h1 > Source code for sed.binning.numba_bin</ h1 > < div class ="highlight "> < pre >
449449< span > </ span > < span class ="sd "> """This file contains code for binning using numba precompiled code for the</ span >
450450< span class ="sd "> sed.binning module</ span >
451-
452451< span class ="sd "> """</ span >
452+ < span class ="kn "> from</ span > < span class ="nn "> __future__</ span > < span class ="kn "> import</ span > < span class ="n "> annotations</ span >
453+
454+ < span class ="kn "> from</ span > < span class ="nn "> collections.abc</ span > < span class ="kn "> import</ span > < span class ="n "> Sequence</ span >
453455< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> Any</ span >
454456< span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> cast</ span >
455- < span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> List</ span >
456- < span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> Sequence</ span >
457- < span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> Tuple</ span >
458- < span class ="kn "> from</ span > < span class ="nn "> typing</ span > < span class ="kn "> import</ span > < span class ="n "> Union</ span >
459457
460458< span class ="kn "> import</ span > < span class ="nn "> numba</ span >
461459< span class ="kn "> import</ span > < span class ="nn "> numpy</ span > < span class ="k "> as</ span > < span class ="nn "> np</ span >
@@ -472,7 +470,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
472470< span class ="sd "> bit integers.</ span >
473471
474472< span class ="sd "> Args:</ span >
475- < span class ="sd "> sample (np.ndarray): The data to be histogram'd with shape N,D.</ span >
473+ < span class ="sd "> sample (np.ndarray): The data to be histogrammed with shape N,D.</ span >
476474< span class ="sd "> bins (Sequence[int]): The number of bins for each dimension D.</ span >
477475< span class ="sd "> ranges (np.ndarray): A sequence of length D, each an optional (lower,</ span >
478476< span class ="sd "> upper) tuple giving the outer bin edges to be used if the edges are</ span >
@@ -497,7 +495,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
497495
498496 < span class ="k "> for</ span > < span class ="n "> i</ span > < span class ="ow "> in</ span > < span class ="nb "> range</ span > < span class ="p "> (</ span > < span class ="n "> ndims</ span > < span class ="p "> ):</ span >
499497 < span class ="n "> delta</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="mi "> 1</ span > < span class ="o "> /</ span > < span class ="p "> ((</ span > < span class ="n "> ranges</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ,</ span > < span class ="mi "> 1</ span > < span class ="p "> ]</ span > < span class ="o "> -</ span > < span class ="n "> ranges</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ,</ span > < span class ="mi "> 0</ span > < span class ="p "> ])</ span > < span class ="o "> /</ span > < span class ="n "> bins</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ])</ span >
500- < span class ="n "> strides</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="n "> hist</ span > < span class ="o "> .</ span > < span class ="n "> strides</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ]</ span > < span class ="o "> //</ span > < span class ="n "> hist</ span > < span class ="o "> .</ span > < span class ="n "> itemsize</ span >
498+ < span class ="n "> strides</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="n "> hist</ span > < span class ="o "> .</ span > < span class ="n "> strides</ span > < span class ="p "> [</ span > < span class ="n "> i</ span > < span class ="p "> ]</ span > < span class ="o "> //</ span > < span class ="n "> hist</ span > < span class ="o "> .</ span > < span class ="n "> itemsize</ span > < span class =" c1 " > # pylint: disable=E1136 </ span >
501499
502500 < span class ="k "> for</ span > < span class ="n "> t</ span > < span class ="ow "> in</ span > < span class ="nb "> range</ span > < span class ="p "> (</ span > < span class ="n "> sample</ span > < span class ="o "> .</ span > < span class ="n "> shape</ span > < span class ="p "> [</ span > < span class ="mi "> 0</ span > < span class ="p "> ]):</ span >
503501 < span class ="n "> is_inside</ span > < span class ="o "> =</ span > < span class ="kc "> True</ span >
@@ -559,7 +557,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
559557< span class ="k "> def</ span > < span class ="nf "> _hist_from_bins</ span > < span class ="p "> (</ span >
560558 < span class ="n "> sample</ span > < span class ="p "> :</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ,</ span >
561559 < span class ="n "> bins</ span > < span class ="p "> :</ span > < span class ="n "> Sequence</ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ],</ span >
562- < span class ="n "> shape</ span > < span class ="p "> :</ span > < span class ="n " > Tuple </ span > < span class ="p "> ,</ span >
560+ < span class ="n "> shape</ span > < span class ="p "> :</ span > < span class ="nb " > tuple </ span > < span class ="p "> ,</ span >
563561< span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> :</ span >
564562< span class ="w "> </ span > < span class ="sd "> """Numba powered binning method, similar to np.histogramdd.</ span >
565563
@@ -569,7 +567,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
569567< span class ="sd "> sample (np.ndarray) : the array of shape (N,D) on which to compute the histogram</ span >
570568< span class ="sd "> bins (Sequence[np.ndarray]): array of shape (N,D) defining the D bins on which</ span >
571569< span class ="sd "> to compute the histogram, i.e. the desired output axes.</ span >
572- < span class ="sd "> shape (Tuple ): shape of the resulting array. Workaround for the fact numba</ span >
570+ < span class ="sd "> shape (tuple ): shape of the resulting array. Workaround for the fact numba</ span >
573571< span class ="sd "> does not allow to create tuples.</ span >
574572< span class ="sd "> Returns:</ span >
575573< span class ="sd "> hist: the computed n-dimensional histogram</ span >
@@ -607,10 +605,10 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
607605< a class ="viewcode-back " href ="../../../sed/binning.html#sed.binning.numba_bin.numba_histogramdd "> [docs]</ a >
608606< span class ="k "> def</ span > < span class ="nf "> numba_histogramdd</ span > < span class ="p "> (</ span >
609607 < span class ="n "> sample</ span > < span class ="p "> :</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ,</ span >
610- < span class ="n "> bins</ span > < span class ="p "> :</ span > < span class ="n " > Union </ span > < span class ="p " > [ </ span > < span class ="nb " > int </ span > < span class ="p "> , </ span > < span class ="n " > Sequence </ span > < span class ="p "> [ </ span > < span class =" nb " > int </ span > < span class ="p " > ], </ span > < span class ="n "> Sequence</ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ], </ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ] ,</ span >
608+ < span class ="n "> bins</ span > < span class ="p "> :</ span > < span class ="nb " > int </ span > < span class ="o " > | </ span > < span class ="n " > Sequence </ span > < span class ="p "> [ </ span > < span class ="nb " > int </ span > < span class ="p "> ] </ span > < span class ="o " > | </ span > < span class ="n "> Sequence</ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ]</ span > < span class ="o " > | </ span > < span class =" n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ,</ span >
611609 < span class ="n "> ranges</ span > < span class ="p "> :</ span > < span class ="n "> Sequence</ span > < span class ="o "> =</ span > < span class ="kc "> None</ span > < span class ="p "> ,</ span >
612- < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="n " > Tuple </ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ,</ span > < span class ="n " > List </ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ]]:</ span >
613- < span class ="w "> </ span > < span class ="sd "> """Multidimensional histogram function, powered by Numba.</ span >
610+ < span class ="p "> )</ span > < span class ="o "> -></ span > < span class ="nb " > tuple </ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ,</ span > < span class ="nb " > list </ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ]]:</ span >
611+ < span class ="w "> </ span > < span class ="sd "> """Multidimensional histogramming function, powered by Numba.</ span >
614612
615613< span class ="sd "> Behaves in total much like numpy.histogramdd. Returns uint32 arrays.</ span >
616614< span class ="sd "> This was chosen because it has a significant performance improvement over</ span >
@@ -620,8 +618,8 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
620618< span class ="sd "> sizes.</ span >
621619
622620< span class ="sd "> Args:</ span >
623- < span class ="sd "> sample (np.ndarray): The data to be histogram'd with shape N,D</ span >
624- < span class ="sd "> bins (Union[ int, Sequence[int], Sequence[np.ndarray], np.ndarray] ): The number</ span >
621+ < span class ="sd "> sample (np.ndarray): The data to be histogrammed with shape N,D</ span >
622+ < span class ="sd "> bins (int | Sequence[int] | Sequence[np.ndarray] | np.ndarray): The number</ span >
625623< span class ="sd "> of bins for each dimension D, or a sequence of bin edges on which to calculate</ span >
626624< span class ="sd "> the histogram.</ span >
627625< span class ="sd "> ranges (Sequence, optional): The range(s) to use for binning when bins is a sequence</ span >
@@ -634,7 +632,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
634632< span class ="sd "> RuntimeError: Internal shape error after binning</ span >
635633
636634< span class ="sd "> Returns:</ span >
637- < span class ="sd "> Tuple [np.ndarray, List [np.ndarray]]: 2-element tuple of The computed histogram</ span >
635+ < span class ="sd "> tuple [np.ndarray, list [np.ndarray]]: 2-element tuple of The computed histogram</ span >
638636< span class ="sd "> and s list of D arrays describing the bin edges for each dimension.</ span >
639637
640638< span class ="sd "> - **hist**: The computed histogram</ span >
@@ -666,7 +664,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
666664
667665 < span class ="c1 "> # method == "array"</ span >
668666 < span class ="k "> if</ span > < span class ="nb "> isinstance</ span > < span class ="p "> (</ span > < span class ="n "> bins</ span > < span class ="p "> [</ span > < span class ="mi "> 0</ span > < span class ="p "> ],</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ):</ span >
669- < span class ="n "> bins</ span > < span class ="o "> =</ span > < span class ="n "> cast</ span > < span class ="p "> (</ span > < span class ="n " > List </ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ],</ span > < span class ="nb "> list</ span > < span class ="p "> (</ span > < span class ="n "> bins</ span > < span class ="p "> ))</ span >
667+ < span class ="n "> bins</ span > < span class ="o "> =</ span > < span class ="n "> cast</ span > < span class ="p "> (</ span > < span class ="nb " > list </ span > < span class ="p "> [</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> ndarray</ span > < span class ="p "> ],</ span > < span class ="nb "> list</ span > < span class ="p "> (</ span > < span class ="n "> bins</ span > < span class ="p "> ))</ span >
670668 < span class ="n "> hist</ span > < span class ="o "> =</ span > < span class ="n "> _hist_from_bins</ span > < span class ="p "> (</ span >
671669 < span class ="n "> sample</ span > < span class ="p "> ,</ span >
672670 < span class ="nb "> tuple</ span > < span class ="p "> (</ span > < span class ="n "> bins</ span > < span class ="p "> ),</ span >
@@ -692,7 +690,7 @@ <h1>Source code for sed.binning.numba_bin</h1><div class="highlight"><pre>
692690 < span class ="n "> bins</ span > < span class ="o "> =</ span > < span class ="nb "> tuple</ span > < span class ="p "> (</ span > < span class ="n "> bins</ span > < span class ="p "> )</ span >
693691
694692 < span class ="c1 "> # Create edge arrays</ span >
695- < span class ="n "> edges</ span > < span class ="p "> :</ span > < span class ="n " > List </ span > < span class ="p "> [</ span > < span class ="n "> Any</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="p "> []</ span >
693+ < span class ="n "> edges</ span > < span class ="p "> :</ span > < span class ="nb " > list </ span > < span class ="p "> [</ span > < span class ="n "> Any</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="p "> []</ span >
696694 < span class ="n "> nbin</ span > < span class ="o "> =</ span > < span class ="n "> np</ span > < span class ="o "> .</ span > < span class ="n "> empty</ span > < span class ="p "> (</ span > < span class ="n "> num_cols</ span > < span class ="p "> ,</ span > < span class ="nb "> int</ span > < span class ="p "> )</ span >
697695
698696 < span class ="k "> for</ span > < span class ="n "> i</ span > < span class ="ow "> in</ span > < span class ="nb "> range</ span > < span class ="p "> (</ span > < span class ="n "> num_cols</ span > < span class ="p "> ):</ span >
0 commit comments