/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2009 The eXist Project
 *  http://exist-db.org
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * $Id$
 */

package org.exist.util.sorters;

import java.util.Comparator;
import java.util.List;

import org.exist.dom.NodeProxy;

/**
 * Interface to some sorting algorithm.
 * <p>
 * This work was undertaken as part of the development of the taxonomic
 * repository at http://biodiversity.org.au . See <A
 * href="ghw-at-anbg.gov.au">Greg Whitbread</A> for further details.
 * 
 * @author pmurray@bigpond.com
 * @author pmurray@anbg.gov.au
 * @author https://sourceforge.net/users/paulmurray
 * @author http://www.users.bigpond.com/pmurray
 * 
 */
public abstract class SortingAlgorithmTester {
	abstract <C extends Comparable<? super C>> void invokeSort(C[] a, int lo, int hi)
		throws Exception;
	
	abstract <C> void invokeSort(C a[], Comparator<C> c, int lo, int hi)
		throws Exception;

	abstract <C extends Comparable<? super C>> void sort(C[] a, int lo, int hi)
		throws Exception;

	abstract <C extends Comparable<? super C>> void sort(C[] a, int lo, int hi, int[] b)
		throws Exception;

	abstract <C> void sort(C[] a, Comparator<C> c,
			int lo, int hi) throws Exception;

	abstract <C extends Comparable<? super C>> void sort(List<C> a, int lo, int hi)
		throws Exception;

	// This one must change its parameters so some Java compilers do not
	// get fooled
	abstract void sort(int lo, int hi,NodeProxy[] a) throws Exception;

	abstract void sortByNodeId(NodeProxy[] a, int lo, int hi) throws Exception;

	abstract void sort(long[] a, int lo, int hi, Object b[]) throws Exception;

	public static SortingAlgorithmTester[] allSorters() {
		return new SortingAlgorithmTester[] {
			new InsertionSortTester(),
			new HeapSortTester(),
			new FastQSortTester(),
//			new HSortTester(),
		};
	}
}