sptree.h

/*
 *
 * Copyright (c) 2014, Laurens van der Maaten (Delft University of Technology)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    This product includes software developed by the Delft University of Technology.
 * 4. Neither the name of the Delft University of Technology nor the names of
 *    its contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY LAURENS VAN DER MAATEN ''AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL LAURENS VAN DER MAATEN BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
 * OF SUCH DAMAGE.
 *
 */


#ifndef SPTREE_H
#define SPTREE_H

using namespace std;


template<typename T, int dimension>
class Cell {

    T corner[dimension];
    T width[dimension];


public:
    Cell();
    Cell(T* inp_corner, T* inp_width);
    ~Cell();

    T getCorner(unsigned int d) const;
    T getWidth(unsigned int d) const;
    void setCorner(unsigned int d, T val);
    void setWidth(unsigned int d, T val);
    bool containsPoint(T point[]) const;
};

template<typename T, int dimension>
class SPTree
{

    // Fixed constants
    static const unsigned int QT_NODE_CAPACITY = 1;

    // Properties of this node in the tree
    SPTree<T, dimension>* parent;
    bool is_leaf;
    unsigned int size;
    unsigned int cum_size;

    // Axis-aligned bounding box stored as a center with half-dimensions to represent the boundaries of this quad tree
    Cell<T, dimension> boundary;

    // Indices in this space-partitioning tree node, corresponding center-of-mass, and list of all children
    T* data;
    T center_of_mass[dimension];
    unsigned int index[QT_NODE_CAPACITY];

    // Children
    SPTree<T, dimension>** children;
    unsigned int no_children;

public:
    SPTree(T* inp_data, unsigned int N);
    SPTree(T* inp_data, T* inp_corner, T* inp_width);
    SPTree(T* inp_data, unsigned int N, T* inp_corner, T* inp_width);
    SPTree(SPTree<T, dimension>* inp_parent, T* inp_data, unsigned int N, T* inp_corner, T* inp_width);
    SPTree(SPTree<T, dimension>* inp_parent, T* inp_data, T* inp_corner, T* inp_width);
    ~SPTree();
    void setData(T* inp_data);
    SPTree<T, dimension>* getParent();
    void construct(Cell<T, dimension> boundary);
    bool insert(unsigned int new_index);
    void subdivide();
    bool isCorrect();
    void rebuildTree();
    void getAllIndices(unsigned int* indices);
    unsigned int getDepth();
    T computeNonEdgeForces(unsigned int point_index, T theta, T neg_f[]) const;
    void computeEdgeForces(unsigned int* row_P, unsigned int* col_P, T* val_P, int N, T pos_f[]) const;
    void print();

private:
    void init(SPTree<T, dimension>* inp_parent, T* inp_data, T* inp_corner, T* inp_width);
    void fill(unsigned int N);
    unsigned int getAllIndices(unsigned int* indices, unsigned int loc);
    bool isChild(unsigned int test_index, unsigned int start, unsigned int end);
};

#endif