Skip to content

Commit 96a9003

Browse files
DOC: In README.md, split the table of gufuncs into smaller tables.
1 parent 0974b39 commit 96a9003

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ that end in `.src`); others use templated C++ functions combined with code
8282
generation tools that can be found in `tools/cxxgen`. The `.src` files are
8383
processed with the script in `ufunclab/tools/conv_template.py`.
8484

85+
*Functions that reduce a one-dimensional sequence to one or two numbers.*
86+
8587
| Function | Description |
8688
| -------- | ----------- |
8789
| [`first`](#first) | First value that matches a target comparison |
@@ -104,20 +106,35 @@ processed with the script in `ufunclab/tools/conv_template.py`.
104106
| [`gini`](#gini) | Gini coefficient |
105107
| [`rms`](#rms) | Root-mean-square for real and complex inputs |
106108
| [`vnorm`](#vnorm) | Vector norm |
109+
110+
*Functions that reduce two one-dimensional arrays to a number.*
111+
112+
| Function | Description |
113+
| -------- | ----------- |
107114
| [`vdot`](#vdot) | Vector dot product for real floating point arrays |
108115
| [`pearson_corr`](#pearson_corr) | Pearson's product-moment correlation coefficient |
109116
| [`wjaccard`](#wjaccard) | Weighted Jaccard index. |
110-
| [`cross2`](#cross2) | 2-d vector cross product (returns scalar) |
111-
| [`cross3`](#cross3) | 3-d vector cross product |
112-
| [`tri_area`](#tri_area) | Area of triangles in n-dimensional space |
113-
| [`tri_area_indexed`](#tri_area_indexed) | Area of triangles in n-dimensional space |
117+
118+
*Functions that transform a one-dimensional array to another one-dimensional array.*
119+
120+
| Function | Description |
121+
| -------- | ----------- |
114122
| [`fillnan1d`](#fillnan1d) | Replace `nan` using linear interpolation |
115123
| [`linear_interp1d`](#linear_interp1d) | Linear interpolation, like `numpy.interp` |
116124
| [`backlash`](#backlash) | Backlash operator |
117125
| [`hysteresis_relay`](#hysteresis_relay) | Relay with hysteresis (Schmitt trigger) |
118126
| [`sosfilter`](#sosfilter) | SOS (second order sections) linear filter |
119127
| [`sosfilter_ic`](#sosfilter_ic) | SOS linear filter with initial condition |
120128
| [`sosfilter_ic_contig`](#sosfilter_ic_contig) | SOS linear filter with contiguous array inputs |
129+
130+
*Other functions.*
131+
132+
| Function | Description |
133+
| -------- | ----------- |
134+
| [`cross2`](#cross2) | 2-d vector cross product (returns scalar) |
135+
| [`cross3`](#cross3) | 3-d vector cross product |
136+
| [`tri_area`](#tri_area) | Area of triangles in n-dimensional space |
137+
| [`tri_area_indexed`](#tri_area_indexed) | Area of triangles in n-dimensional space |
121138
| [`multivariate_logbeta`](#multivariate_logbeta) | Logarithm of the multivariate beta function |
122139

123140
*Other tools*

0 commit comments

Comments
 (0)