Skip to content

Commit

Permalink
docs: in state vector notebook, add link to API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinsung committed Apr 23, 2024
1 parent 84a6d6d commit ba8415e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/explanations/state-vectors-and-gates.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
"source": [
"## Gates\n",
"\n",
"In ffsim, you apply a unitary gate to a state vector by calling a function whose name begins with `apply_`. For example, the function for applying an orbital rotation is called `apply_orbital_rotation`. The first argument to the function is always the state vector itself. The number of orbitals, as well as the number of alpha and beta electrons, are passed as the arguments `norb` and `nelec`.\n",
"In ffsim, you apply a unitary gate to a state vector by calling a function whose name begins with `apply_`. For example, the function for applying an orbital rotation is called `apply_orbital_rotation`. The first argument to the function is always the state vector itself. The number of orbitals, as well as the number of alpha and beta electrons, are passed as the arguments `norb` and `nelec`. See the [API reference](../api/ffsim.rst) for the full list of supported gates and their definitions (search for `ffsim.apply_`).\n",
"\n",
"The following code cell generates a random orbital rotation (represented by an $N \\times N$ unitary matrix) and applies it to the Hartree-Fock state vector we created previously."
]
Expand Down

0 comments on commit ba8415e

Please sign in to comment.