accord-core/src/test/java/accord/utils/RangeTest.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 accord.utils;

import accord.api.Key;
import accord.impl.IntKey.Raw;
import accord.impl.IntKey.Routing;
import accord.primitives.Range;
import accord.impl.IntKey;
import accord.primitives.Range.EndInclusive;
import accord.primitives.Range.StartInclusive;
import accord.primitives.Keys;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;

public class RangeTest
{
    static Raw k(int v)
    {
        return new IntKey.Raw(v);
    }
    static Routing r(int v)
    {
        return new Routing(v);
    }

    private static Range r(int start, int end)
    {
        return IntKey.range(start, end);
    }

    static Range rangeEndIncl(int start, int end)
    {
        return new EndInclusive(r(start), r(end));
    }

    static Range rangeStartIncl(int start, int end)
    {
        return new StartInclusive(r(start), r(end));
    }

    static Keys keys(int... values)
    {
        Key[] keys = new Key[values.length];
        for (int i=0; i<values.length; i++)
            keys[i] = IntKey.key(values[i]);
        return Keys.of(keys);
    }

    private static void assertInvalidKeyRange(int start, int end)
    {
        try
        {
            rangeStartIncl(start, end);
            Assertions.fail("Expected IllegalArgumentException");
        }
        catch (IllegalArgumentException e)
        {
            // expected
        }

        try
        {
            rangeEndIncl(start, end);
            Assertions.fail("Expected IllegalArgumentException");
        }
        catch (IllegalArgumentException e)
        {
            // expected
        }
    }

    @Test
    void invalidRangeTest()
    {
        assertInvalidKeyRange(1, 1);
        assertInvalidKeyRange(2, 1);
    }

    @Test
    void containsTest()
    {
        Range endInclRange = rangeEndIncl(10, 20);
        Assertions.assertFalse(endInclRange.contains(k(10)));
        Assertions.assertFalse(endInclRange.startInclusive());
        Assertions.assertTrue(endInclRange.contains(k(20)));
        Assertions.assertTrue(endInclRange.endInclusive());

        Range startInclRange = rangeStartIncl(10, 20);
        Assertions.assertTrue(startInclRange.contains(k(10)));
        Assertions.assertTrue(startInclRange.startInclusive());
        Assertions.assertFalse(startInclRange.contains(k(20)));
        Assertions.assertFalse(startInclRange.endInclusive());
    }

    private static void assertHigherKeyIndex(int expectedIdx, Range range, Keys keys)
    {
        if (expectedIdx > 0 && expectedIdx < keys.size())
            Assertions.assertTrue(range.contains(keys.get(expectedIdx - 1)));
        int actualIdx = range.nextHigherKeyIndex(keys, 0);
        Assertions.assertEquals(expectedIdx, actualIdx);
    }

    @Test
    void higherKeyIndexTest()
    {
        Keys keys = keys(10, 11, 12, 13, 14, 15, 16);
        assertHigherKeyIndex(0, rangeEndIncl(0, 9), keys);
        assertHigherKeyIndex(0, rangeStartIncl(0, 10), keys);
        assertHigherKeyIndex(0, rangeEndIncl(0, 5), keys);
        assertHigherKeyIndex(0, rangeStartIncl(0, 5), keys);

        assertHigherKeyIndex(1, rangeEndIncl(9, 10), keys);
        assertHigherKeyIndex(0, rangeStartIncl(9, 10), keys);
        assertHigherKeyIndex(5, rangeEndIncl(11, 14), keys);
        assertHigherKeyIndex(4, rangeStartIncl(11, 14), keys);
        assertHigherKeyIndex(6, rangeEndIncl(11, 15), keys);
        assertHigherKeyIndex(5, rangeStartIncl(11, 15), keys);

        assertHigherKeyIndex(7, rangeEndIncl(16, 25), keys);
        assertHigherKeyIndex(7, rangeStartIncl(16, 25), keys);
        assertHigherKeyIndex(7, rangeEndIncl(20, 25), keys);
        assertHigherKeyIndex(7, rangeStartIncl(20, 25), keys);
    }

    private static void assertLowKeyIndex(int expectedIdx, Range range, Keys keys, int lowerBound)
    {
        if (expectedIdx >= 0 && expectedIdx < keys.size())
        {
            Assertions.assertTrue(range.contains(keys.get(expectedIdx)));
        }
        else
        {
            Assertions.assertFalse(range.contains(keys.get(lowerBound)));
            Assertions.assertFalse(range.contains(keys.get(keys.size() - 1)));
        }

        int actualIdx = range.nextCeilKeyIndex(keys, lowerBound);
        Assertions.assertEquals(expectedIdx, actualIdx);
    }

