diff --git a/src/Examples/LinearAlgebra/IterativeSolvers/CompositeSolverExample.cs b/src/Examples/LinearAlgebra/IterativeSolvers/CompositeSolverExample.cs index 1a1c6a73..038c6d2f 100644 --- a/src/Examples/LinearAlgebra/IterativeSolvers/CompositeSolverExample.cs +++ b/src/Examples/LinearAlgebra/IterativeSolvers/CompositeSolverExample.cs @@ -175,7 +175,7 @@ namespace Examples.LinearAlgebra.IterativeSolversExamples /// Creates a fully functional iterative solver with the default settings /// given by this setup. /// - /// A new . + /// A new . public IIterativeSolver CreateNew() { return new BiCgStab(); diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/BiCgStab.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/BiCgStab.cs index 39898d4f..794aed7c 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/BiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/BiCgStab.cs @@ -101,7 +101,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public BiCgStab() @@ -117,17 +117,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IIterator iterator) : this(null, iterator) { @@ -137,7 +137,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -151,18 +151,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -179,7 +179,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/CompositeSolver.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/CompositeSolver.cs index b225590b..53956f10 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/CompositeSolver.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/CompositeSolver.cs @@ -114,7 +114,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative #region Solver information loading methods /// - /// Loads all the available objects from the MathNet.Numerics assembly. + /// Loads all the available objects from the MathNet.Numerics assembly. /// public static void LoadSolverInformation() { @@ -122,9 +122,9 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the MathNet.Numerics assembly. + /// Loads the available objects from the MathNet.Numerics assembly. /// - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformation(Type[] typesToExclude) { LoadSolverInformationFromAssembly(Assembly.GetExecutingAssembly(), typesToExclude); @@ -132,7 +132,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative #if !PORTABLE /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. public static void LoadSolverInformationFromAssembly(string assemblyLocation) @@ -141,10 +141,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(string assemblyLocation, params Type[] typesToExclude) { if (assemblyLocation == null) @@ -180,7 +180,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative #endif /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName) @@ -189,10 +189,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName, params Type[] typesToExclude) { if (assemblyName == null) @@ -212,7 +212,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. public static void LoadSolverInformationFromAssembly(Type typeInAssembly) @@ -221,10 +221,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Type typeInAssembly, params Type[] typesToExclude) { if (typeInAssembly == null) @@ -236,7 +236,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. public static void LoadSolverInformationFromAssembly(Assembly assembly) @@ -245,10 +245,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Assembly assembly, params Type[] typesToExclude) { if (assembly == null) diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/GpBiCg.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/GpBiCg.cs index bf65fa2f..85c3d140 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/GpBiCg.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/GpBiCg.cs @@ -111,7 +111,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public GpBiCg() @@ -127,17 +127,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IIterator iterator) : this(null, iterator) { @@ -147,7 +147,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -161,18 +161,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -227,7 +227,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/MlkBiCgStab.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/MlkBiCgStab.cs index d9daf43b..1e45b998 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/MlkBiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/MlkBiCgStab.cs @@ -114,7 +114,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public MlkBiCgStab() @@ -130,17 +130,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IIterator iterator) : this(null, iterator) { @@ -150,7 +150,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -164,18 +164,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -224,7 +224,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/TFQMR.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/TFQMR.cs index 88c6c4ee..5fdf24c3 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/TFQMR.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterative/TFQMR.cs @@ -89,7 +89,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public TFQMR() @@ -105,17 +105,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IIterator iterator) : this(null, iterator) { @@ -125,7 +125,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -139,18 +139,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -167,7 +167,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterator.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterator.cs index 9d0964b7..43e7dda9 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Iterator.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Iterator.cs @@ -59,7 +59,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers /// /// Creates a default iterator with all the objects. /// - /// A new object. + /// A new object. public static IIterator CreateDefault() { var iterator = new Iterator(); @@ -117,7 +117,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers } /// - /// Adds an to the internal collection of stop-criteria. Only a + /// Adds an to the internal collection of stop-criteria. Only a /// single stop criterium of each type can be stored. /// /// The stop criterium to add. @@ -143,7 +143,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers } /// - /// Removes the from the internal collection. + /// Removes the from the internal collection. /// /// The stop criterium that must be removed. public void Remove(IIterationStopCriterium stopCriterium) @@ -163,10 +163,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers } /// - /// Indicates if the specific stop criterium is stored by the . + /// Indicates if the specific stop criterium is stored by the . /// /// The stop criterium. - /// true if the contains the stop criterium; otherwise false. + /// true if the contains the stop criterium; otherwise false. public bool Contains(IIterationStopCriterium stopCriterium) { return stopCriterium != null && _stopCriterias.ContainsKey(stopCriterium.GetType()); @@ -293,7 +293,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/Preconditioners/UnitPreconditioner.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/Preconditioners/UnitPreconditioner.cs index 168af92b..a10ec796 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/Preconditioners/UnitPreconditioner.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/Preconditioners/UnitPreconditioner.cs @@ -28,10 +28,12 @@ // OTHER DEALINGS IN THE SOFTWARE. // +using System; +using MathNet.Numerics.LinearAlgebra.Solvers; +using MathNet.Numerics.Properties; + namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Preconditioners { - using System; - using Properties; #if NOSYSNUMERICS using Complex = Numerics.Complex; @@ -41,7 +43,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.Preconditioners /// /// A unit preconditioner. This preconditioner does not actually do anything - /// it is only used when running an without + /// it is only used when running an without /// a preconditioner. /// internal sealed class UnitPreconditioner : IPreConditioner diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/DivergenceStopCriterium.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/DivergenceStopCriterium.cs index e7e6a7a5..543a8f17 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/DivergenceStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/DivergenceStopCriterium.cs @@ -213,7 +213,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -353,7 +353,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -364,7 +364,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/FailureStopCriterium.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/FailureStopCriterium.cs index 69556882..d908bf53 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/FailureStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/FailureStopCriterium.cs @@ -44,7 +44,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium #endif /// - /// Defines an that monitors residuals for NaN's. + /// Defines an that monitors residuals for NaN's. /// public sealed class FailureStopCriterium : IIterationStopCriterium { @@ -71,7 +71,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -162,7 +162,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -172,7 +172,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/ResidualStopCriterium.cs b/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/ResidualStopCriterium.cs index a7371d87..30098520 100644 --- a/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/ResidualStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Complex/Solvers/StopCriterium/ResidualStopCriterium.cs @@ -44,7 +44,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium #endif /// - /// Defines an that monitors residuals as stop criterium. + /// Defines an that monitors residuals as stop criterium. /// public sealed class ResidualStopCriterium : IIterationStopCriterium { @@ -218,7 +218,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -369,7 +369,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -380,7 +380,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/BiCgStab.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/BiCgStab.cs index 4cca5644..c3d8e565 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/BiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/BiCgStab.cs @@ -95,7 +95,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public BiCgStab() @@ -111,17 +111,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IIterator iterator) : this(null, iterator) { @@ -131,7 +131,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -145,18 +145,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -173,7 +173,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/CompositeSolver.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/CompositeSolver.cs index 0fc08061..afff0e86 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/CompositeSolver.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/CompositeSolver.cs @@ -109,7 +109,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative #region Solver information loading methods /// - /// Loads all the available objects from the MathNet.Numerics assembly. + /// Loads all the available objects from the MathNet.Numerics assembly. /// public static void LoadSolverInformation() { @@ -117,9 +117,9 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the MathNet.Numerics assembly. + /// Loads the available objects from the MathNet.Numerics assembly. /// - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformation(Type[] typesToExclude) { LoadSolverInformationFromAssembly(Assembly.GetExecutingAssembly(), typesToExclude); @@ -127,7 +127,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative #if !PORTABLE /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. public static void LoadSolverInformationFromAssembly(string assemblyLocation) @@ -136,10 +136,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(string assemblyLocation, params Type[] typesToExclude) { if (assemblyLocation == null) @@ -175,7 +175,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative #endif /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName) @@ -184,10 +184,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName, params Type[] typesToExclude) { if (assemblyName == null) @@ -207,7 +207,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. public static void LoadSolverInformationFromAssembly(Type typeInAssembly) @@ -216,10 +216,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Type typeInAssembly, params Type[] typesToExclude) { if (typeInAssembly == null) @@ -231,7 +231,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. public static void LoadSolverInformationFromAssembly(Assembly assembly) @@ -240,10 +240,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Assembly assembly, params Type[] typesToExclude) { if (assembly == null) diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/GpBiCg.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/GpBiCg.cs index 1e9c63fc..314aacfd 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/GpBiCg.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/GpBiCg.cs @@ -105,7 +105,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public GpBiCg() @@ -121,17 +121,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IIterator iterator) : this(null, iterator) { @@ -141,7 +141,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -155,18 +155,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -221,7 +221,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/MlkBiCgStab.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/MlkBiCgStab.cs index fdc286ad..8370c091 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/MlkBiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/MlkBiCgStab.cs @@ -108,7 +108,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public MlkBiCgStab() @@ -124,17 +124,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IIterator iterator) : this(null, iterator) { @@ -144,7 +144,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -158,18 +158,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -218,7 +218,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/TFQMR.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/TFQMR.cs index 8ad883f9..dd4ec90a 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/TFQMR.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterative/TFQMR.cs @@ -83,7 +83,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public TFQMR() @@ -99,17 +99,17 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IIterator iterator) : this(null, iterator) { @@ -119,7 +119,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -133,18 +133,18 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -161,7 +161,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterator.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterator.cs index 8d0cd0c4..1543f914 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterator.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Iterator.cs @@ -52,9 +52,9 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers private static readonly ICalculationStatus DefaultStatus = new CalculationIndetermined(); /// - /// Creates a default iterator with all the objects. + /// Creates a default iterator with all the objects. /// - /// A new object. + /// A new object. public static IIterator CreateDefault() { var iterator = new Iterator(); @@ -112,7 +112,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers } /// - /// Adds an to the internal collection of stop-criteria. Only a + /// Adds an to the internal collection of stop-criteria. Only a /// single stop criterium of each type can be stored. /// /// The stop criterium to add. @@ -138,7 +138,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers } /// - /// Removes the from the internal collection. + /// Removes the from the internal collection. /// /// The stop criterium that must be removed. public void Remove(IIterationStopCriterium stopCriterium) @@ -158,10 +158,10 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers } /// - /// Indicates if the specific stop criterium is stored by the . + /// Indicates if the specific stop criterium is stored by the . /// /// The stop criterium. - /// true if the contains the stop criterium; otherwise false. + /// true if the contains the stop criterium; otherwise false. public bool Contains(IIterationStopCriterium stopCriterium) { return stopCriterium != null && _stopCriterias.ContainsKey(stopCriterium.GetType()); @@ -288,7 +288,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/Preconditioners/UnitPreconditioner.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/Preconditioners/UnitPreconditioner.cs index 9ffcf90a..102bf37b 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/Preconditioners/UnitPreconditioner.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/Preconditioners/UnitPreconditioner.cs @@ -28,15 +28,17 @@ // OTHER DEALINGS IN THE SOFTWARE. // +using System; +using MathNet.Numerics.LinearAlgebra.Solvers; +using MathNet.Numerics.Properties; + namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.Preconditioners { - using System; - using Properties; using Numerics; /// /// A unit preconditioner. This preconditioner does not actually do anything - /// it is only used when running an without + /// it is only used when running an without /// a preconditioner. /// internal sealed class UnitPreconditioner : IPreConditioner diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/DivergenceStopCriterium.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/DivergenceStopCriterium.cs index 2436bb2f..58a00ab4 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/DivergenceStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/DivergenceStopCriterium.cs @@ -208,7 +208,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -348,7 +348,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -359,7 +359,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/FailureStopCriterium.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/FailureStopCriterium.cs index c2a07a72..1a1379e3 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/FailureStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/FailureStopCriterium.cs @@ -39,7 +39,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium using Numerics; /// - /// Defines an that monitors residuals for NaN's. + /// Defines an that monitors residuals for NaN's. /// public sealed class FailureStopCriterium : IIterationStopCriterium { @@ -66,7 +66,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -157,7 +157,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { diff --git a/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/ResidualStopCriterium.cs b/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/ResidualStopCriterium.cs index 5e2ce616..6bc9b862 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/ResidualStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Solvers/StopCriterium/ResidualStopCriterium.cs @@ -213,7 +213,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -364,7 +364,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -375,7 +375,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/BiCgStab.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/BiCgStab.cs index 601f1517..3850b52a 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/BiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/BiCgStab.cs @@ -93,7 +93,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public BiCgStab() : this(null, null) @@ -108,17 +108,17 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IIterator iterator) : this(null, iterator) { @@ -128,7 +128,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -141,18 +141,18 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -169,7 +169,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/CompositeSolver.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/CompositeSolver.cs index 2e3c7784..c08e0a3c 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/CompositeSolver.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/CompositeSolver.cs @@ -104,7 +104,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative #region Solver information loading methods /// - /// Loads all the available objects from the MathNet.Numerics assembly. + /// Loads all the available objects from the MathNet.Numerics assembly. /// public static void LoadSolverInformation() { @@ -112,9 +112,9 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the MathNet.Numerics assembly. + /// Loads the available objects from the MathNet.Numerics assembly. /// - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformation(Type[] typesToExclude) { LoadSolverInformationFromAssembly(Assembly.GetExecutingAssembly(), typesToExclude); @@ -122,7 +122,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative #if !PORTABLE /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. public static void LoadSolverInformationFromAssembly(string assemblyLocation) @@ -131,10 +131,10 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(string assemblyLocation, params Type[] typesToExclude) { if (assemblyLocation == null) @@ -170,7 +170,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative #endif /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName) @@ -179,10 +179,10 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName, params Type[] typesToExclude) { if (assemblyName == null) @@ -202,7 +202,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. public static void LoadSolverInformationFromAssembly(Type typeInAssembly) @@ -211,10 +211,10 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Type typeInAssembly, params Type[] typesToExclude) { if (typeInAssembly == null) @@ -226,7 +226,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. public static void LoadSolverInformationFromAssembly(Assembly assembly) @@ -235,10 +235,10 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Assembly assembly, params Type[] typesToExclude) { if (assembly == null) @@ -370,7 +370,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/GpBiCg.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/GpBiCg.cs index fb1f2d0e..9d14520b 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/GpBiCg.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/GpBiCg.cs @@ -103,7 +103,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public GpBiCg() : this(null, null) @@ -118,17 +118,17 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IIterator iterator) : this(null, iterator) { @@ -138,7 +138,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -151,18 +151,18 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -223,7 +223,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/MlkBiCgStab.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/MlkBiCgStab.cs index 527861ae..4b0856ce 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/MlkBiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/MlkBiCgStab.cs @@ -106,7 +106,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public MlkBiCgStab() : this(null, null) @@ -121,17 +121,17 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IIterator iterator) : this(null, iterator) { @@ -141,7 +141,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -154,18 +154,18 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -217,7 +217,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/TFQMR.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/TFQMR.cs index 21c165ad..2ce4b35b 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/TFQMR.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Iterative/TFQMR.cs @@ -81,7 +81,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public TFQMR() : this(null, null) @@ -96,17 +96,17 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IIterator iterator) : this(null, iterator) { @@ -116,7 +116,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -129,18 +129,18 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -157,7 +157,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Iterator.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Iterator.cs index 02a5d47b..f6a61106 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Iterator.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Iterator.cs @@ -52,7 +52,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers /// /// Creates a default iterator with all the objects. /// - /// A new object. + /// A new object. public static IIterator CreateDefault() { var iterator = new Iterator(); @@ -110,7 +110,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers } /// - /// Adds an to the internal collection of stop-criteria. Only a + /// Adds an to the internal collection of stop-criteria. Only a /// single stop criterium of each type can be stored. /// /// The stop criterium to add. @@ -156,10 +156,10 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers } /// - /// Indicates if the specific stop criterium is stored by the . + /// Indicates if the specific stop criterium is stored by the . /// /// The stop criterium. - /// true if the contains the stop criterium; otherwise false. + /// true if the contains the stop criterium; otherwise false. public bool Contains(IIterationStopCriterium stopCriterium) { return stopCriterium != null && _stopCriterias.ContainsKey(stopCriterium.GetType()); @@ -203,7 +203,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -286,7 +286,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/Preconditioners/UnitPreconditioner.cs b/src/Numerics/LinearAlgebra/Double/Solvers/Preconditioners/UnitPreconditioner.cs index ee9b5002..9834d3fe 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/Preconditioners/UnitPreconditioner.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/Preconditioners/UnitPreconditioner.cs @@ -28,14 +28,15 @@ // OTHER DEALINGS IN THE SOFTWARE. // +using System; +using MathNet.Numerics.LinearAlgebra.Solvers; +using MathNet.Numerics.Properties; + namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.Preconditioners { - using System; - using Properties; - /// /// A unit preconditioner. This preconditioner does not actually do anything - /// it is only used when running an without + /// it is only used when running an without /// a preconditioner. /// internal sealed class UnitPreconditioner : IPreConditioner diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/DivergenceStopCriterium.cs b/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/DivergenceStopCriterium.cs index 1b618d17..5571db5f 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/DivergenceStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/DivergenceStopCriterium.cs @@ -206,7 +206,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -346,7 +346,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -357,7 +357,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/FailureStopCriterium.cs b/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/FailureStopCriterium.cs index ecef2793..a638e255 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/FailureStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/FailureStopCriterium.cs @@ -37,7 +37,7 @@ using System.Diagnostics; namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium { /// - /// Defines an that monitors residuals for NaN's. + /// Defines an that monitors residuals for NaN's. /// public sealed class FailureStopCriterium : IIterationStopCriterium { @@ -64,7 +64,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -155,7 +155,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -165,7 +165,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/ResidualStopCriterium.cs b/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/ResidualStopCriterium.cs index e06e845c..38b2c6b2 100644 --- a/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/ResidualStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Double/Solvers/StopCriterium/ResidualStopCriterium.cs @@ -211,7 +211,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -362,7 +362,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -373,7 +373,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/BiCgStab.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/BiCgStab.cs index 1666c393..2bb1bf38 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/BiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/BiCgStab.cs @@ -93,7 +93,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public BiCgStab() : this(null, null) @@ -108,17 +108,17 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IIterator iterator) : this(null, iterator) { @@ -128,7 +128,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -141,18 +141,18 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public BiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -169,7 +169,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/CompositeSolver.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/CompositeSolver.cs index 47a1abcc..54e75909 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/CompositeSolver.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/CompositeSolver.cs @@ -107,7 +107,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative #region Solver information loading methods /// - /// Loads all the available objects from the MathNet.Numerics assembly. + /// Loads all the available objects from the MathNet.Numerics assembly. /// public static void LoadSolverInformation() { @@ -115,9 +115,9 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the MathNet.Numerics assembly. + /// Loads the available objects from the MathNet.Numerics assembly. /// - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformation(Type[] typesToExclude) { LoadSolverInformationFromAssembly(Assembly.GetExecutingAssembly(), typesToExclude); @@ -125,7 +125,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative #if !PORTABLE /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. public static void LoadSolverInformationFromAssembly(string assemblyLocation) @@ -134,10 +134,10 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the file location. + /// Loads the available objects from the assembly specified by the file location. /// /// The fully qualified path to the assembly. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(string assemblyLocation, params Type[] typesToExclude) { if (assemblyLocation == null) @@ -173,7 +173,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative #endif /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName) @@ -182,10 +182,10 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the assembly name. + /// Loads the available objects from the assembly specified by the assembly name. /// /// The of the assembly that should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(AssemblyName assemblyName, params Type[] typesToExclude) { if (assemblyName == null) @@ -205,7 +205,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. public static void LoadSolverInformationFromAssembly(Type typeInAssembly) @@ -214,10 +214,10 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the assembly specified by the type. + /// Loads the available objects from the assembly specified by the type. /// /// The type in the assembly which should be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Type typeInAssembly, params Type[] typesToExclude) { if (typeInAssembly == null) @@ -229,7 +229,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. public static void LoadSolverInformationFromAssembly(Assembly assembly) @@ -238,10 +238,10 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Loads the available objects from the specified assembly. + /// Loads the available objects from the specified assembly. /// /// The assembly which will be searched for setup objects. - /// The types that should not be loaded. + /// The types that should not be loaded. public static void LoadSolverInformationFromAssembly(Assembly assembly, params Type[] typesToExclude) { if (assembly == null) @@ -373,7 +373,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/GpBiCg.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/GpBiCg.cs index cba0ae66..8aa750fb 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/GpBiCg.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/GpBiCg.cs @@ -103,7 +103,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public GpBiCg() @@ -119,17 +119,17 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IIterator iterator) : this(null, iterator) { @@ -139,7 +139,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -153,18 +153,18 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public GpBiCg(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -219,7 +219,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/MlkBiCgStab.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/MlkBiCgStab.cs index 3b8dfa4f..5f73e017 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/MlkBiCgStab.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/MlkBiCgStab.cs @@ -105,7 +105,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public MlkBiCgStab() : this(null, null) @@ -120,17 +120,17 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IIterator iterator) : this(null, iterator) { @@ -140,7 +140,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -153,18 +153,18 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public MlkBiCgStab(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -216,7 +216,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/TFQMR.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/TFQMR.cs index 102fa027..ec83f2be 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/TFQMR.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Iterative/TFQMR.cs @@ -81,7 +81,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings and a default preconditioner. /// public TFQMR() @@ -97,17 +97,17 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// When using this constructor the solver will use a default preconditioner. /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IIterator iterator) : this(null, iterator) { @@ -117,7 +117,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// Initializes a new instance of the class. /// /// - /// When using this constructor the solver will use the with + /// When using this constructor the solver will use the with /// the standard settings. /// /// The that will be used to precondition the matrix equation. @@ -131,18 +131,18 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative /// /// /// - /// The main advantages of using a user defined are: + /// The main advantages of using a user defined are: /// /// It is possible to set the desired convergence limits. /// /// It is possible to check the reason for which the solver finished - /// the iterative procedure by calling the property. + /// the iterative procedure by calling the property. /// /// /// /// /// The that will be used to precondition the matrix equation. - /// The that will be used to monitor the iterative process. + /// The that will be used to monitor the iterative process. public TFQMR(IPreConditioner preconditioner, IIterator iterator) { _iterator = iterator; @@ -159,7 +159,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Iterative } /// - /// Sets the that will be used to track the iterative process. + /// Sets the that will be used to track the iterative process. /// /// The iterator. public void SetIterator(IIterator iterator) diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Iterator.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Iterator.cs index 7c81ef83..dc2b97ea 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Iterator.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Iterator.cs @@ -52,7 +52,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers /// /// Creates a default iterator with all the objects. /// - /// A new object. + /// A new object. public static IIterator CreateDefault() { var iterator = new Iterator(); @@ -156,10 +156,10 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers } /// - /// Indicates if the specific stop criterium is stored by the . + /// Indicates if the specific stop criterium is stored by the . /// /// The stop criterium. - /// true if the contains the stop criterium; otherwise false. + /// true if the contains the stop criterium; otherwise false. public bool Contains(IIterationStopCriterium stopCriterium) { return stopCriterium != null && _stopCriterias.ContainsKey(stopCriterium.GetType()); @@ -203,7 +203,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -286,7 +286,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/Preconditioners/UnitPreconditioner.cs b/src/Numerics/LinearAlgebra/Single/Solvers/Preconditioners/UnitPreconditioner.cs index 48ebd37d..e1af68f0 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/Preconditioners/UnitPreconditioner.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/Preconditioners/UnitPreconditioner.cs @@ -28,14 +28,15 @@ // OTHER DEALINGS IN THE SOFTWARE. // +using System; +using MathNet.Numerics.LinearAlgebra.Solvers; +using MathNet.Numerics.Properties; + namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.Preconditioners { - using System; - using Properties; - /// /// A unit preconditioner. This preconditioner does not actually do anything - /// it is only used when running an without + /// it is only used when running an without /// a preconditioner. /// internal sealed class UnitPreconditioner : IPreConditioner diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/DivergenceStopCriterium.cs b/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/DivergenceStopCriterium.cs index 30ec8432..691bf3e0 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/DivergenceStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/DivergenceStopCriterium.cs @@ -206,7 +206,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -346,7 +346,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -357,7 +357,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel diff --git a/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/FailureStopCriterium.cs b/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/FailureStopCriterium.cs index 28f65a2f..75dc39d5 100644 --- a/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/FailureStopCriterium.cs +++ b/src/Numerics/LinearAlgebra/Single/Solvers/StopCriterium/FailureStopCriterium.cs @@ -64,7 +64,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.StopCriterium /// /// Determines the status of the iterative calculation based on the stop criteria stored - /// by the current . Result is set into Status field. + /// by the current . Result is set into Status field. /// /// The number of iterations that have passed so far. /// The vector containing the current solution values. @@ -155,7 +155,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.StopCriterium } /// - /// Resets the to the pre-calculation state. + /// Resets the to the pre-calculation state. /// public void ResetToPrecalculationState() { @@ -165,7 +165,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single.Solvers.StopCriterium /// /// Gets the which indicates what sort of stop criterium this - /// monitors. + /// monitors. /// /// Returns . public StopLevel StopLevel