Preparing the QuantumSimulator for unifying the Dump(). (#867)

* Moved some classes from IQSharp

Author: kuzminrobin

src/Simulation/Core/IOperationFactory.cs

@@ -24,7 +24,7 @@ public interface IOperationFactory
         /// <summary>
         /// Returns an instance of the requested operation.
         /// </summary>
-        I Get<I>(Type T);
+        I Get<I>(Type t);
 
         /// <summary>
         /// Returns an instance of the requested operation.

src/Simulation/Native/src/simulator/capi.hpp

@@ -22,6 +22,8 @@ extern "C"
     MICROSOFT_QUANTUM_DECL void destroy(_In_ unsigned sid); // NOLINT
     MICROSOFT_QUANTUM_DECL void seed(_In_ unsigned sid, _In_ unsigned s); // NOLINT
     MICROSOFT_QUANTUM_DECL void Dump(_In_ unsigned sid, _In_ bool (*callback)(size_t, double, double));
+    
+    // TODO(rokuzmin): What does it return?
     MICROSOFT_QUANTUM_DECL bool DumpQubits(
         _In_ unsigned sid,
         _In_ unsigned n,

src/Simulation/Native/src/simulator/simulatorinterface.hpp

@@ -99,6 +99,7 @@ class SimulatorInterface
     {
         assert(false);
     }
+    // TODO(rokuzmin): What does it return?
     virtual bool dumpQubits(std::vector<logical_qubit_id> const& qs, bool (*callback)(size_t, double, double))
     {
         assert(false);

src/Simulation/Simulators/QuantumSimulator/Dump.cs

@@ -23,48 +23,29 @@ protected virtual QVoid Dump<T>(T target, IQArray<Qubit>? qubits = null)
         {
             var filename = (target is QVoid) ? "" : target.ToString();
 
-            QVoid process(Action<string> channel)
-            {
-                var ids = qubits?.Select(q => (uint)q.Id).ToArray() ?? QubitIds;
-
-                var dumper = new SimpleDumper(this, channel);
-                channel($"# wave function for qubits with ids (least to most significant): {string.Join(";", ids)}");
-
-                if (!dumper.Dump(qubits))
-                {
-                    channel("## Qubits were entangled with an external qubit. Cannot dump corresponding wave function. ##");
-                }
-
-                return QVoid.Instance;
-            }
-
-            var logMessage = this.Get<ICallable<string, QVoid>, Microsoft.Quantum.Intrinsic.Message>();
-
-            // If no file provided, use `Message` to generate the message into the console;
+            // If no file provided, output to the console;
             if (string.IsNullOrWhiteSpace(filename))
             {
-                var op = this.Get<ICallable<string, QVoid>, Microsoft.Quantum.Intrinsic.Message>();
-                return process((msg) => op.Apply(msg));
+                new DisplayableStateDumper(this).Dump(qubits);
             }
             else
             {
                 try
                 {
-                    using (var file = new StreamWriter(filename))
-                    {
-                        return process(file.WriteLine);
-                    }
+                    using var file = new StreamWriter(filename);
+                    new DisplayableStateDumper(this, file.WriteLine).Dump(qubits);
                 }
                 catch (Exception e)
                 {
+                    var logMessage = this.Get<ICallable<string, QVoid>, Microsoft.Quantum.Intrinsic.Message>();
                     logMessage.Apply($"[warning] Unable to write state to '{filename}' ({e.Message})");
-                    return QVoid.Instance;
                 }
             }
+            return QVoid.Instance;
         }
 
-        public class QsimDumpMachine<T> : Quantum.Diagnostics.DumpMachine<T>
-        {
+        public class QsimDumpMachine<T> : Quantum.Diagnostics.DumpMachine<T> // Is inherited (and replaced at runtime)
+        {                                                                    // by (iqsharp's) JupyterDumpMachine<T>.
             private QuantumSimulator Simulator { get; }
 
             public QsimDumpMachine(QuantumSimulator m) : base(m)
@@ -80,8 +61,8 @@ public QsimDumpMachine(QuantumSimulator m) : base(m)
             };
         }
 
-        public class QSimDumpRegister<T> : Quantum.Diagnostics.DumpRegister<T>
-        {
+        public class QSimDumpRegister<T> : Quantum.Diagnostics.DumpRegister<T> // Is inherited (and replaced at runtime)
+        {                                                                      // by (iqsharp's) JupyterDumpRegister<T>.
             private QuantumSimulator Simulator { get; }
 
             public QSimDumpRegister(QuantumSimulator m) : base(m)

src/Simulation/Simulators/QuantumSimulator/NativeImports.cs

@@ -86,6 +86,7 @@ public partial class QuantumSimulator
         [DllImport(QSIM_DLL_NAME, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl, EntryPoint = "Dump")]
         private static extern void sim_Dump(uint id, DumpCallback callback);
 
+        // TODO(rokuzmin): What does it return?
         [DllImport(QSIM_DLL_NAME, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl, EntryPoint = "DumpQubits")]
         private static extern bool sim_DumpQubits(uint id, uint cout, uint[] ids, DumpCallback callback);
 

src/Simulation/Simulators/QuantumSimulator/SimulatorBase.cs

@@ -93,9 +93,9 @@ public SimulatorBase(IQubitManager? qubitManager = null, int? seed = null)
             }
         }
 
-        public I Get<I>(Type T)
+        public I Get<I>(Type t)
         {
-            return (I)this.GetInstance(T);
+            return (I)this.GetInstance(t);
         }
 
         /// <summary>