Version 2.1 update

Major changes:

* A new general Frank Wolfe routine for writing new math solver modules.
  Math solver developers no longer have to write their own Frank Wolfe
  routines for each problem! Just provide it the objective function f(x),
  The gradient, grad[f](x), and the direction finding subproblem function.

* BREAKING CHANGE, the new Frank Wolfe solver splits off Frank Wolfe options
  into its own struct, ``frankWolfeOptions``. Please move the following
  options (if present in your preset) to ``franWolfeOptions``:
   * ``maxIter``
   * ``maxGap``
   * ``linearSearchPrecision``
   * ``linearSearchMinStep``

* Even more parallel processing tools. New example scripts for running basic
  parallel pools using ``xargs`` in Bash, and ``ForEach-Object -Parallel``
  in Windows Power Shell. These let you split the total number of runs from
  the total number of threads. The previous ``BatchJobExample.sh`` was
  updated and renamed ``ParallelExampleBash.sh``.

* Various small bug fixes for validation functions.

* Removed a few ancient functions that snuck into the V2.0.x builds.
   * ``isAnnouncement.m``
   * ``isModuleStruct.m``
   * ``mustBeAnAnnouncement.m``

* Corrected the spelling of ``isBlockDimsWellFormatted.m``. The old spelling
  ``isBlockDimsWellFormated.m`` remains for now but will be removed in the next
  major version.

Author: JBurniston

.gitignore

@@ -11,6 +11,9 @@
 *.log
 *.out
 
+# ignore documentation build files
+docs/build/
+
 # Don't know where this is from but it keeps comming up
 *.DS_Store
 
@@ -26,4 +29,4 @@
 
 # Packaged app and toolbox files
 *.mlappinstall
-*.mltbx
+*.mltbx

BasicProtocols/BasicBB84Alice2D/BasicBB84Alice2DPreset.m

@@ -80,7 +80,8 @@
 % The optimizer module is designed to tweak parameters to increase your
 % keyrate. It's not used in this protocol, though use cases can include
 % tweaking the intensity of coherent pulses used by Alice.
-optimizerMod = QKDOptimizerModule(@coordinateDescentFunc,struct("verboseLevel",0),struct("verboseLevel",0));
+optimizerMod = QKDOptimizerModule(@coordinateDescentFunc,struct("verboseLevel",0),...
+    struct("verboseLevel",0));
 qkdInput.setOptimizerModule(optimizerMod);
 
 
@@ -91,8 +92,8 @@
 % the key and Eve's information.
 mathSolverOptions = struct();
 mathSolverOptions.initMethod = 1; %closest to maximally mixed.
-mathSolverOptions.maxIter = 10; %number of iterations that should be performed
-mathSolverOptions.maxGap = 1e-6;
+mathSolverOptions.frankWolfeMethod = @FrankWolfe.vanilla;
+mathSolverOptions.frankWolfeOptions = struct("maxIter",10,"maxGap",1e-6);
 mathSolverOptions.linearConstraintTolerance = 1e-10;
 mathSolverMod = QKDMathSolverModule(@FW2StepSolver,mathSolverOptions);
 qkdInput.setMathSolverModule(mathSolverMod);
@@ -108,7 +109,7 @@
 % * verboseLevel (default 1): Non-negative integer telling the program how
 %   much information it should display in the command window. 0, minimum; 1
 %   basic information; 2, full details, including CVX output.
-% * errorHandling (2): ErrorHandling object (unit8 or convertible),
+% * errorHandling (2): ErrorHandling object (uint8 or convertible),
 %   detailing how the program should handle run time errors. CatchSilent 1:
 %   catch but don't warn the user and the error message is appended to the
 %   debug info. CatchWarn 2: catch and warn the user. The key rate for the

BasicProtocols/BasicBB84Alice2DFinite/BasicBB84Alice2DFinitePreset.m

@@ -60,8 +60,8 @@
 % math solver options
 mathSolverOptions = struct();
 mathSolverOptions.initMethod = 1;
-mathSolverOptions.maxIter = 50  ;
-mathSolverOptions.maxGap = 1e-6;
+mathSolverOptions.frankWolfeMethod = @FrankWolfe.vanilla;
+mathSolverOptions.frankWolfeOptions = struct("maxIter",50,"maxGap",1e-6);
 mathSolverOptions.blockDiagonal = false;
 mathSolverMod = QKDMathSolverModule(@FW2StepSolver,mathSolverOptions,mathSolverOptions);
 qkdInput.setMathSolverModule(mathSolverMod);

BasicProtocols/BasicBB84Alice2DFinite/mainBasicBB84Alice2DFinite.m

@@ -1,14 +1,14 @@
-%pick the preset file 
-
-qkdInput = BasicBB84Alice2DFinitePreset();
-
-%run the QKDSolver with this input
-results = MainIteration(qkdInput);
-
-%save the results and preset to a file.
-
-save("BasicBB84Alice2DFiniteresults.mat","results","qkdInput");
-
-
-%% plot the result
+%pick the preset file 
+
+qkdInput = BasicBB84Alice2DFinitePreset();
+
+%run the QKDSolver with this input
+results = MainIteration(qkdInput);
+
+%save the results and preset to a file.
+
+save("BasicBB84Alice2DFiniteresults.mat","results","qkdInput");
+
+
+%% plot the result
 QKDPlot.simple1DPlot(qkdInput,results)

BasicProtocols/BasicBB84Alice4D/BasicBB84Alice4DPreset.m

@@ -93,8 +93,8 @@
 % the key and Eve's information.
 mathSolverOptions = struct();
 mathSolverOptions.initMethod = 1; %closest to maximally mixed.
