BitRegister.h

Go to the documentation of this file.

/* Copyright 2016 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef COM_DAFER45_TBTK_BIT_REGISTER
#define COM_DAFER45_TBTK_BIT_REGISTER

#include "TBTK/Streams.h"

#include <sstream>

namespace TBTK{

class BitRegister{
public:
    BitRegister(unsigned int numBits = 8*sizeof(unsigned int));

    BitRegister(const BitRegister &bitRegister);

    const BitRegister operator|(const BitRegister &rhs) const;

    const BitRegister operator&(const BitRegister &rhs) const;

    const BitRegister operator^(const BitRegister &rhs) const;

    const BitRegister operator+(const BitRegister &rhs) const;

    const BitRegister operator-(const BitRegister &rhs) const;

    bool operator<(const BitRegister &rhs) const;

    bool operator>(const BitRegister &rhs) const;

    bool operator==(const BitRegister &rhs) const;

    void operator+=(const BitRegister &rhs);

    void operator-=(const BitRegister &rhs);

    const BitRegister& operator++();

    const BitRegister operator++(int);

    const BitRegister& operator--();

    const BitRegister operator--(int);

    void operator=(const BitRegister &rhs);

    void operator=(unsigned int rhs);

    BitRegister operator<<(unsigned int rhs) const;

    BitRegister operator>>(unsigned int rhs) const;

    void setBit(unsigned int position, bool values);

    bool getBit(unsigned int position) const;

    void setValues(unsigned int values);

    unsigned int getValues() const;

    bool toBool() const;

    unsigned int toUnsignedInt() const;

    void clear();

    void print() const;

    unsigned int getNumBits() const;

    unsigned int getNumOneBits() const;

    bool getMostSignificantBit() const;

    void setMostSignificantBit();

    void clearMostSignificantBit();

    BitRegister cloneStructure() const;

    std::string toString() const;

    friend std::ostream& operator<<(
        std::ostream &stream,
        const BitRegister &bitRegister
    );

//  unsigned int getAsUnsignedInt() const;
private:
    unsigned int values;

    static constexpr unsigned int MOST_SIGNIFICANT_BIT_MASK
        = (unsigned int)0x1 << (8*sizeof(unsigned int)-1);
};

inline const BitRegister BitRegister::operator|(const BitRegister &rhs) const{
    BitRegister result;
    result.values = values | rhs.values;
    return result;
}

inline const BitRegister BitRegister::operator&(const BitRegister &rhs) const{
    BitRegister result;
    result.values = values & rhs.values;
    return result;
}

inline const BitRegister BitRegister::operator^(const BitRegister &rhs) const{
    BitRegister result;
    result.values = values^rhs.values;
    return result;
}

inline const BitRegister BitRegister::operator+(const BitRegister &rhs) const{
    BitRegister result;
    result.values = values + rhs.values;
    return result;
}

inline const BitRegister BitRegister::operator-(const BitRegister &rhs) const{
    BitRegister result;
    result.values = values - rhs.values;
    return result;
}

inline bool BitRegister::operator<(const BitRegister &rhs) const{
    return values < rhs.values;
}

inline bool BitRegister::operator>(const BitRegister &rhs) const{
    return values > rhs.values;
}

inline bool BitRegister::operator==(const BitRegister &rhs) const{
    return values == rhs.values;
}

inline void BitRegister::operator+=(const BitRegister &rhs){
    values += rhs.values;
}

inline void BitRegister::operator-=(const BitRegister &rhs){
    values -= rhs.values;
}

inline const BitRegister& BitRegister::operator++(){
    values++;
    return *this;
}

inline const BitRegister BitRegister::operator++(int){
    BitRegister returnValue;
    returnValue = *this;
    values++;
    return returnValue;
}

inline const BitRegister& BitRegister::operator--(){
    values--;
    return *this;
}

inline const BitRegister BitRegister::operator--(int){
    BitRegister returnValue;
    returnValue = *this;
    values--;
    return returnValue;
}

inline void BitRegister::operator=(const BitRegister &rhs){
    if(this != &rhs)
        values = rhs.values;
}

inline void BitRegister::operator=(unsigned int rhs){
    values = rhs;
}

inline BitRegister BitRegister::operator<<(unsigned int rhs) const{
    BitRegister result;
    result.values = values << rhs;
    return result;
}

inline BitRegister BitRegister::operator>>(unsigned int rhs) const{
    BitRegister result;
    result.values = values >> rhs;
    return result;
}

inline void BitRegister::print() const{
    for(int n = 8*sizeof(values)-1; n >= 0; n--)
        Streams::out << (0x1 & (values >> n));
    Streams::out << "\n";
}

inline void BitRegister::setBit(unsigned int position, bool value){
    values &= ~(1 << position);
    values ^= (value << position);
}

inline bool BitRegister::getBit(unsigned int position) const{
    return (0x1 & (values >> position));
}

inline void BitRegister::setValues(unsigned int values){
    this->values = values;
}

inline unsigned int BitRegister::getValues() const{
    return values;
}

inline bool BitRegister::toBool() const{
    return values;
}

inline unsigned int BitRegister::toUnsignedInt() const{
    return values;
}

inline void BitRegister::clear(){
    values = 0;
}

inline unsigned int BitRegister::getNumBits() const{
    return 8*sizeof(values);
}

inline unsigned int BitRegister::getNumOneBits() const{
    unsigned int x = values;
    x = x - ((x >> 1) & 0x55555555);
    x = (x & 0x33333333) + ((x >> 2) & 0x33333333);
    x = (x & 0x0F0F0F0F) + ((x >> 4) & 0x0F0F0F0F);
    x = x + (x >> 8);
    x = x + (x >> 16);
    return (x & 0x0000003F);
}

inline bool BitRegister::getMostSignificantBit() const{
    return values & MOST_SIGNIFICANT_BIT_MASK;
}

inline void BitRegister::setMostSignificantBit(){
    values |= MOST_SIGNIFICANT_BIT_MASK;
}

inline void BitRegister::clearMostSignificantBit(){
    values &= !MOST_SIGNIFICANT_BIT_MASK;
}

inline BitRegister BitRegister::cloneStructure() const{
    return BitRegister(8*sizeof(unsigned int));
}

inline std::string BitRegister::toString() const{
    std::stringstream stream;
    for(unsigned int n = getNumBits(); n > 0; n--)
        stream << getBit(n - 1);

    return stream.str();
}

inline std::ostream& operator<<(
    std::ostream &stream,
    const BitRegister &bitRegister
){
    stream << bitRegister.toString();

    return stream;
}

};  //End of namespace TBTK

#endif