/*
 * This software is OSI Certified Open Source Software.
 * OSI Certified is a certification mark of the Open Source Initiative.
 *
 * This file is part of the AutoSummary package.
 * AutoSummary is licensed under the terms of the BSD License.
 *
 * Copyright (c) 2005, Charles F. Greenbacker III
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice,
 *       this list of conditions and the following disclaimer in the documentation
 *       and/or other materials provided with the distribution.
 *     * Neither the name of AutoSummary nor the names of its contributors
 *       may be used to endorse or promote products derived from this software without
 *       specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package net.artificialminds.AutoSummary;

import java.util.Comparator;

/**
 * Comparator used to sort 2D array of possible part-of-speech combinations in JPhrase.
 * Counterintuitively, it will cause the array to be sorted in DESCENDING order, because
 * the combinations with the higher scores are the ones we are interested in, and therefore
 * we want them on top.
 *
 * @author  Charlie Greenbacker
 * @version 0.1.0a 20050816
 * @since   AutoSummary 0.1.0a
 */
public class FloatArrayComparator implements Comparator
{
    /**
     * Sole method. Creates a comparator used to sort 2D arrays.
     *
     * @param o1            first object to be compared
     * @param o2            second object to be compared
     * @return              1 if cumulative POS score of o1 is greater than o2, -1 is less than, 0 if equal
     * @since               AutoSummary 0.1.0a
     */
    public int compare(Object o1, Object o2)
    {
        float[] a1 = (float[])o1;
        float[] a2 = (float[])o2;
        int lastItem = a1.length - 1;
        if (a1[lastItem] < a2[lastItem])
            return 1;
        else if (a1[lastItem] > a2[lastItem])
            return -1;
        else return 0;
     }
}