[C/C++] Example / ArrayList

"CArrayListType.h"

//
//  CArrayListType.h
//
//  Created by gchoi on 2014. 6. 15..
//  Copyright (c) 2014년 gchoi. All rights reserved.
//

#ifndef Test_003_CArrayListType_h
#define Test_003_CArrayListType_h

template  class arrayListType
{
public:
    //Overloads the assignment operator bool isEmpty() const;
    const arrayListType& operator = (const arrayListType&);
    
    //Function to determine whether the list is empty
    //Postcondition: Returns true if the list is empty; otherwise, returns false.
    bool isEmpty() const;
    
    //Function to determine whether the list is full.
    //Postcondition: Returns true if the list is full;
    // otherwise, returns false.
    bool isFull() const;
    
    //Function to determine the number of elements in the list
    //Postcondition: Returns the value of length.
    int listSize() const;
    
    //Function to determine the size of the list.
    //Postcondition: Returns the value of maxSize.
    int maxListSize() const;
    
    //Function to output the elements of the list
    //Postcondition: Elements of the list are output on the standard output device.
    void print() const;
    
    //Function to determine whether the item is the same
    //as the item in the list at the position specified by
    //Postcondition: Returns true if list[location] is the same as the item; otherwise, returns false.
    bool isItemAtEqual(int location, const elemType& item) const;
    
    //Function to insert an item in the list at the position specified by location.
    // The item to be inserted is passed as a parameter to the function.
    //Postcondition: Starting at location, the elements of the list are shifted down, list[location] = insertItem;,
    // and length++;. If the list is full or location is out of range, an appropriate message is displayed.
    void insertAt(int location, const elemType& insertItem);
    
    //Function to insert an item at the end of the list.
    //The parameter insertItem specifies the item to be inserted.
    //Postcondition: list[length] = insertItem; and length++;
    // If the list is full, an appropriate message is displayed.
    void insertEnd(const elemType& insertItem);
    
    //Function to remove the item from the list at the position specified by location
    //Postcondition: The list element at list[location] is removed and length is decremented by 1.
    //If location is out of range, an appropriate message is displayed.
    void removeAt(int location);
    
    //Function to retrieve the element from the list at the position specified by location.
    //Postcondition: retItem = list[location]
    // If location is out of range, an appropriate message is displayed.
    void retrieveAt(int location, elemType& retItem) const;
    
    //Function to replace the elements in the list at the position specified by location.
    //The item to be replaced is specified by the parameter repItem.
    //Postcondition: list[location] = repItem
    // If location is out of range, an appropriate message is displayed.
    void replaceAt(int location, const elemType& repItem);
    
    //Function to remove all the elements from the list.
    //After this operation, the size of the list is zero.
    //Postcondition: length = 0;
    void clearList();
    
    //Function to search the list for a given item.
    //Postcondition: If the item is found, returns the location in the array where the item is found;
    // otherwise, returns -1.
    int seqSearch(const elemType& item) const;
    
    //Function to insert the item specified by the parameter insertItem at the end of the list.
    //However, first the list is searched to see whether the item to be inserted is already in the list.
    //Postcondition: list[length] = insertItem and length++
    // If the item is already in the list or the list is full, an appropriate message is displayed.
    void insert(const elemType& insertItem);
    
    //Function to remove an item from the list.
    // The parameter removeItem specifies the item to be removed.
    //Postcondition: If removeItem is found in the list, it is removed from the list and length is decremented by one.
    void remove(const elemType& removeItem);
    
    //constructor
    //Creates an array of the size specified by the parameter size. The default array size is 100.
    //Postcondition: The list points to the array, length = 0, and maxSize = size
    arrayListType(int size = 100);
    
    //copy constructor
    arrayListType(const arrayListType& otherList);
    
    //destructor
    //Deallocates the memory occupied by the array.
    ~arrayListType();

protected:
    //array to hold the list elements
    elemType *list;
    //to store the length of the list
    int length;
    //to store the maximum size of the list
    int maxSize;
};

#endif