BNDMWildcards.java

/*
 * BNDMWildcards.java
 *
 * Created on 19.01.2004.
 *
 * eaio: StringSearch - high-performance pattern matching algorithms in Java
 * Copyright (c) 2003, 2004 Johann Burkard (jb@eaio.com) http://eaio.com
 *
 * 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 libsidutils.stringsearch;

import java.util.Arrays;

/**
 * An implementation of the BNDM algorithm with wildcards ("don't care"
 * symbols). The wildcard character is initially '?', but any character can be
 * used through the {@link #processChars(char[], char)} and the
 * {@link #processBytes (byte[], byte)} methods. <br>
 * <br>
 * This algorithm is around five times faster than
 * com.eaio.stringsearch.ShiftOrWildcards. <br>
 * <br>
 *
 * <pre>
 * Preprocessing: O(2m + &sum;) time
 * </pre>
 *
 * @author <a href="mailto:jb@eaio.com">Johann Burkard</a>
 * @version 1.2
 * @see #processBytes(byte[], byte)
 * @see #processChars(char[], char)
 * @see BNDM
 */
public class BNDMWildcards extends BNDM {

    /**
     * The wildcard character (initially '?').
     */
    public static char wildcard = '?';

    /**
     * Constructor for BNDMWildcards. Note that it is not required to create
     * multiple instances.
     */
    public BNDMWildcards() {
    }

    /**
     * Pre-processing of the pattern. The pattern may not exceed 32 bytes in length.
     * If it does, <b>only its first 32 bytes are processed,</b> which might lead to
     * unexpected results. The wildcard character is obtained from the static
     * {@link #wildcard} field.
     * <p>
     * com.eaio.stringsearch.StringSearch#processBytes(byte[])
     *
     * @see #processBytes(byte[], byte)
     */
    @Override
    public Object processBytes(byte[] pattern) {
        return processBytes(pattern, (byte) wildcard);
    }

    /**
     * Pre-processing of the pattern. The pattern may not exceed 32 bytes in length.
     * If it does, <b>only its first 32 bytes are processed,</b> which might lead to
     * unexpected results. Returns an <code>int</code> array.
     *
     * @param pattern the <code>byte</code> array containing the pattern, may not be
     *                <code>null</code>
     * @param w       the wildcard <code>byte</code> character
     * @return an <code>int</code> array
     */
    public Object processBytes(byte[] pattern, byte w) {
        int j = 0;
        int end = Math.min(pattern.length, 32);

        for (int i = 0; i < end; ++i) {
            if (pattern[i] == w) {
                j |= 1 << end - i - 1;
            }
        }

        int[] b = new int[256];

        if (j != 0) {
            Arrays.fill(b, j);
        }

        j = 1;
        for (int i = end - 1; i >= 0; --i, j <<= 1) {
            b[index(pattern[i])] |= j;
        }

        return b;
    }

    /**
     * Pre-processes the pattern. The pattern may not exceed 32 characters in
     * length. If it does, <b>only its first 32 bytes are processed,</b> which might
     * lead to unexpected results. The wildcard character is obtained from the
     * static {@link #wildcard} field.
     *
     * @param pattern the <code>char</code> array containing the pattern, may not be
     *                <code>null</code>
     * @return a {@link CharIntMap}
     * @see StringSearch#processChars(char[])
     * @see #processChars(char[], char)
     */
    @Override
    public Object processChars(char[] pattern) {
        return processChars(pattern, wildcard);
    }

    /**
     * Pre-processes the pattern. The pattern may not exceed 32 characters in
     * length. If it does, <b>only its first 32 bytes are processed,</b> which might
     * lead to unexpected results. Returns a {@link CharIntMap}.
     *
     * @param pattern the <code>char</code> array containing the pattern, may not be
     *                <code>null</code>
     * @param w       the wildcard character
     * @return a {@link CharIntMap}.
     */
    public Object processChars(char[] pattern, char w) {
        int j = 0;
        int end = Math.min(pattern.length, 32);

        for (int i = 0; i < end; ++i) {
            if (pattern[i] == w) {
                j |= 1 << end - i - 1;
            }
        }

        CharIntMap b = createCharIntMap(pattern, j);

        j = 1;
        for (int i = end - 1; i >= 0; --i, j <<= 1) {
            b.set(pattern[i], b.get(pattern[i]) | j);
        }

        return b;
    }

    /**
     * Pre-processes the pattern. The pattern may not exceed 32 characters in
     * length. If it does, <b>only its first 32 bytes are processed,</b> which might
     * lead to unexpected results. Returns a {@link CharIntMap}.
     *
     * @param pattern the String array containing the pattern, may not be
     *                <code>null</code>
     * @param w       the wildcard character
     * @return a {@link CharIntMap}.
     */
    public Object processString(String pattern, char w) {
        return processChars(pattern.toCharArray(), w);
    }

}