From ad8f72295a2d0892430070aba342db3af03efa6a Mon Sep 17 00:00:00 2001 From: Marcus Cuda Date: Fri, 26 Nov 2010 21:13:53 +0800 Subject: [PATCH] doc: fixed xml doc errors and updated SHFB config --- build/License.txt | 127 ++++++++++++++++++ build/SiteMap.sitemap | 4 + build/mathnet-numerics.shfbproj | 55 ++++++-- src/MathNet.Numerics.5.1.ReSharper | 4 +- src/Numerics/Complex32.cs | 3 +- .../Distributions/Discrete/Categorical.cs | 2 +- .../Discrete/ConwayMaxwellPoisson.cs | 2 +- .../Distributions/Discrete/Geometric.cs | 5 +- .../LinearAlgebra/Complex/DenseMatrix.cs | 2 +- .../LinearAlgebra/Complex/DenseVector.cs | 3 +- .../LinearAlgebra/Complex/SparseMatrix.cs | 2 +- .../LinearAlgebra/Complex32/DenseMatrix.cs | 2 +- .../LinearAlgebra/Complex32/DenseVector.cs | 2 +- .../LinearAlgebra/Complex32/SparseMatrix.cs | 2 +- .../LinearAlgebra/Double/DenseMatrix.cs | 2 +- .../LinearAlgebra/Double/DenseVector.cs | 2 +- .../LinearAlgebra/Double/SparseMatrix.cs | 2 +- .../Generic/Matrix.Arithmetic.cs | 2 - .../Solvers/StopCriterium/StopLevel.cs | 8 +- .../LinearAlgebra/IO/Matlab/MatlabParser.cs | 5 + .../LinearAlgebra/Single/DenseMatrix.cs | 2 +- .../LinearAlgebra/Single/DenseVector.cs | 2 +- .../LinearAlgebra/Single/SparseMatrix.cs | 2 +- src/Numerics/Random/SystemRandomExtensions.cs | 35 +++-- src/Numerics/SpecialFunctions.cs | 4 +- src/Numerics/Statistics/Histogram.cs | 2 +- src/Numerics/Statistics/MCMC/MCMCSampler.cs | 2 +- 27 files changed, 229 insertions(+), 56 deletions(-) create mode 100644 build/License.txt create mode 100644 build/SiteMap.sitemap diff --git a/build/License.txt b/build/License.txt new file mode 100644 index 00000000..bf275cda --- /dev/null +++ b/build/License.txt @@ -0,0 +1,127 @@ +Math.NET Numerics License (MIT/X11) +=================================== + +Copyright (c) 2009 Math.NET + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +Other Copyrights +================ + +Portions of code are inspired by or derived from code +covered by the following copyrights: + +ALGLIB +------ + +Any code from ALGLIB is from version 2.0.1 which is distributed +under the license below. + +Copyright (c) 2007, Sergey Bochkanov (ALGLIB project). + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +- Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +- Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer listed + in this license in the documentation and/or other materials + provided with the distribution. + +- Neither the name of the copyright holders nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +BOOST +----- + +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + +--- + +ZLIB.NET +Copyright (c) 2006-2007, ComponentAce +http://www.componentace.com +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +Redistributions of source code must retain the above copyright notice, this +list of conditions and the following disclaimer. + +Redistributions in binary form must reproduce the above copyright notice, +this list of conditions and the following disclaimer in the documentation +and/or other materials provided with the distribution. + +Neither the name of ComponentAce nor the names of its contributors +may be used to endorse or promote products derived from this software without +specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT +HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT +OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING +IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY +OF SUCH DAMAGE. diff --git a/build/SiteMap.sitemap b/build/SiteMap.sitemap new file mode 100644 index 00000000..38b4a0a8 --- /dev/null +++ b/build/SiteMap.sitemap @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/build/mathnet-numerics.shfbproj b/build/mathnet-numerics.shfbproj index 91a98514..8fd332bd 100644 --- a/build/mathnet-numerics.shfbproj +++ b/build/mathnet-numerics.shfbproj @@ -6,8 +6,8 @@ Debug AnyCPU 2.0 - {45092870-9e6c-4a1d-8923-39a380f35f94} - 1.8.0.0 + {7abd8233-0d4c-4e89-b2e1-0b686c9fc2ca} + 1.9.0.0 Documentation @@ -15,24 +15,51 @@ Documentation .\Help\ - Math.NET-Numerics - Copyright 2009-2010 Math.NET Project - Math.NET Numerics - c:\Programme\Sandcastle\ - doc\ + Documentation + en-US + 4.0.30319 + vs2005 - - - - + + True + Numerical Library for .NET + Copyright %28c%29 2009-2010 Math.NET + True + Math.NET Numerics + API Reference + False + + + + + - + + + + + + + + + + + + + + + + + + + - + \ No newline at end of file diff --git a/src/MathNet.Numerics.5.1.ReSharper b/src/MathNet.Numerics.5.1.ReSharper index 46eefb2a..3c3388e5 100644 --- a/src/MathNet.Numerics.5.1.ReSharper +++ b/src/MathNet.Numerics.5.1.ReSharper @@ -36,7 +36,9 @@ Excel's ipiv blocksize Dont -dll +dll +Criterium +inline diff --git a/src/Numerics/Complex32.cs b/src/Numerics/Complex32.cs index 6987c17f..db2b4166 100644 --- a/src/Numerics/Complex32.cs +++ b/src/Numerics/Complex32.cs @@ -46,8 +46,7 @@ namespace MathNet.Numerics /// The class Complex32 provides all elementary operations /// on complex numbers. All the operators +, -, /// *, /, ==, != are defined in the - /// canonical way. Additional complex trigonometric functions such - /// as , ... + /// canonical way. Additional complex trigonometric functions /// are also provided. Note that the Complex32 structures /// has two special constant values and /// . diff --git a/src/Numerics/Distributions/Discrete/Categorical.cs b/src/Numerics/Distributions/Discrete/Categorical.cs index 9d02f83d..7f8674e1 100644 --- a/src/Numerics/Distributions/Discrete/Categorical.cs +++ b/src/Numerics/Distributions/Discrete/Categorical.cs @@ -445,7 +445,7 @@ namespace MathNet.Numerics.Distributions /// /// The random number generator to use. /// The cumulative distribution of the probability distribution. - /// One sample from the categorical distribution implied by . + /// One sample from the categorical distribution implied by . internal static int DoSample(Random rnd, double[] cdf) { // TODO : use binary search to speed up this procedure. diff --git a/src/Numerics/Distributions/Discrete/ConwayMaxwellPoisson.cs b/src/Numerics/Distributions/Discrete/ConwayMaxwellPoisson.cs index b476b5b1..719d8455 100644 --- a/src/Numerics/Distributions/Discrete/ConwayMaxwellPoisson.cs +++ b/src/Numerics/Distributions/Discrete/ConwayMaxwellPoisson.cs @@ -540,7 +540,7 @@ namespace MathNet.Numerics.Distributions /// The nu parameter. /// The z parameter. /// - /// One sample from the distribution implied by . + /// One sample from the distribution implied by , , and . /// private static int DoSample(Random rnd, double lambda, double nu, double z) { diff --git a/src/Numerics/Distributions/Discrete/Geometric.cs b/src/Numerics/Distributions/Discrete/Geometric.cs index eced457d..c880a785 100644 --- a/src/Numerics/Distributions/Discrete/Geometric.cs +++ b/src/Numerics/Distributions/Discrete/Geometric.cs @@ -195,8 +195,7 @@ namespace MathNet.Numerics.Distributions { get { - return ((2.0 - _p) / Math.Sqrt(1.0 - _p)); - + return (2.0 - _p) / Math.Sqrt(1.0 - _p); } } @@ -321,7 +320,7 @@ namespace MathNet.Numerics.Distributions /// The random number generator to use. /// The p parameter /// - /// One sample from the distribution implied by . + /// One sample from the distribution implied by . /// private static int DoSample(Random rnd, double p) { diff --git a/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs index f5bcd150..64b2c35c 100644 --- a/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs @@ -92,7 +92,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Row-major_order public DenseMatrix(int rows, int columns, Complex[] array) : base(rows, columns) { diff --git a/src/Numerics/LinearAlgebra/Complex/DenseVector.cs b/src/Numerics/LinearAlgebra/Complex/DenseVector.cs index ba9d78d1..c9f2dc3a 100644 --- a/src/Numerics/LinearAlgebra/Complex/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Complex/DenseVector.cs @@ -30,7 +30,6 @@ namespace MathNet.Numerics.LinearAlgebra.Complex using System.Collections.Generic; using System.Linq; using System.Numerics; - using Distributions; using Generic; using NumberTheory; using Properties; @@ -1102,7 +1101,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Matrix M[i,j] = this[i] * v[j]. /// - /// + /// public Matrix OuterProduct(DenseVector v) { return OuterProduct(this, v); diff --git a/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs index 4ba63ff3..556dcce9 100644 --- a/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs @@ -145,7 +145,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Column-major_order /// If length is less than * . /// public SparseMatrix(int rows, int columns, Complex[] array) : this(rows, columns) diff --git a/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs index 57851c00..5a348928 100644 --- a/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs @@ -92,7 +92,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Row-major_order public DenseMatrix(int rows, int columns, Complex32[] array) : base(rows, columns) { diff --git a/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs b/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs index 35c8f2a7..0ca97754 100644 --- a/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Complex32/DenseVector.cs @@ -1154,7 +1154,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Matrix M[i,j] = this[i] * v[j]. /// - /// + /// public Matrix OuterProduct(DenseVector v) { return OuterProduct(this, v); diff --git a/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs index ad5862ca..2b828690 100644 --- a/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs @@ -145,7 +145,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Column-major_order /// If length is less than * . /// public SparseMatrix(int rows, int columns, Complex32[] array) : this(rows, columns) diff --git a/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs index 4b76de50..8e2d0a39 100644 --- a/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs @@ -91,7 +91,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Row-major_order public DenseMatrix(int rows, int columns, double[] array) : base(rows, columns) { diff --git a/src/Numerics/LinearAlgebra/Double/DenseVector.cs b/src/Numerics/LinearAlgebra/Double/DenseVector.cs index f561b356..95e0e97d 100644 --- a/src/Numerics/LinearAlgebra/Double/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Double/DenseVector.cs @@ -1194,7 +1194,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Matrix M[i,j] = this[i] * v[j]. /// - /// + /// public Matrix OuterProduct(DenseVector v) { return OuterProduct(this, v); diff --git a/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs index 8207a234..289ab609 100644 --- a/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs @@ -144,7 +144,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Column-major_order /// If length is less than * . /// public SparseMatrix(int rows, int columns, double[] array) : this(rows, columns) diff --git a/src/Numerics/LinearAlgebra/Generic/Matrix.Arithmetic.cs b/src/Numerics/LinearAlgebra/Generic/Matrix.Arithmetic.cs index 73ace896..c6f1ba62 100644 --- a/src/Numerics/LinearAlgebra/Generic/Matrix.Arithmetic.cs +++ b/src/Numerics/LinearAlgebra/Generic/Matrix.Arithmetic.cs @@ -27,7 +27,6 @@ namespace MathNet.Numerics.LinearAlgebra.Generic { using System; - using System.Numerics; using Distributions; using Factorization; using Properties; @@ -36,7 +35,6 @@ namespace MathNet.Numerics.LinearAlgebra.Generic /// /// Defines the base class for Matrix classes. /// - /// Supported data types are double, single, , and . public abstract partial class Matrix { /// diff --git a/src/Numerics/LinearAlgebra/Generic/Solvers/StopCriterium/StopLevel.cs b/src/Numerics/LinearAlgebra/Generic/Solvers/StopCriterium/StopLevel.cs index ef7b6856..48e5b847 100644 --- a/src/Numerics/LinearAlgebra/Generic/Solvers/StopCriterium/StopLevel.cs +++ b/src/Numerics/LinearAlgebra/Generic/Solvers/StopCriterium/StopLevel.cs @@ -32,24 +32,24 @@ namespace MathNet.Numerics.LinearAlgebra.Generic.Solvers.StopCriterium public enum StopLevel { /// - /// The monitors calculation failures in the + /// The monitors calculation failures in the /// iterative calculation. /// CalculationFailure, /// - /// The monitors the calculation for signs of divergence. + /// The monitors the calculation for signs of divergence. /// Divergence, /// - /// The guards the calculation against unlimited continuation + /// The guards the calculation against unlimited continuation /// by monitoring user specified limits, e.g. the maximum number of iterations. /// StoppedWithoutConvergence, /// - /// The monitors the calculation for convergence, usually + /// The monitors the calculation for convergence, usually /// based on the residuals of the calculation. /// Convergence diff --git a/src/Numerics/LinearAlgebra/IO/Matlab/MatlabParser.cs b/src/Numerics/LinearAlgebra/IO/Matlab/MatlabParser.cs index 288228f2..1b3f71ad 100644 --- a/src/Numerics/LinearAlgebra/IO/Matlab/MatlabParser.cs +++ b/src/Numerics/LinearAlgebra/IO/Matlab/MatlabParser.cs @@ -519,6 +519,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab /// The row indices. /// The column indices. /// The reader to read from. + /// The length of the stored data. private static void PopulateComplexSparseMatrix(Matrix matrix, DataType type, bool isComplex, IList ir, IList jc, BinaryReader reader, int dataSize) { var col = 0; @@ -635,6 +636,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab /// The row indices. /// The column indices. /// The reader to read from. + /// The length of the stored data. private static void PopulateComplex32SparseMatrix(Matrix matrix, DataType type, bool isComplex, IList ir, IList jc, BinaryReader reader, int dataSize) { var col = 0; @@ -751,6 +753,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab /// if set to true if the Matlab complex flag is set. /// The number of rows. /// The number of columns. + /// The length of the stored data. /// Returns a populated dense matrix. private static Matrix PopulateDenseMatrix(DataType type, BinaryReader reader, bool isComplex, int rows, int columns, int size) { @@ -918,6 +921,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab /// The reader to read from. /// The number of rows. /// The number of columns. + /// The length of the stored data. public static void PopulateComplexDenseMatrix(Matrix matrix, DataType type, bool isComplex, BinaryReader reader, int rows, int columns, int dataSize) { switch (type) @@ -1154,6 +1158,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab /// The reader to read from. /// The number of rows. /// The number of columns. + /// The length of the stored data. public static void PopulateComplex32DenseMatrix(Matrix matrix, DataType type, bool isComplex, BinaryReader reader, int rows, int columns, int dataSize) { switch (type) diff --git a/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs index daea7c13..5a790c6b 100644 --- a/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs @@ -91,7 +91,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Row-major_order public DenseMatrix(int rows, int columns, float[] array) : base(rows, columns) { diff --git a/src/Numerics/LinearAlgebra/Single/DenseVector.cs b/src/Numerics/LinearAlgebra/Single/DenseVector.cs index eec92b19..b5d8c133 100644 --- a/src/Numerics/LinearAlgebra/Single/DenseVector.cs +++ b/src/Numerics/LinearAlgebra/Single/DenseVector.cs @@ -1194,7 +1194,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Matrix M[i,j] = this[i] * v[j]. /// - /// + /// public Matrix OuterProduct(DenseVector v) { return OuterProduct(this, v); diff --git a/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs index d79efe6c..958ac02c 100644 --- a/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs @@ -144,7 +144,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// The number of rows. /// The number of columns. - /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. + /// The one dimensional array to create this matrix from. This array should store the matrix in column-major order. see: http://en.wikipedia.org/wiki/Column-major_order /// If length is less than * . /// public SparseMatrix(int rows, int columns, float[] array) : this(rows, columns) diff --git a/src/Numerics/Random/SystemRandomExtensions.cs b/src/Numerics/Random/SystemRandomExtensions.cs index bbf68023..4b837d5d 100644 --- a/src/Numerics/Random/SystemRandomExtensions.cs +++ b/src/Numerics/Random/SystemRandomExtensions.cs @@ -32,7 +32,7 @@ namespace MathNet.Numerics.Random { using System; - /// + /// /// This class implements extension methods for the System.Random class. The extension methods generate /// pseudo-random distributed numbers for types other than double and int32. /// @@ -41,16 +41,20 @@ namespace MathNet.Numerics.Random /// /// Returns a nonnegative random number less than . /// + /// + /// The random object to extend. + /// /// /// A 64-bit signed integer greater than or equal to 0, and less than ; that is, - /// the range of return values includes 0 but not . + /// the range of return values includes 0 but not . /// /// - public static long NextInt64(this System.Random rnd) + public static long NextInt64(this Random rnd) { - byte[] buffer = new byte[sizeof(Int64)]; + var buffer = new byte[sizeof(long)]; + rnd.NextBytes(buffer); - long candidate = BitConverter.ToInt64(buffer, 0); + var candidate = BitConverter.ToInt64(buffer, 0); // wrap negative numbers around, mapping every negative number to a distinct nonnegative number // MinValue -> 0, -1 -> MaxValue @@ -63,14 +67,17 @@ namespace MathNet.Numerics.Random /// /// Returns a random number of the full Int32 range. /// + /// + /// The random object to extend. + /// /// /// A 32-bit signed integer of the full range, including 0, negative numbers, /// and . /// /// - public static int NextFullRangeInt32(this System.Random rnd) + public static int NextFullRangeInt32(this Random rnd) { - byte[] buffer = new byte[sizeof(Int32)]; + var buffer = new byte[sizeof(int)]; rnd.NextBytes(buffer); return BitConverter.ToInt32(buffer, 0); } @@ -78,14 +85,17 @@ namespace MathNet.Numerics.Random /// /// Returns a random number of the full Int64 range. /// + /// + /// The random object to extend. + /// /// /// A 64-bit signed integer of the full range, including 0, negative numbers, /// and . /// /// - public static long NextFullRangeInt64(this System.Random rnd) + public static long NextFullRangeInt64(this Random rnd) { - byte[] buffer = new byte[sizeof(Int64)]; + var buffer = new byte[sizeof(long)]; rnd.NextBytes(buffer); return BitConverter.ToInt64(buffer, 0); } @@ -93,11 +103,14 @@ namespace MathNet.Numerics.Random /// /// Returns a nonnegative decimal floating point random number less than 1.0. /// + /// + /// The random object to extend. + /// /// /// A decimal floating point number greater than or equal to 0.0, and less than 1.0; that is, /// the range of return values includes 0.0 but not 1.0. /// - public static decimal NextDecimal(this System.Random rnd) + public static decimal NextDecimal(this Random rnd) { decimal candidate; @@ -106,7 +119,7 @@ namespace MathNet.Numerics.Random // indeed be reached, with uniform probability. do { - candidate = new Decimal( + candidate = new decimal( rnd.NextFullRangeInt32(), rnd.NextFullRangeInt32(), rnd.NextFullRangeInt32(), diff --git a/src/Numerics/SpecialFunctions.cs b/src/Numerics/SpecialFunctions.cs index 0029f0c3..d70dfab2 100644 --- a/src/Numerics/SpecialFunctions.cs +++ b/src/Numerics/SpecialFunctions.cs @@ -329,7 +329,7 @@ namespace MathNet.Numerics } /// - /// Computes the logit function. + /// Computes the logit function. see: http://en.wikipedia.org/wiki/Logit /// /// The parameter for which to compute the logit function. This number should be /// between 0 and 1. @@ -345,7 +345,7 @@ namespace MathNet.Numerics } /// - /// Computes the logistic function. + /// Computes the logistic function. see: http://en.wikipedia.org/wiki/Logistic /// /// The parameter for which to compute the logistic function. /// The logistic function of . diff --git a/src/Numerics/Statistics/Histogram.cs b/src/Numerics/Statistics/Histogram.cs index f567310c..465147d8 100644 --- a/src/Numerics/Statistics/Histogram.cs +++ b/src/Numerics/Statistics/Histogram.cs @@ -187,7 +187,7 @@ namespace MathNet.Numerics.Statistics /// /// Checks whether two Buckets are equal; this method tolerates a difference in lowerbound, upperbound - /// and count given by . + /// and count given by . /// public override bool Equals(object obj) { diff --git a/src/Numerics/Statistics/MCMC/MCMCSampler.cs b/src/Numerics/Statistics/MCMC/MCMCSampler.cs index 46b6e28c..02e475f2 100644 --- a/src/Numerics/Statistics/MCMC/MCMCSampler.cs +++ b/src/Numerics/Statistics/MCMC/MCMCSampler.cs @@ -98,7 +98,7 @@ namespace MathNet.Numerics.Statistics.Mcmc protected int mSamples; /// - /// Initializes a new instance of the class. + /// Initializes a new instance of the class. /// /// Thread safe instances are two and half times slower than non-thread /// safe classes.