org.osgl.util.algo.ArraySearch Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of osgl-tool Show documentation
A simple Java toolkit
The newest version!
package org.osgl.util.algo;

/*-
 * #%L
 * Java Tool
 * %%
 * Copyright (C) 2014 - 2017 OSGL (Open Source General Library)
 * %%
 * 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.
 * #L%
 */

import org.osgl.$;

import java.util.Comparator;

/**
 * Created with IntelliJ IDEA.
 * User: luog
 * Date: 20/11/13
 * Time: 10:10 PM
 * To change this template use File | Settings | File Templates.
 */
public interface ArraySearch extends ArrayAlgorithm, $.Func5, Integer> {
    /**
     * Search array region specified by {@code from} and {@code to} using
     * the predicate specified
     *
     * @param ts the sorted array to be searched
     * @param from the from index
     * @param to the to index
     * @param key the key to search the array
     * @param comp the comparator function
     * @return index of the search key, if it is contained in the array;
     *         otherwise, (-(insertion point) - 1).  The
     *         insertion point is defined as the point at which the
     *         key would be inserted into the array: the index of the first
     *         element greater than the key, or a.length if all
     *         elements in the array are less than the specified key.  Note
     *         that this guarantees that the return value will be >= 0 if
     *         and only if the key is found.
     */
    @Override
    Integer apply(T[] ts, Integer from, Integer to, T key, Comparator comp);
}