Show a nice report about big_o

[harisaisundhar]

Can I be assigned to this ?

[pberkes]

Sure! Would you mind suggesting what the report could look like before implementing? I think it would save some time rather than discuss after the fact

[harisaisundhar]

Sure! The best algo could just be printed as it is. As of the others, we could print a table which has columns [Ranking, Complexities, Time, Residuals] where the rows are sorted on ascending based on their time.

[harisaisundhar]

Also since this print_report function can only be called for the results of big_o function, it would be better to create this function within the big_o() function only, With an introduction of a new default parameter print_report.

By default we could initialise it to False, thus it will not break any current code. Users who needs to get the report can send a parameter with print_report = True to get the reports printed.

Just an idea, does that sound good to you. Or do you have any other ways to achieve this in mind ?

[pberkes]

I'm not fond of that idea, because it leads to an explosion of keyword arguments in the long run. The general principle is to separate calculations and reporting/plotting.

I think the idea would be to write something like

best, others = big_o.big_o(heapify, data_generator_heapify, max_n=10**7)
print(big_o_report(best, others))

and big_o_report returns a nicely formatted string.

big_o_report could live in a new module reports

[pberkes]

Part of this task would also be to add the usage as an example in the documentaion

[harisaisundhar]

Got it! That can be done. Will start working on it. Can I go ahead with the proposed table design for report ?