Add linked_list skeleton

Author: ramsafin

CMakeLists.txt

@@ -8,4 +8,5 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 include_directories(include)
 
 # add executables
-add_executable(arrays src/arrays_list.cpp include/array_list.hpp)
+add_executable(array_list src/arrays_list.cpp include/array_list.hpp)
+add_executable(linked_list src/linked_list.cpp include/linked_list.hpp)

include/array_list.hpp

@@ -1,8 +1,9 @@
 #pragma once
 
-#include <string>
 #include <algorithm>  // copy
+#include <cassert>    // assert
 #include <stdexcept>  // out_of_range
+#include <string>     // to_string
 
 namespace itis {
 
@@ -74,7 +75,9 @@ struct ArrayList {
   }
 
   /**
-   * Удаление элементов массива. Сложность операции - O(n).
+   * Удаление всех элементов массива.
+   * Сложность операции - O(1).
+   *
    * Емкость (capacity) массива остается прежним.
    */
   void Clear() {
@@ -106,6 +109,7 @@ struct ArrayList {
    */
   int IndexOf(char element) const {
     // To Do ...
+    return {};
   }
 
   /**
@@ -149,7 +153,8 @@ struct ArrayList {
    * @param new_capacity - новая емкость массива (должна быть больше предыдущей)
    */
   void resize(int new_capacity) {
-    if (new_capacity <= capacity_) return;
+    assert(new_capacity > capacity_);
+
     // To Do ...
   }
 

include/linked_list.hpp

@@ -0,0 +1,170 @@
+#pragma once
+
+#include <cassert>    // assert
+#include <stdexcept>  // out_of_range
+#include <string>     // to_string
+
+namespace itis {
+
+/**
+ * Структура "узел".
+ * Хранит в себе данные и указатель на следующий узел.
+ */
+struct Node {
+  char data;
+  Node *next_;  // указатель на следующий узел
+};
+
+struct LinkedList {
+ public:
+  // default constructor
+  LinkedList() = default;
+
+  ~LinkedList() {
+    // To Do ...
+  }
+
+  /**
+   * Добавление элемента в конец списка.
+   * Сложность операции - O(1).
+   *
+   * @param element - значение элемента
+   */
+  void PushBack(char element) {
+    // To Do ...
+  }
+
+  /**
+   * Вставка элемента в список по индексу.
+   * Сложность операции вставки - O(1).
+   * Сложность операции поиска узла - O(n).
+   *
+   * @param index - позиция для вставки
+   * @param element - значение элемента
+   *
+   * @throws выбрасывает ошибку out_of_range при работе с некорректным индексом.
+   */
+  void Insert(int index, char element) {
+    check_out_of_range(index);
+    // To Do ...
+  }
+
+  /**
+   * Удаление элемента списка по индексу.
+   * Сложность операции удаления - O(1).
+   * Сложность операции поиска узла - O(n).
+   *
+   * @param index - индекс удаляемого элемента
+   * @return значение удаленного элемента
+   *
+   * @throws выбрасывает ошибку out_of_range при работе с некорректным индексом.
+   */
+  char Remove(int index) {
+    check_out_of_range(index);
+    // To Do ...
+    return {};
+  }
+
+  /**
+   * Удаление всех элементов списка. Сложность операции - O(n).
+   */
+  void Clear() {
+    // To Do ...
+  }
+
+  /**
+   * Получение элемента списка по индексу.
+   * Сложность операции - O(n).
+   *
+   * @param index - индекс элемента
+   * @return значение элемента по индексу
+   *
+   * @throws выбрасывает ошибку out_of_range при работе с некорректным индексом.
+   */
+  char Get(int index) const {
+    check_out_of_range(index);
+
+    // To Do ...
+    return {};
+  }
+
+  /**
+   * Вычисление индекса элемента.
+   * Сложность операции - O(n).
+   *
+   * @param element - значение элемента
+   * @return индекс элемента или -1 при остутствии элемента в списке
+   */
+  int IndexOf(char element) const {
+    // To Do ...
+    return {};
+  }
+
+  /**
+   * Проверка наличия хотя бы одного элемента в массиве.
+   * Сложность операции - O(1).
+   *
+   * @return при наличии хотя бы одного элемента - true, иначе - false
+   */
+  bool IsEmpty() const {
+    // To Do ...
+    return {};
+  }
+
+  int GetSize() const {
+    return size_;
+  }
+
+  int GetCapacity() const {
+    return size_;
+  }
+
+ private:
+
+  /**
+   * Поиск узла списка по значению элемента.
+   * Сложность операции - O(n).
+   *
+   * Если в списке несколько элементов с одинаковым значением,
+   * то возвращается первый встретившийся узел.
+   *
+   * @param element - значение элемента в узле
+   * @return указатель на узел или nullptr - при отсутствии узла с таким значением
+   */
+  Node *find_node(char element) const {
+    // To Do ...
+    return nullptr;
+  }
+
+  /**
+   * Поиск узла списка по значению элемента.
+   * Сложность операции - O(n).
+   *
+   * @param element - значение элемента в узле
+   * @return указатель на узел или nullptr - при отсутствии узла с таким значением
+   */
+  Node *find_node(int index) const {
+    assert(index >= 0 && index < size_);
+
+    // To Do ...
+    return nullptr;
+  }
+
+ private:
+  int size_{0};
+
+  Node *head_{nullptr};
+  Node *tail_{nullptr};
+
+  void check_out_of_range(int index) const;
+};
+
+// реализация методов
+
+void LinkedList::check_out_of_range(int index) const {
+  if (index >= size_) {
+    throw std::out_of_range("index is out of range: " + std::to_string(size_));
+  }
+}
+
+}  // namespace itis

src/linked_list.cpp

@@ -0,0 +1,14 @@
+#include "linked_list.hpp"
+
+#include <iostream>
+
+using namespace itis;
+
+int main() {
+
+  auto list = LinkedList();
+
+  // To Do ...
+
+  return 0;
+}