qpp/ in front of \file

Signed-off-by: Vlad Gheorghiu <[email protected]>
softwareQinc · Jul 17, 2024 · 6b1cc3e · 6b1cc3e
1 parent 6335eab
commit 6b1cc3e
Show file tree

Hide file tree

Showing 38 changed files with 42 additions and 42 deletions.
diff --git a/include/qpp/MATLAB/matlab.hpp b/include/qpp/MATLAB/matlab.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file MATLAB/matlab.hpp
+ * \file qpp/MATLAB/matlab.hpp
  * \brief Input/output interfacing with MATLAB
  */
 

diff --git a/include/qpp/classes/codes.hpp b/include/qpp/classes/codes.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/codes.hpp
+ * \file qpp/classes/codes.hpp
  * \brief Quantum error correcting codes
  */
 

diff --git a/include/qpp/classes/exception.hpp b/include/qpp/classes/exception.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/exception.hpp
+ * \file qpp/classes/exception.hpp
  * \brief Exceptions
  */
 

diff --git a/include/qpp/classes/gates.hpp b/include/qpp/classes/gates.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/gates.hpp
+ * \file qpp/classes/gates.hpp
  * \brief Quantum gates
  */
 

diff --git a/include/qpp/classes/idisplay.hpp b/include/qpp/classes/idisplay.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/idisplay.hpp
+ * \file qpp/classes/idisplay.hpp
  * \brief Textual representation interface
  */
 

diff --git a/include/qpp/classes/ijson.hpp b/include/qpp/classes/ijson.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/ijson.hpp
+ * \file qpp/classes/ijson.hpp
  * \brief Basic JSON serialization
  */
 

diff --git a/include/qpp/classes/init.hpp b/include/qpp/classes/init.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/init.hpp
+ * \file qpp/classes/init.hpp
  * \brief Initialization
  */
 

diff --git a/include/qpp/classes/layouts.hpp b/include/qpp/classes/layouts.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/layouts.hpp
+ * \file qpp/classes/layouts.hpp
  * \see qpp::ILayout
  * \brief Various qudit placement layouts, all must implement the interface
  * \a qpp::ILayout

diff --git a/include/qpp/classes/noise.hpp b/include/qpp/classes/noise.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/noise.hpp
+ * \file qpp/classes/noise.hpp
  * \brief Noise models
  */
 

diff --git a/include/qpp/classes/qbase_engine.hpp b/include/qpp/classes/qbase_engine.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/qbase_engine.hpp
+ * \file qpp/classes/qbase_engine.hpp
  * \brief Base class for quantum engines
  */
 

diff --git a/include/qpp/classes/qcircuit_traits.hpp b/include/qpp/classes/qcircuit_traits.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/qcircuit_traits.hpp
+ * \file qpp/classes/qcircuit_traits.hpp
  * \brief Quantum circuit traits (compile-time)
  */
 

diff --git a/include/qpp/classes/qdummy_engine.hpp b/include/qpp/classes/qdummy_engine.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/qdummy_engine.hpp
+ * \file qpp/classes/qdummy_engine.hpp
  * \brief No-op (dummy) quantum engines
  */
 

diff --git a/include/qpp/classes/qengine.hpp b/include/qpp/classes/qengine.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/qengine.hpp
+ * \file qpp/classes/qengine.hpp
  * \brief Quantum engines
  */
 

diff --git a/include/qpp/classes/qengine_traits.hpp b/include/qpp/classes/qengine_traits.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/qengine_traits.hpp
+ * \file qpp/classes/qengine_traits.hpp
  * \brief Quantum engine traits (run-time)
  */
 

diff --git a/include/qpp/classes/qnoisy_engine.hpp b/include/qpp/classes/qnoisy_engine.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/qnoisy_engine.hpp
+ * \file qpp/classes/qnoisy_engine.hpp
  * \brief Noisy quantum engines
  */
 

diff --git a/include/qpp/classes/random_devices.hpp b/include/qpp/classes/random_devices.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/random_devices.hpp
+ * \file qpp/classes/random_devices.hpp
  * \brief Random devices
  */
 

diff --git a/include/qpp/classes/reversible.hpp b/include/qpp/classes/reversible.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/reversible.hpp
+ * \file qpp/classes/reversible.hpp
  * \brief Support for classical reversible circuits
  */
 

diff --git a/include/qpp/classes/states.hpp b/include/qpp/classes/states.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/states.hpp
+ * \file qpp/classes/states.hpp
  * \brief Quantum states
  */
 

diff --git a/include/qpp/classes/timer.hpp b/include/qpp/classes/timer.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file classes/timer.hpp
+ * \file qpp/classes/timer.hpp
  * \brief Timing
  */
 

diff --git a/include/qpp/constants.hpp b/include/qpp/constants.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file constants.hpp
+ * \file qpp/constants.hpp
  * \brief Constants
  */
 

