Skip to content

(t, m, s)-nets generator v.2.0.0
Compare
Choose a tag to compare
@jointpoints jointpoints released this 26 Sep 16:45
· 85 commits to master since this release
2.0.0
c788504
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

DISCLAIMER

The interface of the generator and its implementation have drastically changed in this version making it incompatible with the previous one. Hereafter, the tips of the following form:

<correct pattern for the previous version> -> <correct pattern for the new version>

have been written to simplify users' transition and resolution of likely compatibility issues.

CHANGELOG

Overall changes

  • The irrpoly library providing the interface for irreducible polynomials over finite fields has been updated to the latest version.
  • Names and documentation have been changed to follow the notation from the the new theoretical materials that have been added to the "knowledge" branch.
  • Experimental features have been added that can be toggled by defining TMS_EXPERIMENTAL macro.
  • TsTests and automatic tester have been updated.

Changes in the project structure

  • New structure of the include folder has been introduced:

    • The main include file niederreiter2.hpp has been relocated into include/tms-nets;
    • The new folder include/tms-nets/details has been created to store the first-party utility files;
    • The new folder include/tms-nets/thirdparty has been created to store the third-party utility files;
      To avoid compatibility issues related to the changes in the project structure one needs to consider the new path of the main include file:
      include/niederreiter2.hpp -> include/tms-nets/niederreiter2.hpp

  • A first-party gf2poly.hpp include file with the functions handling the generation of irreducible polynomials over F₂ has been added into include/tms-nets/details folder. Previously, these functions had been defined right inside the niederreiter2.hpp file;

  • A third-party irrpoly library has been placed into include/tms-nets/thirdparty folder;

  • A draft of the documentation main page has been added into tools folder.

Changes in the user interface

  • A library's namespace name has been changed to tms;
    sequences -> tms
  • First-party utility functions handling the generation of irreducible polynomials over F₂ have been placed inside tms::gf2poly namespace;
    sequences:: -> tms::gf2poly::
  • To provide compatibility with the new version of irrpoly a new utility function make_gf2poly has been added with the help of which a polynomial can be created by the vector of its coefficients. This function is advised to be used instead of the irrpoly native interface for creation of known polynomials;
  • A new public template tms::Matrix<T> has been added which is equivalent to std::vector< std::vector<T> >;
  • The tms::Niederreiter template class of a net generator has been redesigned to only depend on a single template parameter, namely the unsigned integral type needed to store the values of intermediate calculations. Digit capacity, at the same time, is now needs to be specified as the first argument of constructors;
    sequences::Niederreiter<U, N>(...) -> tms::Niederreiter<U>(N, ...)
  • Manual setting of a generator is now easier due to new constructors that accept initialiser lists;
  • A user has been enabled to specify the initialising values of all recurring sequences that are used in the process of generation with the help of additional arguments of constructors;
  • The getter for nbits has been renamed into get_m;
    get_nbits -> get_m
  • store_point_real and get_next_point_int methods have been removed;
  • The _real suffix in the names of methods has been removed, the get_ prefix in the names of methods has been replaced with generate_;
    get_point_int -> generate_point_int
    get_point_real -> generate_point
    for_each_point_real -> for_each_point
  • The role of getters is now played by generate_point and generate_point_int methods for a single point, and by for_each_point* methods for a range of points;
  • store* methods and cast_point_int_to_real method have been removed from the public access.

Changes in the implementation

  • initialize_c and calculate_v methods have been reorganised into initialize_direction_numbers and fill_container_recursively;
  • New checks have been added in the process of generation, e.g. is_matrix_of_initial_values_valid method.

Changes in the tests

  • TsTests' infrastructure has been updated to fix the bug with incorrect handling of NULL argument;
  • Optimisations of TsTests for digital (t, m, s)-nets have been improved (follow new instructions in the TsTests Usage and Development Guide);
  • Three different sets of test cases have been added into the automatic tester: critical, regular and exhaustive;
  • Logging of the automatic tester has been improved.
Assets 2
Loading