diff --git a/docs/densitytensor.rst b/docs/densitytensor.rst index 2554789..a5d1144 100644 --- a/docs/densitytensor.rst +++ b/docs/densitytensor.rst @@ -1,7 +1,8 @@ -densitytensor +Mixed state simulation ======================= .. toctree:: + :titlesonly: densitytensor/all_zeros_densitytensor densitytensor/kraus diff --git a/docs/densitytensor/all_zeros_densitytensor.rst b/docs/densitytensor/all_zeros_densitytensor.rst index cefd58d..26b67d9 100644 --- a/docs/densitytensor/all_zeros_densitytensor.rst +++ b/docs/densitytensor/all_zeros_densitytensor.rst @@ -1 +1,4 @@ +all_zeros_densitytensor +============================================== + .. autofunction:: qujax.all_zeros_densitytensor diff --git a/docs/densitytensor/densitytensor_to_measured_densitytensor.rst b/docs/densitytensor/densitytensor_to_measured_densitytensor.rst index 09e9f8d..c69c499 100644 --- a/docs/densitytensor/densitytensor_to_measured_densitytensor.rst +++ b/docs/densitytensor/densitytensor_to_measured_densitytensor.rst @@ -1 +1,4 @@ +densitytensor_to_measured_densitytensor +============================================== + .. autofunction:: qujax.densitytensor_to_measured_densitytensor diff --git a/docs/densitytensor/densitytensor_to_measurement_probabilities.rst b/docs/densitytensor/densitytensor_to_measurement_probabilities.rst index 619788d..723cbb8 100644 --- a/docs/densitytensor/densitytensor_to_measurement_probabilities.rst +++ b/docs/densitytensor/densitytensor_to_measurement_probabilities.rst @@ -1 +1,4 @@ +densitytensor_to_measurement_probabilities +============================================== + .. autofunction:: qujax.densitytensor_to_measurement_probabilities diff --git a/docs/densitytensor/get_densitytensor_to_expectation_func.rst b/docs/densitytensor/get_densitytensor_to_expectation_func.rst index d6763d6..6314d01 100644 --- a/docs/densitytensor/get_densitytensor_to_expectation_func.rst +++ b/docs/densitytensor/get_densitytensor_to_expectation_func.rst @@ -1 +1,4 @@ +get_densitytensor_to_expectation_func +============================================== + .. autofunction:: qujax.get_densitytensor_to_expectation_func diff --git a/docs/densitytensor/get_densitytensor_to_sampled_expectation_func.rst b/docs/densitytensor/get_densitytensor_to_sampled_expectation_func.rst index ce0815e..02371b6 100644 --- a/docs/densitytensor/get_densitytensor_to_sampled_expectation_func.rst +++ b/docs/densitytensor/get_densitytensor_to_sampled_expectation_func.rst @@ -1 +1,4 @@ +get_densitytensor_to_sampled_expectation_func +============================================== + .. autofunction:: qujax.get_densitytensor_to_sampled_expectation_func diff --git a/docs/densitytensor/get_params_to_densitytensor_func.rst b/docs/densitytensor/get_params_to_densitytensor_func.rst index bd7eb1c..a6343dc 100644 --- a/docs/densitytensor/get_params_to_densitytensor_func.rst +++ b/docs/densitytensor/get_params_to_densitytensor_func.rst @@ -1 +1,4 @@ +get_params_to_densitytensor_func +============================================== + .. autofunction:: qujax.get_params_to_densitytensor_func diff --git a/docs/densitytensor/kraus.rst b/docs/densitytensor/kraus.rst index 5467e80..e2f4720 100644 --- a/docs/densitytensor/kraus.rst +++ b/docs/densitytensor/kraus.rst @@ -1 +1,4 @@ +kraus +============================================== + .. autofunction:: qujax.kraus diff --git a/docs/densitytensor/partial_trace.rst b/docs/densitytensor/partial_trace.rst index e78e5d7..c7df4d9 100644 --- a/docs/densitytensor/partial_trace.rst +++ b/docs/densitytensor/partial_trace.rst @@ -1 +1,4 @@ +partial_trace +============================================== + .. autofunction:: qujax.partial_trace diff --git a/docs/densitytensor/statetensor_to_densitytensor.rst b/docs/densitytensor/statetensor_to_densitytensor.rst index 677fb0d..f2cc8de 100644 --- a/docs/densitytensor/statetensor_to_densitytensor.rst +++ b/docs/densitytensor/statetensor_to_densitytensor.rst @@ -1 +1,4 @@ +statetensor_to_densitytensor +============================================== + .. autofunction:: qujax.statetensor_to_densitytensor diff --git a/docs/index.rst b/docs/index.rst index 3a56bb3..7fded40 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,6 +44,7 @@ Contents .. toctree:: :caption: API Reference: + :titlesonly: Pure state simulation Mixed state simulation diff --git a/docs/statetensor.rst b/docs/statetensor.rst index 6db8d56..dea7fba 100644 --- a/docs/statetensor.rst +++ b/docs/statetensor.rst @@ -1,7 +1,8 @@ -statetensor +Pure state simulation ======================= .. toctree:: + :titlesonly: statetensor/all_zeros_statetensor statetensor/apply_gate diff --git a/docs/statetensor/all_zeros_statetensor.rst b/docs/statetensor/all_zeros_statetensor.rst index 7627f9a..76e1492 100644 --- a/docs/statetensor/all_zeros_statetensor.rst +++ b/docs/statetensor/all_zeros_statetensor.rst @@ -1 +1,4 @@ +all_zeros_statetensor +============================================== + .. autofunction:: qujax.all_zeros_statetensor diff --git a/docs/statetensor/apply_gate.rst b/docs/statetensor/apply_gate.rst index 6e4d407..a7486b0 100644 --- a/docs/statetensor/apply_gate.rst +++ b/docs/statetensor/apply_gate.rst @@ -1 +1,4 @@ +apply_gate +============================================== + .. autofunction:: qujax.apply_gate diff --git a/docs/statetensor/get_params_to_statetensor_func.rst b/docs/statetensor/get_params_to_statetensor_func.rst index c76c174..4c19368 100644 --- a/docs/statetensor/get_params_to_statetensor_func.rst +++ b/docs/statetensor/get_params_to_statetensor_func.rst @@ -1 +1,4 @@ +get_params_to_statetensor_func +============================================== + .. autofunction:: qujax.get_params_to_statetensor_func diff --git a/docs/statetensor/get_params_to_unitarytensor_func.rst b/docs/statetensor/get_params_to_unitarytensor_func.rst index 177cc73..99f83d7 100644 --- a/docs/statetensor/get_params_to_unitarytensor_func.rst +++ b/docs/statetensor/get_params_to_unitarytensor_func.rst @@ -1 +1,4 @@ +get_params_to_unitarytensor_func +============================================== + .. autofunction:: qujax.get_params_to_unitarytensor_func diff --git a/docs/statetensor/get_statetensor_to_expectation_func.rst b/docs/statetensor/get_statetensor_to_expectation_func.rst index 2f79376..f46c742 100644 --- a/docs/statetensor/get_statetensor_to_expectation_func.rst +++ b/docs/statetensor/get_statetensor_to_expectation_func.rst @@ -1 +1,4 @@ +get_statetensor_to_expectation_func +============================================== + .. autofunction:: qujax.get_statetensor_to_expectation_func diff --git a/docs/statetensor/get_statetensor_to_sampled_expectation_func.rst b/docs/statetensor/get_statetensor_to_sampled_expectation_func.rst index 77dea52..58a3fda 100644 --- a/docs/statetensor/get_statetensor_to_sampled_expectation_func.rst +++ b/docs/statetensor/get_statetensor_to_sampled_expectation_func.rst @@ -1 +1,4 @@ +get_statetensor_to_sampled_expectation_func +============================================== + .. autofunction:: qujax.get_statetensor_to_sampled_expectation_func diff --git a/docs/utils.rst b/docs/utils.rst index 078f22c..502295a 100644 --- a/docs/utils.rst +++ b/docs/utils.rst @@ -1,7 +1,8 @@ -utils +Utility functions ======================= .. toctree:: + :titlesonly: utils/bitstrings_to_integers utils/check_circuit @@ -10,4 +11,3 @@ utils utils/repeat_circuit utils/sample_bitstrings utils/sample_integers - diff --git a/docs/utils/bitstrings_to_integers.rst b/docs/utils/bitstrings_to_integers.rst index f5f221d..24bb5d6 100644 --- a/docs/utils/bitstrings_to_integers.rst +++ b/docs/utils/bitstrings_to_integers.rst @@ -1 +1,4 @@ +bitstrings_to_integers +============================================== + .. autofunction:: qujax.bitstrings_to_integers diff --git a/docs/utils/check_circuit.rst b/docs/utils/check_circuit.rst index 09f5acb..739b530 100644 --- a/docs/utils/check_circuit.rst +++ b/docs/utils/check_circuit.rst @@ -1 +1,4 @@ +check_circuit +============================================== + .. autofunction:: qujax.check_circuit diff --git a/docs/utils/integers_to_bitstrings.rst b/docs/utils/integers_to_bitstrings.rst index f8235ed..484bd5d 100644 --- a/docs/utils/integers_to_bitstrings.rst +++ b/docs/utils/integers_to_bitstrings.rst @@ -1 +1,4 @@ +integers_to_bitstrings +============================================== + .. autofunction:: qujax.integers_to_bitstrings diff --git a/docs/utils/print_circuit.rst b/docs/utils/print_circuit.rst index 7b2c53a..1d2ea62 100644 --- a/docs/utils/print_circuit.rst +++ b/docs/utils/print_circuit.rst @@ -1 +1,4 @@ +print_circuit +============================================== + .. autofunction:: qujax.print_circuit diff --git a/docs/utils/repeat_circuit.rst b/docs/utils/repeat_circuit.rst index c7b0991..895b494 100644 --- a/docs/utils/repeat_circuit.rst +++ b/docs/utils/repeat_circuit.rst @@ -1 +1,4 @@ +repeat_circuit +============================================== + .. autofunction:: qujax.repeat_circuit diff --git a/docs/utils/sample_bitstrings.rst b/docs/utils/sample_bitstrings.rst index a75877f..4f0a89e 100644 --- a/docs/utils/sample_bitstrings.rst +++ b/docs/utils/sample_bitstrings.rst @@ -1 +1,4 @@ +sample_bitstrings +============================================== + .. autofunction:: qujax.sample_bitstrings diff --git a/docs/utils/sample_integers.rst b/docs/utils/sample_integers.rst index 46bddbd..1b8498e 100644 --- a/docs/utils/sample_integers.rst +++ b/docs/utils/sample_integers.rst @@ -1 +1,4 @@ +sample_integers +============================================== + .. autofunction:: qujax.sample_integers