MathTools.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file MathTools.hh
 *
 * Mathematical tools.
 *
 * Declarations.
 *
 * @author Ari Metsähalme 2005 (ari.metsahalme-no.spam-tut.fi)
 *
 */
 
#ifndef TTA_MATH_TOOLS_HH
#define TTA_MATH_TOOLS_HH
 
#include <utility>
 
#include "BaseType.hh"
 
class MathTools {
public:
    static unsigned int bitLength(long unsigned int number);
    static bool bitFieldsEquals(
        unsigned enc1, unsigned pos1,
        unsigned enc2, unsigned pos2,
        unsigned width);
    static long unsigned int concatenateBits(
        long unsigned int msbBitField, unsigned msbWidth,
        long unsigned int lsbBitField, unsigned lsbWidth);
    static int ceil_log2(long unsigned int number);
    template<typename NumberType>
    static int ceil_div(NumberType dividee, NumberType diveder);
    static int requiredBits(unsigned long int number);
    static int requiredBits0Bit0(long unsigned int number);
    static int requiredBitsSigned(SLongWord number);
    static int requiredBitsSigned(int number);
    static int requiredBitsSigned(UInt32 number);
    static int requiredBitsSigned(ULongWord number);
    static SLongWord signExtendTo(SLongWord value, int width);
    static ULongWord zeroExtendTo(ULongWord value, int width);
    
    static SLongWord fastSignExtendTo(SLongWord value, int width);
    static ULongWord fastZeroExtendTo(ULongWord value, int width);
 
    template<class IntegerType>
    static void setBit(
        IntegerType& bits, unsigned int index, bool bitState = true);
    
    static int random(int, int);
    static unsigned int roundUpToPowerTwo(unsigned int number);
    static int roundUpToPowerTwo(int number);
    static SLongWord roundDownToPowerTwo(SLongWord number);
    static bool isInPowerOfTwo(unsigned int number);
    template<typename ResultNumberTypeS, typename ResultNumberTypeU=ResultNumberTypeS>
    static std::pair<ResultNumberTypeS, ResultNumberTypeU> bitsToIntegerRange(
        unsigned bitWidth, bool signExtending);
    static bool bit(ULongWord integer, unsigned int index);
    
    static ULongWord roundDownToPowerTwo(ULongWord number);
};
 
#include "MathTools.icc"
 
#endif