diff --git a/docs/content/DescriptiveStatistics.fsx b/docs/content/DescriptiveStatistics.fsx index ab987013..ce7997e1 100644 --- a/docs/content/DescriptiveStatistics.fsx +++ b/docs/content/DescriptiveStatistics.fsx @@ -26,13 +26,13 @@ However, various statistics can be computed much more efficiently if the data so has known properties or structure, that's why the following classes provide specialized static implementations: -* `ArrayStatistics` provides routines optimized for single-dimensional arrays. Some +* **ArrayStatistics** provides routines optimized for single-dimensional arrays. Some of these routines end with the `Inplace` suffix, indicating that they reorder the input array slightly towards being sorted during execution - without fully sorting them, which could be expensive. -* `SortedArrayStatistics` provides routines optimized for an array sorting ascendingly. +* **SortedArrayStatistics** provides routines optimized for an array sorting ascendingly. Especially order-statistics are very efficient this way, some even with constant time complexity. -* `StreamingStatistics` processes large amounts of data without keeping them in memory. +* **StreamingStatistics** processes large amounts of data without keeping them in memory. Useful if data larger than local memory is streamed directly from a disk or network. Another alternative, in case you need to gather a whole set of statistical characteristics diff --git a/docs/content/RandomAndDistributions.fsx b/docs/content/Random.fsx similarity index 92% rename from docs/content/RandomAndDistributions.fsx rename to docs/content/Random.fsx index b1a1b8ed..e3b6bc84 100644 --- a/docs/content/RandomAndDistributions.fsx +++ b/docs/content/Random.fsx @@ -101,10 +101,10 @@ or a `System.Decimal`? Extending discrete random numbers to different ranges or if the distribution should still be uniform over the chosen range. That's why we've added a few extensions methods which are available on all RNGs (including System.Random itself): -* NextInt64: generates a 64 bit integer, uniform in the range [0, Long.MaxValue) -* NextFullRangeInt32: generates a 32 bit integer, uniform in the range [Int.MinValue, Int.MaxValue] -* NextFullRangeInt64: generates a 64 bit integer, uniform in the range [Long.MinValue, Long.MaxValue] -* NextDecimal: generates a `System.Decimal`, uniform in the range [0.0, 1.0) +* **NextInt64** generates a 64 bit integer, uniform in the range [0, Long.MaxValue) +* **NextDecimal** generates a `System.Decimal`, uniform in the range [0.0, 1.0) +* **NextFullRangeInt32** generates a 32 bit integer, uniform in the range [Int.MinValue, Int.MaxValue] +* **NextFullRangeInt64** generates a 64 bit integer, uniform in the range [Long.MinValue, Long.MaxValue] Seeds @@ -151,16 +151,16 @@ Uniform Random Number Generators Up to now we've used only `SystemRandomSource`, but there's much more: -* `SystemRandomSource`: Wraps the .NET BCL System.Random to provide thread-safety -* `CryptoRandomSource`: Wraps the .NET BCL RNGCryptoServiceProvider. *Not available in portable builds.* -* `MersenneTwister`: Mersenne Twister 19937 generator -* `Xorshift`: Multiply-with-carry XOR-shift generator -* `Mcg31m1`: Multiplicative congruential generator using a modulus of 2^31-1 and a multiplier of 1132489760 -* `Mcg59`: Multiplicative congruential generator using a modulus of 2^59 and a multiplier of 13^13 -* `WH1982`: Wichmann-Hill's 1982 combined multiplicative congruential generator -* `WH2006`: Wichmann-Hill's 2006 combined multiplicative congruential generator -* `Mrg32k3a`: 32-bit combined multiple recursive generator with 2 components of order 3 -* `Palf`: Parallel Additive Lagged Fibonacci generator +* **SystemRandomSource**: Wraps the .NET System.Random to provide thread-safety +* **CryptoRandomSource**: Wraps the .NET RNGCryptoServiceProvider. *Not available in portable builds.* +* **MersenneTwister**: Mersenne Twister 19937 generator +* **Xorshift**: Multiply-with-carry XOR-shift generator +* **Mcg31m1**: Multiplicative congruential generator using a modulus of 2^31-1 and a multiplier of 1132489760 +* **Mcg59**: Multiplicative congruential generator using a modulus of 2^59 and a multiplier of 13^13 +* **WH1982**: Wichmann-Hill's 1982 combined multiplicative congruential generator +* **WH2006**: Wichmann-Hill's 2006 combined multiplicative congruential generator +* **Mrg32k3a**: 32-bit combined multiple recursive generator with 2 components of order 3 +* **Palf**: Parallel Additive Lagged Fibonacci generator Let's sample a few uniform random values using Mersenne Twister in C#: diff --git a/docs/content/index.fsx b/docs/content/index.fsx index aa32ceca..07089a2a 100644 --- a/docs/content/index.fsx +++ b/docs/content/index.fsx @@ -12,14 +12,14 @@ Installation Instructions The recommended way to get Math.NET Numerics is to use NuGet. The following packages are provided and maintained in the public [NuGet Gallery](https://nuget.org/profiles/mathnet/): -- `MathNet.Numerics` - core package, including .Net 4, .Net 3.5 and portable/PCL builds. -- `MathNet.Numerics.FSharp` - optional extensions for a better F# experience. BigRational. -- `MathNet.Numerics.Data.Text` - optional extensions for text-based matrix input/output. -- `MathNet.Numerics.Data.Matlab` - optional extensions for MATLAB matrix file input/output. -- `MathNet.Numerics.MKL.Win-x86` - optional Linear Algebra MKL native provider. -- `MathNet.Numerics.MKL.Win-x64` - optional Linear Algebra MKL native provider. -- `MathNet.Numerics.Signed` - strong-named version of the core package *(not recommended)*. -- `MathNet.Numerics.FSharp.Signed` - strong-named version of the F# package *(not recommended)*. +- **MathNet.Numerics** - core package, including .Net 4, .Net 3.5 and portable/PCL builds. +- **MathNet.Numerics.FSharp** - optional extensions for a better F# experience. BigRational. +- **MathNet.Numerics.Data.Text** - optional extensions for text-based matrix input/output. +- **MathNet.Numerics.Data.Matlab** - optional extensions for MATLAB matrix file input/output. +- **MathNet.Numerics.MKL.Win-x86** - optional Linear Algebra MKL native provider. +- **MathNet.Numerics.MKL.Win-x64** - optional Linear Algebra MKL native provider. +- **MathNet.Numerics.Signed** - strong-named version of the core package *(not recommended)*. +- **MathNet.Numerics.FSharp.Signed** - strong-named version of the F# package *(not recommended)*. Alternatively you can also download the binaries in Zip packages, available on [CodePlex](http://mathnetnumerics.codeplex.com/releases): diff --git a/docs/tools/templates/template.cshtml b/docs/tools/templates/template.cshtml index 1e376ec2..00220c20 100644 --- a/docs/tools/templates/template.cshtml +++ b/docs/tools/templates/template.cshtml @@ -51,7 +51,7 @@
  • Class Reference
  • Getting Started
    • -
  • Getting started
    • +
  • Getting started
  • Constants
  • Floating-Point Numbers
  • Arbitrary Precision Numbers
    • @@ -71,7 +71,7 @@
  • Generation
  • Generating Data
    • -
  • Random Numbers
    • +
  • Random Numbers
  • Transformation
  • Fourier Transform (FFT)