BitArray.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Niek Linnenbank
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __LIBSTD_BITARRAY_H
#define __LIBSTD_BITARRAY_H
 
#include "Macros.h"
#include "Assert.h"
#include "Types.h"
 
class BitArray
{
  public:
 
    enum Result
    {
        Success,
        InvalidArgument,
        OutOfMemory
    };
 
  public:
 
    BitArray(const Size bitCount, u8 *array = ZERO);
 
    virtual ~BitArray();
 
    Size size() const;
 
    Size count(const bool on) const;
 
    void set(const Size bit, const bool value = true);
 
    void setRange(const Size from, const Size to);
 
    Result setNext(Size *bit,
                   const Size count = 1,
                   const Size offset = 0,
                   const Size boundary = 1);
 
    void unset(const Size bit);
 
    void clear();
 
    bool isSet(const Size bit) const;
 
    u8 * array() const;
 
    void setArray(u8 *array, const Size bitCount = ZERO);
 
    bool operator[](const Size bit) const;
 
    bool operator[](const int bit) const;
 
  private:
 
    Size calculateBitmapSize(const Size bitCount) const;
 
  private:
 
    Size m_bitCount;
 
    Size m_set;
 
    u8 *m_array;
 
    bool m_allocated;
};
 
#endif /* __LIBSTD_BITARRAY_H */