Merge pull request #16 from DeDuckProject/add-more-pairs

DeDuckProject · web-flow · commit ab8f00a73fc1 · 2025-05-26T18:50:51.000+03:00
Added average fidelity indication
diff --git a/.gitignore b/.gitignore
@@ -12,6 +12,9 @@ dist
 dist-ssr
 *.local
 
+# TypeScript
+*.d.ts
+
 # Editor directories and files
 .vscode/*
 !.vscode/extensions.json
diff --git a/epp-engine.md b/epp-engine.md
@@ -54,6 +54,7 @@ export interface SimulationState {
   round: number;
   complete: boolean;
   purificationStep: PurificationStep;
+  averageFidelity: number; // Average fidelity across all pairs
   pendingPairs?: {
     controlPairs: QubitPair[];
     targetPairs: QubitPair[];
@@ -239,6 +240,18 @@ This separation ensures that the engine module can focus on the protocol impleme
 
 The Monte Carlo engine in particular makes extensive use of the computational basis operators in the real calculations module.
 
+## Average Fidelity Calculation
+
+Both simulation engines automatically calculate and maintain the average fidelity across all pairs in the current state. This provides a real-time measure of the overall quality of the entangled pairs during the purification process.
+
+The average fidelity is calculated using the `calculateAverageFidelity` utility function from `src/utils/fidelityUtils.ts`, which:
+- Takes an array of QubitPair objects
+- Extracts the fidelity value from each pair
+- Returns the arithmetic mean of all fidelities
+- Handles edge cases (empty arrays return 0)
+
+This metric is automatically updated in the `getCurrentState()` method of both engines and is displayed in the control panel UI for real-time monitoring.
+
 ## Engine Selection
 
 The simulation controller allows selecting between the two engine types:
diff --git a/epp_components.md b/epp_components.md
@@ -17,6 +17,7 @@ This document defines all UI components used in the EPP (Entanglement Purificati
 - `currentRound`: number - The current purification round
 - `currentStep`: PurificationStep - The current step within the purification process
 - `pairsRemaining`: number - Number of qubit pairs remaining in the simulation
+- `averageFidelity`: number - Average fidelity across all pairs (displayed to 3 decimal places)
 
 **Example Usage**:
 ```tsx
@@ -30,6 +31,7 @@ This document defines all UI components used in the EPP (Entanglement Purificati
   currentRound={currentRound}
   currentStep={purificationStep}
   pairsRemaining={pairs.length}
+  averageFidelity={averageFidelity}
 />
 ```
 
diff --git a/src/components/App.tsx b/src/components/App.tsx
@@ -76,6 +76,7 @@ const App: React.FC = () => {
             currentRound={state.round}
             currentStep={state.purificationStep}
             pairsRemaining={state.pairs.length}
+            averageFidelity={state.averageFidelity}
             engineType={engineType}
             viewBasis={viewBasis}
           />
diff --git a/src/components/ControlPanel.d.ts b/src/components/ControlPanel.d.ts
@@ -13,6 +13,7 @@ interface ControlPanelProps {
     currentRound: number;
     currentStep: PurificationStep;
     pairsRemaining: number;
+    averageFidelity: number;
     engineType: EngineType;
     viewBasis: Basis;
     className?: string;
diff --git a/src/components/ControlPanel.tsx b/src/components/ControlPanel.tsx
@@ -18,6 +18,7 @@ interface ControlPanelProps {
   currentRound: number;
   currentStep: PurificationStep;
   pairsRemaining: number;
+  averageFidelity: number;
   engineType: EngineType;
   viewBasis: Basis;
   className?: string;
@@ -37,6 +38,7 @@ const ControlPanel: React.FC<ControlPanelProps> = ({
   currentRound,
   currentStep,
   pairsRemaining,
+  averageFidelity,
   engineType,
   viewBasis,
   className = '',
@@ -205,6 +207,7 @@ const ControlPanel: React.FC<ControlPanelProps> = ({
           <p><strong>Distillation Round:</strong> {currentRound}</p>
           <p><strong>Current Step:</strong> {currentStep}</p>
           <p><strong>Pairs Remaining:</strong> {pairsRemaining}</p>
+          <p><strong>Average Fidelity:</strong> {averageFidelity.toFixed(3)}</p>
           <p><strong>Status:</strong> {isComplete ? 'Complete' : 'In Progress'}</p>
         </div>
       </CollapsibleSection>
diff --git a/src/engine/averageSimulationEngine.ts b/src/engine/averageSimulationEngine.ts
@@ -3,6 +3,7 @@ import {createNoisyEPRWithChannel} from './quantumStates';
 import {bilateralCNOT, depolarize, exchangePsiMinusPhiPlus, preparePairsForCNOT} from './operations';
 import {BellState, fidelityFromBellBasisMatrix, toBellBasis} from "../engine_real_calculations/bell/bell-basis.ts";
 import {DensityMatrix} from "../engine_real_calculations/matrix/densityMatrix";
+import {calculateAverageFidelity} from '../utils/fidelityUtils';
 
 export class AverageSimulationEngine implements ISimulationEngine {
   private params: SimulationParameters;
@@ -34,11 +35,14 @@ export class AverageSimulationEngine implements ISimulationEngine {
       });
     }
 
+    const averageFidelity = calculateAverageFidelity(pairs);
+
     return {
       pairs,
       round: 0,
       complete: false,
-      purificationStep: 'initial'
+      purificationStep: 'initial',
+      averageFidelity
     };
   }
 
@@ -245,7 +249,11 @@ export class AverageSimulationEngine implements ISimulationEngine {
   }
 
   public getCurrentState(): SimulationState {
-    return { ...this.state };
+    const averageFidelity = calculateAverageFidelity(this.state.pairs);
+    return { 
+      ...this.state,
+      averageFidelity
+    };
   }
 
   public updateParams(params: SimulationParameters): void {
diff --git a/src/engine/monteCarloSimulationEngine.ts b/src/engine/monteCarloSimulationEngine.ts
@@ -6,6 +6,7 @@ import {pauliTwirl} from "../engine_real_calculations/operations/pauliTwirling";
 import {applyPauli, applyCNOT, tensor, measureQubit} from "../engine_real_calculations";
 import {partialTrace} from "../engine_real_calculations/operations/partialTrace";
 import {preparePairsForCNOT} from "./operations";
+import {calculateAverageFidelity} from '../utils/fidelityUtils';
 
 /**
  * Monte Carlo Simulation Engine that uses the computational basis for calculations
@@ -58,11 +59,14 @@ export class MonteCarloSimulationEngine implements ISimulationEngine {
       });
     }
     
+    const averageFidelity = calculateAverageFidelity(pairs);
+    
     return {
       pairs,
       round: 0,
       complete: false,
-      purificationStep: 'initial'
+      purificationStep: 'initial',
+      averageFidelity
     };
   }
   
@@ -394,7 +398,11 @@ export class MonteCarloSimulationEngine implements ISimulationEngine {
   }
   
   public getCurrentState(): SimulationState {
-    return { ...this.state };
+    const averageFidelity = calculateAverageFidelity(this.state.pairs);
+    return { 
+      ...this.state,
+      averageFidelity
+    };
   }
   
   public updateParams(params: SimulationParameters): void {
diff --git a/src/engine/types.d.ts b/src/engine/types.d.ts
@@ -27,6 +27,7 @@ export interface SimulationState {
     round: number;
     complete: boolean;
     purificationStep: PurificationStep;
+    averageFidelity: number;
     pendingPairs?: {
         controlPairs: QubitPair[];
         targetPairs: QubitPair[];
diff --git a/src/engine/types.ts b/src/engine/types.ts
@@ -35,6 +35,7 @@ export interface SimulationState {
   round: number;
   complete: boolean;
   purificationStep: PurificationStep;  // Track which step we're on within a round
+  averageFidelity: number; // Add average fidelity calculation
   pendingPairs?: { // Store intermediate state during a round
     controlPairs: QubitPair[];
     targetPairs: QubitPair[];
diff --git a/src/utils/fidelityUtils.ts b/src/utils/fidelityUtils.ts
@@ -0,0 +1,15 @@
+import { QubitPair } from '../engine/types';
+
+/**
+ * Calculates the average fidelity from an array of qubit pairs
+ * @param pairs Array of qubit pairs
+ * @returns Average fidelity value, or 0 if no pairs
+ */
+export function calculateAverageFidelity(pairs: QubitPair[]): number {
+  if (pairs.length === 0) {
+    return 0;
+  }
+  
+  const totalFidelity = pairs.reduce((sum, pair) => sum + pair.fidelity, 0);
+  return totalFidelity / pairs.length;
+} 
diff --git a/tests/components/App.test.tsx b/tests/components/App.test.tsx
@@ -39,6 +39,7 @@ describe('App', () => {
     round: 2,
     complete: false,
     purificationStep: 'cnot' as PurificationStep,
+    averageFidelity: 0.8,
     pendingPairs: {
       controlPairs: [{ id: 1, fidelity: 0.8, densityMatrix: {} as any, basis: Basis.Bell }],
       targetPairs: []
@@ -116,6 +117,9 @@ describe('App', () => {
     expect(screen.getByText('cnot')).toBeDefined();
     expect(screen.getByText('Pairs Remaining:')).toBeDefined();
     expect(screen.getByText('1')).toBeDefined();
+    expect(screen.getByText('Average Fidelity:')).toBeDefined();
+    // Use getAllByText to handle multiple instances of the same value
+    expect(screen.getAllByText('0.800').length).toBeGreaterThan(0);
     expect(screen.getByText('Status:')).toBeDefined();
     expect(screen.getByText('In Progress')).toBeDefined();
   });
@@ -170,7 +174,8 @@ describe('App', () => {
     render(<App />);
     
     // Check that the fidelity value from our mock state is displayed
-    expect(screen.getByText('0.800')).toBeDefined();
+    // Use getAllByText since the value appears in both ControlPanel and EnsembleDisplay
+    expect(screen.getAllByText('0.800').length).toBeGreaterThan(0);
     
     // Check that the data-view-basis attribute is set correctly on the mock EnsembleDisplay
     const ensembleDisplay = screen.getByTestId('ensemble-display');
diff --git a/tests/components/ControlPanel.test.tsx b/tests/components/ControlPanel.test.tsx
@@ -67,6 +67,7 @@ describe('ControlPanel', () => {
     currentRound: 1,
     currentStep: 'initial' as PurificationStep,
     pairsRemaining: 10,
+    averageFidelity: 0.765,
     engineType: EngineType.Average,
     viewBasis: Basis.Bell
   };
@@ -352,4 +353,18 @@ describe('ControlPanel', () => {
       expect(statusInfo).toHaveTextContent('Complete');
     });
   });
+
+  test('displays average fidelity in status section', () => {
+    render(<ControlPanel {...defaultProps} />);
+    
+    expect(screen.getByText('Average Fidelity:')).toBeInTheDocument();
+    expect(screen.getByText('0.765')).toBeInTheDocument();
+  });
+
+  test('formats average fidelity to 3 decimal places', () => {
+    render(<ControlPanel {...defaultProps} averageFidelity={0.123456789} />);
+    
+    expect(screen.getByText('Average Fidelity:')).toBeInTheDocument();
+    expect(screen.getByText('0.123')).toBeInTheDocument();
+  });
 }); 
diff --git a/tests/controller/simulationController.test.ts b/tests/controller/simulationController.test.ts
@@ -27,7 +27,8 @@ describe('SimulationController', () => {
     pairs: [],
     round: 0,
     complete: false,
-    purificationStep: 'initial'
+    purificationStep: 'initial',
+    averageFidelity: 0
   };
 
   beforeEach(() => {
diff --git a/tests/engine/averageSimulationEngine.test.ts b/tests/engine/averageSimulationEngine.test.ts
@@ -356,4 +356,16 @@ describe('AverageSimulationEngine', () => {
             });
         });
     });
+
+    test('average fidelity is always calculated in getCurrentState', () => {
+        const engine = new AverageSimulationEngine(initialParams);
+        
+        const state1 = engine.getCurrentState();
+        expect(state1.averageFidelity).toBeGreaterThan(0);
+        
+        // Progress and check again
+        engine.nextStep();
+        const state2 = engine.getCurrentState();
+        expect(state2.averageFidelity).toBeGreaterThan(0);
+    });
 }); 
