Max/Min Function Bug Fix and Updates

Tianyu659 commented 10 months ago

Description

fixed previous behavior of logging None: None in Op.HIGHLIGHT when a constant is selected as the best element during comparisons
updated some APIs to make the function more intuitive and user friendly. The old API should still work fine (none of the demo files are changed and should behave the same).

specifically:

users can now explicitly compare constants using the constants parameter
users can call max with only indices if they don't really wish to make changes to the elements before comparing
current code using None as index for a constant in elements still work. see the updated tests (below) & all the demos still have the same behavior, i believe

so if users prefer the None way to do it it would still work. I mainly wanted to provide an option to call the max function with less confusion when comparing existing elements without transformation. so arguably

dp.max([0,1], constants=[c[0]])
dp.max([i for i in range(50)])

could be more straightforward than

dp.max([0, 1, None], [dp[0], dp[1], c[0]])
dp.max([i for i in range(50)], [dp[i] for i in range50]])

created more testing for min max functions

TODO

[x] bug fix
[x] api update

TESTING

[x] see dp_array_logger_test

Questions

none atm

Status

[x] I have read the guidelines in CONTRIBUTING.md
[x] I have formatted my code using yapf
[x] I have linted my code with pylint
[x] I have tested my code by running pytest
[x] I have added a one-line description of my change to the changelog in HISTORY.md
[x] This PR is ready to go

Tianyu659 commented 10 months ago

@ramirodcv i was fixing something in min/max (see description) and end up making some updates to the function (backward compatible with current demos). would be great if you can take a look at lmk what you think since this was your feature. @itsdawei too

itsdawei commented 10 months ago

What is the expected behavior when a constant is the best element?

Tianyu659 commented 10 months ago

What is the expected behavior when a constant is the best element?

best constant value returned, nothing highlighted, involved array elements Op.READ

itsdawei commented 10 months ago

What is the expected behavior when a constant is the best element?

best constant value returned, nothing highlighted, involved array elements Op.READ

What does "involved array elements Op.READ" mean?

Tianyu659 commented 10 months ago

What is the expected behavior when a constant is the best element?

best constant value returned, nothing highlighted, involved array elements Op.READ

What does "involved array elements Op.READ" mean?

oh any involved array elements will show up in the READ operation list. they are READ and this is recorded

itsdawei / dpvis