Refactor: Permute systems index offset

[vprusso]

In much the same spirit as #145, it would make sense to have a consistent indexing pattern amongst the functions offered in toqito. We should also make this change in the permute_systems.py file as well.

That is, the indexing offset for permute_systems starts at 1 but to be consistent with the rest of the functions (and indeed, to be more intuitive from the perspective of a Python programmer) it should assume an index starting at 0.

[anushkrishnav]

Can you give me more info on the above? I would love to take this task

[vprusso]

Hi @anushkrishnav ,

Of course, thank you for your interest.

The general idea here is that some functions in toqito start with an index offset starting at 1. This is confusing and not very Pythonic, as most index offsets are expected to begin at 0. This is because many of the functions in toqtio were converted from MATLAB functions (which has the index starting at 1 instead of 0).

So, the general idea is for us to convert the permute_systems function to behave in a way that uses index 0 instead of 1. This would also ensure that the change does not break anything that depends on this function.

Does this make sense? I am happy to provide more information/context if helpful. Also, please let me know if you have additional questions. Happy hacking!

[anushkrishnav]

Awesome, I will get started into this, I was checking the codebase and do see what you are talking about, will take on this task

Thanks for the comment !

[vprusso]

No problem at all. Happy hacking, @anushkrishnav !

[anushkrishnav]

Is there a sample test case by anychance ?
Is this a good one ?

from toqito.perms import permute_systems
import numpy as np
test_input_mat = np.array(
   [
       [1, 2, 3, 4, 5, 6, 7, 8],
       [9, 10, 11, 12, 13, 14, 15, 16],
       [17, 18, 19, 20, 21, 22, 23, 24],
       [25, 26, 27, 28, 29, 30, 31, 32],
       [33, 34, 35, 36, 37, 38, 39, 40],
       [41, 42, 43, 44, 45, 46, 47, 48],
       [49, 50, 51, 52, 53, 54, 55, 56],
       [57, 58, 59, 60, 61, 62, 63, 64],
   ]
)
print(permute_systems(test_input_mat, [1, 2, 0]))

[anushkrishnav]

kindly assigned the issue to me,, Issued a PR with a potential solution , if the solution is alright then will finish up the tests and docs and issue a final commit

[vprusso]

Hi @anushkrishnav

There is an entire test suite that runs both permute_systems and functions that depend on permute_systems.

If you check in the perms/tests/ directory, for instance, you will find the corresponding test cases for permute_systems.py

You can run the entire test suite from the root directory of the project by running pytest ., or, simply run a specific set of tests using pytest as well. If you consult the main README file of toqito, it describes how to run the tests.

Let me know if that helps!