tprtree/Node.h

Go to the documentation of this file.

/******************************************************************************
 * Project:  libspatialindex - A C++ library for spatial indexing
 * Author:   Marios Hadjieleftheriou, mhadji@gmail.com
 ******************************************************************************
 * Copyright (c) 2002, Marios Hadjieleftheriou
 *
 * All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
******************************************************************************/

#pragma once
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wcast-qual"

namespace SpatialIndex
{
    namespace TPRTree
    {
        class TPRTree;
        class Leaf;
        class Index;
        class Node;

        typedef Tools::PoolPointer<Node> NodePtr;

        class Node : public SpatialIndex::INode
        {
        public:
            ~Node() override;

            //
            // Tools::IObject interface
            //
            Tools::IObject* clone() override;

            //
            // Tools::ISerializable interface
            //
            uint32_t getByteArraySize() override;
            void loadFromByteArray(const uint8_t* data) override;
            void storeToByteArray(uint8_t** data, uint32_t& len) override;

            //
            // SpatialIndex::IEntry interface
            //
            id_type getIdentifier() const override;
            void getShape(IShape** out) const override;

            //
            // SpatialIndex::INode interface
            //
            uint32_t getChildrenCount() const override;
            id_type getChildIdentifier(uint32_t index)  const override;
            void getChildShape(uint32_t index, IShape** out)  const override;
            void getChildData(uint32_t index, uint32_t& length, uint8_t** data) const override;
            uint32_t getLevel() const override;
            bool isIndex() const override;
            bool isLeaf() const override;

        private:
            Node();
            Node(TPRTree* pTree, id_type id, uint32_t level, uint32_t capacity);

            virtual Node& operator=(const Node&);

            virtual bool insertEntry(uint32_t dataLength, uint8_t* pData, MovingRegion& mbr, id_type id);
            virtual void deleteEntry(uint32_t index);

            virtual bool insertData(uint32_t dataLength, uint8_t* pData, MovingRegion& mbr, id_type id, std::stack<id_type>& pathBuffer, uint8_t* overflowTable);
            virtual void reinsertData(uint32_t dataLength, uint8_t* pData, MovingRegion& mbr, id_type id, std::vector<uint32_t>& reinsert, std::vector<uint32_t>& keep);

            virtual void rstarSplit(uint32_t dataLength, uint8_t* pData, MovingRegion& mbr, id_type id, std::vector<uint32_t>& group1, std::vector<uint32_t>& group2);

            virtual void condenseTree(std::stack<NodePtr>& toReinsert, std::stack<id_type>& pathBuffer, NodePtr& ptrThis);

            virtual NodePtr chooseSubtree(const MovingRegion& mbr, uint32_t level, std::stack<id_type>& pathBuffer) = 0;
            virtual NodePtr findLeaf(const MovingRegion& mbr, id_type id, std::stack<id_type>& pathBuffer) = 0;

            virtual void split(uint32_t dataLength, uint8_t* pData, MovingRegion& mbr, id_type id, NodePtr& left, NodePtr& right) = 0;

            TPRTree* m_pTree{nullptr};
                // Parent of all nodes.

            uint32_t m_level{0};
                // The level of the node in the tree.
                // Leaves are always at level 0.

            id_type m_identifier{-1};
                // The unique ID of this node.

            uint32_t m_children{0};
                // The number of children pointed by this node.

            uint32_t m_capacity{0};
                // Specifies the node capacity.

            MovingRegion m_nodeMBR;
                // The minimum bounding region enclosing all data contained in the node.

            uint8_t** m_pData{nullptr};
                // The data stored in the node.

            MovingRegionPtr* m_ptrMBR{nullptr};
                // The corresponding data MBRs.

            id_type* m_pIdentifier{nullptr};
                // The corresponding data identifiers.

            uint32_t* m_pDataLength{nullptr};

            uint32_t m_totalDataLength{0};

            class RstarSplitEntry
            {
            public:
                MovingRegion* m_pRegion;
                uint32_t m_index;
                uint32_t m_sortDim;

                RstarSplitEntry(MovingRegion* pr, uint32_t index, uint32_t dimension)
                    : m_pRegion(pr), m_index(index), m_sortDim(dimension) {}

                static int compareLow(const void* pv1, const void* pv2)
                {
                    RstarSplitEntry* pe1 = * (RstarSplitEntry**) pv1;
                    RstarSplitEntry* pe2 = * (RstarSplitEntry**) pv2;

                    if (pe1->m_pRegion->m_pLow[pe1->m_sortDim] < pe2->m_pRegion->m_pLow[pe1->m_sortDim]) return -1;
                    if (pe1->m_pRegion->m_pLow[pe1->m_sortDim] > pe2->m_pRegion->m_pLow[pe1->m_sortDim]) return 1;
                    return 0;
                }

                static int compareHigh(const void* pv1, const void* pv2)
                {
                    RstarSplitEntry* pe1 = * (RstarSplitEntry**) pv1;
                    RstarSplitEntry* pe2 = * (RstarSplitEntry**) pv2;

                    if (pe1->m_pRegion->m_pHigh[pe1->m_sortDim] < pe2->m_pRegion->m_pHigh[pe1->m_sortDim]) return -1;
                    if (pe1->m_pRegion->m_pHigh[pe1->m_sortDim] > pe2->m_pRegion->m_pHigh[pe1->m_sortDim]) return 1;
                    return 0;
                }

                static int compareVLow(const void* pv1, const void* pv2)
                {
                    RstarSplitEntry* pe1 = * (RstarSplitEntry**) pv1;
                    RstarSplitEntry* pe2 = * (RstarSplitEntry**) pv2;

                    if (pe1->m_pRegion->m_pVLow[pe1->m_sortDim] < pe2->m_pRegion->m_pVLow[pe1->m_sortDim]) return -1;
                    if (pe1->m_pRegion->m_pVLow[pe1->m_sortDim] > pe2->m_pRegion->m_pVLow[pe1->m_sortDim]) return 1;
                    return 0;
                }

                static int compareVHigh(const void* pv1, const void* pv2)
                {
                    RstarSplitEntry* pe1 = * (RstarSplitEntry**) pv1;
                    RstarSplitEntry* pe2 = * (RstarSplitEntry**) pv2;

                    if (pe1->m_pRegion->m_pVHigh[pe1->m_sortDim] < pe2->m_pRegion->m_pVHigh[pe1->m_sortDim]) return -1;
                    if (pe1->m_pRegion->m_pVHigh[pe1->m_sortDim] > pe2->m_pRegion->m_pVHigh[pe1->m_sortDim]) return 1;
                    return 0;
                }
            }; // RstarSplitEntry

            class ReinsertEntry
            {
            public:
                uint32_t m_index;
                double m_dist;

                ReinsertEntry(uint32_t index, double dist) : m_index(index), m_dist(dist) {}

                static int compareReinsertEntry(const void* pv1, const void* pv2)
                {
                    ReinsertEntry* pe1 = * (ReinsertEntry**) pv1;
                    ReinsertEntry* pe2 = * (ReinsertEntry**) pv2;

                    if (pe1->m_dist < pe2->m_dist) return -1;
                    if (pe1->m_dist > pe2->m_dist) return 1;
                    return 0;
                }
            }; // ReinsertEntry

            // Needed to access protected members without having to cast from Node.
            // It is more efficient than using member functions to access protected members.
            friend class TPRTree;
            friend class Leaf;
            friend class Index;
            friend class Tools::PointerPool<Node>;
        }; // Node
    }
}
#pragma GCC diagnostic pop