2016-11-01 05:04:38 +00:00
|
|
|
# Versioning
|
|
|
|
|
|
2016-11-01 05:12:16 +00:00
|
|
|
Recommended commits are tagged "x.y.z".
|
2016-11-01 05:04:38 +00:00
|
|
|
|
|
|
|
|
* New z = Bugs fixed.
|
|
|
|
|
* New y = Features added.
|
|
|
|
|
* New x = Backward compatibility is not guaranteed.
|
|
|
|
|
|
2016-11-01 05:12:16 +00:00
|
|
|
Each tagged commit normally passes QA tests. Users are
|
|
|
|
|
encouraged to always test the latest version.
|
2016-11-01 05:04:38 +00:00
|
|
|
|
|
|
|
|
# Coding style
|
|
|
|
|
|
2016-09-02 21:43:09 +00:00
|
|
|
leansdr uses C++ for namespaces and type-safe polymorphism.
|
|
|
|
|
No attempt is made to follow popular object-oriented practices.
|
|
|
|
|
|
|
|
|
|
* Member variables are not prefixed with "m_".
|
|
|
|
|
|
|
|
|
|
* Destructors are not implemented and memory management is minimal.
|
|
|
|
|
In practice, after the signal processing flow graph is instantiated,
|
|
|
|
|
no allocation/deallocation is expected until exit.
|
|
|
|
|
|
|
|
|
|
* There are no unnecessary getter/setter methods.
|
|
|
|
|
|
|
|
|
|
* Dependencies are kept to a minimum (no STL, no iostream).
|
|
|
|
|
|
2016-11-01 05:04:38 +00:00
|
|
|
# Known limitations
|
2016-09-02 21:43:09 +00:00
|
|
|
|
2016-11-01 05:04:38 +00:00
|
|
|
* The code is not intended to be thread-safe.
|
2017-12-09 19:49:52 +00:00
|
|
|
|
|
|
|
|
* Ideally, signal processing software should always yield the same
|
|
|
|
|
output when presented with the same input.
|
|
|
|
|
leandvb should be deterministic on fast input streams (files).
|
|
|
|
|
However, on real-time streams, scheduling randomness can affect
|
|
|
|
|
internal feedback loops and cause small variations in the output.
|
