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

C++ backend for Binary Indexed Trees #561

Merged
merged 4 commits into from
Jun 15, 2024
Merged
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
162 changes: 162 additions & 0 deletions pydatastructs/trees/_backend/cpp/BinaryIndexedTree.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
#ifndef TREES_BINARYINDEXEDTREE_HPP
#define TREES_BINARYINDEXEDTREE_HPP

#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <structmember.h>
#include <cstdlib>
#include "../../../utils/_backend/cpp/utils.hpp"
#include "../../../utils/_backend/cpp/TreeNode.hpp"
#include "../../../linear_data_structures/_backend/cpp/arrays/ArrayForTrees.hpp"
#include "../../../linear_data_structures/_backend/cpp/arrays/DynamicOneDimensionalArray.hpp"

// Copied binary trees and changed the name to BinaryIndexedTree
// Start from the struct

typedef struct {
PyObject_HEAD
OneDimensionalArray* array;
PyObject* tree;
PyObject* flag;
} BinaryIndexedTree;

static void BinaryIndexedTree_dealloc(BinaryIndexedTree *self) {
Py_TYPE(self)->tp_free(reinterpret_cast<PyObject*>(self));
}

static PyObject* BinaryIndexedTree_update(BinaryIndexedTree* self, PyObject *args) {
long index = PyLong_AsLong(PyObject_GetItem(args, PyZero));
long value = PyLong_AsLong(PyObject_GetItem(args, PyOne));
long _index = index;
long _value = value;
if (PyList_GetItem(self->flag, index) == PyZero) {
PyList_SetItem(self->flag, index, PyOne);
index += 1;
while (index < self->array->_size + 1) {
long curr = PyLong_AsLong(PyList_GetItem(self->tree, index));
PyList_SetItem(self->tree, index, PyLong_FromLong(curr + value));
index = index + (index & (-1*index));
}
}
else {
value = value - PyLong_AsLong(self->array->_data[index]);
index += 1;
while (index < self->array->_size + 1) {
long curr = PyLong_AsLong(PyList_GetItem(self->tree, index));
PyList_SetItem(self->tree, index, PyLong_FromLong(curr + value));
index = index + (index & (-1*index));
}
}
self->array->_data[_index] = PyLong_FromLong(_value);
Py_RETURN_NONE;
}

static PyObject* BinaryIndexedTree___new__(PyTypeObject* type, PyObject *args, PyObject *kwds) {
BinaryIndexedTree *self;
self = reinterpret_cast<BinaryIndexedTree*>(type->tp_alloc(type, 0));

// Python code is such that arguments are: type(array[0]) and array

if (PyType_Ready(&OneDimensionalArrayType) < 0) { // This has to be present to finalize a type object. This should be called on all type objects to finish their initialization.
return NULL;
}
PyObject* _one_dimensional_array = OneDimensionalArray___new__(&OneDimensionalArrayType, args, kwds);
if ( !_one_dimensional_array ) {
return NULL;
}
self->array = reinterpret_cast<OneDimensionalArray*>(_one_dimensional_array);
self->tree = PyList_New(self->array->_size+2);
for(int i=0;i<self->array->_size+2;i++){
PyList_SetItem(self->tree, i, PyZero);
}
self->flag = PyList_New(self->array->_size);
for(int i=0;i<self->array->_size;i++){
PyList_SetItem(self->flag, i, PyZero);
BinaryIndexedTree_update(self, Py_BuildValue("(OO)", PyLong_FromLong(i), self->array->_data[i]));
}

return reinterpret_cast<PyObject*>(self);
}

static PyObject* BinaryIndexedTree_get_prefix_sum(BinaryIndexedTree* self, PyObject *args) {
long index = PyLong_AsLong(PyObject_GetItem(args, PyZero));
index += 1;
long sum = 0;
while (index > 0) {
sum += PyLong_AsLong(PyList_GetItem(self->tree, index));
index = index - (index & (-1*index));
}

return PyLong_FromLong(sum);
}

static PyObject* BinaryIndexedTree_get_sum(BinaryIndexedTree* self, PyObject *args) {
long left_index = PyLong_AsLong(PyObject_GetItem(args, PyZero));
long right_index = PyLong_AsLong(PyObject_GetItem(args, PyOne));
if (left_index >= 1) {
long l1 = PyLong_AsLong(BinaryIndexedTree_get_prefix_sum(self, Py_BuildValue("(O)", PyLong_FromLong(right_index))));
long l2 = PyLong_AsLong(BinaryIndexedTree_get_prefix_sum(self, Py_BuildValue("(O)", PyLong_FromLong(left_index - 1))));
return PyLong_FromLong(l1 - l2);
}
else {
return BinaryIndexedTree_get_prefix_sum(self, Py_BuildValue("(O)", PyLong_FromLong(right_index)));
}
}


