Adding ability to perturb a vector by some factor #861
Conversation
…/toqito into 260-perturb-vector
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #861 +/- ##
======================================
Coverage 97.9% 97.9%
======================================
Files 165 166 +1
Lines 3253 3262 +9
Branches 713 715 +2
======================================
+ Hits 3185 3194 +9
Misses 44 44
Partials 24 24 ☔ View full report in Codecov by Sentry. |
toqito/matrix_ops/perturb_vectors.py
Outdated
| >>> from toqito.matrix_ops import perturb_vectors | ||
| >>> import numpy as np | ||
| >>> vectors = [np.array([1.0, 2.0]), np.array([3.0, 4.0])] | ||
| >>> perturbed_vectors = perturb_vectors(vectors, eps=0.1) |
There was a problem hiding this comment.
| >>> perturbed_vectors = perturb_vectors(vectors, eps=0.1) | |
| >>> perturb_vectors(vectors, eps=0.1) |
Show the output as we want it to show in the documentation build. You can use # doctest: +SKIP for doctest failures as we expect the output to be different due to randn.
toqito/toqito/rand/random_unitary.py
Line 24 in 4a4ce5e
There was a problem hiding this comment.
This is not done yet. See #861 (comment)
Co-authored-by: Purva Thakre <66048318+purva-thakre@users.noreply.github.com>
|
Thanks for the changes and updates, @Shivansh20128 ! LGTM, but I'll ping @purva-thakre to see if she has any additional final comments. Great work, as always! |
| >>> import numpy as np | ||
| >>> vectors = [np.array([1.0, 2.0]), np.array([3.0, 4.0])] | ||
| >>> perturb_vectors(vectors, eps=0.1) # doctest: +SKIP | ||
|
|
There was a problem hiding this comment.
@Shivansh20128 You have to add the output manually here. Right now, the RTD output is blank for the example.
See below for example:
toqito/toqito/rand/random_povm.py
Lines 21 to 34 in 9b355a5
There was a problem hiding this comment.
@purva-thakre Added! I hope its fine now.
Description
Provide a brief description of the PR's purpose here. If your PR is supposed to fix an existing issue, use
a keyword to link your PR to the issue.
Adding the ability to perturb a vector by some random value by adding a submodule in matrix_ops.
This PR includes the docstring, the function as described in the issue mentioned, and the tests for the feature function.
#Resolves #260
Changes
Notable changes that this PR has either accomplished or will accomplish. Feel free to add more lines to the itemized list
below.
perturb_vectorsperturb_vectorsperturb_vectorsin filetest_perturb_vector.pyChecklist
Before marking your PR ready for review, make sure you checked the following locally. If this is your first PR, you might be notified of some workflow failures after a maintainer has approved the workflow jobs to be run on your PR.
Additional information is available in the documentation.
rufffor errors related to code style and formatting.pytest.Sphinxbuild can be checked locally for any failures related to your PRlinkcheckto check for broken links in the documentationdoctestto verify the examples in the function docstrings work as expected.