net.algart.math.patterns.QuickPointCountPattern Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algart Show documentation

Open-source Java libraries, supporting generalized smart arrays and matrices with elements of any types, including a wide set of 2D-, 3D- and multidimensional image processing and other algorithms, working with arrays and matrices.

There is a newer version: 1.4.23

Show newest version

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2007-2024 Daniel Alievsky, AlgART Laboratory (http://algart.net)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package net.algart.math.patterns;

/**
 * Interface, used by {@link Pattern} implementations to indicate that
 * they support quick access to the number of points in pattern.
 *
 * More precisely, if a pattern implements this interface, then there is a guarantee that the following
 * methods work very quickly (O(1) operations) and without any exceptions:
 *
 * 
 * {@link #pointCount()},
 * {@link #largePointCount()},
 * {@link #isSurelySinglePoint()},
 * {@link #isSurelyOriginPoint()}.
 * 
 *
 * There is a guarantee, that the following methods (and, in this package, only they)
 * create patterns, implementing this interface:
 *
 * 
 * {@link SimplePattern} constructor,
 * {@link Patterns#newPattern(net.algart.math.Point...)},
 * {@link Patterns#newPattern(java.util.Collection)},
 * {@link Patterns#newUniformGridPattern(net.algart.math.Point, double[], java.util.Collection)},
 * {@link Patterns#newIntegerPattern(net.algart.math.IPoint...)},
 * {@link Patterns#newIntegerPattern(java.util.Collection)},
 * {@link Patterns#newSphereIntegerPattern(net.algart.math.Point, double)},
 * {@link Patterns#newEllipsoidIntegerPattern(net.algart.math.Point, double...)},
 * {@link Patterns#newSurface(Pattern, net.algart.math.functions.Func)},
 * {@link Patterns#newSpaceSegment Patterns.newSpaceSegment(UniformGridPattern, Func, Func, double, double)},
 * {@link Patterns#newRectangularUniformGridPattern(net.algart.math.Point, double[], net.algart.math.IRange...)},
 * 
 * {@link Patterns#newRectangularIntegerPattern(net.algart.math.IRange...)},
 * {@link Patterns#newRectangularIntegerPattern(net.algart.math.IPoint, net.algart.math.IPoint)}.
 * 
 *
 * @author Daniel Alievsky
 *
 * @see DirectPointSetPattern
 */
public interface QuickPointCountPattern extends Pattern {
    /**
     * Returns true if and only if the number of points in this pattern is greater
     * than Long.MAX_VALUE. In this case, {@link #pointCount()} returns Long.MAX_VALUE,
     * but you can get the approximate number of points by {@link #largePointCount()} method.
     *
     * There is a guarantee that this method works very quickly (O(1) operations).
     * This method never throws any exceptions.
     *
     * @return true if the number of points in this pattern is greater than Long.MAX_VALUE.
     */
    boolean isPointCountVeryLarge();
}