/shared/development/google_code/rssoft/libccsoft/lib/CC_ReliabilityMatrix.h

Go to the documentation of this file.

/*
 Copyright 2013 Edouard Griffiths <f4exb at free dot fr>

 This file is part of CCSoft. A Convolutional Codes Soft Decoding library

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

 This program 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
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Boston, MA  02110-1301  USA

 Reliability Matrix class. 
 Analog data is entered first then the normalization method is called to get the actual reliability data (probabilities).

 */

#ifndef __CC_RELIABILITY_MATRIX_H__
#define __CC_RELIABILITY_MATRIX_H__

#include <iostream>

namespace ccsoft
{

class CC_ReliabilityMatrix
{
public:
    CC_ReliabilityMatrix(unsigned int nb_symbols_log2, unsigned int message_length);
    
    CC_ReliabilityMatrix(const CC_ReliabilityMatrix& relmat);

    ~CC_ReliabilityMatrix();

    void enter_symbol_data(float *symbol_data);

    void enter_symbol_data(unsigned int message_symbol_index, float *symbol_data);
    
    void enter_erasure();

    void enter_erasure(unsigned int message_symbol_index);

    void normalize();

    void reset_message_symbol_count()
    {
        _message_symbol_count = 0;
    }

    unsigned int get_nb_symbols_log2() const
    {
        return _nb_symbols_log2;
    }

    unsigned int get_nb_symbols() const
    {
        return _nb_symbols;
    }

    unsigned int get_message_length() const
    {
        return _message_length;
    }

    float& operator()(unsigned int i_row, unsigned int i_col)
    {
        return _matrix[_nb_symbols*i_col + i_row];
    }
    
    const float& operator()(unsigned int i_row, unsigned int i_col) const
    {
        return _matrix[_nb_symbols*i_col + i_row];
    }
    
    const float *get_raw_matrix() const
    {
        return _matrix;
    }
    
    float *get_raw_matrix() 
    {
        return _matrix;
    }
    
    float find_max(unsigned int& i_row, unsigned int& i_col) const;

    float find_max_in_col(unsigned int& i_row, unsigned int i_col, float prev_max = 1.0) const;

    friend std::ostream& operator <<(std::ostream& os, const CC_ReliabilityMatrix& matrix);
    

protected:
    unsigned int _nb_symbols_log2;
    unsigned int _nb_symbols;
    unsigned int _message_length;
    unsigned int _message_symbol_count; 
    float *_matrix; 
};


}

#endif // __CC_RELIABILITY_MATRIX_H__