Browse Source

doc: fixed xml doc errors and updated SHFB config

pull/36/head
Marcus Cuda 16 years ago
parent
commit
ad8f72295a
  1. 127
      build/License.txt
  2. 4
      build/SiteMap.sitemap
  3. 55
      build/mathnet-numerics.shfbproj
  4. 4
      src/MathNet.Numerics.5.1.ReSharper
  5. 3
      src/Numerics/Complex32.cs
  6. 2
      src/Numerics/Distributions/Discrete/Categorical.cs
  7. 2
      src/Numerics/Distributions/Discrete/ConwayMaxwellPoisson.cs
  8. 5
      src/Numerics/Distributions/Discrete/Geometric.cs
  9. 2
      src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs
  10. 3
      src/Numerics/LinearAlgebra/Complex/DenseVector.cs
  11. 2
      src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs
  12. 2
      src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs
  13. 2
      src/Numerics/LinearAlgebra/Complex32/DenseVector.cs
  14. 2
      src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs
  15. 2
      src/Numerics/LinearAlgebra/Double/DenseMatrix.cs
  16. 2
      src/Numerics/LinearAlgebra/Double/DenseVector.cs
  17. 2
      src/Numerics/LinearAlgebra/Double/SparseMatrix.cs
  18. 2
      src/Numerics/LinearAlgebra/Generic/Matrix.Arithmetic.cs
  19. 8
      src/Numerics/LinearAlgebra/Generic/Solvers/StopCriterium/StopLevel.cs
  20. 5
      src/Numerics/LinearAlgebra/IO/Matlab/MatlabParser.cs
  21. 2
      src/Numerics/LinearAlgebra/Single/DenseMatrix.cs
  22. 2
      src/Numerics/LinearAlgebra/Single/DenseVector.cs
  23. 2
      src/Numerics/LinearAlgebra/Single/SparseMatrix.cs
  24. 35
      src/Numerics/Random/SystemRandomExtensions.cs
  25. 4
      src/Numerics/SpecialFunctions.cs
  26. 2
      src/Numerics/Statistics/Histogram.cs
  27. 2
      src/Numerics/Statistics/MCMC/MCMCSampler.cs

127
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.

4
build/SiteMap.sitemap

@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<siteMap xmlns="http://schemas.microsoft.com/AspNet/SiteMap-File-1.0">
<siteMapNode title="License" url="License.txt" isDefault="true" />
</siteMap>

55
build/mathnet-numerics.shfbproj

