diff --git a/AUTHORS.md b/CONTRIBUTORS.md similarity index 94% rename from AUTHORS.md rename to CONTRIBUTORS.md index a9abfb01..35edda13 100644 --- a/AUTHORS.md +++ b/CONTRIBUTORS.md @@ -1,7 +1,7 @@ -Math.NET Numerics Authors -========================= +Math.NET Numerics Contributors +============================== -The Math.NET project is a community effort. This page only lists actual code contributors for practical reasons, but any contributions like submitting issues or helping the community are just as valuable. Thanks a lot. +The Math.NET project is a community effort. This page only lists actual code contributors for practical reasons, but any contributions like submitting issues or helping the community are just as valuable. ### Maintainers diff --git a/COPYRIGHT.md b/LICENSE.md similarity index 100% rename from COPYRIGHT.md rename to LICENSE.md diff --git a/README.md b/README.md index 4715b4e1..37adc762 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ SL5 and .NET for Windows Store apps. Math.NET Numerics is covered under the terms of the [MIT/X11](http://mathnetnumerics.codeplex.com/license) license. You may therefore link to it and use it in both opensource and proprietary -software projects. See also the [copyright](COPYRIGHT.md) file in the root folder. +software projects. See also the [license](LICENSE.md) file in the root folder. Math.NET Numerics is the result of merging [dnAnalytics](http://dnanalytics.codeplex.com/) with [Math.NET Iridium](http://www.mathdotnet.com/Iridium.aspx) and replaces both. @@ -56,7 +56,7 @@ Installation Instructions Download the *MathNet.Numerics.dll* assembly, add a reference to it to your project and you're done. To make this even simpler we publish binary releases to the [**NuGet Gallery**](http://nuget.org/) as package *MathNet.Numerics* (or *MathNet.Numerics.FSharp* for F# integration). Alternatively we also publish binary releases including documentation on [CodePlex](http://mathnetnumerics.codeplex.com/releases). -[Release Notes & Changes](RELEASENOTES.md) +* [Release Notes & Changes](RELEASENOTES.md) Team & Contributors ------------------- @@ -72,4 +72,4 @@ Matthew Kitchin, Rana Ian, Andrew Kurochka, Thaddaeus Parker, Sergey Bochkanov (ALGLIB), John Maddock (Boost), Stephen L. Moshier (Cephes Math Library) -See also the [AUTHORS](AUTHORS.md) file for a full list of all contributors. +See [contributors](CONTRIBUTORS.md) file for a full list of all contributors. diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 68eb2169..89e95998 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,7 +1,7 @@ Math.NET Numerics Release Notes =============================== -- Website: [numerics.mathdotnet.com](http://numerics.mathdotnet.com) +- **Website: [numerics.mathdotnet.com](http://numerics.mathdotnet.com)** - GitHub/Mainline: [github.com/mathnet/mathnet-numerics](https://github.com/mathnet/mathnet-numerics) - CodePlex: [mathnetnumerics.codeplex.com](http://mathnetnumerics.codeplex.com) - License: MIT/X11 Open Source diff --git a/build/NuGet/.gitignore b/build/NuGet/.gitignore index 6319ac19..ae514304 100644 --- a/build/NuGet/.gitignore +++ b/build/NuGet/.gitignore @@ -1,2 +1,4 @@ lib -content \ No newline at end of file +content +readme.txt +license.txt \ No newline at end of file diff --git a/build/NuGet/Numerics/readme.txt b/build/NuGet/Numerics/readme.txt new file mode 100644 index 00000000..89e95998 --- /dev/null +++ b/build/NuGet/Numerics/readme.txt @@ -0,0 +1,113 @@ +Math.NET Numerics Release Notes +=============================== + +- **Website: [numerics.mathdotnet.com](http://numerics.mathdotnet.com)** +- GitHub/Mainline: [github.com/mathnet/mathnet-numerics](https://github.com/mathnet/mathnet-numerics) +- CodePlex: [mathnetnumerics.codeplex.com](http://mathnetnumerics.codeplex.com) +- License: MIT/X11 Open Source + +NuGet Packages, available in the [NuGet Gallery](https://nuget.org/profiles/mathnet/): + +- `MathNet.Numerics` - core package, including both .Net 4 and portable builds +- `MathNet.Numerics.FSharp` - optional extensions for a better F# experience +- `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.Samples` - code samples in C# +- `MathNet.Numerics.FSharp.Samples` - code samples in F# + +Zip Packages, available on [CodePlex](http://mathnetnumerics.codeplex.com/releases): + +- Binaries - core package and F# extensions, including both .Net 4 and portable builds +- Signed Binaries - strong-named version of the core package (not recommended) + +Over time some members and classes within Math.NET Numerics have been replaced with more suitable alternatives. In order to maintain compatibility, such parts are not removed immediately but instead marked with the **Obsolete-attribute**. We strongly recommend to follow the instructions in the attribute text whenever you find any code calling an obsolete member, since we do intend to remove them at the next major release, v3.0. + +v2.5.0 - Preliminary, TBA +------------------------- + +### *Potentially Breaking Changes:* + +Despite semver this release contains two changes that may potentially break code, without triggering a major version number change. The changes fix semantic bugs and a major usability issue without changing the formal API itself. Most users are not expected to be affected negatively, although some workarounds to fix the inconsistencies may no longer be needed. Nevertheless, this is an exceptional case and we try hard to avoid such changes in the future. + +- Statistics like Min, Max, Mean, Variance and Standard Deviation no longer throw exceptions if the data set is empty (unless the data set itself is null) but instead return NaN. Variance and Standard Deviation will also return NaN if the set contains only a single entry. Population Variance and Population Standard Deviation will return 0 in this case. *This may break code in case you relied upon the previous unusual and inconsistent behavior.* + +- Matrix and Vector `ToString` methods no longer render the whole structure to a string for large data, among others because they used to wreak havoc in debugging and interactive scenarios like F# FSI. Instead, ToString now only renders an excerpt of the data, together with a line about dimension, type and in case of sparse data a sparseness indicator. The intention is to give a good idea about the data in a visually useful way. How much data is shown can be adjusted in the Control class. See also ToTypeString and ToVector/MatrixString. *This may break code if you relied upon ToString to export your full data to text form intended to be parsed again later. Note that the classes in the MathNet.Numerics.IO library are more appropriate for storing and loading data.* + +### Statistics: + +- More consistent behavior for empty and single-element data sets. See above in the 'Potentially Breaking Changes' section. +- Reworked order statistics (Quantile, Quartile, Percentile, IQR, Fivenum, etc.), supporting compatibility with all 9 R-types, Excel and Mathematica. +- Old Percentile class now leverages the new order statistics, fixing a range check bug as side effect. +- New Hybrid Monte Carlo sampler for multivariate distributions +- New financial statistics: absolute risk and return measures +- Explicit efficient statistics for sorted arrays, unsorted arrays and sequences/streams. Avoids multiple enumerations. +- Some statistics like Quantile or empirical inverse CDF can optionally return a parametric function when multiple evaluations are needed, like for plotting. + +### Linear Algebra: + +- More reasonable ToString behavior for matrices and vectors. See above in the 'Potentially Breaking Changes' section. +- Performance: reworked and tuned common parallelization. Some operations are up to 3 magnitudes faster in some cases. Replaced copy loops with native routines. More algorithms are storage-aware (and should thus perform better especially on sparse data). +- Fixed range checks in the thin QR decomposition. +- Fixed bug in Gram Schmidt for solving tall matrices. +- Vectors now implement the BCL IList interfaces (fixed-length) for better integration with existing .Net code. +- Matrix/Vector parsing has been updated to be able to parse the new visual format as well (see ToMatrixString). +- DebuggerDisplay attributes for matrices/vectors. +- Map/IndexedMap combinators with storage-aware and partially parallelized implementations for both dense and sparse data. +- Reworked Matrix/Vector construction from arrays, enumerables, indexed enumerables, nested enumerables or by providing an init function/lambda. Non-obsolete constructors now always use the raw data array directly, while static functions always return a matrix/vector independent of the provided data source. +- F#: Improved extensions for matrix and vector construction: create, zeroCreate, randomCreate, init, ofArray2, ofRowSeq/List, ofColumnSeq/List, ofSeqi/Listi (indexed). Storage-aware for performance. +- F#: Updated map/mapi and other combinators to leverage core implementation, added map*nz* variants where zero-values may be skipped (relevant mostly for sparse matrices). +- F#: Idiomatic slice setters for sub-matrices and sub-vectors + +### Misc: + +- Control: Simpler usage with new static ConfigureAuto and ConfigureSingleThread methods. Resolved misleading configuration logic and naming around disabling parallelization. +- Control: New settings for linear algebra ToString behavior. +- Parallelization: Reworked our common logic to avoid expensive lambda calls in inner loops. Tunable. +- Various minor improvements on consistency, performance, tests, xml docs, obsolete attributes, redundant code, argument checks, resources, cleanup, etc. + + +v2.4.0 - February 3, 2013 +------------------------- + +- Drops the dependency on the zlib library. We thus no longer have any dependencies on other packages. +- Adds Modified Bessel & Struve special functions +- Fixes a bug in our iterative kurtosis statistics formula + +### Linear Algebra: + +- Performance work, this time mostly around accessing matrix rows/columns as vectors. Opting out from targeted patching in our matrix and vector indexers to allow inlining. +- Fixes an issue around Thin-QR solve +- Simplifications around using native linear algebra providers (see Math.NET Numerics With Native Linear Algebra) + +### F#: + +- Adds the BigRational module from the F# PowerPack, now to be maintained here instead. +- Better support for our Complex types (close to the F# PowerPack Complex type) + +v2.3.0 - November 25, 2012 +-------------------------- + +### Portable Library Build: + +- Adds support for WP8 (.Net 4.0 and higher, SL5, WP8 and .NET for Windows Store apps) +- New: portable build also for F# extensions (.Net 4.5, SL5 and .NET for Windows Store apps) +- NuGet: portable builds are now included in the main packages, no more need for special portable packages + +### Linear Algebra: + +- Continued major storage rework, in this release focusing on vectors (previous release was on matrices) +- Thin QR decomposition (in addition to existing full QR) +- Static CreateRandom for all dense matrix and vector types +- F#: slicing support for matrices and vectors + +### Random and Probability Distributions: + +- Consistent static Sample methods for all continuous and discrete distributions (was previously missing on a few) +- F#: better usability for random numbers and distributions. + +### Misc: + +- F# extensions are now using F# 3.0 +- Updated Intel MKL references for our native linear algebra providers +- Various bug, performance and usability fixes diff --git a/build/NuGet/nuget-signed.proj b/build/NuGet/nuget-signed.proj index e637bcb1..e55e7903 100644 --- a/build/NuGet/nuget-signed.proj +++ b/build/NuGet/nuget-signed.proj @@ -16,8 +16,8 @@ - - + + diff --git a/build/NuGet/nuget.proj b/build/NuGet/nuget.proj index a5222d60..587db78a 100644 --- a/build/NuGet/nuget.proj +++ b/build/NuGet/nuget.proj @@ -25,10 +25,15 @@ - - - - + + + + + + + + +