diff --git a/include/qpp/entanglement.hpp b/include/qpp/entanglement.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file entanglement.hpp
+ * \file qpp/entanglement.hpp
  * \brief Entanglement functions
  */
 

diff --git a/include/qpp/entropies.hpp b/include/qpp/entropies.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file entropies.hpp
+ * \file qpp/entropies.hpp
  * \brief Entropy functions
  */
 

diff --git a/include/qpp/experimental/experimental.hpp b/include/qpp/experimental/experimental.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file experimental/experimental.hpp
+ * \file qpp/experimental/experimental.hpp
  * \brief Experimental/test functions/classes
  */
 
@@ -195,7 +195,7 @@ measure_seq(const Eigen::MatrixBase<Derived>& A, std::vector<idx> target,
 #endif // QPP_OPENMP
                 { out_state += current_ket; }
             } // end if(overlap_ket)
-        }     // end for
+        } // end for
         realT norm_out_state = norm(out_state);
         prob = norm_out_state * norm_out_state;
         out_state = out_state / norm_out_state;
@@ -249,9 +249,9 @@ measure_seq(const Eigen::MatrixBase<Derived>& A, std::vector<idx> target,
 #endif // QPP_OPENMP
                         { out_state += cA(i, j) * current_ket * current_bra; }
                     } // end if(overlap_bra)
-                }     // end for(all bras)
-            }         // end if(overlap_ket)
-        }             // end for(all kets)
+                } // end for(all bras)
+            } // end if(overlap_ket)
+        } // end for(all kets)
         prob = trace(out_state).real();
         out_state = out_state / prob;
     } // end else(density matrix)

diff --git a/include/qpp/functions.hpp b/include/qpp/functions.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file functions.hpp
+ * \file qpp/functions.hpp
  * \brief Generic quantum computing functions
  */
 

diff --git a/include/qpp/input_output.hpp b/include/qpp/input_output.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file input_output.hpp
+ * \file qpp/input_output.hpp
  * \brief Input/output functions
  */
 

diff --git a/include/qpp/instruments.hpp b/include/qpp/instruments.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file instruments.hpp
+ * \file qpp/instruments.hpp
  * \brief Measurement functions
  */
 

diff --git a/include/qpp/internal/classes/iomanip.hpp b/include/qpp/internal/classes/iomanip.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file internal/classes/iomanip.hpp
+ * \file qpp/internal/classes/iomanip.hpp
  * \brief Input/output manipulators
  */
 

diff --git a/include/qpp/internal/classes/singleton.hpp b/include/qpp/internal/classes/singleton.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file internal/classes/singleton.hpp
+ * \file qpp/internal/classes/singleton.hpp
  * \brief Singleton pattern via CRTP
  */
 

diff --git a/include/qpp/internal/util.hpp b/include/qpp/internal/util.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file internal/util.hpp
+ * \file qpp/internal/util.hpp
  * \brief Internal utility functions
  */
 

diff --git a/include/qpp/number_theory.hpp b/include/qpp/number_theory.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file number_theory.hpp
+ * \file qpp/number_theory.hpp
  * \brief Number theory functions
  */
 

diff --git a/include/qpp/operations.hpp b/include/qpp/operations.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file operations.hpp
+ * \file qpp/operations.hpp
  * \brief Quantum operation functions
  */
 

diff --git a/include/qpp/options.hpp b/include/qpp/options.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file options.hpp
+ * \file qpp/options.hpp
  * \brief Options
  */
 

diff --git a/include/qpp/qasm/qasm.hpp b/include/qpp/qasm/qasm.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file qasm/qasm.hpp
+ * \file qpp/qasm/qasm.hpp
  * \brief OpenQASM to QCircuit interface
  */
 

diff --git a/include/qpp/qpp.h b/include/qpp/qpp.h
@@ -32,7 +32,7 @@
 // ALWAYS include it in main.cpp
 
 /**
- * \file qpp.h
+ * \file qpp/qpp.h
  * \brief Quantum++ main header file, includes all other required headers
  */
 

diff --git a/include/qpp/random.hpp b/include/qpp/random.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file random.hpp
+ * \file qpp/random.hpp
  * \brief Randomness-related functions
  */
 

diff --git a/include/qpp/statistics.hpp b/include/qpp/statistics.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file statistics.hpp
+ * \file qpp/statistics.hpp
  * \brief Statistics functions
  */
 

diff --git a/include/qpp/traits.hpp b/include/qpp/traits.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file traits.hpp
+ * \file qpp/traits.hpp
  * \brief Type traits
  */
 

diff --git a/include/qpp/types.hpp b/include/qpp/types.hpp
@@ -25,7 +25,7 @@
  */
 
 /**
- * \file types.hpp
+ * \file qpp/types.hpp
  * \brief Type aliases
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,7 +25,7 @@ @@
      */
     /**
-     * \file MATLAB/matlab.hpp
+     * \file qpp/MATLAB/matlab.hpp
      * \brief Input/output interfacing with MATLAB
      */
@@ Expand Down @@