d_tree_point_locator_path.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_PATH_H
#define D_TREE_POINT_LOCATOR_PATH_H

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

#ifndef D_BIN_COORDINATES_H
#include "SheafSystem/d_bin_coordinates.h"
#endif

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

//#undef DIAGNOSTIC_OUTPUT
//#define DIAGNOSTIC_OUTPUT

namespace geometry
{

template <int DC, int DB>
class d_bounding_box;
template <int DC, int DB>
class d_tree_point_locator;

template <int DC, int DB>
class SHEAF_DLL_SPEC d_tree_point_locator_path
{

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

public:

  typedef sheaf::size_type size_type;

  static const size_type DEGREE = 1<<DC;

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

  virtual bool invariant() const;

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

  virtual ~d_tree_point_locator_path();

  d_tree_point_locator_path(const d_bin_coordinates<DC, DB>& xpt,
                            const d_tree_point_locator<DC, DB>* xtree);

  d_tree_point_locator_path(const d_tree_point_locator<DC, DB>* xtree);

  size_type depth() const;

  size_type height() const;

  static size_type max_height();

  static size_type max_depth();

  d_tree_point_locator<DC, DB>* tree() const;

  size_type head() const;

  void ascend();

  void descend();

  void put_head(size_type xhead);

  void reset();

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

  const d_bin_coordinates<DC, DB>& path() const;

  static size_type degree();

private:

  d_tree_point_locator_path();

  size_type _height;

  // Tree is included as feature in this class
  // only because it is a convenient and efficient
  // place to put it for use by various clients.
  // It is not used in this class.

  const d_tree_point_locator<DC, DB>* _tree;

  d_bin_coordinates<DC, DB> _path;

};

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

template <int DC, int DB>
SHEAF_DLL_SPEC 
std::ostream&
operator<<(std::ostream &os, const d_tree_point_locator_path<DC, DB>& xpath);
 
} // namespace geometry

#endif // ifndef D_TREE_POINT_LOCATOR_PATH_H