no.digipost.util.bisect.Suggester Maven / Gradle / Ivy

Go to download

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

Some stellar general purpose utils.

The newest version!

/*
 * Copyright (C) Posten Norge AS
 *
 * Licensed 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 no.digipost.util.bisect;

/**
 * A suggester function is used by {@link BisectSearch} to generate
 * suggestions from distinct "points" of a range of integers. A suggestion
 * must align its ordering with the natural ordering of integers for a
 * bisection search to work.
 *
 * @param  The type of suggestions generated by this function
 */
@FunctionalInterface
public interface Suggester {

    /**
     * Generate a {@link Suggestion}.
     *
     * @param point the "point" which the geenrated suggestion must be based on
     *
     * @return the suggestion
     */
    Suggestion suggest(int point) throws Exception;
}