school/cs235/lab08/QSInterface.h
2016-04-06 20:46:10 -07:00

127 lines
3.8 KiB
C++

#pragma once
#include <iostream>
#include <string>
using namespace std;
/*
* WARNING: It is expressly forbidden to modify any part of this document, including its name
*/
class QSInterface
{
public:
QSInterface(){}
virtual ~QSInterface(){}
/*
* For all methods below, it is assumed that the given array's size is correctly provided by the following parameter.
*/
/*
* sortAll()
*
* Sorts elements of the given array. After this method is called, every
* element in the array is less than or equal to the following element.
*
* Does nothing if the given array is empty.
*
* @param data
* an array of integers
* @param size
* the correct size of the given array
*/
virtual void sortAll(int data[], int size) = 0;
/*
* sort()
*
* Sorts elements of the given array between the two given indices. After
* this method is called, every element between the indices is less than or
* equal to the following element.
*
* Does nothing if the given array is empty, if either of the given integers
* is out of bounds, or if the first integer is not less than the second
* integer.
*
* @param data
* an array of integers
* @param size
* the correct size of the given array
* @param left
* the left boundary for the subarray to sort
* @param right
* the right boundary for the subarray to sort
*/
virtual void sort(int data[], int size, int left, int right) = 0;
/*
* medianOfThree()
*
* Performs median-of-three pivot selection from among the values in
* the given array between the two given indices. Median-of-three pivot
* selection will sort the first, middle, and last elements in a given
* array with respect to each other. After this method is called,
* data[first] <= data[middle] <= data[last], where middle =
* (first + last)/2.
*
* Does nothing if the given array is empty, if either of the given integers
* is out of bounds, or if the first integer is not less than the second
* integer.
*
* @param data
* an array of integers
* @param size
* the correct size of the given array
* @param left
* the left boundary for the subarray from which to find a pivot
* @param right
* the right boundary for the subarray from which to find a pivot
*/
virtual void medianOfThree(int data[], int size, int left, int right) = 0;
/*
* Partitions a subarray around a pivot value selected according to
* median-of-three pivot selection.
*
* The values which are smaller than the pivot should be placed to the left
* of the pivot; the values which are larger than the pivot should be placed
* to the right of the pivot.
*
* Does nothing and returns -1 if the given array is null, if either of the
* given integers is out of bounds, or if the first integer is not less than
* the second integer.
*
* @param data
* an array of integers
* @param size
* the correct size of the given array
* @param left
* the left boundary for the subarray to partition
* @param right
* the right boundary for the subarray to partition
* @return the pivot's ending index after the partition completes; -1 if
* provided with bad input
*/
virtual int partition(int data[], int size, int left, int right) = 0;
/*
* Swaps the values at the given indices within the given array.
*
* After this method is called, the values in data[i] and data[j] should be
* swapped.
*
* Does nothing if the given array is null or if either of the given
* integers is out of bounds.
*
* @param data
* an array of integers
* @param size
* the correct size of the given array
* @param i
* the first index
* @param j
* the second index
*/
virtual void swap(int data[], int size, int i, int j) = 0;
};