Skip to content
Test vector RaptorQ
C C++ Python CMake Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
algebra
api
in
rfc6330_alg
samples_tests
tools
tvrq
.gitignore
CMakeLists.txt
LICENSE
NOTICE
README.txt

README.txt

TvRQ:  Test vector RaptorQ
==========================

This is the RaptorQ version that's based on simple Gaussian Elimination;
used to generate test data. TvRQ is a test vector implementation of RaptorQ 
that is meant to test for compliance (correct encoding and decoding) and is 
not implemented to be fast, and in fact it is a quite slow implementation 
of RaptorQ. 

For a compliant and faster implementation please refer to CodornicesRq 
available here: https://www.codornices.info/

Configuration & Building
------------------------

TvRQ uses the "cmake" build system generator; so apart from the usual
suspects needed to build, such as a C compiler, make (on UNIX), etc.,
you need cmake.  If the python module _tvrq is to be built, a python
installation including the development libraries as well as the cffi
module is required.

The code might use some C99 features, so I'm not sure it will compile
out of the box with Visual C.

To prepare building in a build/ subdirectory, do the following from
within the TvRQ root:

	$ mkdir build
	$ cd build
	$ cmake ..

This verifies the system configuration and then populates the build/
subfolder with necessary build files, such as a Makefile, etc.  Building
can then be done by issuing:

	$ cmake --build .

To install the TvRQ libraries to be discovered easily by other software, do:

	$ sudo cmake --build . --target install

If all works out smoothly, this builds the tvrq dynamic library
(libtvrq.so on Linux), as well as a number of test tools called test_*
or testi_*

Optional Components
-------------------

On Linux, the _tvrq Python module is available, it's a simple CFFI-based
module that provides access to the TvRQ functionality from Python.  For
it to be built, the BUILD_PYTHON_MODULE option must be enabled, and the
necessary python development libraries, as well as the Python cffi
module must be installed.  The option is enabled by adding -D
BUILD_PYTHON_MODULE=ON to the cmake configuration command line, or by
editing build/CMakeCache.txt accordingly.

Running the testing tools
-------------------------

There are two kinds of testing tools, the test_* and the testi_* kind.
the "i" in testi_ stands for "interactive".  The interactive tools print
out some output (e.g. a matrix) on screen in response to command line
arguments.  The user can thus check if the output is as expected.  They
do not however have a way to sanity-check that output themselves.  The
test_* tools on the other hand perform some self-consistency checks, and
return a nonzero exit status in the case of failures.  Short description
of the tools:

	test_gf256	- sanity checks the GF(256) finite field operations
	test_m256v	- sanity checks matrix operations
	test_rq_api	- sanity check the RQ code via the API (help: -h)

	testi_lt	- display lt rows. Args: <K> <ISI0> <ISI1> ...
	testi_ldpc	- display ldpc rows. Args: <K>
	testi_hdpc	- display hdpc rows. Args: <K> <fast-flag>
	testi_parameters - display parameter computation. Args: <K>
	testi_rq_matrix	- display the entire RQ matrix. Args <K> <ISI0> ...

Running the test suite
----------------------

The testsuite is based on ctest.  From the build directory, run

	$ ctest

Takes slightly more than a minute to complete.  Currently, only the
test_* are added to the test suite.  In the future, might add testi_*
tools and compare the output with expected values.
You can’t perform that action at this time.