Changeset 1950 for trunk


Ignore:
Timestamp:
Feb 29, 2012, 10:01:25 PM (7 years ago)
Author:
ksherdy
Message:

Updated comments format.

Location:
trunk/lib
Files:
13 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/bitblock.hpp

    r1934 r1950  
    1 /*
     1#ifndef BITBLOCK_HPP
     2#define BITBLOCK_HPP
     3
     4/*=============================================================================
    25    IDISA Library Import - Generic
    36    Copyright (C) 2011, Robert D. Cameron, Kenneth S. Herdy
     
    58    Licensed to International Characters Inc.
    69       under the Academic Free License version 3.0.
    7 */
    8 #ifndef BITBLOCK_HPP
    9 #define BITBLOCK_HPP
     10=============================================================================*/
    1011
    11 //#define NDEBUG //if NDEBUG then disable assertions
     12#define NDEBUG //if NDEBUG then disable assertions
    1213
    1314#define __STDC_LIMIT_MACROS
     
    103104}
    104105
    105 #endif /* BITBLOCK_HPP */
     106#endif // BITBLOCK_HPP
    106107
    107108
  • trunk/lib/bitblock128.hpp

    r1890 r1950  
    1 /*
     1#ifndef BITBLOCK128_HPP_
     2#define BITBLOCK128_HPP_
     3/*=============================================================================
    24    bitblock128 - Specific 128 bit IDISA implementations.
    35
     
    810       under the Academic Free License version 3.0.
    911
    10 */
    11 #ifndef BITBLOCK128_HPP_
    12 #define BITBLOCK128_HPP_
     12=============================================================================*/
    1313
    1414#include "idisa128.hpp"
     
    7979}
    8080
    81 
    82 
    83 #endif /* BITBLOCK128_HPP_ */
     81#endif // BITBLOCK128_HPP_
  • trunk/lib/bitblock256.hpp

    r1815 r1950  
    1 /*
     1#ifndef BITBLOCK256_HPP_
     2#define BITBLOCK256_HPP_
     3
     4/*=============================================================================
    25    bitblock256 - Specific 256 bit IDISA implementations.
    36
     
    811       under the Academic Free License version 3.0.
    912
    10 */
    11 
    12 #ifndef BITBLOCK256_HPP_
    13 #define BITBLOCK256_HPP_
     13=============================================================================*/
    1414
    1515#include "idisa128.hpp"
     
    2626};
    2727
    28 #endif /* BITBLOCK256_HPP_ */
     28#endif // BITBLOCK256_HPP_
  • trunk/lib/bitblock_align.hpp

    r1918 r1950  
    11#ifndef BITBLOCK_ALIGN_HPP
    22#define BITBLOCK_ALIGN_HPP
     3
     4/*=============================================================================
     5  bitblock_align.hpp - Alignment assertion.
     6  Created on:
     7  Author: Ken Herdy
     8=============================================================================*/
    39
    410#include "bitblock.hpp"
  • trunk/lib/bitblock_iterator.hpp

    r1932 r1950  
    1 /*
    2  * bitblock_iterator.hpp
    3  */
    4 
    51#ifndef BITBLOCK_ITERATOR_H_
    62#define BITBLOCK_ITERATOR_H_
     3
     4/*=============================================================================
     5  bitblock_iterator.hpp
     6  Created on:
     7  Author: Ken Herdy
     8=============================================================================*/
    79
    810#include <iterator>
     
    133135
    134136
    135 #endif /* BITBLOCK_ITERATOR_H_ */
     137#endif // BITBLOCK_ITERATOR_H_
    136138
  • trunk/lib/bitblock_scan.hpp

    r1932 r1950  
    1 /*
    2  * bitblock_scan.hpp
    3  */
    4 
    51#ifndef BITBLOCK_SCAN_H_
    62#define BITBLOCK_SCAN_H_
     3
     4/*=============================================================================
     5  bitblock_scan.hpp
     6  Created on:
     7  Author: Ken Herdy
     8=============================================================================*/
    79
    810#include <iterator>
     
    112114
    113115
    114 #endif /* BITBLOCK_SCAN_H_ */
     116#endif // BITBLOCK_SCAN_H_
    115117
  • trunk/lib/bitstream_iterator.hpp

    r1932 r1950  
    1 /*
    2  * bit_stream_iterator.hpp
    3  */
    4 
    51#ifndef BIT_STREAM_ITERATOR_H_
    62#define BIT_STREAM_ITERATOR_H_
     3
     4/*=============================================================================
     5  bit_stream_iterator.hpp
     6  Created on:
     7  Author: Ken Herdy
     8=============================================================================*/
    79
    810#include <iterator>
  • trunk/lib/builtins.hpp

    r1906 r1950  
    1 /*
     1#ifndef BUILTINS_HPP_
     2#define BUILTINS_HPP_
     3
     4/*=============================================================================
    25    builtin - Compiler dependent builtin function wrappers.
    36
     
    710    Licensed to International Characters Inc.
    811       under the Academic Free License version 3.0.
    9  */
    10 
    11 #ifndef BUILTINS_HPP_
    12 #define BUILTINS_HPP_
     12=============================================================================*/
    1313
    1414#include "config.hpp"
     
    9696#endif
    9797
    98 #endif /* BUILTINS_HPP */
     98#endif // BUILTINS_HPP
  • trunk/lib/byte_compare.hpp

    r1852 r1950  
    1 /*
     1#ifndef BYTE_COMPARE_HPP
     2#define BYTE_COMPARE_HPP
     3
     4/*=============================================================================
    25    byte_compare - Byte comparison methods.
    36
     
    69    Licensed to the public under the Open Software License 3.0.
    710    Licensed to International Characters Inc.
    8        under the Academic Free License version 3.0.
     11    under the Academic Free License version 3.0.
     12=============================================================================*/
    913
    10 
    11    WARNING:
    12        
    13    for L is 1, choose T = uint8_t
    14    for L in [2,3], choose T = uint16_t
    15    for L in [4,7], choose T = uint32_t
    16    for L in [8,15], choose = uint64_t
    17    for L in [16,00), T = BitBlock
    18 
    19    Otherwise results are not valid due to pointer casts.
    20 
    21    TODO - STATIC ASSERT - sizeof(T) <= L
    22 
    23 */
    24 
    25 #ifndef BYTE_COMPARE_HPP
    26 #define BYTE_COMPARE_HPP
     14///////////////////////////////////////////////////////////////////////////////
     15//
     16//   WARNING: L (Length)
     17//
     18//   for L is 1, choose T = uint8_t
     19//   for L in [2,3], choose T = uint16_t
     20//   for L in [4,7], choose T = uint32_t
     21//   for L in [8,15], choose = uint64_t
     22//   for L in [16,00), T = BitBlock
     23//   Otherwise results are not valid due to pointer casts.
     24//
     25//   TODO - STATIC ASSERT - sizeof(T) <= L
     26//
     27///////////////////////////////////////////////////////////////////////////////
    2728
    2829#include "bitblock.hpp"
  • trunk/lib/byte_pool.hpp

    r1832 r1950  
    1 /*
    2  * Created on: 18-December-2011
    3  * Author: Ken Herdy
    4  *
    5  * Byte pool. Templated on our custom allocator, see allocator.hpp.
    6  *
    7  */
    81#ifndef BYTE_POOL_HPP
    92#define BYTE_POOL_HPP
     3
     4/*=============================================================================
     5  byte_pool.hpp - Byte pool. Templated on our custom allocator, see allocator.hpp.
     6  Created on: 18-December-2011
     7  Author: Ken Herdy
     8=============================================================================*/
    109
    1110#include "allocator.hpp"
  • trunk/lib/carryQ.hpp

    r1933 r1950  
    1 /*
    2  * carryQ.hpp
    3  */
    4 
    51#ifndef CARRYQ_HPP_
    62#define CARRYQ_HPP_
     3
     4/*=============================================================================
     5  carryQ.hpp - Byte pool. Templated on our custom allocator, see allocator.hpp.
     6  Created on: 18-December-2011
     7  Author: Ken Herdy
     8=============================================================================*/
    79
    810#include <stdint.h>
     
    1315#include "stdio.h"
    1416
    15 /*
    16  * Carry method variants.
    17  *
    18  * BitBlock_op_ci_co()  - standard block non while loop statement and in final block if ignore the carry out
    19  * BitBlock_op_co()     - standard block while loop and in final block while loop if ignore carry out
    20  * BitBlock_op_ci()             - final block non while loop statement
    21  * BitBlock_op()                - final while loop statement
    22  *
    23  * BitBlock_op_ci(), BitBlock_op() methods not implemented to reduce the total number of
    24  * methods and Pablo compiler complexity.
    25  *
    26  */
     17///////////////////////////////////////////////////////////////////////////////
     18//
     19// Carry method variants.
     20//
     21// BitBlock_op_ci_co()  - standard block non while loop statement and in final block if ignore the carry out
     22// BitBlock_op_co()     - standard block while loop and in final block while loop if ignore carry out
     23// BitBlock_op_ci()             - final block non while loop statement
     24// BitBlock_op()                - final while loop statement
     25//
     26// BitBlock_op_ci(), BitBlock_op() methods not implemented to reduce the total number of
     27// methods and Pablo compiler complexity.
     28//
     29///////////////////////////////////////////////////////////////////////////////
    2730
    2831#define interpose32(x,y,pos) interpose32_<pos>(x,y)     
     
    238241};
    239242
    240 #endif /* CARRYQ_HPP_ */
     243#endif // CARRYQ_HPP_
  • trunk/lib/config.hpp

    r1873 r1950  
    1 /*
    2     config - Compiler dependent configuration.
     1#ifndef CONFIG_HPP_
     2#define CONFIG_HPP_
     3
     4/*=============================================================================
     5    config.hpp - Compiler dependent configuration.
    36
    47    Copyright (C) 2011, Robert D. Cameron, Kenneth S. Herdy, Hua Huang and Nigel Medforth.
     
    69    Licensed to International Characters Inc.
    710       under the Academic Free License version 3.0.
    8  */
    9 
    10 #ifndef CONFIG_HPP_
    11 #define CONFIG_HPP_
     11=============================================================================*/
    1212
    1313#if !(defined (_MSC_VER) || (defined __GNUC__))
     
    6363#endif
    6464
    65 #endif /* CONFIG_HPP_ */
     65#endif // CONFIG_HPP_
  • trunk/lib/debug.hpp

    r1749 r1950  
    1 /*
    2  * debug.hpp - DEBUG macros.
    3  */
    4 
    51#ifndef DEBUG_HPP_
    62#define DEBUG_HPP_
     3
     4/*=============================================================================
     5  debug.hpp - Debug macros.
     6  Created on:
     7  Author: Ken Herdy
     8=============================================================================*/
    79
    810#include <iostream>
     
    1719#endif
    1820
    19 #endif /* DEBUG_HPP_ */
     21#endif // DEBUG_HPP_
Note: See TracChangeset for help on using the changeset viewer.