search

fair-acc / gnuradio4

Prototype implementations for a more compile-time efficient flowgraph API
GNU Lesser General Public License v3.0
22 stars 8 forks source link

Rename numerator to output_chunk_size and denominator to input_chunk_size #370

Closed drslebedev closed 1 week ago

drslebedev commented 1 week ago

Naming is hard...

In the Block class, we had members denominator and numerator, which can be confusing due to how they are used. These fields define the resampling ratio as numerator/denominator. The exact implementation takes denominator input samples and creates numerator output samples. Meaning that n_input = k * denominator and n_output = k * numerator. They also act as constraints for the minimum number of input/output samples.

In this PR numerator is renamed to output_chunk_size and denominator to input_chunk_size which should reflect the purpose of these variables clearly.

In addition documentation was also updated.

sonarcloud[bot] commented 1 week ago

Quality Gate Passed Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
81.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud