commit 8fe7f28a923b3d6bd911c3d5ec22e1d7105f594c
parent d8813b1698e34708f39da299ac907206467a543c
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Wed, 15 Nov 2017 15:04:38 +0100
Add release notes for Star Sampling 0.5
Diffstat:
| M | README.md | | | 53 | ++++++++++++++++++++++++++++++++++------------------- |
1 file changed, 34 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
@@ -1,36 +1,51 @@
# Star SamPling
The purpose of this library is to generate [pseudo] random numbers and random
-variates. While it is based on C++11 random generators, its API remains pure C.
+variates. While it is partly based on C++11 random generators, its API remains
+pure C.
## How to build
The Star-Sampling library relies on the [CMake](http://www.cmake.org) and the
-[RCMake](https://gitlab.com/vaplv/rcmake/) package to build. It also depends on
-the [RSys](https://gitlab.com/vaplv/rsys/) library and C++11 random number
-generators.
-
-First ensure that CMake and a C++11 compiler is installed on your system. Then
-install the RCMake package as well as the RSys library. Finally Generate the
-project from the `cmake/CMakeLists.txt` file by appending to the
-`CMAKE_PREFIX_PATH` variable the `<RCMAKE_INSTALL_DIR>` and
-`<RSYS_INSTALL_DIR>` directories, where `<RCMAKE_INSTALL_DIR>`, and
-`<RSYS_INSTALL_DIR>` are the install directories of the RCMake package and the
-RSys library, respectively.
+[RCMake](https://gitlab.com/vaplv/rcmake/) packages to build. It also depends
+on the [RSys](https://gitlab.com/vaplv/rsys/) library and on random number
+generators from C++11 and the
+[Random123](https://github.com/DEShawResearch/Random123-Boost/) library.
+
+First ensure that CMake and a C++11 compiler are installed on your system. Then
+install the RCMake package as well as the RSys and Random123 libraries. Finally
+generate the project from the `cmake/CMakeLists.txt` file by appending to the
+`CMAKE_PREFIX_PATH` variable the `<RCMAKE_INSTALL_DIR>`, `<RSYS_INSTALL_DIR>`
+and `<RANDOM123_INSTALL_DIR>` directories, where `<RCMAKE_INSTALL_DIR>`,
+`<RSYS_INSTALL_DIR>` and `<RANDOM123_INSTALL_DIR>` are the install directories
+of the RCMake package and the RSys and Random123 libraries, respectively.
### Microsoft Visual Studio
-When built with Visual Studio, the Star-Sampling library depends on the
-[Boost](http://www.boost.org) random library rather than the STL that is
-actually not fully compliant with the C++11 standard.
+When building Star-Sampling using Visual Studio, the Star-Sampling library
+also depends on the [Boost](http://www.boost.org) random library as a
+replacement for the STL libray that is not fully compliant with the C++11
+standard on current Microsoft compilers.
-For this platform, install the Boost random library. Then generate the CMake
-project as above with, in addition, the Boost install directory added to the
-`CMAKE_PREFIX_PATH` variable and the `BOOST_INCLUDEDIR` cmake variable set to
-the path that contains the Boost header directory.
+For this platform install the Boost random library. Then generate the CMake
+project as above, excepted that you need to add the Boost install directory to
+the `CMAKE_PREFIX_PATH` variable and to set the `BOOST_INCLUDEDIR` cmake
+variable to the directory that contains the `boost` include directory.
## Release notes
+### Version 0.5
+
+- Rename the ssp_ran_uniform_disk API call into ssp_ran_uniform_disk_local.
+- Add a more general version of the uniform disk random variate allowing
+ users to provide the disk's normal.
+- Add a float equivalent for all the already defined double random variates.
+- Add some missing pdf API calls.
+- Change the API of some random variates that returned the pdf as an additional
+ vector component along with the sampled vector (i.e. filling up a vector[4]
+ instead of a vector[3]). The pdf is now returned through an optional
+ dedicated argument.
+
### Version 0.4
- Update the API of the random variates to return double precision reals
