// Copyright (c) 2020  GeometryFactory (France).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org).
//
// $URL$
// $Id$
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-Commercial
//
// Author(s)     : Simon Giraudot

#ifndef CGAL_OCTREE_H
#define CGAL_OCTREE_H

#include <CGAL/license/Orthtree.h>

#include <CGAL/Orthtree.h>
#include <CGAL/Orthtree_traits_3.h>

namespace CGAL {

/*!
 * \ingroup PkgOrthtreeClasses
 *
 * \brief alias that specialized the `Orthtree` class to a 3D Octree.
 *
 * These two types are exactly equivalent:
 * - `Octree<GeomTraits, PointRange, PointMap>`
 * - `Orthtree<Orthtree_traits_3<GeomTraits>, PointRange, PointMap>`.
 *
 * \warning this is a not a real class but an alias, please refer to
 * the documentation of `Orthtree`.
 *
 * \tparam GeomTraits is a model of Kernel
 * \tparam PointRange is a range type that provides random access iterators over the indices of a set of points.
 * \tparam PointMap is a type that maps items in the range to Point data
 */
template <typename GeomTraits, typename PointRange,
          typename PointMap = Identity_property_map
         <typename std::iterator_traits<typename PointRange::iterator>::value_type> >
#ifdef DOXYGEN_RUNNING
class Octree;
#else
using Octree = Orthtree<Orthtree_traits_3<GeomTraits>, PointRange, PointMap>;
#endif

} // namespace CGAL


#endif // CGAL_OCTREE_H