-mathSolverOptions.maxIter = 10; %number of iterations that should be performed
-mathSolverOptions.maxGap = 1e-6;
+mathSolverOptions.frankWolfeMethod = @FrankWolfe.vanilla;
+mathSolverOptions.frankWolfeOptions = struct("maxIter",10,"maxGap",1e-6);
 mathSolverOptions.linearConstraintTolerance = 1e-10;
 mathSolverMod = QKDMathSolverModule(@FW2StepSolver,mathSolverOptions);
 qkdInput.setMathSolverModule(mathSolverMod);
@@ -117,5 +117,5 @@
 %   point is set to nan and the error message is appended to the debug
 %   info.  The key rate for the point is set to nan. DontCatch 3: don't
 %   catch the error and let it up the stack.
-qkdInput.setGlobalOptions(struct("errorHandling",ErrorHandling.CatchWarn,"verboseLevel",1,"cvxSolver","SDPT3", "cvxPrecision", "high"));
+qkdInput.setGlobalOptions(struct("errorHandling",ErrorHandling.CatchWarn,"verboseLevel",1,"cvxSolver","SeDuMi", "cvxPrecision", "high"));
 end

BasicProtocols/BasicBB84Alice4D/mainBasicBB84Alice4D.m

@@ -1,13 +1,13 @@
-%pick the preset file to use In this case we start with a basic qubit BB84
-%protocol with no loss. Feel free to open up the module and look at what it
-%sets!
-qkdInput = BasicBB84Alice4DPreset();
-
-%run the QKDSolver with this input
-results = MainIteration(qkdInput);
-
-%save the results and preset to a file.
-save("BasicBB84Alice4DResults.mat","results","qkdInput");
-
-%% plot the result
+%pick the preset file to use In this case we start with a basic qubit BB84
+%protocol with no loss. Feel free to open up the module and look at what it
+%sets!
+qkdInput = BasicBB84Alice4DPreset();
+
+%run the QKDSolver with this input
+results = MainIteration(qkdInput);
+
+%save the results and preset to a file.
+save("BasicBB84Alice4DResults.mat","results","qkdInput");
+
+%% plot the result
 QKDPlot.simple1DPlot(qkdInput,results)

BasicProtocols/BasicBB84Lossy/BasicBB84LossyPreset.m

@@ -49,8 +49,8 @@
 % math solver options
 mathSolverOptions = struct();
 mathSolverOptions.initMethod = 1;
-mathSolverOptions.maxIter = 10;
-mathSolverOptions.maxGap = 1e-6;
+mathSolverOptions.frankWolfeMethod = @FrankWolfe.vanilla;
+mathSolverOptions.frankWolfeOptions = struct("maxIter",10,"maxGap",1e-6);
 mathSolverOptions.blockDiagonal = true;
 mathSolverMod = QKDMathSolverModule(@FW2StepSolver,mathSolverOptions);
 qkdInput.setMathSolverModule(mathSolverMod);

BasicProtocols/BasicBB84Lossy/mainBasicBB84Lossy.m

@@ -1,11 +1,11 @@
-%pick preset
-qkdInput = BasicBB84LossyPreset();
-
-%run the QKDSolver with this input and store results
-results = MainIteration(qkdInput);
-
-%save the results and preset to a file.
-save("BasicBB84LossyResults.mat","results","qkdInput");
-
-%% plot the result
+%pick preset
+qkdInput = BasicBB84LossyPreset();
+
+%run the QKDSolver with this input and store results
+results = MainIteration(qkdInput);
+
+%save the results and preset to a file.
+save("BasicBB84LossyResults.mat","results","qkdInput");
+
+%% plot the result
 QKDPlot.simple1DPlot(qkdInput,results,"xScaleStyle","dB","yScaleStyle","log")

BasicProtocols/BasicBB84WCPDecoy/BasicBB84WCPDecoyKeyRateFunc.m

@@ -113,8 +113,8 @@
 
 modParser.addOptionalParam("rhoA", nan, @(x) isequaln(x,nan) || isDensityOperator(x));
 
-modParser.addOptionalParam("blockDimsA", nan, @isBlockDimsWellFormated);
-modParser.addOptionalParam("blockDimsB", nan, @isBlockDimsWellFormated);
+modParser.addOptionalParam("blockDimsA", nan, @isBlockDimsWellFormatted);
+modParser.addOptionalParam("blockDimsB", nan, @isBlockDimsWellFormatted);
 modParser.addAdditionalConstraint(@(x,y) blockDimsMustMatch(x,y),["blockDimsA","dimA"]);
 modParser.addAdditionalConstraint(@(x,y) blockDimsMustMatch(x,y),["blockDimsB","dimB"]);
 modParser.addAdditionalConstraint(@(blockDimsA,blockDimsB) ~xor(isequaln(blockDimsA,nan),isequaln(blockDimsB,nan)),["blockDimsA","blockDimsB"]);

BasicProtocols/BasicBB84WCPDecoy/BasicBB84WCPDecoyPreset.m

@@ -50,8 +50,8 @@
 % math solver options
 mathSolverOptions = struct();
 mathSolverOptions.initMethod = 1;
-mathSolverOptions.maxIter = 10;
-mathSolverOptions.maxGap = 1e-6;
+mathSolverOptions.frankWolfeMethod = @FrankWolfe.vanilla;
+mathSolverOptions.frankWolfeOptions = struct("maxIter",10,"maxGap",1e-6);
 mathSolverOptions.blockDiagonal = true;
 mathSolverMod = QKDMathSolverModule(@FW2StepSolver,mathSolverOptions,mathSolverOptions);
 qkdInput.setMathSolverModule(mathSolverMod);