commons-geometry-core/src/main/java/org/apache/commons/geometry/core/partitioning/bsp/BSPSubtree.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
package org.apache.commons.geometry.core.partitioning.bsp;

import org.apache.commons.geometry.core.Point;

/** Interface for types that form the root of BSP subtrees. This includes trees
 * themselves as well as each node in a tree.
 * @param <P> Point implementation type
 * @param <N> Node implementation type
 */
public interface BSPSubtree<P extends Point<P>, N extends BSPTree.Node<P, N>> {

    /** Return the total number of nodes in the subtree.
     * @return the total number of nodes in the subtree.
     */
    int count();

    /** The height of the subtree, ie the length of the longest downward path from
     * the subtree root to a leaf node. A leaf node has a height of 0.
     * @return the height of the subtree.
     */
    int height();

    /** Accept a visitor instance, calling it with each node from the subtree.
     * @param visitor visitor called with each subtree node
     */
    void accept(BSPTreeVisitor<P, N> visitor);

    /** Get an iterable for accessing the nodes in this subtree. This provides a simple
     * alternative to {@link #accept(BSPTreeVisitor)} for accessing tree nodes but is not
     * as powerful or flexible since the node iteration order is fixed.
     * @return an iterable for accessing the nodes in this subtree
     */
    Iterable<N> nodes();
}