@ -6,8 +6,8 @@
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{45092870-9e6c-4a1d-8923-39a380f35f94}</ProjectGuid>
<SHFBSchemaVersion>1.8.0.0</SHFBSchemaVersion>
<ProjectGuid>{7abd8233-0d4c-4e89-b2e1-0b686c9fc2ca}</ProjectGuid>
<SHFBSchemaVersion>1.9.0.0</SHFBSchemaVersion>
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual
Studio adds them anyway -->
<AssemblyName>Documentation</AssemblyName>
@ -15,24 +15,51 @@
<Name>Documentation</Name>
<!-- SHFB properties -->
<OutputPath>.\Help\</OutputPath>
<HtmlHelpName>Math.NET-Numerics</HtmlHelpName>
<CopyrightText>Copyright 2009-2010 Math.NET Project</CopyrightText>
<HelpTitle>Math.NET Numerics</HelpTitle>
<SandcastlePath>c:\Programme\Sandcastle\</SandcastlePath>
<WorkingPath>doc\</WorkingPath>
<HtmlHelpName>Documentation</HtmlHelpName>
<Language>en-US</Language>
<FrameworkVersion>4.0.30319</FrameworkVersion>
<PresentationStyle>vs2005</PresentationStyle>
<DocumentationSources>
<DocumentationSource sourceFile="bin\MathNet.Numerics.dll" />
<DocumentationSource sourceFile="bin\MathNet.Numerics.FSharp.dll" />
<DocumentationSource sourceFile="bin\MathNet.Numerics.FSharp.xml" />
<DocumentationSource sourceFile="bin\MathNet.Numerics.xml" /></DocumentationSources>
<DocumentationSource sourceFile="..\out\lib\Net40\MathNet.Numerics.dll" xmlns="" />
<DocumentationSource sourceFile="..\out\lib\Net40\MathNet.Numerics.xml" xmlns="" /></DocumentationSources>
<Preliminary>True</Preliminary>
<ProjectSummary>Numerical Library for .NET</ProjectSummary>
<CopyrightText>Copyright %28c%29 2009-2010 Math.NET</CopyrightText>
<RootNamespaceContainer>True</RootNamespaceContainer>
<HelpTitle>Math.NET Numerics</HelpTitle>
<RootNamespaceTitle>API Reference</RootNamespaceTitle>
<IncludeFavorites>False</IncludeFavorites>
<PlugInConfigurations>
<PlugInConfig id="Hierarchical Table of Contents" enabled="True" xmlns="">
<configuration />
</PlugInConfig>
<PlugInConfig id="Additional Content Only" enabled="True" xmlns=""><configuration /></PlugInConfig></PlugInConfigurations>
</PropertyGroup>
<!-- There are no properties for these two groups but they need to appear in
order for Visual Studio to perform the build. -->
<!-- There are no properties for these groups. AnyCPU needs to appear in
order for Visual Studio to perform the build. The others are optional
common platform types that may appear. -->
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
</PropertyGroup>
<ItemGroup>
<Content Include="License.txt" />
</ItemGroup>
<ItemGroup>
<SiteMap Include="SiteMap.sitemap" />
</ItemGroup>
<!-- Import the SHFB build targets -->
<Import Project="C:\Programme\EWSoftware\Sandcastle Help File Builder\SandcastleHelpFileBuilder.targets" />
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" />
</Project>

4
src/MathNet.Numerics.5.1.ReSharper

@ -36,7 +36,9 @@ Excel's
ipiv
blocksize
Dont
dll</UserWords>
dll
Criterium
inline</UserWords>
</CustomDictionary>
</Dictionaries>
</CustomDictionaries>

3
src/Numerics/Complex32.cs

@ -46,8 +46,7 @@ namespace MathNet.Numerics
/// The class <c>Complex32</c> provides all elementary operations
/// on complex numbers. All the operators <c>+</c>, <c>-</c>,
/// <c>*</c>, <c>/</c>, <c>==</c>, <c>!=</c> are defined in the
/// canonical way. Additional complex trigonometric functions such
/// as <see cref="Trig.Cosine(Complex32)"/>, ...
/// canonical way. Additional complex trigonometric functions
/// are also provided. Note that the <c>Complex32</c> structures
/// has two special constant values <see cref="Complex32.NaN"/> and
/// <see cref="Complex32.Infinity"/>.

2
src/Numerics/Distributions/Discrete/Categorical.cs

