Linting. Updating docs. Updating CHANGELOG. Updating badge on README.

vprusso · Jun 18, 2023 · e3ecb0b · e3ecb0b
1 parent aab34e5
commit e3ecb0b
Show file tree

Hide file tree

Showing 168 changed files with 781 additions and 934 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -318,4 +318,6 @@
 
 - Thanks to @AmanieOxana for integrating the completely bounded trace and spectral norms. https://github.com/vprusso/toqito/pull/157
 
-- Thanks to @ErikQQY for refactoring and simplifying the partial trace and partial transpose functions.
+- Thanks to @ErikQQY for refactoring and simplifying the partial trace and partial transpose functions.
+
+- Thanks to @elads888 for adding the `is_diagonally_dominant` feature to allow one to determine if a matrix is diagonally dominant.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ experience of students and instructors in classes pertaining to quantum
 information.
 
 
-[![build status](http://img.shields.io/travis/vprusso/toqito.svg?style=plastic)](https://travis-ci.org/vprusso/toqito)
+[![build status](https://github.com/vprusso/toqito/actions/workflows/build-test-actions.yml/badge.svg?style=plastic)](https://github.com/vprusso/toqito/actions/workflows/build-test-actions.yml/badge.svg)
 [![doc status](https://readthedocs.org/projects/toqito/badge/?version=latest&style=plastic)](https://toqito.readthedocs.io/en/latest/)
 [![codecov](https://codecov.io/gh/vprusso/toqito/branch/master/graph/badge.svg?style=plastic)](https://codecov.io/gh/vprusso/toqito)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4743211.svg)](https://doi.org/10.5281/zenodo.4743211)

diff --git a/docs/_autosummary/toqito.channel_metrics.channel_fidelity.rst b/docs/_autosummary/toqito.channel_metrics.channel_fidelity.rst
@@ -1,4 +1,4 @@
-toqito.channel\_metrics.channel\_fidelity
+toqito.channel\_metrics.channel\_fidelity
 =========================================
 
 .. currentmodule:: toqito.channel_metrics

diff --git a/docs/_autosummary/toqito.channel_metrics.diamond_norm.rst b/docs/_autosummary/toqito.channel_metrics.diamond_norm.rst
@@ -0,0 +1,6 @@
+toqito.channel\_metrics.diamond\_norm
+=====================================
+
+.. currentmodule:: toqito.channel_metrics
+
+.. autofunction:: diamond_norm
diff --git a/docs/_autosummary/toqito.channel_ops.apply_channel.rst b/docs/_autosummary/toqito.channel_ops.apply_channel.rst
@@ -1,4 +1,4 @@
-toqito.channel\_ops.apply\_channel
+toqito.channel\_ops.apply\_channel
 ==================================
 
 .. currentmodule:: toqito.channel_ops

diff --git a/docs/_autosummary/toqito.channel_ops.choi_to_kraus.rst b/docs/_autosummary/toqito.channel_ops.choi_to_kraus.rst
@@ -1,4 +1,4 @@
-toqito.channel\_ops.choi\_to\_kraus
+toqito.channel\_ops.choi\_to\_kraus
 ===================================
 
 .. currentmodule:: toqito.channel_ops

diff --git a/docs/_autosummary/toqito.channel_ops.dual_channel.rst b/docs/_autosummary/toqito.channel_ops.dual_channel.rst
@@ -1,4 +1,4 @@
-toqito.channel\_ops.dual\_channel
+toqito.channel\_ops.dual\_channel
 =================================
 
 .. currentmodule:: toqito.channel_ops

diff --git a/docs/_autosummary/toqito.channel_ops.kraus_to_choi.rst b/docs/_autosummary/toqito.channel_ops.kraus_to_choi.rst
@@ -1,4 +1,4 @@
-toqito.channel\_ops.kraus\_to\_choi
+toqito.channel\_ops.kraus\_to\_choi
 ===================================
 
 .. currentmodule:: toqito.channel_ops

diff --git a/docs/_autosummary/toqito.channel_ops.partial_channel.rst b/docs/_autosummary/toqito.channel_ops.partial_channel.rst
@@ -1,4 +1,4 @@
-toqito.channel\_ops.partial\_channel
+toqito.channel\_ops.partial\_channel
 ====================================
 
 .. currentmodule:: toqito.channel_ops

diff --git a/docs/_autosummary/toqito.channel_props.choi_rank.rst b/docs/_autosummary/toqito.channel_props.choi_rank.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.choi\_rank
+toqito.channel\_props.choi\_rank
 ================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_completely_positive.rst b/docs/_autosummary/toqito.channel_props.is_completely_positive.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_completely\_positive
+toqito.channel\_props.is\_completely\_positive
 ==============================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_herm_preserving.rst b/docs/_autosummary/toqito.channel_props.is_herm_preserving.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_herm\_preserving
+toqito.channel\_props.is\_herm\_preserving
 ==========================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_positive.rst b/docs/_autosummary/toqito.channel_props.is_positive.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_positive
+toqito.channel\_props.is\_positive
 ==================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_quantum_channel.rst b/docs/_autosummary/toqito.channel_props.is_quantum_channel.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_quantum\_channel
+toqito.channel\_props.is\_quantum\_channel
 ==========================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_trace_preserving.rst b/docs/_autosummary/toqito.channel_props.is_trace_preserving.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_trace\_preserving
+toqito.channel\_props.is\_trace\_preserving
 ===========================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_unital.rst b/docs/_autosummary/toqito.channel_props.is_unital.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_unital
+toqito.channel\_props.is\_unital
 ================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channel_props.is_unitary.rst b/docs/_autosummary/toqito.channel_props.is_unitary.rst
@@ -1,4 +1,4 @@
-toqito.channel\_props.is\_unitary
+toqito.channel\_props.is\_unitary
 =================================
 
 .. currentmodule:: toqito.channel_props

diff --git a/docs/_autosummary/toqito.channels.choi.rst b/docs/_autosummary/toqito.channels.choi.rst
@@ -1,4 +1,4 @@
-toqito.channels.choi
+toqito.channels.choi
 ====================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.channels.dephasing.rst b/docs/_autosummary/toqito.channels.dephasing.rst
@@ -1,4 +1,4 @@
-toqito.channels.dephasing
+toqito.channels.dephasing
 =========================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.channels.depolarizing.rst b/docs/_autosummary/toqito.channels.depolarizing.rst
@@ -1,4 +1,4 @@
-toqito.channels.depolarizing
+toqito.channels.depolarizing
 ============================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.channels.partial_trace.rst b/docs/_autosummary/toqito.channels.partial_trace.rst
@@ -1,4 +1,4 @@
-toqito.channels.partial\_trace
+toqito.channels.partial\_trace
 ==============================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.channels.partial_transpose.rst b/docs/_autosummary/toqito.channels.partial_transpose.rst
@@ -1,4 +1,4 @@
-toqito.channels.partial\_transpose
+toqito.channels.partial\_transpose
 ==================================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.channels.realignment.rst b/docs/_autosummary/toqito.channels.realignment.rst
@@ -1,4 +1,4 @@
-toqito.channels.realignment
+toqito.channels.realignment
 ===========================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.channels.reduction.rst b/docs/_autosummary/toqito.channels.reduction.rst
@@ -1,4 +1,4 @@
-toqito.channels.reduction
+toqito.channels.reduction
 =========================
 
 .. currentmodule:: toqito.channels

diff --git a/docs/_autosummary/toqito.matrices.clock.rst b/docs/_autosummary/toqito.matrices.clock.rst
diff --git a/docs/_autosummary/toqito.matrices.cnot.rst b/docs/_autosummary/toqito.matrices.cnot.rst
diff --git a/docs/_autosummary/toqito.matrices.fourier.rst b/docs/_autosummary/toqito.matrices.fourier.rst
diff --git a/docs/_autosummary/toqito.matrices.gell_mann.rst b/docs/_autosummary/toqito.matrices.gell_mann.rst
diff --git a/docs/_autosummary/toqito.matrices.gen_gell_mann.rst b/docs/_autosummary/toqito.matrices.gen_gell_mann.rst
diff --git a/docs/_autosummary/toqito.matrices.gen_pauli.rst b/docs/_autosummary/toqito.matrices.gen_pauli.rst
diff --git a/docs/_autosummary/toqito.matrices.hadamard.rst b/docs/_autosummary/toqito.matrices.hadamard.rst
diff --git a/docs/_autosummary/toqito.matrices.iden.rst b/docs/_autosummary/toqito.matrices.iden.rst
diff --git a/docs/_autosummary/toqito.matrices.pauli.rst b/docs/_autosummary/toqito.matrices.pauli.rst
diff --git a/docs/_autosummary/toqito.matrices.shift.rst b/docs/_autosummary/toqito.matrices.shift.rst
diff --git a/docs/_autosummary/toqito.matrix_ops.inner_product.rst b/docs/_autosummary/toqito.matrix_ops.inner_product.rst
diff --git a/docs/_autosummary/toqito.matrix_ops.outer_product.rst b/docs/_autosummary/toqito.matrix_ops.outer_product.rst
diff --git a/docs/_autosummary/toqito.matrix_ops.tensor.rst b/docs/_autosummary/toqito.matrix_ops.tensor.rst
diff --git a/docs/_autosummary/toqito.matrix_ops.unvec.rst b/docs/_autosummary/toqito.matrix_ops.unvec.rst
diff --git a/docs/_autosummary/toqito.matrix_ops.vec.rst b/docs/_autosummary/toqito.matrix_ops.vec.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_block_positive.rst b/docs/_autosummary/toqito.matrix_props.is_block_positive.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_commuting.rst b/docs/_autosummary/toqito.matrix_props.is_commuting.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_density.rst b/docs/_autosummary/toqito.matrix_props.is_density.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_diagonal.rst b/docs/_autosummary/toqito.matrix_props.is_diagonal.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_hermitian.rst b/docs/_autosummary/toqito.matrix_props.is_hermitian.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_idempotent.rst b/docs/_autosummary/toqito.matrix_props.is_idempotent.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_identity.rst b/docs/_autosummary/toqito.matrix_props.is_identity.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_normal.rst b/docs/_autosummary/toqito.matrix_props.is_normal.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_permutation.rst b/docs/_autosummary/toqito.matrix_props.is_permutation.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_positive_definite.rst b/docs/_autosummary/toqito.matrix_props.is_positive_definite.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_positive_semidefinite.rst b/docs/_autosummary/toqito.matrix_props.is_positive_semidefinite.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_projection.rst b/docs/_autosummary/toqito.matrix_props.is_projection.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_square.rst b/docs/_autosummary/toqito.matrix_props.is_square.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_symmetric.rst b/docs/_autosummary/toqito.matrix_props.is_symmetric.rst
diff --git a/docs/_autosummary/toqito.matrix_props.is_unitary.rst b/docs/_autosummary/toqito.matrix_props.is_unitary.rst