commons-geometry-core/src/test/java/org/apache/commons/geometry/core/partition/test/PartitionTestUtils.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.partition.test;

import org.apache.commons.geometry.core.Point;
import org.apache.commons.geometry.core.partitioning.bsp.BSPTree;
import org.apache.commons.geometry.core.partitioning.bsp.BSPTree.Node;
import org.apache.commons.geometry.core.precision.DoublePrecisionContext;
import org.apache.commons.geometry.core.precision.EpsilonDoublePrecisionContext;
import org.junit.Assert;

/** Class containing utility methods for tests related to the
 * partition package.
 */
public class PartitionTestUtils {

    public static final double EPS = 1e-6;

    public static final DoublePrecisionContext PRECISION =
            new EpsilonDoublePrecisionContext(EPS);

    /**
     * Asserts that corresponding values in the given points are equal.
     * @param expected
     * @param actual
     */
    public static void assertPointsEqual(TestPoint2D expected, TestPoint2D actual) {
        String msg = "Expected points to equal " + expected + " but was " + actual + ";";
        Assert.assertEquals(msg, expected.getX(), actual.getX(), EPS);
        Assert.assertEquals(msg, expected.getY(), actual.getY(), EPS);
    }

    public static void assertSegmentsEqual(TestLineSegment expected, TestLineSegment actual) {
        String msg = "Expected line segment to equal " + expected + " but was " + actual;

        Assert.assertEquals(msg, expected.getStartPoint().getX(),
                actual.getStartPoint().getX(), EPS);
        Assert.assertEquals(msg, expected.getStartPoint().getY(),
                actual.getStartPoint().getY(), EPS);

        Assert.assertEquals(msg, expected.getEndPoint().getX(),
                actual.getEndPoint().getX(), EPS);
        Assert.assertEquals(msg, expected.getEndPoint().getY(),
                actual.getEndPoint().getY(), EPS);
    }

    public static void assertIsInternalNode(Node<?, ?> node) {
        Assert.assertNotNull(node.getCut());
        Assert.assertNotNull(node.getMinus());
        Assert.assertNotNull(node.getPlus());

        Assert.assertTrue(node.isInternal());
        Assert.assertFalse(node.isLeaf());
    }

    public static void assertIsLeafNode(Node<?, ?> node) {
        Assert.assertNull(node.getCut());
        Assert.assertNull(node.getMinus());
        Assert.assertNull(node.getPlus());

        Assert.assertFalse(node.isInternal());
        Assert.assertTrue(node.isLeaf());
    }

    /** Assert that the given tree for has a valid, consistent internal structure. This checks that all nodes
     * in the tree are owned by the tree, that the node depth values are correct, and the cut nodes have children
     * and non-cut nodes do not.
     * @param tree tree to check
     */
    public static <P extends Point<P>, N extends BSPTree.Node<P, N>> void assertTreeStructure(final BSPTree<P, N> tree) {
        assertTreeStructureRecursive(tree, tree.getRoot(), 0);
    }

    /** Recursive method to assert that a tree has a valid internal structure.
     * @param tree tree to check
     * @param node node to check
     * @param expectedDepth the expected depth of the node in the tree
     */
    private static <P extends Point<P>, N extends BSPTree.Node<P, N>> void assertTreeStructureRecursive(
            final BSPTree<P, N> tree, final BSPTree.Node<P, N> node, final int expectedDepth) {

        Assert.assertSame("Node has an incorrect owning tree", tree, node.getTree());
        Assert.assertEquals("Node has an incorrect depth property", node.depth(), expectedDepth);

        if (node.getCut() == null) {
            String msg = "Node without cut cannot have children";

            Assert.assertNull(msg, node.getMinus());
            Assert.assertNull(msg, node.getPlus());
        }
        else {
            String msg = "Node with cut must have children";

            Assert.assertNotNull(msg, node.getMinus());
            Assert.assertNotNull(msg, node.getPlus());

            assertTreeStructureRecursive(tree, node.getPlus(), expectedDepth + 1);
            assertTreeStructureRecursive(tree, node.getMinus(), expectedDepth + 1);
        }
    }
}