d_tree_point_locator.h

Go to the documentation of this file.

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//


#ifndef D_TREE_POINT_LOCATOR_H
#define D_TREE_POINT_LOCATOR_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef D_BIN_POINT_LOCATOR_H
#include "SheafSystem/d_bin_point_locator.h"
#endif

#ifndef D_TREE_POINT_LOCATOR_NODE_H
#include "SheafSystem/d_tree_point_locator_node.h"
#endif

#ifndef PTR_LINKED_POOL_H
#include "SheafSystem/ptr_linked_pool.h"
#endif

#ifndef STD_IOSTREAM_H
#include "SheafSystem/std_iostream.h"
#endif

//#undef DIAGNOSTIC_OUTPUT
//#define DIAGNOSTIC_OUTPUT

namespace geometry
{

template <int DC, int DB>
class SHEAF_DLL_SPEC d_tree_point_locator : public d_bin_point_locator<DC, DB>
{
  friend class d_tree_point_locator_node<DC, DB>;

  // ===========================================================
  // ===========================================================

public:

  d_tree_point_locator(sec_ed& xcoords, size_type xdepth);

  d_tree_point_locator(sec_ed& xcoords);

  virtual ~d_tree_point_locator();

  const d_tree_point_locator_node<DC, DB>& root() const;

  size_type depth() const;

  static size_type max_depth();

  size_type size();

  size_type capacity();

  static size_type& default_depth();

protected:

  d_tree_point_locator() {};

  d_tree_point_locator(const d_tree_point_locator<DC, DB>& xother) {};

    virtual d_tree_point_locator& operator=(const point_locator& xother) {return *this;};

      d_tree_point_locator& operator=(const d_tree_point_locator<DC, DB>& xother) {return *this;};

  void update_bins();

  ptr_linked_pool< d_tree_point_locator_node<DC, DB> >& node_pool();

  ptr_linked_pool< d_tree_point_locator_node<DC, DB> > _node_pool;

  d_tree_point_locator_node<DC, DB> _root;

  size_type _depth;



  // ===========================================================
  // ===========================================================

public:

  typedef singly_linked_list<const d_bounding_box<DC, DB>*> box_list_type;

  virtual void insert_box(d_bounding_box<DC, DB>* xbox);

  virtual void remove_box(d_bounding_box<DC, DB>* xbox);

  virtual const box_list_type& box_list(sec_vd_value_type* xpt,
                                        size_type xpt_ub) const;

  virtual bool contains_box(d_bounding_box<DC, DB>* xbox) const;

  virtual void clear();



  // ===========================================================
  // ===========================================================

public:

  virtual bool invariant() const;



};

// ===========================================================
// NON-MEMBER FUNCTIONS
// ===========================================================

template <int DC, int DB>
SHEAF_DLL_SPEC 
std::ostream&
operator<<(std::ostream& xos, const d_tree_point_locator<DC, DB>& xtree);
 
} // namespace geometry

#endif // D_TREE_POINT_LOCATOR_H