diff --git a/tests/engine/monteCarloSimulationEngine.test.ts b/tests/engine/monteCarloSimulationEngine.test.ts
@@ -253,6 +253,18 @@ describe('MonteCarloSimulationEngine', () => {
       const state2 = engine.getCurrentState();
       expect(state1).toEqual(state2);
     });
+
+    test('average fidelity is always calculated in getCurrentState', () => {
+        const engine = new MonteCarloSimulationEngine(initialParams);
+        
+        const state1 = engine.getCurrentState();
+        expect(state1.averageFidelity).toBeGreaterThan(0);
+        
+        // Progress and check again
+        engine.nextStep();
+        const state2 = engine.getCurrentState();
+        expect(state2.averageFidelity).toBeGreaterThan(0);
+    });
   });
 
   describe('Step Progression via nextStep()', () => {
diff --git a/tests/utils/fidelityUtils.test.ts b/tests/utils/fidelityUtils.test.ts
@@ -0,0 +1,91 @@
+import { describe, test, expect } from 'vitest';
+import { calculateAverageFidelity } from '../../src/utils/fidelityUtils';
+import { QubitPair, Basis } from '../../src/engine/types';
+import { DensityMatrix } from '../../src/engine_real_calculations/matrix/densityMatrix';
+
+describe('FidelityUtils', () => {
+  test('calculates average fidelity correctly for multiple pairs', () => {
+    const pairs: QubitPair[] = [
+      {
+        id: 0,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 0.8,
+        basis: Basis.Bell
+      },
+      {
+        id: 1,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 0.6,
+        basis: Basis.Bell
+      },
+      {
+        id: 2,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 0.9,
+        basis: Basis.Bell
+      }
+    ];
+
+    const averageFidelity = calculateAverageFidelity(pairs);
+    expect(averageFidelity).toBeCloseTo((0.8 + 0.6 + 0.9) / 3, 5);
+  });
+
+  test('returns 0 for empty pairs array', () => {
+    const averageFidelity = calculateAverageFidelity([]);
+    expect(averageFidelity).toBe(0);
+  });
+
+  test('returns the fidelity value for single pair', () => {
+    const pairs: QubitPair[] = [
+      {
+        id: 0,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 0.75,
+        basis: Basis.Bell
+      }
+    ];
+
+    const averageFidelity = calculateAverageFidelity(pairs);
+    expect(averageFidelity).toBe(0.75);
+  });
+
+  test('handles pairs with perfect fidelity', () => {
+    const pairs: QubitPair[] = [
+      {
+        id: 0,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 1.0,
+        basis: Basis.Bell
+      },
+      {
+        id: 1,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 1.0,
+        basis: Basis.Bell
+      }
+    ];
+
+    const averageFidelity = calculateAverageFidelity(pairs);
+    expect(averageFidelity).toBe(1.0);
+  });
+
+  test('handles pairs with very low fidelity', () => {
+    const pairs: QubitPair[] = [
+      {
+        id: 0,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 0.1,
+        basis: Basis.Bell
+      },
+      {
+        id: 1,
+        densityMatrix: DensityMatrix.bellPsiMinus(),
+        fidelity: 0.05,
+        basis: Basis.Bell
+      }
+    ];
+
+    const averageFidelity = calculateAverageFidelity(pairs);
+    expect(averageFidelity).toBeCloseTo(0.075, 5);
+  });
+}); 