static struct PyMethodDef BinaryIndexedTree_PyMethodDef[] = {
{"update", (PyCFunction) BinaryIndexedTree_update, METH_VARARGS, NULL},
{"get_prefix_sum", (PyCFunction) BinaryIndexedTree_get_prefix_sum, METH_VARARGS, NULL},
{"get_sum", (PyCFunction) BinaryIndexedTree_get_sum, METH_VARARGS, NULL},
{NULL}
};

static PyMemberDef BinaryIndexedTree_PyMemberDef[] = {
{"array", T_OBJECT_EX, offsetof(BinaryIndexedTree, array), 0, "array"},
{"tree", T_OBJECT_EX, offsetof(BinaryIndexedTree, tree), 0, "tree"},
{"flag", T_OBJECT_EX, offsetof(BinaryIndexedTree, flag), 0, "flag"},
{NULL} /* Sentinel */
};


static PyTypeObject BinaryIndexedTreeType = {
/* tp_name */ PyVarObject_HEAD_INIT(NULL, 0) "BinaryIndexedTree",
/* tp_basicsize */ sizeof(BinaryIndexedTree),
/* tp_itemsize */ 0,
/* tp_dealloc */ (destructor) BinaryIndexedTree_dealloc,
/* tp_print */ 0,
/* tp_getattr */ 0,
/* tp_setattr */ 0,
/* tp_reserved */ 0,
/* tp_repr */ 0,
/* tp_as_number */ 0,
/* tp_as_sequence */ 0,
/* tp_as_mapping */ 0,
/* tp_hash */ 0,
/* tp_call */ 0,
/* tp_str */ 0,
/* tp_getattro */ 0,
/* tp_setattro */ 0,
/* tp_as_buffer */ 0,
/* tp_flags */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
/* tp_doc */ 0,
/* tp_traverse */ 0,
/* tp_clear */ 0,
/* tp_richcompare */ 0,
/* tp_weaklistoffset */ 0,
/* tp_iter */ 0,
/* tp_iternext */ 0,
/* tp_methods */ BinaryIndexedTree_PyMethodDef,
/* tp_members */ BinaryIndexedTree_PyMemberDef,
/* tp_getset */ 0,
/* tp_base */ &PyBaseObject_Type,
/* tp_dict */ 0,
/* tp_descr_get */ 0,
/* tp_descr_set */ 0,
/* tp_dictoffset */ 0,
/* tp_init */ 0,
/* tp_alloc */ 0,
/* tp_new */ BinaryIndexedTree___new__,
};

#endif
7 changes: 7 additions & 0 deletions pydatastructs/trees/_backend/cpp/trees.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#include "BinaryTreeTraversal.hpp"
#include "SelfBalancingBinaryTree.hpp"
#include "RedBlackTree.hpp"
#include "BinaryIndexedTree.hpp"

static struct PyModuleDef trees_struct = {
PyModuleDef_HEAD_INIT,
Expand Down Expand Up @@ -47,5 +48,11 @@ PyMODINIT_FUNC PyInit__trees(void) {
Py_INCREF(&RedBlackTreeType);
PyModule_AddObject(trees, "RedBlackTree", reinterpret_cast<PyObject*>(&RedBlackTreeType));

if (PyType_Ready(&BinaryIndexedTreeType) < 0) {
return NULL;
}
Py_INCREF(&BinaryIndexedTreeType);
PyModule_AddObject(trees, "BinaryIndexedTree", reinterpret_cast<PyObject*>(&BinaryIndexedTreeType));

return trees;
}
5 changes: 3 additions & 2 deletions pydatastructs/trees/binary_trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -1760,8 +1760,9 @@ class BinaryIndexedTree(object):
__slots__ = ['tree', 'array', 'flag']

def __new__(cls, array, **kwargs):
raise_if_backend_is_not_python(
cls, kwargs.get('backend', Backend.PYTHON))
backend = kwargs.get('backend', Backend.PYTHON)
if backend == Backend.CPP:
return _trees.BinaryIndexedTree(type(array[0]), array, **kwargs)
obj = object.__new__(cls)
obj.array = OneDimensionalArray(type(array[0]), array)
obj.tree = [0] * (obj.array._size + 2)
Expand Down
9 changes: 7 additions & 2 deletions pydatastructs/trees/tests/test_binary_trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -361,11 +361,11 @@ def test_select_rank(expected_output):
test_select_rank([])


def test_BinaryIndexedTree():
def _test_BinaryIndexedTree(backend):

FT = BinaryIndexedTree

t = FT([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
t = FT([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], backend=backend)

assert t.get_sum(0, 2) == 6
assert t.get_sum(0, 4) == 15
Expand All @@ -375,6 +375,11 @@ def test_BinaryIndexedTree():
assert t.get_sum(0, 4) == 114
assert t.get_sum(1, 9) == 54

def test_BinaryIndexedTree():
_test_BinaryIndexedTree(Backend.PYTHON)

def test_cpp_BinaryIndexedTree():
_test_BinaryIndexedTree(Backend.CPP)

def test_CartesianTree():
tree = CartesianTree()
Expand Down
Loading