tutorials/feature/qudit.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Introduction to qudit quantum computing\n",
    "\n",
    "In this tutorial, users will learn how to use qudit setting in QuAIRKit.\n",
    "\n",
    "**Table of Contents**\n",
    "- [Review on qubit case](#Review-on-qubit-case)\n",
    "- [Setup for qutrit case](#Setup-for-qutrit-case)\n",
    "- [Setup for general cases](#Setup-for-general-cases)\n",
    "- [Operations in qudit circuits](#Operations-in-qudit-circuits)\n",
    "    - [Adding custom gates](#Adding-custom-gates)\n",
    "    - [Adding custom channels](#Adding-custom-channels)\n",
    "    - [Measurement](#Measurement)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "import quairkit as qkit\n",
    "from quairkit import Circuit\n",
    "from quairkit.database import *\n",
    "from quairkit.loss import *\n",
    "\n",
    "qkit.set_dtype('complex128')\n",
    "split_line = '\\n' + '-' * 100 + '\\n'  # a line of '-' for better readability"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Review on qubit case\n",
    "\n",
    "The default setting in quantum computing is qubit unless specified otherwise. For detailed instruction on qubit circuits, please refer to the tutorials of states and circuits.\n",
    "\n",
    "Users can check the number of qubits, qutrits, and systems in the circuit using  `cir.num_qubits`, `cir.num_qutrits` and `cir.num_systems`, respectively.\n",
    "\n",
    "For example, one can create a circuit with 3 qubits:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The diagram of the quantum circuit:\n"
     ]
    },
    {
     "data": {
      "image/png": "iVBORw0KGgoAAAANSUhEUgAAAQMAAACyCAYAAABGMKqvAAAAOXRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjkuMiwgaHR0cHM6Ly9tYXRwbG90bGliLm9yZy8hTgPZAAAACXBIWXMAAA9hAAAPYQGoP6dpAAAgl0lEQVR4nO3de1TUdf4/8Od4GS7DgAMIAwUEXnJVSEktFa3WQivFzM3j5bQRHfLSrp3ctPxmBzvmoU3zspl6TBTLFTU3U7dWiUC7eIMMST2isYiTiaLAcBHkMs/fHw3zY2CAmQFmlH09zpmj8/m8P+/P6w0fnvO58UFBkhBC/M/r5uwChBB3BgkDIQQACQMhhJGEgRACgISBEMJIwkAIAUDCQAhhJGEghAAgYSCEMJIwEEIAkDAQQhhJGAghAEgYCCGMJAyEEACAHo5eYXV1NWpqahy9WtGFKJVKuLq6OruMLsehYVBdXY3Q0FAUFhY6crWii9FqtcjPz5dA6GAODYOamhoUFhZCp9PB09PTkasWXURZWRmCgoJQU1MjYdDBHH6YAACenp4SBkLcYeQEohACgISBEMJIwkAIAUDCQAhhJGEghAAgYSCEMJIwEEIAkDAQQhg55aYjIcT/RxL5+fm4fv06qqur0bdvX9x7770Or0P2DIRwksrKSnz88ceIjIzEgAEDMHnyZDz22GMICQnBH//4R+zZswe1tbUOq0fCQAgnOH78OEJDQ7F+/XrMmzcPJSUluHjxIgDg4sWLmDBhAhYuXIiIiAj897//dUhNEgZCONjRo0fxxBNP4O2338apU6cQHx8PlUplmu/r64tFixbhl19+QXR0NEaPHo1Lly51el1dKgwyMjIQGRkJg8Hg7FJEK6ZMmYLk5GRnl+EUJSUliImJwd///nf89a9/hUKhaLFt9+7dsWbNGkydOhUxMTGdv13TgfR6PQFQr9fbtFxpaSkVCgXT09PNptfV1VGlUjElJYUkGR4ezgMHDljs45lnniEAZmRktLm+w4cPMyoqiiqVihqNhjExMaZ5KSkpjIqKolqtpj1fPluXr6+v5+LFi+nn50eVSsXx48fz0qVLLba3ZZwkuWjRIg4cOJBqtZoBAQGMi4vjjRs32jWGtvo8c+YM/f39WVVVZVWNjdm7DZGkwWBgeno6P/zwQ6amprK+vt7mPtpr1apVHD16tMV5LY3t9u3b9Pf358GDBzu1trtizyArKwsKhQLDhg0zm3727FlUVlZixIgR+Prrr1FSUoKnnnqq2fKffPIJbt26ZdW6vv32W8TExGDOnDkoKipCYWEh3nrrLdN8jUaDefPmYc2aNXaNxdbl33//faSkpODbb79FYWEhgoODMWnSJIufEraMs0H37t2xfft23Lx5E9nZ2dDpdIiNjW3XGNrqc9CgQQgLC8OOHTtsqrU9ysvL8dBDD+HJJ5/EG2+8gUmTJiEyMhKlpaUOq8FgMGDDhg145ZVXbFpOqVQiPj4e69ev76TKjDo1apqwN9UTExM5cODAZtM3bdpEX19fkuScOXMYGxvbrI1Op2NQUBALCgqs+sQcOXIkX3/99TZrysjIsGvPwNblQ0JCuH79etP7kpISKpVKHjlyxKydreNsyYEDB6hWq61qa+0YLPWZkJDAiRMn2lyfvdvQggUL6OLiQgCml1Kp5Msvv2xzDfb68ccf6eXlxerqaovzWxtbfn4+u3XrxvLy8k6rz+r7DMrKytodPPb2kZmZiREjRjSbfvLkSdP0U6dOYdq0aWbzSSIuLg5LlixBcHBwm+uprKzEiRMnMHr0aAwbNgz5+fno378/3n33XYwbN86u2ttDr9ejoKDAbI+oV69e6Nu3L7KzszF27FgAto+zNd988w0eeOCBdvVhTZ/h4eHYuHGj3X3aui19+umnuH37ttm0mpoa7Ny5EytWrLC7Dlvk5+cjICAAt2/fblYL8Pv3u/G/jfXq1QsAcOnSJZu/x9Y+SMjqMPDy8rKpgI6UmZmJxYsXN5t+4sQJTJ06FcDvJ2aa1rhhwwaQxMsvv2zVekpKSmAwGLB9+3Z89dVXGDx4MJKTkzFp0iScOXMGYWFh7R+MDRo2+IYNoUGvXr3MfhhsHWdLdu/ejc2bN+PIkSPt6seaPj09PVFcXGx3v0FBQe0tDcDvX2NHb9ttra+1H/bw8HCb10fSqnZWh4GltLJVw/PrbHHt2jXodDoMHz7cbHpxcTHOnTuHVatWAQC8vb3NaszLy8OyZctw/Phxq9elVqsBAHFxcRg6dCgAID4+HmvWrMGhQ4cwd+5cm2pvr4ZEb/q1Ly0tNc2zZ5yW7Ny5E3PnzsX+/fsRGRnZrr6s6bOsrAze3t52923rczT/7//+D5s3bzb7RO7ZsydmzZqFtWvX2l2HLbKzsxETE4OLFy/CxcWl2fwrV65g4MCBOHfuHO655x6zeQUFBRgyZAh0Oh08PDw6pT6rw8BZzyz89ddfAaDZhpOSkgIfHx88+uijAIAHH3wQZ8+eNc3/7rvvcPPmTTz44INmy02ePBkzZ87Ehg0bmq3Ly8sLYWFhzS73tHb5pzN5eXkhJCQEWVlZpkMFvV6PvLw8DBkyBIB942wqKSkJCxcuxL///W+MHj26Q2pvq88zZ840OyFsC1ufo/nee+/h5MmTOH36NLp3746qqioMGDAAq1evdti2HRUVBT8/P6SlpWHGjBnN5jfs7anV6mY17d69GxMnTkRgYGDnFdhpZyMssOfkT0VFBTUaDePj43njxg2WlpZyx44dVKvVTE5ONrVLS0tjUFCQ6XJRZWUldTqd2QsAd+/ezeLi4hbX98EHHzAgIIA5OTmsq6vjli1bqFKpmJ+fT/L3y5lVVVU8dOgQAbCqqopVVVVml6kSEhIYEhJisX9rlm8sMTGRYWFhzM3NZUVFBWfPns3w8HCbxtlaPWvXrqWPjw8zMzNb/JrYOgZr+hw1ahQ3b95s9TobtPfSYkZGBlesWEEALCkpsbmP9mrt0mLD906n05lNd9SlxTs+DEjy2LFjHDt2LNVqNb29vRkVFcW9e/c2axcREdHifQYkLZ5lnz17NidMmGB6bzAY+M477zAgIIBqtZoPP/wwDx8+bJq/detWszPSDa/G/cbGxvKFF16wWENbyzetp76+nm+++SZ79+5Nd3d3RkdHm4LJ2nG2Vg8A9ujRgyqVyuxVUFBgsR5rxtBWn2fPnqWfnx9v3brV6jgsaU8YdGQf9iouLqaPjw/XrVvXbJ6lMDAYDHzllVfMPgA6y10RBtZKT0/n0KFDnXIzSWN9+vTh5cuXnVpDY3daPVOmTOGWLVvsWvZuDwOSPHr0KD08PPiPf/yDBoPBNL1pGNTV1XH+/PnUarVtfgB0BAVp5anGDtBw5lav18vfTRB26Yht6E7YDo8fP46YmBgEBgZi3rx5mDlzJkpLSxEUFITs7GwcPHgQGzduhKurK7766iuEhoZ2ek13xR2IQnQ1Dz/8MPLz8/GXv/wFGzZsgEajMV3BioyMRGpqKlauXImcnByHBAEAyJ6BuKt0lT2Dxmh8uMm5c+cwadIkZGZmtutKi73kSUdCOJlCoUBYWBh8fHwAAP369XNKHXKYIMQdouF+Fmfd1yJhIIQAIGEghDCSMBBCAJAwEEIYSRgIIQBIGAghjCQMhBAAJAyEEEZOuQOxI56nKP43ybbTeRwaBkqlElqttsOeXyf+N2m1WiiVSmeX0eU4NAxcXV2Rn5+PmpoaR65WdDFKpRKurq7OLqPLcfhhgqurq3wjhbgDyQlEIQQACQMhhJGEgRACgISBEMJIwkAIAUDCQAhhJGEghAAgYSCEMJIwEEIAcMIdiNXV1XI7smgXuR25czg0DKqrqxEaGorCwkJHrlZ0MVqtFvn5+RIIHcyhYVBTU4PCwkLodLo74i/ZiLtPWVkZgoKCUFNTI2HQwZzyPANPT08JAyHuMHICUQgBQMJACGEkYSCEACBhIIQwkjAQQgCQMBBCGEkYCCEASBgIIYycctOREM5w5swZZGVloaioCABw+vRpjBkzxslV3Tlkz0B0aXV1ddi5cyfGjBmD4cOHY9u2bfj6668BAOPHj8fIkSOxfft2+eU5SBiILqy8vByTJk3C4sWLMWXKFFy5cgUZGRnYsmULACArKwszZszA0qVLMWHCBJSWljq3YCeTMBBd0u3btxETE4OamhpkZ2djwYIF8Pb2Nmvj6emJ+fPnIzs7G25ubnj66adRVVXlpIqdr0uFQUZGBiIjI2EwGJxdimjFlClTkJyc3KnrSExMhF6vx/79++Hl5dVqWw8PD/zrX/+CwWBAQkJCp9Z1R6MD6fV6AqBer7dpudLSUioUCqanp5tNr6uro0qlYkpKCkkyPDycBw4cMM1PSEhgt27dqFKpTK/p06e3uq5ly5YxLCyMnp6e9PHxYXR0NH/66SfT/IEDB5r15+bmRgD8/PPPrRpLSkoKo6KiqFarac2X39r2hw8fZlRUFFUqFTUaDWNiYqyqp76+nosXL6afnx9VKhXHjx/PS5cuWbUsST7zzDMEwIyMDNO0mzdvMi4ujgEBAfTw8GBMTAx1Op1p/pkzZ+jv78+qqiqr19PAmm3o9u3b9Pf353/+8x+L83U6HQGY1UT+/jXUaDS8detWm3VUVVVx69atnDVrFhcuXMgLFy7YNhAL7P356Ch3RRikpaWxW7duLCsrM5t++vRpAmBeXh5TU1N57733sr6+3jQ/ISGBjzzyiE3rys3NZXFxMcnfN6qVK1dSq9Wa9dvY2rVr6ePjY/WGffDgQe7YsYNJSUlWhYE17Y8cOUJPT09u376dt27d4u3bt3nixAmr6klMTOR9993H8+fPs7y8nPHx8QwPD29xvI1t27aN0dHRzcJg4sSJnDhxIktKSlheXs7p06dzyJAhZn2OHDmSSUlJVtXYmDXb0K5du9inT58Wx9BSGBgMBg4aNIhbt25ttYbKykpGRkaaPgiUSiWVSiUPHjxo83gakzCwQmJiIgcOHNhs+qZNm+jr60uSnDNnDmNjY83m2xMGjVVXV3P16tUEYAqIpgYMGMBFixbZ3HdGRoZVYWBN+5EjR/L111+3uQaSDAkJ4fr1603vS0pKqFQqeeTIkVaX0+l0DAoKYkFBgVkYVFRUUKFQMDMz09T24sWLBMBvv/3WNC0hIYETJ060uV5rtqE///nPXLJkSau1WwoDkly+fDn/9Kc/tVrD2rVr6erqSgBmr3vuuceqEG2Js8PA6vsMysrK2nc80o4+MjMzMWLEiGbTT548aZp+6tQpTJs2rVmbrKws9O7dG+7u7hg9ejSWL1+O0NDQVtf35ZdfYtasWdDr9VAoFFiwYAE0Gk2zdunp6bhw4QLmzJlj17g6QmVlJU6cOIHRo0dj2LBhyM/PR//+/fHuu+9i3LhxrS6r1+tRUFCAYcOGmab16tULffv2RXZ2NsaOHWtxOZKIi4vDkiVLEBwc3Gxe438b//+nn34yXdcPDw/Hxo0bbR+wUWvbUlFREcLDw1tsU15ebvq3aRsvLy8UFRW12v/nn3+O6urqZtOvXr2Kn3/+uc3tqyUN6+yIn7XGrH6QkLWpgSYp2J6XrckXFBRk9unVIDw8nEuXLiVJ9uvXjx9//LHZ/J9//pmXLl2iwWDglStX+PzzzzMsLIzl5eVWrffmzZtctWoV9+zZY3H+1KlT+dRTT9k0lgYdtWfQ8Cmn1Wp56tQp1tTUcNOmTXRzc2NeXl6rfV6+fJkAmh3vjho1isuWLWtxuY8++oiPP/646T2aHCaMGzeOTz75JG/cuMHS0lI+99xzVCgUfPfdd01tUlNT2bNnz7aG3UzDp6e8rH9Zy+o9A71eb23TFjU8v84W165dg06nw/Dhw82mFxcX49y5c1i1ahUAwNvbu1mNgwcPNv0/MDAQSUlJ8PLywtGjRxEdHd3mur29vfHqq69Co9FgwIABGDRokGneb7/9hn379uGLL76waTwdTa1WAwDi4uIwdOhQAEB8fDzWrFmDQ4cOYe7cuS0u2/CJ0fTrVlpa2uKnSV5eHpYtW4bjx4+32O/27dvx+uuvIyIiAgqFAgsXLsTBgwfh6+tralNWVtbsUp8tWnuO5ltvvYXi4mJs2LDB4ny9Xo/g4GBcvny52ZWG1157DSSxZs2aFtf9ww8/YPLkyaitrTVN69mzJx599FHs2bPH9sEYNfx8OO0ZoTZHczvYc0yUlZVlOknY2Lp16+jn58fa2lqS5Lx58/jiiy+22ldtbS3d3d1tOtFTW1tLNzc37t2712x6QkICQ0ND7T5G7MhzBmFhYXzrrbfMpg0aNMji3lRTISEh3LBhg+l9aWkpXVxcWjxnsHXrVvbs2ZM+Pj6mFwB6enpyzpw5FpfJyckhAJ4/f940benSpXz66afbrK8pa7ahnJwcurq68ubNmzb1UVZWRg8PD6tOvq5fv57u7u50cXEhAI4ZM6bF9VnL2ecM7vgwqKiooEajYXx8vGm3c8eOHVSr1UxOTja1S0tLY1BQkNkP586dO3n9+nWS5LVr1xgbG8uQkJBmVyUaW7t2La9evUqSvH79OuPj49mrVy8WFhaa2tTW1jIwMJDvvfeexT4SEhIYEhJicV5dXR2rqqp46NAhAmBVVRWrqqpaDBVr2n/wwQcMCAhgTk4O6+rquGXLFqpUKubn57dZT2JiIsPCwpibm8uKigrOnj271asJlZWV1Ol0Zi8A3L17t+kk6/nz51lUVESDwcAzZ87wwQcf5EsvvWTWz6hRo7h582aL62iNtdvQmDFj+P7779vUx4cffshhw4ZZXUtFRQXT0tI67AdYwsAKx44d49ixY6lWq+nt7c2oqKhmn9QkGRERYXafwaRJk+jr60s3NzcGBgZy+vTpvHjxotkys2fP5oQJE0zvJ0+eTH9/f7q7u1Or1TImJoY//vij2TJ79uyhi4sLi4qKLNYbGxvLF154weK8rVu3WjyuazjmblpPW+3J3y+JvfPOOwwICKBarebDDz/Mw4cPW1VPfX0933zzTfbu3Zvu7u6Mjo42hYileixpWk9SUhIDAwPp5ubGkJAQvvPOO6yrqzPNP3v2LP38/Ky6nt+UtdtQamoqVSoVv//+e6v6yMzMpIeHB/fv398p9Ti6L3vcFWFgrfT0dA4dOrRdl3c6Qp8+fXj58mWn1tDYnVbPlClTuGXLFruWtWUb2rhxIz08PPjZZ5/RYDBY7MNgMHD//v309PTk6tWrO7UeR/Zljy4VBqLrs3Ub2rVrF319fXn//fdzzZo1zM3NZW5uLgFw5cqVHDRoEL29vfnJJ584pB5H9WWPLvW7CUI0NW3aNPz66694++23sXv3bkREROD+++8HAKSkpGDhwoX49ddf8fzzzzu5UueTh5uILs/FxQWzZs3CrFmzAPz+Z/6qq6uhVquhUCicXN2dQ8JA/M9RKpVQKpXOLuOOI4cJQggAEgZCCCMJAyEEAAkDIYSRhIEQAoCEgRDCSMJACAFAwkAIYeSUm446+rFO4n+HbDudx6FhoFQqodVqbX7akRCNabVauYOwEzg0DFxdXZGfny9/1060i1KphKurq7PL6HIcfpjg6uoq30gh7kByAlEIAUDCQAhhJGEghAAgYSCEMJIwEEIAkDAQQhhJGAghAEgYCCGMJAyEEAAkDIQQRg6/Hbm6ulp+N0G0i/xuQudwaBhUV1cjNDQUhYWFjlyt6GK0Wi3y8/MlEDqYQ8OgpqYGhYWF0Ol08PT0dOSqRRdRVlaGoKAg1NTUSBh0MKc83MTT01PCQIg7jJxAFEIAkDAQQhhJGAghAEgYCCGMJAyEEAAkDIQQRhIGQggAEgZCCCOn3HQkxN2svr4eBw8eRFpaGq5fvw4AWLt2LWbPng0/Pz8nV2c/2TMQwko1NTVYsWIF+vXrh/j4eNTW1kKr1QIADh06hODgYMyaNQtnz551cqX2kTAQwgrl5eV46qmn8Omnn2LFihUoKCjAunXr8NprrwEAdu7ciZycHGg0GowcORKpqalOrth2cpggRBtqa2sxdepUAMDRo0fh4eFhsV3//v2xbt06jBo1ClOnTkVaWhoeeughR5baLl1uzyAjIwORkZEwGAzOLkW0YsqUKUhOTnZ2GVZJTk5GQUEB9u7d22IQNDZz5ky8/fbbeOmll0DSARV2EDqQXq8nAOr1epuXLS0tpUKhYHp6utn0uro6qlQqpqSkkCTDw8N54MAB0/z6+nouXryYfn5+VKlUHD9+PC9dumT1ep955hkCYEZGhmlaQkICu3XrRpVKZXpNnz7d6j5trWnZsmUMCwujp6cnfXx8GB0dzZ9++snmNtawNN6mFi1axIEDB1KtVjMgIIBxcXG8ceOGaX5hYSFnzJjB3r1708vLiyNHjuSRI0fM+jhz5gz9/f1ZVVVlU33t2YbsYTAYOGTIEG7atMnifJ1ORwDU6XRm02/dukWNRtNs3JaUl5czISGBffv2JQCuWLGCdXV1HVK/Le6aMEhLS2O3bt1YVlZmNv306dMEwLy8PKampvLee+9lfX29aX5iYiLvu+8+nj9/nuXl5YyPj2d4eLhZm5Zs27aN0dHRFsPgkUcesXkM9taUm5vL4uJikuTt27e5cuVKarVas/bWtGlLS+NtavHixTx16hRramp47do1PvHEE5w4caJp/rPPPstHHnmERUVFrKur48qVK+nh4cGSkhKzfkaOHMmkpCSr6yMdHwZHjx6lp6cnKyoqLM5vKQxI8m9/+xunTZvWav91dXWMjIyki4sLARAAXVxcOHPmzA6p3xZ3TRgkJiZy4MCBzaZv2rSJvr6+JMk5c+YwNjbWbH5ISAjXr19vel9SUkKlUtlmYut0OgYFBbGgoKDDw8Demkiyurqaq1evJgDTD789bZpqbbxtOXDgANVqtel9REQE161bZ3pfXl5OAMzKyjJbLiEhwSxErOHoMPjggw/47LPPtji/tTA4cuQIg4KCWu1/3759dHV1NQVBw6t79+7Mzc1td/22sPoEYllZWbsPSdrTR2ZmJkaMGNFs+smTJ03TT506hWnTppnm6fV6FBQUYNiwYaZpvXr1Qt++fZGdnY2xY8daXBdJxMXFYcmSJQgODrbYJisrC71794a7uztGjx6N5cuXIzQ0tM1x2FvTl19+iVmzZkGv10OhUGDBggXQaDQ2t7F3vK355ptv8MADD5jev/HGG0hKSsLUqVPh4+ODjz76CP3798fgwYPNlgsPD8fGjRttXh/QMdujNYqKiuDu7t7i+srLy03/Nm3Ts2dP6PX6Vms9duwY6urqmk13dXXFDz/8YLp02R5WP0jI2tRAk+Rqz8ueVA8KCjL7NG0QHh7OpUuXkiT79evHjz/+2DTv8uXLBMALFy6YLTNq1CguW7asxXV99NFHfPzxx83G3viT8ueff+alS5doMBh45coVPv/88wwLC2N5eXmb47C3pgY3b97kqlWruGfPnna1aayt8bZm165d9PDw4I8//mialp+fz/Hjx5s+4fz8/Hj06NFmy6amprJnz55WradBw56BvKx/WcvqPQO9Xm9t0xY1PL/OVteuXYNOp8Pw4cPNphcXF+PcuXNYtWoVAMDb29uszoZEbFp7aWlpi2mZl5eHZcuW4fjx4y3W0/gTLjAwEElJSfDy8sLRo0cRHR3d6ljsqakxb29vvPrqq9BoNBgwYAAGDRpkV5sG1oy3JTt37sTcuXOxf/9+REZGAgAMBgPGjRuHxx57DMXFxVCr1fjyyy/x5JNP4rvvvkN4eLhp+bKyMnh7e9u8XgAOe47moUOH8NprryEnJwc9ejT/cdHr9QgODsbly5fh5eVlNm/16tU4fPgw9u3b12L/t27dQkREBIqLi1FfXw/g9z2K8PBwpKenQ6FQdOyAWmNTLLeTvcd7WVlZppOEja1bt45+fn6sra0lSc6bN48vvviiWZuQkBBu2LDB9L60tJQuLi4tHp9v3bqVPXv2pI+Pj+kFgJ6enpwzZ47FZWpra+nu7s6DBw9aNR5ba7K0Pjc3N+7du7ddbUj7xkuSmzdvpkaj4ffff282/caNGwTAnJwcs+lDhw7lypUrzaYtXbqUTz/9dKv1NeXocwZ1dXUMDg5u8evYUj11dXW87777rNo7y8vL4xNPPEGFQsEePXpwxowZVp/r6Uh3RRhUVFRQo9EwPj6eN27cYGlpKXfs2EG1Ws3k5GRTu7S0NAYFBTW7mhAWFsbc3FxWVFRw9uzZrZ65r6yspE6nM3sB4O7du03foJ07d/L69eskyWvXrjE2NpYhISFmVzoSEhIYEhJicR221rR27VpevXqVJHn9+nXGx8ezV69eLCwstLpNS/VYM15L9fj4+DAzM9Pi/D/84Q98+eWXqdfrWV9fz3379lGpVDY79Bg1ahQ3b95ssY+WODoMSHL58uWMioqyeLmvpXp2797NwMBA1tTUWL2e2tpam67+dLS7IgxI8tixYxw7dizVajW9vb0ZFRVlMa0jIiKa3Wfw5ptvsnfv3nR3d2d0dDTz8/PNlpk9ezYnTJjQ4rrR5Bh60qRJ9PX1pZubGwMDAzl9+nRevHjRbJnY2Fi+8MILFvtrq6am9UyePJn+/v50d3enVqtlTEyM2TG6NW1aq6et8TatBwB79Ohhdp+FSqViQUEBSfLChQucPHkye/fuTbVazcGDB5udyyHJs2fP0s/Pj7du3bKqpgbOCIPi4mL279+fr7zySrMfVkv1ZGVl0dPTkzt27HBYjR3hrgkDa6Wnp3Po0KFOTViS7NOnDy9fvuzUGhq70+qZMmUKt2zZYvNyzggD8vdd+dDQUD733HP85ZdfLNZTVVXFpKQkqtVqrlq1yqH1dQQF6bj7JcvKyuDl5QW9Xi9/N0HYxZnb0LVr1zB//nx88cUXeOyxxzBt2jSoVCpMnz4d8+fPxz//+U/4+vpi+fLlpt9luJvILyoJYSV/f3/s2rULV69exebNm7Ft2zbcvHkTAPDbb7/hs88+w6OPPurYKwAdSPYMxF3lTtuGSKK8vBxqtfquDYEGsmcgRDsoFIo7IpQ6Qpf7FWYhhH0kDIQQACQMhBBGEgZCCAASBkIIIwkDIQQACQMhhJGEgRACgJNuOnLUI6tE1yPbTudxaBgolUpotVq7nnYkRAOtVgulUunsMroch/5uAgBUV1ejpqbGkasUXYxSqYSrq6uzy+hyHB4GQog7k5xAFEIAkDAQQhhJGAghAEgYCCGMJAyEEAAkDIQQRhIGQggAEgZCCCMJAyEEAAkDIYSRhIEQAoCEgRDCSMJACAFAwkAIYfT/AD4WgdMSNVTmAAAAAElFTkSuQmCC",
      "text/plain": [
       "<Figure size 249x165 with 1 Axes>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "----------------------------------------------------------------------------------------------------\n",
      "\n",
      "Are the systems composed of qubits? True\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of qubits in the circuit is 3\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of qutrits in the circuit is 0\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of systems in the circuit is 3\n",
      "----------------------------------------------------------------------------------------------------\n"
     ]
    }
   ],
   "source": [
    "num_qubits = 3  # number of qubits\n",
    "cir = Circuit(num_qubits)  # construct a circuit with specifying the number of qubits\n",
    "\n",
    "cir.complex_entangled_layer()  # add a complex entangled layer\n",
    "\n",
    "print('The diagram of the quantum circuit:')\n",
    "cir.plot()\n",
    "print(split_line)   # a line of '-' for better readability\n",
    "\n",
    "print(f'Are the systems composed of qubits? {cir().are_qubits()}', end=split_line)\n",
    "print(f'The total number of qubits in the circuit is {cir.num_qubits}', end=split_line)\n",
    "print(f'The total number of qutrits in the circuit is {cir.num_qutrits}', end=split_line)\n",
    "print(f'The total number of systems in the circuit is {cir.num_systems}', end=split_line)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "One can also verify the dimension of each system using the `System dimension` attribute from the `State` class."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The output state of the circuit is \n",
      "---------------------------------------------------\n",
      " Backend: state_vector\n",
      " System dimension: [2, 2, 2]\n",
      " System sequence: [2, 0, 1]\n",
      "[ 0.59+0.j   -0.01-0.07j -0.19+0.26j -0.03-0.15j -0.06+0.04j -0.33-0.56j\n",
      "  0.13+0.04j -0.11-0.26j]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "print(f'The output state of the circuit is {cir()}') "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Setup for qutrit case\n",
    "\n",
    "To configure the qudit state and its corresponding circuit, users can set `system_dim` to $d$, where $d$ represents the dimension of the qudit. \n",
    "\n",
    "For instance, one can assign `system_dim` = $3$ for qutrit. Then, the following code establishes the qutrit setup:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The number of systems of the state is 2\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The dimension of each system of the state is [3, 3]\n",
      "----------------------------------------------------------------------------------------------------\n",
      "Are the systems composed of qutrits? True \n",
      "----------------------------------------------------------------------------------------------------\n",
      "\n",
      "Random 2-qutrit states: \n",
      "---------------------------------------------------\n",
      " Backend: density_matrix\n",
      " System dimension: [3, 3]\n",
      " System sequence: [0, 1]\n",
      "[[ 0.11+0.j   -0.04-0.04j  0.  -0.04j -0.03+0.01j -0.  +0.03j  0.  +0.02j\n",
      "  -0.  -0.01j -0.  -0.02j -0.01-0.03j]\n",
      " [-0.04+0.04j  0.1 +0.j   -0.02-0.06j -0.01-0.j   -0.  +0.02j  0.02+0.01j\n",
      "  -0.01+0.02j -0.01-0.02j  0.01-0.01j]\n",
      " [ 0.  +0.04j -0.02+0.06j  0.23+0.j    0.04-0.01j -0.03+0.j   -0.08+0.03j\n",
      "  -0.  +0.01j  0.03-0.02j -0.01-0.03j]\n",
      " [-0.03-0.01j -0.01+0.j    0.04+0.01j  0.1 +0.j    0.01-0.03j  0.02+0.j\n",
      "   0.01-0.01j  0.04+0.01j -0.03+0.01j]\n",
      " [-0.  -0.03j -0.  -0.02j -0.03-0.j    0.01+0.03j  0.11+0.j   -0.02-0.02j\n",
      "   0.  +0.01j -0.01+0.03j -0.04+0.02j]\n",
      " [ 0.  -0.02j  0.02-0.01j -0.08-0.03j  0.02-0.j   -0.02+0.02j  0.11+0.j\n",
      "   0.02-0.01j -0.01-0.01j -0.01-0.01j]\n",
      " [-0.  +0.01j -0.01-0.02j -0.  -0.01j  0.01+0.01j  0.  -0.01j  0.02+0.01j\n",
      "   0.09+0.j   -0.  +0.03j -0.03+0.01j]\n",
      " [-0.  +0.02j -0.01+0.02j  0.03+0.02j  0.04-0.01j -0.01-0.03j -0.01+0.01j\n",
      "  -0.  -0.03j  0.09+0.j    0.01+0.j  ]\n",
      " [-0.01+0.03j  0.01+0.01j -0.01+0.03j -0.03-0.01j -0.04-0.02j -0.01+0.01j\n",
      "  -0.03-0.01j  0.01-0.j    0.07+0.j  ]]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "rho = random_state(2, system_dim=3) # generate a random 2-qutrit state\n",
    "\n",
    "print(f'The number of systems of the state is {rho.num_systems}', end=split_line)\n",
    "print(f'The dimension of each system of the state is {rho.system_dim}', end=split_line)\n",
    "print(f'Are the systems composed of qutrits? {rho.are_qutrits()}', split_line)\n",
    "\n",
    "print(f'Random 2-qutrit states: {rho}')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The corresponding qutrit circuit is as follows:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Are the systems composed of qutrits? True\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of qubits in the circuit is 0\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of qutrits in the circuit is 2\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of systems in the circuit is 2\n",
      "----------------------------------------------------------------------------------------------------\n"
     ]
    }
   ],
   "source": [
    "cir = Circuit(num_systems=2, system_dim=3)  # create a circuit with 2 systems, each of dimension 3\n",
    "\n",
    "print(f'Are the systems composed of qutrits? {cir().are_qutrits()}', end=split_line)\n",
    "print(f'The total number of qubits in the circuit is {cir.num_qubits}', end=split_line)\n",
    "print(f'The total number of qutrits in the circuit is {cir.num_qutrits}', end=split_line)\n",
    "print(f'The total number of systems in the circuit is {cir.num_systems}', end=split_line)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Setup for general cases\n",
    "\n",
    "QuAIRKit supports general $d$-dimensional setup for qudits, as well as their compound, by setting `system_dim` as $[d_0, d_2, d_3, \\cdots, d_{n-1}]$.\n",
    "\n",
    "For example, to configure a 3-qudit system with dimensions $[2, 3, 6]$:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The number of systems of the state is 3\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The dimension of each system of the state is [2, 3, 6]\n",
      "----------------------------------------------------------------------------------------------------\n",
      "Random 3-qudit states: \n",
      "---------------------------------------------------\n",
      " Backend: density_matrix\n",
      " System dimension: [2, 3, 6]\n",
      " System sequence: [0, 1, 2]\n",
      "[[ 0.03+0.j    0.  -0.01j -0.  -0.01j ...  0.02+0.j   -0.01-0.02j\n",
      "   0.01+0.j  ]\n",
      " [ 0.  +0.01j  0.01+0.j    0.  -0.j   ... -0.01-0.j    0.01-0.01j\n",
      "  -0.01-0.j  ]\n",
      " [-0.  +0.01j  0.  +0.j    0.01+0.j   ... -0.01+0.01j  0.  -0.j\n",
      "   0.  +0.j  ]\n",
      " ...\n",
      " [ 0.02-0.j   -0.01+0.j   -0.01-0.01j ...  0.04+0.j   -0.  +0.j\n",
      "   0.01-0.01j]\n",
      " [-0.01+0.02j  0.01+0.01j  0.  +0.j   ... -0.  -0.j    0.03+0.j\n",
      "  -0.  -0.01j]\n",
      " [ 0.01-0.j   -0.01+0.j    0.  -0.j   ...  0.01+0.01j -0.  +0.01j\n",
      "   0.03+0.j  ]]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "rho = random_state(num_systems=3, system_dim=[2, 3, 6])   # generate a random state with 3 systems of dimensions [2, 3, 6]\n",
    "\n",
    "print(f'The number of systems of the state is {rho.num_systems}', end=split_line)\n",
    "print(f'The dimension of each system of the state is {rho.system_dim}', end=split_line)\n",
    "\n",
    "print(f'Random 3-qudit states: {rho}')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For clarity, the following figure illustrates compound dimensions of qudits in a quantum circuit.\n",
    "\n",
    "<figure style=\"text-align: center;\">\n",
    "  <img src=\".\\figures\\tutorial of qudit circuit.svg\" alt=\"alt text\" width=\"150\"/>\n",
    "  <figcaption>Fig.1: Depiction of a qudit circuit with compound dimensions.</figcaption>\n",
    "</figure>\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The total number of qubits in the circuit is 1\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of qutrits in the circuit is 1\n",
      "----------------------------------------------------------------------------------------------------\n",
      "The total number of systems in the circuit is 3\n",
      "----------------------------------------------------------------------------------------------------\n"
     ]
    }
   ],
   "source": [
    "cir = Circuit(3, system_dim=[2, 3, 6])  # generate a random state with 3 systems of dimensions [2, 3, 6]\n",
    "\n",
    "print(f'The total number of qubits in the circuit is {cir.num_qubits}', end=split_line)\n",
    "print(f'The total number of qutrits in the circuit is {cir.num_qutrits}', end=split_line)\n",
    "print(f'The total number of systems in the circuit is {cir.num_systems}', end=split_line)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Operations in qudit circuits\n",
    "\n",
    "QuAIRKit offers a variety of operations for qudit circuits, including:\n",
    "\n",
    "- [Adding custom gates](#Adding-custom-gates)\n",
    "- [Adding custom channels](#Adding-custom-channels)\n",
    "- [Measurement](#Measurement)\n",
    "\n",
    "In this section, we will demonstrate how to use these operations."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Adding custom gates\n",
    "\n",
    "One can define and incorporate custom gates into qudit circuits. Here is an example of how to define custom gates in qudit circuits:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The diagram of the qudit circuit:\n"
     ]
    },
    {
     "data": {
      "image/png": "iVBORw0KGgoAAAANSUhEUgAAAOsAAACyCAYAAACjizjqAAAAOXRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjkuMiwgaHR0cHM6Ly9tYXRwbG90bGliLm9yZy8hTgPZAAAACXBIWXMAAA9hAAAPYQGoP6dpAAAJXElEQVR4nO3dT2gT+RvH8U/ETLNFjFKRUWixFNGDq4uILNhCBME/uIqKYA+KCspKTy5CF6KLKEoFQVDw4sWb9ORBEZU97FbPYhEFEW21JaSIhUl3Y5ywnd/hRxdKq84mYyZP+n6dNJNmniZ5k3bSfCcRBEEgAHVvXtwDAAiHWAEjiBUwglgBI4gVMIJYASOIFTCCWAEjiBUwglgBI4gVMIJYASOIFTCCWAEj5sc9ADClVCrJ9/24xwjNcRylUqma7Y9YURdKpZLa29uVz+fjHiU013U1NDRUs2CJFXXB933l83mNjIxo4cKFcY/zVYVCQa2trfJ9n1gxNy1cuNBErHHgABNgBLECRhArYASxAkYQK2AEsQJGECtgBLECRhArYASxAkYQK2AEsQJGECtgBLECRhArYASxAkaE/vB5oVD4lnNgjrP6/Ipi7rAftg8dazqdrngYoFG1trZWfRtBEIS6XuhYPc+reBjga6bWNLKmlmtGhY6VdXGAmWq5ZhQHmAAjiBUwglgBI4gVMIJYASOIFTCCWAEjiBUwglgBI4gVMIJYASOIFTCCWAEjiBUwglgBI4gVMIJYASOIFTCCWNGw+vv7lclktHjxYrW0tKizs1MPHjyIe6yKESsazuTkpA4fPqxsNqve3l6NjY1pdHRUBw8e1I4dO3T79u24R6xIIgi7DiLwDRUKBaXTaXmeV/UCZOfPn9f169f15MkTLVu2bNq2ffv2aWxsTI8fP65qH1HOGxavrGgo4+Pj6uvrUzabnRGqJK1atUojIyMxTFY9YkVDefjwoYrForq7u2fdPjw8PGvEFhArGkoul1Nzc7NaWlpmbJuYmNC9e/e0e/fuGCarHrGiobS1talYLCqXy83YdubMGaXTafX09MQwWfWIFQ1l586dWrlypY4ePap3795Jkt68eaPjx4+rv79fd+7cMXt2CWJFQ0mlUnr06JFaW1vV1dWlBQsWaMuWLWpubtbg4KDWrl0b94gV460b1IU43gqpBm/dAPis0GeRi0qpVJLv+7Xebd1wHEepVCruMWBQTWMtlUpqb29XPp+v5W7riuu6GhoaIlj8ZzWN1fd95fP5mp6Atp5MnTDY931ixX9W8x+DpdqegBZoFBxgAowgVsAIYgWMIFbACGIFjCBWwAhiBYwgVsAIYgWMIFbACGIFjDAd64oVK3Tz5s0Zl2cyGZ09e/bffycSCd2/f/+z15nt/0C9MR1rWEuWLNGpU6f0zz//xD0KULE5EevRo0c1MTGhGzduxD0KULE5Eet3332nvr4+/fbbbyoUCnGPA1RkTsQqSQcOHFBHR4cuXLjw1euWSiVt2rRJmUxGGzZs0K1bt2owIfBloT98HsUrUtSvaslkUuVyecbl5XJZyWRy2mWJREJXrlzR5s2b9fPPP3/xdpuamvTHH38omUzK8zytWbPms6djqASv7jNZvU+imDvsQgyhY02n0xUP8620t7fr1atX0y6bnJzUmzdv1NHRMeP6P/74o/bs2aPe3t4v3m4ikfg39r/++ivytWZbW1sjvT3EJ4rHMuxqwKFj9Tyv4mGmTK1BFJUjR46op6dH27dvV1dXlz5+/KiLFy8qkUho27Zts35NX1+fVq9erebmZmUymc/etud5+umnn/T8+XNdunQpspklzdk1qL4k6udGrdTysQwdaz0+ubq7u1UqlXTy5EkNDw8rlUpp48aN+v3337Vo0aJZv6atrU2//PLLV393TafTGhgY0Pv377Vhwwbt378/sp8uWIOqcdTysazpivxWVl33fV/JZFKJRELFYlE//PCDnj17pqampqpu18r3Hwdr900c88ayumG9e/nypXp6ejRv3jx9+vRJ586dqzpUoFrEOovvv/9eAwMDcY8BTDNn3mcFrCNWwAhiBYwgVsAIYgWMIFbACGIFjCBWwAhiBYwgVsAIYgWMIFbAiFj+kN/qEh7Vmqvf939h5T6KY86axuo4jlzXNbkiQFRc15XjOHGPUXcsPjdq/VjW9MPn0v9XDvR9v5a7rCuO4yiVSsU9Rl36Fs+NqeVivsXyK7V+LGseK1BL1lag+BIOMAFGECtgBLECRhArYASxAkYQK2AEsQJGECtgBLECRhArYASnzzDA2t9T8/fP3wax1rlSqaT29nbl8/m4RwnNdV0NDQ0RbMSItc75vq98Pm/mBMxTn3LxfZ9YI0asRnACZnCACTCCWAEjiBUwglgBI4gVMIJYASOIFTCCWAEjiBUwglgBI4gVMIJYASOIdQ7q7+9XJpPR4sWL1dLSos7OTj148CDusfAVxDqHTE5O6vDhw8pms+rt7dXY2JhGR0d18OBB7dixQ7dv3457xMiMjo7qxIkTWrdunSTp7t27MU8UgQB1zfO8QFLgeV7Vt3Xu3LnAdd0gl8vN2LZ3795g06ZNVe8jynkrlc/ngyVLlgTJZDKQFEgKHMcJrl69GttMUeCVdY4YHx9XX1+fstmsli1bNmP7qlWrNDIyEsNk0bt27ZomJiZULpf/vcz3fWWzWX369CnGyaoT+sPnVs5I3Wiiut8fPnyoYrGo7u7uWbcPDw/PGnGl4ny+/Pnnn7NG+ffff+vFixfq6OiIYarPC7uoQOhY0+l0xcMgfrlcTs3NzWppaZmxbWJiQvfu3VNvb29k+6vHM5hPTk5q/fr1cY8xQxDyFMmhY/U8r+JhULmpNY2q1dbWpmKxqFwup+XLl0/bdubMGaXTafX09FS9nylxrhn18uVLdXZ2TlsRsqmpSYcOHdLly5djmSkScf/SjC+L6oDNx48fg5UrVwZbt24N3r59GwRBELx+/To4duxY4LpuMDg4GMW4dXGAKQiCYGBgIFi3bl0gKViwYEHw66+/BuVyOdaZqsWCaXNEKpXSo0ePdPr0aXV1denDhw9aunSpdu3apcHBQS1dujTuESPV1dWlp0+fqlwua/78+UokEnGPVLVEEIT8gRmxKBQKSqfT8jzPxOqG1ua1hLduACOIFTCCWAEjiBUwglgBI4gVMIJYASOIFTCCWAEjiBUwglgBI4gVMIJYASP4iJwRVpbVsTKnRcRa5xzHkeu6dblMyue4rivHceIeo+HweVYDSqXStCVK6p3jOEqlUnGP0XCIFTCCA0yAEcQKGEGsgBHEChhBrIARxAoYQayAEcQKGEGsgBHEChhBrIARxAoYQayAEcQKGPE/TjKnoqEO0PAAAAAASUVORK5CYII=",
      "text/plain": [
       "<Figure size 224x165 with 1 Axes>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "# generate a random state with 3 systems of dimensions [2, 3, 6]\n",
    "cir = Circuit(3, system_dim=[2, 3, 6])  \n",
    "\n",
    "# add a 3-dimension gate acting on the system 1\n",
    "cir.universal_qudits([1])  \n",
    "# add a 6-dimension custom gate acting on the system 2\n",
    "cir.oracle(random_unitary(1, system_dim=6), system_idx=[2]) \n",
    "# add a custom gate with the system 2 as control qudit acting on the 3 systems \n",
    "cir.control_oracle(random_unitary(2, system_dim=[3, 2]), system_idx=[2, 1, 0])  \n",
    "\n",
    "print('The diagram of the qudit circuit:')\n",
    "cir.plot()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Adding custom channels\n",
    "\n",
    "One can create and integrate custom channels into qudit circuits. Here’s a simple example of how to create a replacement channel in QuAIRKit:\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The first system is replaced with state \n",
      "---------------------------------------------------\n",
      " Backend: density_matrix\n",
      " System dimension: [4]\n",
      " System sequence: [0]\n",
      "[[ 0.36+0.j   -0.05-0.01j -0.12-0.06j -0.02+0.21j]\n",
      " [-0.05+0.01j  0.3 +0.j   -0.1 +0.02j -0.16-0.06j]\n",
      " [-0.12+0.06j -0.1 -0.02j  0.11+0.j    0.02-0.06j]\n",
      " [-0.02-0.21j -0.16+0.06j  0.02+0.06j  0.23+0.j  ]]\n",
      "---------------------------------------------------\n",
      "\n",
      "while the output state of first system is: \n",
      "---------------------------------------------------\n",
      " Backend: density_matrix\n",
      " System dimension: [4]\n",
      " System sequence: [0]\n",
      "[[ 0.36+0.j   -0.05-0.01j -0.12-0.06j -0.02+0.21j]\n",
      " [-0.05+0.01j  0.3 +0.j   -0.1 +0.02j -0.16-0.06j]\n",
      " [-0.12+0.06j -0.1 -0.02j  0.11+0.j    0.02-0.06j]\n",
      " [-0.02-0.21j -0.16+0.06j  0.02+0.06j  0.23+0.j  ]]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "# create a circuit with 3 qudits and dimensions [2, 3, 6] for corresponding qudit systems\n",
    "cir = Circuit(3, system_dim=[4, 3, 2])  \n",
    "\n",
    "rho = random_state(1, system_dim=4) # create a random state \n",
    "\n",
    "# generate the replacement channel in Choi representation\n",
    "replacement_choi_repr = replacement_choi(rho) \n",
    "# add the replacement channel acting on the system 0\n",
    "cir.choi_channel(replacement_choi_repr, system_idx=[0]) \n",
    "\n",
    "print('The first system is replaced with state', rho)\n",
    "print('while the output state of first system is:', cir().trace([1, 2]))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Similarly, QuAIRKit also supports batch computation for qudits. The following code demonstrates a simple example of batch computation in circuits:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The output state of the second system is: \n",
      "---------------------------------------------------\n",
      " Backend: density_matrix\n",
      " System dimension: [3]\n",
      " System sequence: [0]\n",
      " Batch size: [5]\n",
      "\n",
      " # 0:\n",
      "[[ 0.28+0.j   -0.05+0.24j  0.02-0.11j]\n",
      " [-0.05-0.24j  0.49+0.j   -0.04-0.21j]\n",
      " [ 0.02+0.11j -0.04+0.21j  0.23+0.j  ]]\n",
      " # 1:\n",
      "[[ 0.28+0.j   -0.05+0.24j  0.02-0.11j]\n",
      " [-0.05-0.24j  0.49+0.j   -0.04-0.21j]\n",
      " [ 0.02+0.11j -0.04+0.21j  0.23+0.j  ]]\n",
      " # 2:\n",
      "[[ 0.28+0.j   -0.05+0.24j  0.02-0.11j]\n",
      " [-0.05-0.24j  0.49+0.j   -0.04-0.21j]\n",
      " [ 0.02+0.11j -0.04+0.21j  0.23+0.j  ]]\n",
      " # 3:\n",
      "[[ 0.28+0.j   -0.05+0.24j  0.02-0.11j]\n",
      " [-0.05-0.24j  0.49+0.j   -0.04-0.21j]\n",
      " [ 0.02+0.11j -0.04+0.21j  0.23+0.j  ]]\n",
      " # 4:\n",
      "[[ 0.28+0.j   -0.05+0.24j  0.02-0.11j]\n",
      " [-0.05-0.24j  0.49+0.j   -0.04-0.21j]\n",
      " [ 0.02+0.11j -0.04+0.21j  0.23+0.j  ]]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "batch_size = 5  # the numbar of batch size\n",
    "\n",
    "# create a circuit with 3 qudits and dimensions [2, 3, 6] for corresponding qudit systems\n",
    "cir = Circuit(3, system_dim=[2, 3, 6])  \n",
    "cir.universal_qudits(system_idx=[0, 1])  # add a universal gate to qudit system 0 and 1\n",
    "cir.oracle(random_unitary(1, size=batch_size, system_dim=6), system_idx=[2])    # add an custom gate to qudit system 2\n",
    "\n",
    "print('The output state of the second system is:', cir().trace([0, 2]))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Measurement\n",
    "\n",
    "Measurement operations in qudits are similar to those in qubit systems. Users just need to set the measurement basis dimensions to match the corresponding qudit system."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "The first state for obtaining measurement result '1' for the system 0 is "
     ]
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "---------------------------------------------------\n",
      " Backend: state_vector\n",
      " System dimension: [2, 3, 6]\n",
      " System sequence: [0, 1, 2]\n",
      "[ 0.14-0.18j -0.02+0.13j  0.05-0.21j -0.  -0.03j  0.05-0.1j  -0.05-0.j\n",
      "  0.09-0.18j  0.  +0.11j  0.01-0.19j -0.  -0.02j  0.03-0.09j -0.04+0.01j\n",
      "  0.22+0.24j -0.18-0.06j  0.28+0.13j  0.04+0.01j  0.13+0.09j  0.01-0.07j\n",
      " -0.14+0.18j  0.02-0.13j -0.05+0.21j  0.  +0.03j -0.05+0.1j   0.05+0.j\n",
      " -0.09+0.18j -0.  -0.11j -0.01+0.19j  0.  +0.02j -0.03+0.09j  0.04-0.01j\n",
      " -0.22-0.24j  0.18+0.06j -0.28-0.13j -0.04-0.01j -0.13-0.09j -0.01+0.07j]\n",
      "---------------------------------------------------\n",
      "\n",
      "The first state for obtaining measurement result '2' for the system 1, and '4' for the system 2 is \n",
      "---------------------------------------------------\n",
      " Backend: state_vector\n",
      " System dimension: [2, 3, 6]\n",
      " System sequence: [0, 1, 2]\n",
      "[ 0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j\n",
      "  0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j\n",
      "  0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.34+0.47j  0.  +0.j\n",
      "  0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j\n",
      "  0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j\n",
      "  0.  +0.j    0.  +0.j    0.  +0.j    0.  +0.j   -0.74-0.33j  0.  +0.j  ]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "op = Measure('x') # define Pauli X basis as the measurement basis \n",
    "\n",
    "# measure the system 0 in the X basis for obtaining measurement result '1'\n",
    "prob, state = op(cir(), system_idx=[0], keep_state=True, desired_result='1')    \n",
    "print(\"The first state for obtaining measurement result '1' for the system 0 is\", state[0])\n",
    "\n",
    "\n",
    "op = Measure()  # computational basis as the measurement basis \n",
    "\n",
    "# measure systems 1 and 2, and obtaining measurement result '2' for the system 1, and '4' for the system 2\n",
    "prob, state = op(cir(), system_idx=[1, 2], desired_result='24', keep_state=True)\n",
    "print(\"The first state for obtaining measurement result '2' for the system 1, and '4' for the system 2 is\", state[0])"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "After measuring some qudits, if we want to perform additional operations, users can utilize the `cir.collapse` function to collapse the measured qudits. By printing the output state of the circuit, the average probability distribution of the collapsed qudits is obtained.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "systems [1, 2] collapse to the state |1>|3> with (average) probability 0.009825415569497007\n",
      "\n",
      " After collapsing the second qudit to its first eigenstate and the third qudit to its third eigenstate the state of the first system is: \n",
      "---------------------------------------------------\n",
      " Backend: density_matrix\n",
      " System dimension: [2]\n",
      " System sequence: [0]\n",
      " Batch size: [5]\n",
      "\n",
      " # 0:\n",
      "[[0.95+0.j   0.08+0.19j]\n",
      " [0.08-0.19j 0.05+0.j  ]]\n",
      " # 1:\n",
      "[[0.95+0.j   0.08+0.19j]\n",
      " [0.08-0.19j 0.05+0.j  ]]\n",
      " # 2:\n",
      "[[0.95+0.j   0.08+0.19j]\n",
      " [0.08-0.19j 0.05+0.j  ]]\n",
      " # 3:\n",
      "[[0.95+0.j   0.08+0.19j]\n",
      " [0.08-0.19j 0.05+0.j  ]]\n",
      " # 4:\n",
      "[[0.95+0.j   0.08+0.19j]\n",
      " [0.08-0.19j 0.05+0.j  ]]\n",
      "---------------------------------------------------\n",
      "\n"
     ]
    }
   ],
   "source": [
    "batch_size = 5  # the numbar of batch size\n",
    "\n",
    "# create a circuit with 3 qudits and dimensions [2, 3, 6] for corresponding qudit systems\n",
    "cir = Circuit(3, system_dim=[2, 3, 6])  \n",
    "\n",
    "cir.universal_qudits(system_idx=[0, 1])  # add a universal gate to qudit system 0 and 1\n",
    "cir.oracle(random_unitary(1, size=batch_size, system_dim=6), system_idx=[2])    # add an custom gate to qudit system 2\n",
    "\n",
    "# Collapse the second qudit to its first eigenstate and the third qudit to its third eigenstate\n",
    "cir.collapse([1, 2], desired_result='13', if_print=True)\n",
    "\n",
    "print(\"\\n After collapsing the second qudit to its first eigenstate and the third qudit to its third eigenstate\",\n",
    "      \"the state of the first system is:\", cir().trace([1, 2]))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "---"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "---------VERSION---------\n",
      "quairkit: 0.2.0\n",
      "torch: 2.4.1+cpu\n",
      "numpy: 1.26.0\n",
      "scipy: 1.14.1\n",
      "matplotlib: 3.9.2\n",
      "---------SYSTEM---------\n",
      "Python version: 3.10.15\n",
      "OS: Windows\n",
      "OS version: 10.0.26100\n",
      "---------DEVICE---------\n",
      "CPU: ARMv8 (64-bit) Family 8 Model 1 Revision 201, Qualcomm Technologies Inc\n"
     ]
    }
   ],
   "source": [
    "qkit.print_info()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "quair_test",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.10.15"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}