feat: added random_states func + tests

[ankit-pn]

Description

added random_states function and its test as described in issue #380

Todos

Notable points that this PR has either accomplished or will accomplish.

• Implemented random_state function in rand/random_states.py
• Implemented its test in rand/test/test_random_states.py

Status

• Ready to go

[ankit-pn]

Is there any doc specifying what kind of code style that we need to follow, or which formatter I need to use to format the python code?

[purva-thakre]

@ankit-pn if you look at the output of the failing tests, it tells you what error is being caught by which formatter/linter.

Once those are fixed, you will also have to add qiskit as a dependency in the following file otherwise check-build workflow will fail because qiskit can't be imported by pytest.

toqito/pyproject.toml

Line 18 in 73641d8

[tool.poetry.dependencies]

[ankit-pn]

@ankit-pn if you look at the output of the failing tests, it tells you what error is being caught by which formatter/linter.

Once those are fixed, you will also have to add qiskit as a dependency in the following file otherwise check-build workflow will fail because qiskit can't be imported by pytest.

toqito/pyproject.toml

Line 18 in 73641d8

[tool.poetry.dependencies]

Thanks Purva, I have added qiskit as dependencies in pyproject.toml and formatted the code accordingly.

[vprusso]

Also, don't forget to address the issues that the linter is catching here

Additionally, you'll need to add toqito.rand.random_state to docs/states.rst under the "States" heading.

Feel free to ping if you have any questions!

[purva-thakre]

@ankit-pn To check if all the workflows pass locally (after all the dependencies are installed in your virtual environment)

• For ruff, use ruff check . in the main toqito directory.
• For pylint, use poetry run pylint --fail-under=10.0 toqito/ in the main toqito directory
• For pytest use pytest in toqito/toqito

If you don't understand what an error is trying to tell you, you can look at how the function docstrings/tests are formatted in other modules.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (73641d8) 97.5% compared to head (38706f6) 97.6%.
Report is 4 commits behind head on master.

Additional details and impacted files

@@          Coverage Diff           @@
##           master    #383   +/-   ##
======================================
  Coverage    97.5%   97.6%           
======================================
  Files         152     153    +1     
  Lines        3043    3042    -1     
  Branches      743     742    -1     
======================================
+ Hits         2968    2970    +2     
+ Misses         46      45    -1     
+ Partials       29      27    -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[purva-thakre]

You do want to make sure you stay consistent with how these are listed in the docstrings of existing functions.

For example,

toqito/toqito/channel_ops/apply_channel.py

Lines 93 to 98 in 5c1571a

	:raises ValueError: If matrix is not Choi matrix.
	:param mat: A matrix.
	:param phi_op: A superoperator. :code:`phi_op` should be provided either as a Choi matrix,
	or as a list of numpy arrays with either 1 or 2 columns whose entries are its
	Kraus operators.
	:return: The result of applying the superoperator :code:`phi_op` to the operator :code:`mat`.

Also, make sure you add this new function to the docs as Vincent said in his comment.

[ankit-pn]

specifying parameter with :param tag is failing ruff check . . is there any way to bypass it. I am getting this error if i remove argument description that i have included in previous pr and use :param tag.

ruff check rand/ --fix
rand/random_states.py:7:5: D417 Missing argument descriptions in the docstring for `random_states`: `d`, `n`
Found 1 error.

[purva-thakre]

Is your docstring following everything as expected? For example, Ruff is set to using === for section headings instead of ---.

Pay attention to the full docstring I linked above and don't use an auto-formatter. FYI, we don't use black.

[ankit-pn]

i have pushed a change, pls review it and let me if it is ok or i need to make some more change.

[vprusso]

Also, don't forget to address the issues that the linter is catching here

Additionally, you'll need to add toqito.rand.random_state to docs/states.rst under the "States" heading.

Feel free to ping if you have any questions!

Seems like this still isn't part of the diff, @ankit-pn

[ankit-pn]

It should be added to rand.rst?

[ankit-pn]

has made fixes for it, can you check? have added toqito.rand.random_state to docs/rand.rst.

[vprusso]

has made fixes for it, can you check? have added toqito.rand.random_state to docs/rand.rst.

Yep! That's what I was suggesting. Nice!

[vprusso]

LGTM! I'll approve but want to wait for @purva-thakre to give the final sign-off.

Great work, @ankit-pn, thank you again for your contribution!

[purva-thakre]

LGTM too! 🎆