From 8cf40fbaf145efeb0ec46e3fddec3c1bb4dc6404 Mon Sep 17 00:00:00 2001 From: Christoph Ruegg Date: Sun, 4 May 2014 10:47:07 +0200 Subject: [PATCH] LA: fix wrong description in vector infinity norm inline docs --- CONTRIBUTORS.md | 11 +++++++---- src/Numerics/LinearAlgebra/Complex/DenseVector.cs | 2 +- src/Numerics/LinearAlgebra/Complex/SparseVector.cs | 2 +- src/Numerics/LinearAlgebra/Complex/Vector.cs | 2 +- src/Numerics/LinearAlgebra/Complex32/DenseVector.cs | 2 +- src/Numerics/LinearAlgebra/Complex32/SparseVector.cs | 2 +- src/Numerics/LinearAlgebra/Complex32/Vector.cs | 2 +- src/Numerics/LinearAlgebra/Double/DenseVector.cs | 2 +- src/Numerics/LinearAlgebra/Double/SparseVector.cs | 2 +- src/Numerics/LinearAlgebra/Double/Vector.cs | 2 +- src/Numerics/LinearAlgebra/Single/DenseVector.cs | 2 +- src/Numerics/LinearAlgebra/Single/SparseVector.cs | 2 +- src/Numerics/LinearAlgebra/Single/Vector.cs | 2 +- src/Numerics/LinearAlgebra/Vector.Arithmetic.cs | 2 +- 14 files changed, 20 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 165a5fbc..4849dbaf 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -73,13 +73,16 @@ This section is incomplete - let us know if we forgot something.* - Andrew Kurochka - Thaddaeus Parker -### Other Numerical Works & Resources +### Other Numerical Works, References & Resources *As inspiration, reference or more - depending on the licensing terms* -- ALGLIB: [Sergey Bochkanov](http://www.alglib.net/) -- Boost: John Maddock -- Cephes Math Library: Stephen L. Moshier +- [ALGLIB](http://www.alglib.net/): Sergey Bochkanov +- [Boost](http://www.boost.org/): John Maddock +- [Netlib/Cephes Math Library](http://www.netlib.org/cephes/): Stephen L. Moshier +- [Stand-alone code for numerical computing](http://www.johndcook.com/stand_alone_code.html): John D. Cook +- [Miscellaneous Utility Library](http://www.yoda.arachsys.com/csharp/miscutil/): Marc Gravell, Jon Skeet +- [NIST Digital Library of Mathematical Functions](http://www.johndcook.com/stand_alone_code.html) ### Special Thanks diff --git a/src/Numerics/LinearAlgebra/Complex/DenseVector.cs b/src/Numerics/LinearAlgebra/Complex/DenseVector.cs index 30908336..0499b8c4 100644 --- a/src/Numerics/LinearAlgebra/Complex/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Complex/DenseVector.cs @@ -599,7 +599,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(_values, (i, v) => v.Magnitude, Math.Max, 0d); diff --git a/src/Numerics/LinearAlgebra/Complex/SparseVector.cs b/src/Numerics/LinearAlgebra/Complex/SparseVector.cs index 89882200..5b9dba27 100644 --- a/src/Numerics/LinearAlgebra/Complex/SparseVector.cs +++ b/src/Numerics/LinearAlgebra/Complex/SparseVector.cs @@ -714,7 +714,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, _storage.ValueCount, i => _storage.Values[i].Magnitude, Math.Max, 0d); diff --git a/src/Numerics/LinearAlgebra/Complex/Vector.cs b/src/Numerics/LinearAlgebra/Complex/Vector.cs index a845c929..22f82db2 100644 --- a/src/Numerics/LinearAlgebra/Complex/Vector.cs +++ b/src/Numerics/LinearAlgebra/Complex/Vector.cs @@ -414,7 +414,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, Count, i => At(i).Magnitude, Math.Max, 0d); diff --git a/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs b/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs index 031f2bda..d0b77387 100644 --- a/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs @@ -594,7 +594,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(_values, (i, v) => v.Magnitude, Math.Max, 0f); diff --git a/src/Numerics/LinearAlgebra/Complex32/SparseVector.cs b/src/Numerics/LinearAlgebra/Complex32/SparseVector.cs index b0abb41e..66ea720c 100644 --- a/src/Numerics/LinearAlgebra/Complex32/SparseVector.cs +++ b/src/Numerics/LinearAlgebra/Complex32/SparseVector.cs @@ -709,7 +709,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, _storage.ValueCount, i => _storage.Values[i].Magnitude, Math.Max, 0f); diff --git a/src/Numerics/LinearAlgebra/Complex32/Vector.cs b/src/Numerics/LinearAlgebra/Complex32/Vector.cs index 42a0f603..a2fa809e 100644 --- a/src/Numerics/LinearAlgebra/Complex32/Vector.cs +++ b/src/Numerics/LinearAlgebra/Complex32/Vector.cs @@ -409,7 +409,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, Count, i => At(i).Magnitude, Math.Max, 0f); diff --git a/src/Numerics/LinearAlgebra/Double/DenseVector.cs b/src/Numerics/LinearAlgebra/Double/DenseVector.cs index 5b13743a..0c12ad99 100644 --- a/src/Numerics/LinearAlgebra/Double/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Double/DenseVector.cs @@ -676,7 +676,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(_values, (i, v) => Math.Abs(v), Math.Max, 0d); diff --git a/src/Numerics/LinearAlgebra/Double/SparseVector.cs b/src/Numerics/LinearAlgebra/Double/SparseVector.cs index 6555f23d..d5c4761c 100644 --- a/src/Numerics/LinearAlgebra/Double/SparseVector.cs +++ b/src/Numerics/LinearAlgebra/Double/SparseVector.cs @@ -756,7 +756,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, _storage.ValueCount, i => Math.Abs(_storage.Values[i]), Math.Max, 0d); diff --git a/src/Numerics/LinearAlgebra/Double/Vector.cs b/src/Numerics/LinearAlgebra/Double/Vector.cs index 9f385221..9f4599d4 100644 --- a/src/Numerics/LinearAlgebra/Double/Vector.cs +++ b/src/Numerics/LinearAlgebra/Double/Vector.cs @@ -420,7 +420,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, Count, i => Math.Abs(At(i)), Math.Max, 0d); diff --git a/src/Numerics/LinearAlgebra/Single/DenseVector.cs b/src/Numerics/LinearAlgebra/Single/DenseVector.cs index e57131ad..d71b34c2 100644 --- a/src/Numerics/LinearAlgebra/Single/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Single/DenseVector.cs @@ -666,7 +666,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(_values, (i, v) => Math.Abs(v), Math.Max, 0f); diff --git a/src/Numerics/LinearAlgebra/Single/SparseVector.cs b/src/Numerics/LinearAlgebra/Single/SparseVector.cs index ad5a9bfe..6cca3fd1 100644 --- a/src/Numerics/LinearAlgebra/Single/SparseVector.cs +++ b/src/Numerics/LinearAlgebra/Single/SparseVector.cs @@ -757,7 +757,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, _storage.ValueCount, i => Math.Abs(_storage.Values[i]), Math.Max, 0f); diff --git a/src/Numerics/LinearAlgebra/Single/Vector.cs b/src/Numerics/LinearAlgebra/Single/Vector.cs index 87eba786..bea3e5a1 100644 --- a/src/Numerics/LinearAlgebra/Single/Vector.cs +++ b/src/Numerics/LinearAlgebra/Single/Vector.cs @@ -420,7 +420,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public override double InfinityNorm() { return CommonParallel.Aggregate(0, Count, i => Math.Abs(At(i)), Math.Max, 0f); diff --git a/src/Numerics/LinearAlgebra/Vector.Arithmetic.cs b/src/Numerics/LinearAlgebra/Vector.Arithmetic.cs index ae42c104..a5e56b40 100644 --- a/src/Numerics/LinearAlgebra/Vector.Arithmetic.cs +++ b/src/Numerics/LinearAlgebra/Vector.Arithmetic.cs @@ -984,7 +984,7 @@ namespace MathNet.Numerics.LinearAlgebra /// /// Calculates the infinity norm of the vector. /// - /// The square root of the sum of the squared values. + /// The maximum absolute value. public abstract double InfinityNorm(); ///