srsLDPCEncoderUnittest.m

%srsLDPCEncoderUnittest Unit tests for the LDPC encoder.
%   This class implements unit tests for the LDPC encoder using the matlab.unittest
%   framework. The simplest use consists in creating an object with
%       testCase = srsLDPCEncoderUnittest
%   and then running all the tests with
%       testResults = testCase.run
%
%   srsLDPCEncoderUnittest Properties (Constant):
%
%   srsBlock      - The tested block (i.e., 'ldpc_encoder').
%   srsBlockType  - The type of the tested block, including layer
%                   (i.e., '/phy/upper/channel_coding/ldpc').
%
%   srsLDPCEncoderUnittest Properties (ClassSetupParameter):
%
%   outputPath - Path to the folder where the test results are stored.
%
%   srsLDPCEncoderUnittest Properties (TestParameter):
%
%   baseGraph  - LDPC base graph.
%   liftSize   - Lifting size accepted by NR LDPC codes.
%
%   srsLDPCEncoderUnittest Methods (TestTags = {'testvector'}):
%
%   testvectorGenerationCases - Generates a test vector for the given base graph
%                               and lifting size.
%
%   srsLDPCEncoderUnittest Methods (Access = protected):
%
%   addTestIncludesToHeaderFile     - Adds include directives to the test header file.
%   addTestDefinitionToHeaderFile   - Adds details (e.g., type/variable declarations)
%                                     to the test header file.
%
%   See also matlab.unittest, nrLDPCEncode.

%   Copyright 2021-2024 Software Radio Systems Limited
%
%   This file is part of srsRAN-matlab.
%
%   srsRAN-matlab is free software: you can redistribute it and/or
%   modify it under the terms of the BSD 2-Clause License.
%
%   srsRAN-matlab is distributed in the hope that it will be useful,
%   but WITHOUT ANY WARRANTY; without even the implied warranty of
%   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
%   BSD 2-Clause License for more details.
%
%   A copy of the BSD 2-Clause License can be found in the LICENSE
%   file in the top-level directory of this distribution.

classdef srsLDPCEncoderUnittest < srsTest.srsBlockUnittest
    properties (Constant)
        %Name of the tested block.
        srsBlock = 'ldpc_encoder'

        %Type of the tested block, including layers.
        srsBlockType = 'phy/upper/channel_coding/ldpc'
    end

    properties (ClassSetupParameter)
        %Path to results folder (old 'ldpc_encoder' tests will be erased).
        outputPath = {['testLDPCencoder', char(datetime('now', 'Format', 'yyyyMMdd''T''HHmmss'))]}
    end

    properties (TestParameter)
        %LDPC base graph (1, 2).
        baseGraph = {1, 2}

        %Lifting size accepted by NR LDPC codes.
        liftSize = num2cell(srsLib.phy.upper.channel_coding.ldpc.srsLDPCLiftingSizes)
    end

    methods (Access = protected)
        function addTestIncludesToHeaderFile(~, fileID)
        %addTestIncludesToHeaderFile(OBJ, FILEID) adds include directives to
        %   the header file pointed by FILEID, which describes the test vectors.

            fprintf(fileID, '#include "srsran/support/file_vector.h"\n');
        end

        function addTestDefinitionToHeaderFile(~, fileID)
        %addTestDefinitionToHeaderFile(OBJ, FILEID) adds test details (e.g., type
        %   and variable declarations) to the header file pointed by FILEID, which
        %   describes the test vectors.

            fprintf(fileID, 'struct test_case_t {\n');
            fprintf(fileID, 'unsigned nof_messages            = 0;\n');
            fprintf(fileID, 'unsigned bg                      = 0;\n');
            fprintf(fileID, 'unsigned ls                      = 0;\n');
            fprintf(fileID, 'file_vector<uint8_t> messages;\n');
            fprintf(fileID, 'file_vector<uint8_t> codeblocks;\n');
            fprintf(fileID, '};\n');
        end
    end % of methods (Access = protected)

    methods (Test, TestTags = {'testvector'})
        function testvectorGenerationCases(obj, baseGraph, liftSize)
        %testvectorGenerationCases Generates a test vector for the given base graph
        %   and lifting size.

            import srsTest.helpers.writeUint8File

            % generate a unique test ID
            testID = obj.generateTestID;

            baseMsgLength = 22;
            if baseGraph == 2
                baseMsgLength = 10;
            end

            msgLength = baseMsgLength * liftSize;

            % fraction of filler bits
            fracFillers = 0.1;

            nFiller = ceil(msgLength * fracFillers);

            % random messages
            nMessages = 10;
            messages = [randi([0, 1], msgLength - nFiller, nMessages); ...
                -1 * ones(nFiller, nMessages)];

            % encode
            codeblocks = nrLDPCEncode(messages, baseGraph);

            % use SRS convention for filler bits
            messages(messages == -1) = 254;
            codeblocks(codeblocks == -1) = 254;

            % write messages
            obj.saveDataFile('_test_input', testID, @writeUint8File, messages(:));

            % write codeblocks
            obj.saveDataFile('_test_output', testID, @writeUint8File, codeblocks(:));

            % generate the test case entry
            testCaseString = obj.testCaseToString(testID, {nMessages, ...
                baseGraph, liftSize}, false, '_test_input', '_test_output');

            % add the test to the file header
            obj.addTestToHeaderFile(obj.headerFileID, testCaseString);

        end % of function addTestIncludesToHeaderFile
    end % of methods (Access = protected)

end % of classdef srsLDPCEncoderUnittest