Missing documentation for `depolarizing` and `dephasing`
Before reporting this bug:
- [x] Verify there is not an existing issue for it already
- [x] You are using the latest version of
toqitowith a python version>=3.10
Describe the bug
The depolarizing channel with parameter $p$ is often defined as
$$\Phi(\rho)=p\mathrm{Tr}[\rho]\frac{I}{d}+(1-p)\rho$$
with its Choi matrix being
$$\frac{p}{d}I\otimes I+(1-p)|\psi\rangle!\langle\psi|$$
with $\ket{\psi}$ being the (unnormalized) maximally entangled state. However, it seems like the depolarizing function swaps $p$ and $1-p$, which is the Qetlab convention, as seen here.
https://github.com/vprusso/toqito/blob/d0c797ae9ee3a93bd3c1d6c1f81d7fbb8fa0d58c/toqito/channels/depolarizing.py#L94-L95
Furthermore, the documentation doesn't state how the parameter $p_0$ is applied, which is crucial to know which convention is used. In all cases, the documentation should be transformed to include the parameter $p_0$ instead of the totally depolarizing channel only.
The same missing documentation concerning how the parameter is used occurs for the dephasing function.
Both documentations should be updated accordingly to reflect the use of the parameters of the channels.
If this is still being worked on I would like to take up this issue
Sure, @RohitP2005 , if you'd like to give this a go, you're more than welcome to do so. Also, thanks to @tnemoz for flagging this!