Changeset 5296

Show
Ignore:
Timestamp:
10/09/07 21:05:12 (6 years ago)
Author:
caguayog
Message:

Adding documentation

Location:
experimental/components/ReedSolomon/trunk/ReedSolomon
Files:
3 added
4 modified

Legend:

Unmodified
Added
Removed

  • experimental/components/ReedSolomon/trunk/ReedSolomon/Doxyfile

    r5295 r5296  
    1818# by quotes) that should identify the project. 
    1919 
    20 PROJECT_NAME           = "RS_Encoder_8" 
     20PROJECT_NAME           = "RS_Encoder_char" 
    2121 
    2222# The PROJECT_NUMBER tag can be used to enter a project or revision number.  
    … …  
    461461 
    462462INPUT                  = documentation.txt      \ 
    463                          RS_Encoder_8.cpp  \ 
    464                          RS_Encoder_8.h 
     463                         src/RS_Encoder_char.cpp    \ 
     464                         src/RS_Encoder_char.h      \ 
     465                         src/RS_Decoder_char.cpp    \ 
     466                         src/RS_Decoder_char.h 
    465467 
    466468# If the value of the INPUT tag contains directories, you can use the  

  • experimental/components/ReedSolomon/trunk/ReedSolomon/configure.ac

    r5295 r5296  
    1 AC_INIT(RS_Encoder_8, 0.6.0) 
     1AC_INIT(RS_Encoder_char, 0.6.0) 
    22AM_INIT_AUTOMAKE 
    33 

  • experimental/components/ReedSolomon/trunk/ReedSolomon/documentation.txt

    r5295 r5296  
    33Copyright 2007 Virginia Polytechnic Institute and State University 
    44 
    5 This file is part of the OSSIE RS_Encoder_8. 
     5This file is part of the OSSIE RS_Encoder_char. 
    66 
    7 OSSIE RS_Encoder_8 is free software; you can redistribute it and/or modify 
     7OSSIE RS_Encoder_char is free software; you can redistribute it and/or modify 
    88it under the terms of the GNU General Public License as published by 
    99the Free Software Foundation; either version 2 of the License, or 
    1010(at your option) any later version. 
    1111 
    12 OSSIE RS_Encoder_8 is distributed in the hope that it will be useful, 
     12OSSIE RS_Encoder_char is distributed in the hope that it will be useful, 
    1313but WITHOUT ANY WARRANTY; without even the implied warranty of 
    1414MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    … …  
    1616 
    1717You should have received a copy of the GNU General Public License 
    18 along with OSSIE RS_Encoder_8; if not, write to the Free Software 
     18along with OSSIE RS_Encoder_char; if not, write to the Free Software 
    1919Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
    2020 
    2121****************************************************************************/ 
    2222 
    23 /*! \mainpage RS_Encoder_8 
     23/*! \mainpage RS_Codec_char 
    2424 
    2525\section description Basic description 
    26 Include a basic description of the RS_Encoder_8 component here 
     26These functions implement Reed-Solomon error control encoding and decoding. 
     27 
     28The functions take unsigned char arrays and can handle codes with symbols 
     29of 8 bits or less (i.e., with codewords of 255 symbols or less). 
     30 
     31They are implemented using code from http://www.ka9q.net/code/fec/ 
    2732 
    2833\section properties Properties 
    2934This section details the properties 
    3035 
    31 \subsection prop_property_name Property Name (DCE:xxxx-xxx-xxx-xxx-xxxx) 
     36\subsection Symbol_Size SymSize (DCE:65f8707e-769f-11dc-9fa3-0015c55120b9) 
     37The symbol size in bits, up to 8. The resulting Reed-Solomon code word will 
     38have 2^SymSize - 1 symbols. The codeword may be shortened with the padding 
     39property described below. The default value is 8. 
     40 
     41\subsection Generator_polynomial GenPoly (DCE:341d1c94-769f-11dc-90a1-0015c55120b9) 
     42the extended Galois field generator polynomial coefficients with the 0th 
     43coefficient in the low order bit. The polynomial must be primitive. 
     44Default value is 0x187 (x^8 + x^7 + x^2 + x + 1) 
     45 
     46\subsection F_C_R FCR (DCE:046586a8-769f-11dc-8235-0015c55120b9) 
     47The first consecutive root of the Reed Solomon code generator polynomial. 
     48Default value is 112. 
     49 
     50\subsection primitive Primitive (DCE:e20771a2-769e-11dc-a9a6-0015c55120b9) 
     51The primitive element in the Galois field, in index form, used to generate the 
     52Reed Solomon code generator polynomial. Default value is 11. 
     53 
     54\subsection number_roots nRoots (DCE:c4ee9424-769e-11dc-8471-0015c55120b9) 
     55The number of roots in the Reed Solomon code 
     56generator polynomial. This equals the number of parity symbols 
     57per code block. Default value is 32. 
     58 
     59\subsection padding Padding (DCE:b14f7b72-769e-11dc-9508-0015c55120b9) 
     60Gives the number of leading symbols in the codeword 
     61that are implicitly padded to zero in a shortened code block. 
     62Default value is 0. 
     63 
     64The resulting Reed-Solomon code has parameters (N,K), where 
     65N = 2^\fBsymsize\fR - \fBpad\fR - 1 and K = N-\fBnroots\fR. 
     66 
    3267 
    3368\section interfaces Interfaces 
    … …  
    4580 
    4681\section references References 
    47  
     82http://www.ka9q.net/code/fec/ 
    4883*/ 

  • experimental/components/ReedSolomon/trunk/ReedSolomon/src/rs.h

    r5295 r5296  
    2424void free_rs_char(void *rs); 
    2525 
    26 /* CCSDS standard (255,223) RS codec with conventional (*not* dual-basis) 
    27  *  * symbol representation 
    28  *   */ 
    29 void encode_rs_8(unsigned char *data,unsigned char *parity,int pad); 
    30 int decode_rs_8(unsigned char *data,int *eras_pos,int no_eras,int pad); 
    3126 
    32