Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Common template for inline vector implementation. #245

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 40 additions & 37 deletions src/bits.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,61 +27,64 @@
// 64 * 2^16. 2^17 values, each value can store 64 bits.
#define kMaxSizeBits 8388608

// A stack vector of length 5, having the functions of std::vector needed for Bits.
struct SmallVector {
typedef uint16_t size_type;
template <class item_type, class size_type_arg, unsigned capacity>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's my argument against making item_type a template parameter:

As it stands in your patch, it's not correct. The template parameter cannot be an arbitrary type, since they're all constructed up-front they must be default constructable. In order to make this more correct, you would need something like:

static_assert(std::is_integral_t<item_type>, "InlineVector inly supports integral types");

Which brings me to my next point. We don't currently need this additional generality/complexity. I don't think it makes sense to make things more general/complex just for the sake of it (in fact, I would argue that keeping everything as specific as possible makes for easier-to-read programs).

Now, you say you'll need this template parameter in your next PR. So, let's punt this change until that PR.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The template parameter cannot be an arbitrary type, since they're all constructed up-front they must be default constructable.

Yeah, I figured that out already in my next patch. Let's see if you like it ;)
Added static assert for now.

class InlineVector {
public:

SmallVector() noexcept { count_ = 0; }
static_assert(std::is_integral<item_type>::value, "InlineVector only supports integral types");

uint64_t& operator[](const uint16_t index) { return v_[index]; }
typedef size_type_arg size_type;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the way this spells nowadays is:

Suggested change
typedef size_type_arg size_type;
using size_type = size_type_arg;


uint64_t operator[](const uint16_t index) const { return v_[index]; }
item_type& operator[](const size_type index) {
assert(index < capacity);
return v_[index];
}

void push_back(uint64_t value) { v_[count_++] = value; }
item_type operator[](const size_type index) const {
assert(index < capacity);
return v_[index];
}

SmallVector& operator=(const SmallVector& other)
{
void push_back(item_type value) {
assert(count_ < capacity);
v_[count_++] = value;
}

InlineVector& operator=(const InlineVector& other) & {
count_ = other.count_;
for (size_type i = 0; i < other.count_; i++) v_[i] = other.v_[i];
return (*this);
}

size_type size() const noexcept { return count_; }

void resize(const size_type n) { count_ = n; }

private:
uint64_t v_[10];
size_type count_;
};

// A stack vector of length 1024, having the functions of std::vector needed for Bits.
// The max number of Bits that can be stored is 1024 * 64
struct ParkVector {
typedef uint32_t size_type;

ParkVector() noexcept { count_ = 0; }
InlineVector& operator=(const std::vector<item_type>& other) & {
assert(other.size() <= capacity);

uint64_t& operator[](const uint32_t index) { return v_[index]; }

uint64_t operator[](const uint32_t index) const { return v_[index]; }

void push_back(uint64_t value) { v_[count_++] = value; }

ParkVector& operator=(const ParkVector& other)
{
count_ = other.count_;
for (size_type i = 0; i < other.count_; i++) v_[i] = other.v_[i];
count_ = other.size();
for (size_type i = 0; i < static_cast<size_type>(other.size()); i++) v_[i] = other[i];
return (*this);
}

size_type size() const noexcept { return count_; }

private:
uint64_t v_[2048];
size_type count_;
void resize(const size_type n) {
assert(n <= capacity);
count_ = n;
}

size_type max_size() const { return capacity; }

private:
item_type v_[capacity];
size_type count_ = 0;
};

// A stack vector of length 10, having the functions of std::vector needed for Bits.
using SmallVector = InlineVector<uint64_t, uint8_t, 10>;

// A stack vector of length 2048, having the functions of std::vector needed for Bits.
// The max number of Bits that can be stored is 2048 * 64
using ParkVector = InlineVector<uint64_t, uint16_t, 2048>;

/*
* This class represents an array of bits. These are stored in an
* array of integers, allowing for efficient bit manipulations. The Bits class provides
Expand Down
32 changes: 32 additions & 0 deletions tests/test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,38 @@ TEST_CASE("Util")

TEST_CASE("Bits")
{
SECTION("Inline Vector")
{
const size_t test_size = 16384;
InlineVector<uint64_t, uint16_t, test_size> test_vector;
for(size_t i = 0; i < test_vector.max_size(); i++)
test_vector.push_back(i & (64 - 1));

REQUIRE(test_vector.size() == test_size);
for(size_t i = 0; i < test_vector.size(); i++)
REQUIRE(test_vector[static_cast<uint16_t>(i)] == (i & (64 - 1)));

std::vector<uint64_t> std_vector;
for(size_t i = 0; i < test_size / 2; i++)
std_vector.push_back(test_size - i);

test_vector = std_vector;
REQUIRE(test_vector.size() == std_vector.size());

for(size_t i = 0; i < test_vector.size(); i++)
REQUIRE(test_vector[static_cast<uint16_t>(i)] == (test_size - i));

InlineVector<uint64_t, uint16_t, test_size> other_vector;
for(size_t i = 0; i < test_size / 2 + 256; i++)
other_vector.push_back(test_size + i);

test_vector = other_vector;
REQUIRE(test_vector.size() == other_vector.size());

for(size_t i = 0; i < test_vector.size(); i++)
REQUIRE(test_vector[static_cast<uint16_t>(i)] == (test_size + i));
}

SECTION("Slicing and manipulating")
{
Bits g = Bits(13271, 15);
Expand Down