add removeFirst() and removeLast() methods (#18)

* add removeFirst() and removeLast() methods

* clang

Author: nkaaf

examples/List/ManageElements/ManageElements.ino

@@ -36,18 +36,24 @@ void setup() {
   Serial.print(list.getSize());
   Serial.println(" element(s)");
 
+  Serial.println("Adding 10 more elements");
+  // Add 10 more elements
+  int y = 0;
+  for (int i = 0; i < 10; ++i) {
+    list.add(y);
+    y++;
+  }
+
   // Remove element from list
-  list.remove(0); // With this, you will remove the first element of the list.
-  Serial.print("After the deletion, the list has: ");
+  list.remove(3); // With this, you will remove the third element of the list.
+  Serial.print("After the deletion of the third element, the list has: ");
   Serial.print(list.getSize());
   Serial.println(" element(s)");
 
-  // Add 10 more elements
-  int e = 0;
-  for (int i = 0; i < 10; ++i) {
-    list.add(e);
-  }
-  Serial.print("After the insertion, the list has: ");
+  // Remove the first and the last element
+  list.removeFirst();
+  list.removeLast();
+  Serial.print("After the deletion of the first and the last element, the list has: ");
   Serial.print(list.getSize());
   Serial.println(" element(s)");
 

keywords.txt

@@ -24,6 +24,8 @@ clear	KEYWORD2
 getValue	KEYWORD2
 getPointer	KEYWORD2
 remove	KEYWORD2
+removeFirst	KEYWORD2
+removeLast	KEYWORD2
 removeAll	KEYWORD2
 getSize	KEYWORD2
 isMutable	KEYWORD2

src/AbstractList.hpp

@@ -127,7 +127,7 @@ template <typename T> class AbstractList {
   /*!
    * @copybrief AbstractList::addLast()
    * @note Alias of addLast().
-   * @see   addLast()
+   * @see addLast()
    *
    * @param value   Value to add.
    */
@@ -167,7 +167,6 @@ template <typename T> class AbstractList {
 
   /*!
    * @brief Add all entries from the given list at the end of the list.
-   * @see   addAll()
    *
    * @param list    Other list to copy from.
    */
@@ -182,16 +181,13 @@ template <typename T> class AbstractList {
 
   /*!
    * @brief Add a new entry at the end of the list.
-   * @see   add()
    *
    * @param value   Value to add.
    */
   void addLast(T &value) { addAtIndex(getSize(), value); }
 
   /*!
    * @copydoc AbstractList::get()
-   * @note Alias of get().
-   * @see get()
    */
   T *getPointer(int index) { return get(index); }
 
@@ -224,10 +220,20 @@ template <typename T> class AbstractList {
    */
   virtual void remove(int index) = 0;
 
+  /*!
+   * @brief Remove the first entry from the list.
+   */
+  virtual void removeFirst() { remove(0); }
+
+  /*!
+   * @brief Remove the las entry from the list.
+   */
+  virtual void removeLast() { remove(getSize() - 1); }
+
   /*!
    * @copybrief AbstractList::clear()
    * @note Alias of clear().
-   * @see clear().
+   * @see clear()
    */
   void removeAll() { clear(); }
 
@@ -250,7 +256,7 @@ template <typename T> class AbstractList {
    *
    * @return    true if the list is empty; false otherwise
    */
-  bool isEmpty() { return size == 0; }
+  bool isEmpty() { return getSize() == 0; }
 
   /*!
    * @brief Get an array which represent the list.