Node.h

Go to the documentation of this file.

/******************************************************************************
 * Project:  libspatialindex - A C++ library for spatial indexing
 * Author:   Marios Hadjieleftheriou, [email protected]
 ******************************************************************************
 * 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
 
namespace SpatialIndex
{
        namespace RTree
        {
                class RTree;
                class Leaf;
                class Index;
                class Node;
 
                typedef Tools::PoolPointer<Node> NodePtr;
 
                class Node : public SpatialIndex::INode
                {
                public:
                        virtual ~Node();
 
                        //
                        // Tools::IObject interface
                        //
                        virtual Tools::IObject* clone();
 
                        //
                        // Tools::ISerializable interface
                        //
                        virtual uint32_t getByteArraySize();
                        virtual void loadFromByteArray(const byte* data);
                        virtual void storeToByteArray(byte** data, uint32_t& len);
 
                        //
                        // SpatialIndex::IEntry interface
                        //
                        virtual id_type getIdentifier() const;
                        virtual void getShape(IShape** out) const;
 
                        //
                        // SpatialIndex::INode interface
                        //
                        virtual uint32_t getChildrenCount() const;
                        virtual id_type getChildIdentifier(uint32_t index)  const;
                        virtual void getChildShape(uint32_t index, IShape** out)  const;
                        virtual void getChildData(uint32_t index, uint32_t& length, byte** data) const;
                        virtual uint32_t getLevel() const;
                        virtual bool isIndex() const;
                        virtual bool isLeaf() const;
 
                private:
                        Node();
                        Node(RTree* pTree, id_type id, uint32_t level, uint32_t capacity);
 
                        virtual Node& operator=(const Node&);
 
                        virtual void insertEntry(uint32_t dataLength, byte* pData, Region& mbr, id_type id);
                        virtual void deleteEntry(uint32_t index);
 
                        virtual bool insertData(uint32_t dataLength, byte* pData, Region& mbr, id_type id, std::stack<id_type>& pathBuffer, byte* overflowTable);
                        virtual void reinsertData(uint32_t dataLength, byte* pData, Region& mbr, id_type id, std::vector<uint32_t>& reinsert, std::vector<uint32_t>& keep);
 
                        virtual void rtreeSplit(uint32_t dataLength, byte* pData, Region& mbr, id_type id, std::vector<uint32_t>& group1, std::vector<uint32_t>& group2);
                        virtual void rstarSplit(uint32_t dataLength, byte* pData, Region& mbr, id_type id, std::vector<uint32_t>& group1, std::vector<uint32_t>& group2);
 
                        virtual void pickSeeds(uint32_t& index1, uint32_t& index2);
 
                        virtual void condenseTree(std::stack<NodePtr>& toReinsert, std::stack<id_type>& pathBuffer, NodePtr& ptrThis);
 
                        virtual NodePtr chooseSubtree(const Region& mbr, uint32_t level, std::stack<id_type>& pathBuffer) = 0;
                        virtual NodePtr findLeaf(const Region& mbr, id_type id, std::stack<id_type>& pathBuffer) = 0;
 
                        virtual void split(uint32_t dataLength, byte* pData, Region& mbr, id_type id, NodePtr& left, NodePtr& right) = 0;
 
                        RTree* m_pTree;
                                // Parent of all nodes.
 
                        uint32_t m_level;
                                // The level of the node in the tree.
                                // Leaves are always at level 0.
 
                        id_type m_identifier;
                                // The unique ID of this node.
 
                        uint32_t m_children;
                                // The number of children pointed by this node.
 
                        uint32_t m_capacity;
                                // Specifies the node capacity.
 
                        Region m_nodeMBR;
                                // The minimum bounding region enclosing all data contained in the node.
 
                        byte** m_pData;
                                // The data stored in the node.
 
                        RegionPtr* m_ptrMBR;
                                // The corresponding data MBRs.
 
                        id_type* m_pIdentifier;
                                // The corresponding data identifiers.
 
                        uint32_t* m_pDataLength;
 
                        uint32_t m_totalDataLength;
 
                        class RstarSplitEntry
                        {
                        public:
                                Region* m_pRegion;
                                uint32_t m_index;
                                uint32_t m_sortDim;
 
                                RstarSplitEntry(Region* 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;
 
                                        assert(pe1->m_sortDim == pe2->m_sortDim);
 
                                        if (pe1->m_pRegion->m_pLow[pe1->m_sortDim] < pe2->m_pRegion->m_pLow[pe2->m_sortDim]) return -1;
                                        if (pe1->m_pRegion->m_pLow[pe1->m_sortDim] > pe2->m_pRegion->m_pLow[pe2->m_sortDim]) return 1;
                                        return 0;
                                }
 
                                static int compareHigh(const void* pv1, const void* pv2)
                                {
                                        RstarSplitEntry* pe1 = * (RstarSplitEntry**) pv1;
                                        RstarSplitEntry* pe2 = * (RstarSplitEntry**) pv2;
 
                                        assert(pe1->m_sortDim == pe2->m_sortDim);
 
                                        if (pe1->m_pRegion->m_pHigh[pe1->m_sortDim] < pe2->m_pRegion->m_pHigh[pe2->m_sortDim]) return -1;
                                        if (pe1->m_pRegion->m_pHigh[pe1->m_sortDim] > pe2->m_pRegion->m_pHigh[pe2->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 RTree;
                        friend class Leaf;
                        friend class Index;
                        friend class Tools::PointerPool<Node>;
                        friend class BulkLoader;
                }; // Node
        }
}