d_tree_point_locator_node.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_NODE_H
#define D_TREE_POINT_LOCATOR_NODE_H

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

#ifndef SHEAF_H
#include "SheafSystem/sheaf.h"
#endif

#ifndef SINGLY_LINKED_LIST_H
#include "SheafSystem/singly_linked_list.h"
#endif

//#undef DIAGNOSTIC_OUTPUT
//#define DIAGNOSTIC_OUTPUT

namespace sheaf
{
template <class T>
class ptr_linked_pool;

}

namespace geometry
{

using namespace sheaf;
  
template <int DC, int DB>
class d_bounding_box;
template <int DC, int DB>
class d_tree_point_locator_path;

template <int DC, int DB>
class SHEAF_DLL_SPEC d_tree_point_locator_node
{
  friend class ptr_linked_pool< d_tree_point_locator_node<DC, DB> >;

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

public:

  typedef sheaf::size_type size_type;

  d_tree_point_locator_node();

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

  d_tree_point_locator_node<DC, DB>& operator=
    (const d_tree_point_locator_node<DC, DB>& xother);

  bool operator==(const d_tree_point_locator_node<DC, DB>& xother);

  ~d_tree_point_locator_node();

  bool invariant() const;

  d_tree_point_locator_node<DC, DB>* branch(int xindex) const;

  bool is_leaf() const;

  bool is_empty() const;

  void insert_box(const d_bounding_box<DC, DB>* xbox,
                  d_tree_point_locator_path<DC, DB>& xpath);

  void remove_box(const d_bounding_box<DC, DB>* xbox,
                  d_tree_point_locator_path<DC, DB>& xpath);

  bool contains_box(const d_bounding_box<DC, DB>* xbox,
                    d_tree_point_locator_path<DC, DB>& xpath) const;

  void clear();

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

  const box_list_type& box_list(d_tree_point_locator_path<DC, DB>& xpath) const;

  const box_list_type& box_list() const;

  std::string* to_string() const;

  static size_type degree();

  size_type branch_ct() const;

protected:

  box_list_type _box_list;

  static const size_type DEGREE = 1<<DC;

  d_tree_point_locator_node<DC, DB>* _branches[DEGREE];

  size_type _branch_ct;

  d_tree_point_locator_node<DC, DB>* next() const;

  void put_next(d_tree_point_locator_node<DC, DB>* xnode);


};

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

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

#endif // D_TREE_POINT_LOCATOR_NODE_H