@ -445,7 +445,7 @@ namespace MathNet.Numerics.Distributions
/// </summary>
/// <param name="rnd">The random number generator to use.</param>
/// <param name="cdf">The cumulative distribution of the probability distribution.</param>
/// <returns>One sample from the categorical distribution implied by <see cref="cdf"/>.</returns>
/// <returns>One sample from the categorical distribution implied by <paramref name="cdf"/>.</returns>
internal static int DoSample(Random rnd, double[] cdf)
{
// TODO : use binary search to speed up this procedure.

2
src/Numerics/Distributions/Discrete/ConwayMaxwellPoisson.cs

@ -540,7 +540,7 @@ namespace MathNet.Numerics.Distributions
/// <param name="nu">The nu parameter.</param>
/// <param name="z">The z parameter.</param>
/// <returns>
/// One sample from the distribution implied by <see cref="cdf"/>.
/// One sample from the distribution implied by <paramref name="lambda"/>, <paramref name="nu"/>, and <paramref name="z"/>.
/// </returns>
private static int DoSample(Random rnd, double lambda, double nu, double z)
{

5
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
/// <param name="rnd">The random number generator to use.</param>
/// <param name="p">The p parameter</param>
/// <returns>
/// One sample from the distribution implied by <param name="p"/>.
/// One sample from the distribution implied by <paramref name="p"/>.
/// </returns>
private static int DoSample(Random rnd, double p)
{

2
src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs

@ -92,7 +92,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Row-major_order"/></param>
/// <param name="array">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 </param>
public DenseMatrix(int rows, int columns, Complex[] array)
: base(rows, columns)
{

3
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
/// <returns>
/// Matrix M[i,j] = this[i] * v[j].
/// </returns>
/// <seealso cref="OuterProduct"/>
/// <seealso cref="OuterProduct(DenseVector, DenseVector)"/>
public Matrix<Complex> OuterProduct(DenseVector v)
{
return OuterProduct(this, v);

2
src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs

@ -145,7 +145,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Column-major_order"/></param>
/// <param name="array">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 </param>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="array"/> length is less than <paramref name="rows"/> * <paramref name="columns"/>.
/// </exception>
public SparseMatrix(int rows, int columns, Complex[] array) : this(rows, columns)

2
src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs

@ -92,7 +92,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Row-major_order"/></param>
/// <param name="array">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 </param>
public DenseMatrix(int rows, int columns, Complex32[] array)
: base(rows, columns)
{

2
src/Numerics/LinearAlgebra/Complex32/DenseVector.cs

@ -1154,7 +1154,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32
/// <returns>
/// Matrix M[i,j] = this[i] * v[j].
/// </returns>
/// <seealso cref="OuterProduct"/>
/// <seealso cref="OuterProduct(DenseVector, DenseVector)"/>
public Matrix<Complex32> OuterProduct(DenseVector v)
{
return OuterProduct(this, v);

2
src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs

@ -145,7 +145,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Column-major_order"/></param>
/// <param name="array">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 </param>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="array"/> length is less than <paramref name="rows"/> * <paramref name="columns"/>.
/// </exception>
public SparseMatrix(int rows, int columns, Complex32[] array) : this(rows, columns)

2
src/Numerics/LinearAlgebra/Double/DenseMatrix.cs

@ -91,7 +91,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Row-major_order"/></param>
/// <param name="array">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 </param>
public DenseMatrix(int rows, int columns, double[] array)
: base(rows, columns)
{

2
src/Numerics/LinearAlgebra/Double/DenseVector.cs

@ -1194,7 +1194,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double
/// <returns>
/// Matrix M[i,j] = this[i] * v[j].
/// </returns>
/// <seealso cref="OuterProduct"/>
/// <seealso cref="OuterProduct(DenseVector, DenseVector)"/>
public Matrix<double> OuterProduct(DenseVector v)
{
return OuterProduct(this, v);

2
src/Numerics/LinearAlgebra/Double/SparseMatrix.cs

@ -144,7 +144,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Column-major_order"/></param>
/// <param name="array">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 </param>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="array"/> length is less than <paramref name="rows"/> * <paramref name="columns"/>.
/// </exception>
public SparseMatrix(int rows, int columns, double[] array) : this(rows, columns)

2
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
/// <summary>
/// Defines the base class for <c>Matrix</c> classes.
/// </summary>
/// <typeparam name="T">Supported data types are double, single, <see cref="Complex"/>, and <see cref="Complex32"/>.</typeparam>
public abstract partial class Matrix<T>
{
/// <summary>

8
src/Numerics/LinearAlgebra/Generic/Solvers/StopCriterium/StopLevel.cs

@ -32,24 +32,24 @@ namespace MathNet.Numerics.LinearAlgebra.Generic.Solvers.StopCriterium
public enum StopLevel
{
/// <summary>
/// The <see cref="IIterationStopCriterium"/> monitors calculation failures in the
/// The <see cref="IIterationStopCriterium{T}"/> monitors calculation failures in the
/// iterative calculation.
/// </summary>
CalculationFailure,
/// <summary>
/// The <see cref="IIterationStopCriterium"/> monitors the calculation for signs of divergence.
/// The <see cref="IIterationStopCriterium{T}"/> monitors the calculation for signs of divergence.
/// </summary>
Divergence,
/// <summary>
/// The <see cref="IIterationStopCriterium"/> guards the calculation against unlimited continuation
/// The <see cref="IIterationStopCriterium{T}"/> guards the calculation against unlimited continuation
/// by monitoring user specified limits, e.g. the maximum number of iterations.
/// </summary>
StoppedWithoutConvergence,
/// <summary>
/// The <see cref="IIterationStopCriterium"/> monitors the calculation for convergence, usually
/// The <see cref="IIterationStopCriterium{T}"/> monitors the calculation for convergence, usually
/// based on the residuals of the calculation.
/// </summary>
Convergence

5
src/Numerics/LinearAlgebra/IO/Matlab/MatlabParser.cs

@ -519,6 +519,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab
/// <param name="ir">The row indices.</param>
/// <param name="jc">The column indices.</param>
/// <param name="reader">The reader to read from.</param>
/// <param name="dataSize">The length of the stored data.</param>
private static void PopulateComplexSparseMatrix(Matrix<Complex> matrix, DataType type, bool isComplex, IList<int> ir, IList<int> jc, BinaryReader reader, int dataSize)
{
var col = 0;
@ -635,6 +636,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab
/// <param name="ir">The row indices.</param>
/// <param name="jc">The column indices.</param>
/// <param name="reader">The reader to read from.</param>
/// <param name="dataSize">The length of the stored data.</param>
private static void PopulateComplex32SparseMatrix(Matrix<Complex32> matrix, DataType type, bool isComplex, IList<int> ir, IList<int> jc, BinaryReader reader, int dataSize)
{
var col = 0;
@ -751,6 +753,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab
/// <param name="isComplex">if set to <c>true</c> if the Matlab complex flag is set.</param>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="size">The length of the stored data.</param>
/// <returns>Returns a populated dense matrix.</returns>
private static Matrix<TDataType> PopulateDenseMatrix(DataType type, BinaryReader reader, bool isComplex, int rows, int columns, int size)
{
@ -918,6 +921,7 @@ namespace MathNet.Numerics.LinearAlgebra.IO.Matlab
/// <param name="reader">The reader to read from.</param>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="dataSize">The length of the stored data.</param>
public static void PopulateComplexDenseMatrix(Matrix<Complex> 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
/// <param name="reader">The reader to read from.</param>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="dataSize">The length of the stored data.</param>
public static void PopulateComplex32DenseMatrix(Matrix<Complex32> matrix, DataType type, bool isComplex, BinaryReader reader, int rows, int columns, int dataSize)
{
switch (type)

2
src/Numerics/LinearAlgebra/Single/DenseMatrix.cs

@ -91,7 +91,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Row-major_order"/></param>
/// <param name="array">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 </param>
public DenseMatrix(int rows, int columns, float[] array)
: base(rows, columns)
{

2
src/Numerics/LinearAlgebra/Single/DenseVector.cs

@ -1194,7 +1194,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single
/// <returns>
/// Matrix M[i,j] = this[i] * v[j].
/// </returns>
/// <seealso cref="OuterProduct"/>
/// <seealso cref="OuterProduct(DenseVector, DenseVector)"/>
public Matrix<float> OuterProduct(DenseVector v)
{
return OuterProduct(this, v);

2
src/Numerics/LinearAlgebra/Single/SparseMatrix.cs

@ -144,7 +144,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single
/// </summary>
/// <param name="rows">The number of rows.</param>
/// <param name="columns">The number of columns.</param>
/// <param name="array">The one dimensional array to create this matrix from. This array should store the matrix in column-major order. <seealso cref="http://en.wikipedia.org/wiki/Column-major_order"/></param>
/// <param name="array">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 </param>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="array"/> length is less than <paramref name="rows"/> * <paramref name="columns"/>.
/// </exception>
public SparseMatrix(int rows, int columns, float[] array) : this(rows, columns)

35
src/Numerics/Random/SystemRandomExtensions.cs

@ -32,7 +32,7 @@ namespace MathNet.Numerics.Random
{
using System;
/// <summary>
/// <summary>
/// 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.
/// </summary>
@ -41,16 +41,20 @@ namespace MathNet.Numerics.Random
/// <summary>
/// Returns a nonnegative random number less than <see cref="Int64.MaxValue"/>.
/// </summary>
/// <param name="rnd">
/// The random object to extend.
/// </param>
/// <returns>
/// A 64-bit signed integer greater than or equal to 0, and less than <see cref="Int64.MaxValue"/>; that is,
/// the range of return values includes 0 but not <paramref name="Int64.MaxValue"/>.
/// the range of return values includes 0 but not <see cref="Int64.MaxValue"/>.
/// </returns>
/// <seealso cref="NextFullRangeInt64"/>
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
/// <summary>
/// Returns a random number of the full Int32 range.
/// </summary>
/// <param name="rnd">
/// The random object to extend.
/// </param>
/// <returns>
/// A 32-bit signed integer of the full range, including 0, negative numbers,
/// <see cref="Int32.MaxValue"/> and <see cref="Int32.MinValue"/>.
/// </returns>
/// <seealso cref="System.Random.Next()"/>
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
/// <summary>
/// Returns a random number of the full Int64 range.
/// </summary>
/// <param name="rnd">
/// The random object to extend.
/// </param>
/// <returns>
/// A 64-bit signed integer of the full range, including 0, negative numbers,
/// <see cref="Int64.MaxValue"/> and <see cref="Int64.MinValue"/>.
/// </returns>
/// <seealso cref="NextInt64"/>
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
/// <summary>
/// Returns a nonnegative decimal floating point random number less than 1.0.
/// </summary>
/// <param name="rnd">
/// The random object to extend.
/// </param>
/// <returns>
/// 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.
/// </returns>
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(),

4
src/Numerics/SpecialFunctions.cs

@ -329,7 +329,7 @@ namespace MathNet.Numerics
}
/// <summary>
/// Computes the logit function. <seealso cref="http://en.wikipedia.org/wiki/Logit"/>
/// Computes the logit function. see: http://en.wikipedia.org/wiki/Logit
/// </summary>
/// <param name="p">The parameter for which to compute the logit function. This number should be
/// between 0 and 1.</param>
@ -345,7 +345,7 @@ namespace MathNet.Numerics
}
/// <summary>
/// Computes the logistic function. <seealso cref="http://en.wikipedia.org/wiki/Logistic"/>
/// Computes the logistic function. see: http://en.wikipedia.org/wiki/Logistic
/// </summary>
/// <param name="p">The parameter for which to compute the logistic function.</param>
/// <returns>The logistic function of <paramref name="p"/>.</returns>

2
src/Numerics/Statistics/Histogram.cs

@ -187,7 +187,7 @@ namespace MathNet.Numerics.Statistics
/// <summary>
/// Checks whether two Buckets are equal; this method tolerates a difference in lowerbound, upperbound
/// and count given by <seealso cref="Precsion.AlmostEqual"/>.
/// and count given by <seealso cref="Precision.AlmostEqual(double,double)"/>.
/// </summary>
public override bool Equals(object obj)
{

2
src/Numerics/Statistics/MCMC/MCMCSampler.cs

@ -98,7 +98,7 @@ namespace MathNet.Numerics.Statistics.Mcmc
protected int mSamples;
/// <summary>
/// Initializes a new instance of the <see cref="McmcSampler"/> class.
/// Initializes a new instance of the <see cref="McmcSampler{T}"/> class.
/// </summary>
/// <remarks>Thread safe instances are two and half times slower than non-thread
/// safe classes.</remarks>

Loading…
Cancel
Save