    private static void assertLowKeyIndex(int expectedIdx, Range range, Keys keys)
    {
        assertLowKeyIndex(expectedIdx, range, keys, 0);
    }

    @Test
    void lowKeyIndexTest()
    {
        Keys keys = keys(10, 11, 12, 13, 14, 15, 16);
        assertLowKeyIndex(-1, rangeEndIncl(0, 5), keys);
        assertLowKeyIndex(-1, rangeStartIncl(0, 5), keys);
        assertLowKeyIndex(-1, rangeEndIncl(0, 9), keys);
        assertLowKeyIndex(-1, rangeStartIncl(0, 9), keys);

        assertLowKeyIndex(0, rangeEndIncl(5, 10), keys);
        assertLowKeyIndex(-1, rangeStartIncl(5, 10), keys);
        assertLowKeyIndex(2, rangeEndIncl(11, 15), keys);
        assertLowKeyIndex(1, rangeStartIncl(11, 15), keys);
        assertLowKeyIndex(3, rangeEndIncl(12, 14), keys);
        assertLowKeyIndex(2, rangeStartIncl(12, 14), keys);
        assertLowKeyIndex(6, rangeEndIncl(15, 20), keys);
        assertLowKeyIndex(5, rangeStartIncl(15, 20), keys);

        assertLowKeyIndex(-8, rangeEndIncl(16, 20), keys);
        assertLowKeyIndex(6, rangeStartIncl(16, 20), keys);
        assertLowKeyIndex(-8, rangeEndIncl(20, 25), keys);
        assertLowKeyIndex(-8, rangeStartIncl(20, 25), keys);

        // non-intersecting
        assertLowKeyIndex(-2, rangeStartIncl(12, 14), keys(10, 16));
    }

    @Test
    void fullyContainsTest()
    {
        Assertions.assertTrue(r(100, 200).contains(r(100, 200)));
        Assertions.assertTrue(r(100, 200).contains(r(150, 200)));
        Assertions.assertTrue(r(100, 200).contains(r(100, 150)));
        Assertions.assertTrue(r(100, 200).contains(r(125, 175)));

        Assertions.assertFalse(r(100, 200).contains(r(50, 60)));
        Assertions.assertFalse(r(100, 200).contains(r(100, 250)));
        Assertions.assertFalse(r(100, 200).contains(r(150, 250)));
        Assertions.assertFalse(r(100, 200).contains(r(50, 200)));
        Assertions.assertFalse(r(100, 200).contains(r(50, 150)));
        Assertions.assertFalse(r(100, 200).contains(r(250, 260)));
    }

    @Test
    void compareIntersectingTest()
    {
        Assertions.assertEquals(1, r(100, 200).compareIntersecting(r(0, 100)));
        Assertions.assertEquals(1, r(100, 200).compareIntersecting(r(0, 99)));

        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(0, 101)));

        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(99, 199)));
        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(99, 200)));
        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(99, 201)));
        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(101, 199)));
        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(125, 175)));
        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(100, 201)));
        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(101, 201)));

        Assertions.assertEquals(0, r(100, 200).compareIntersecting(r(199, 300)));

        Assertions.assertEquals(-1, r(100, 200).compareIntersecting(r(200, 300)));
        Assertions.assertEquals(-1, r(100, 200).compareIntersecting(r(201, 300)));
    }

    private static void assertIntersection(Range expected, Range a, Range b)
    {
        Assertions.assertEquals(expected, a.intersection(b));
        Assertions.assertEquals(expected, b.intersection(a));
    }

    @Test
    void intersectionTest()
    {
        assertIntersection(r(25, 75), r(0, 75), r(25, 100));
        assertIntersection(r(0, 75), r(0, 75), r(0, 100));
        assertIntersection(r(25, 100), r(0, 100), r(25, 100));
        assertIntersection(r(25, 75), r(0, 100), r(25, 75));
        assertIntersection(r(0, 100), r(0, 100), r(0, 100));
    }

    @Test
    void intersectsTest()
    {
        Range range = r(100, 200);
        Assertions.assertTrue(range.intersects(keys(50, 150, 250)));
        Assertions.assertTrue(range.intersects(keys(150, 250)));
        Assertions.assertTrue(range.intersects(keys(50, 150)));

        Assertions.assertFalse(range.intersects(keys()));
        Assertions.assertFalse(range.intersects(keys(50, 75)));
        Assertions.assertFalse(range.intersects(keys(50, 75, 250, 300)));
        Assertions.assertFalse(range.intersects(keys(250, 300)));
    }
}