feat: add contains() method to DynamicArray (#7270)

* feat: add contains() method to DynamicArray

* style: fix clang formatting

* style: fix clang format issues

* style: apply remaining clang formatting

---------

Co-authored-by: Deniz Altunkapan <deniz.altunkapan@outlook.com>

Author: Neha-2005-VCE

src/main/java/com/thealgorithms/datastructures/dynamicarray/DynamicArray.java

@@ -63,7 +63,8 @@ public void add(final E element) {
      *
      * @param index   the index at which the element is to be placed
      * @param element the element to be inserted at the specified index
-     * @throws IndexOutOfBoundsException if index is less than 0 or greater than or equal to the number of elements
+     * @throws IndexOutOfBoundsException if index is less than 0 or greater than or
+     *                                   equal to the number of elements
      */
     public void put(final int index, E element) {
         if (index < 0) {
@@ -82,7 +83,8 @@ public void put(final int index, E element) {
      *
      * @param index the index of the element to retrieve
      * @return the element at the specified index
-     * @throws IndexOutOfBoundsException if index is less than 0 or greater than or equal to the current size
+     * @throws IndexOutOfBoundsException if index is less than 0 or greater than or
+     *                                   equal to the current size
      */
     @SuppressWarnings("unchecked")
     public E get(final int index) {
@@ -97,7 +99,8 @@ public E get(final int index) {
      *
      * @param index the index of the element to be removed
      * @return the element that was removed from the array
-     * @throws IndexOutOfBoundsException if index is less than 0 or greater than or equal to the current size
+     * @throws IndexOutOfBoundsException if index is less than 0 or greater than or
+     *                                   equal to the current size
      */
     public E remove(final int index) {
         if (index < 0 || index >= size) {
@@ -127,6 +130,21 @@ public boolean isEmpty() {
         return size == 0;
     }
 
+    /**
+     * Checks whether the array contains the specified element.
+     *
+     * @param element the element to check for
+     * @return true if the array contains the specified element, false otherwise
+     */
+    public boolean contains(final E element) {
+        for (int i = 0; i < size; i++) {
+            if (Objects.equals(elements[i], element)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     /**
      * Returns a sequential stream with this collection as its source.
      *
@@ -137,7 +155,8 @@ public Stream<E> stream() {
     }
 
     /**
-     * Ensures that the array has enough capacity to hold the specified number of elements.
+     * Ensures that the array has enough capacity to hold the specified number of
+     * elements.
      *
      * @param minCapacity the minimum capacity required
      */
@@ -150,7 +169,8 @@ private void ensureCapacity(int minCapacity) {
 
     /**
      * Removes the element at the specified index without resizing the array.
-     * This method shifts any subsequent elements to the left and clears the last element.
+     * This method shifts any subsequent elements to the left and clears the last
+     * element.
      *
      * @param index the index of the element to remove
      */
@@ -163,7 +183,8 @@ private void fastRemove(int index) {
     }
 
     /**
-     * Returns a string representation of the array, including only the elements that are currently stored.
+     * Returns a string representation of the array, including only the elements
+     * that are currently stored.
      *
      * @return a string containing the elements in the array
      */
@@ -227,7 +248,9 @@ public E next() {
         /**
          * Removes the last element returned by this iterator.
          *
-         * @throws IllegalStateException if the next method has not yet been called, or the remove method has already been called after the last call to the next method
+         * @throws IllegalStateException if the next method has not yet been called, or
+         *                               the remove method has already been called after
+         *                               the last call to the next method
          */
         @Override
         public void remove() {
@@ -242,7 +265,8 @@ public void remove() {
         /**
          * Checks for concurrent modifications to the array during iteration.
          *
-         * @throws ConcurrentModificationException if the array has been modified structurally
+         * @throws ConcurrentModificationException if the array has been modified
+         *                                         structurally
          */
         private void checkForComodification() {
             if (modCount != expectedModCount) {
@@ -251,7 +275,8 @@ private void checkForComodification() {
         }
 
         /**
-         * Performs the given action for each remaining element in the iterator until all elements have been processed.
+         * Performs the given action for each remaining element in the iterator until
+         * all elements have been processed.
          *
          * @param action the action to be performed for each element
          * @throws NullPointerException if the specified action is null

src/test/java/com/thealgorithms/datastructures/dynamicarray/DynamicArrayTest.java

@@ -255,4 +255,23 @@ public void testCapacityDoubling() {
         assertEquals(3, array.getSize());
         assertEquals("Charlie", array.get(2));
     }
+
+    @Test
+    public void testContains() {
+        DynamicArray<Integer> array = new DynamicArray<>();
+        array.add(1);
+        array.add(2);
+        array.add(3);
+
+        assertTrue(array.contains(2));
+        assertFalse(array.contains(5));
+    }
+
+    @Test
+    public void testContainsWithNull() {
+        DynamicArray<String> array = new DynamicArray<>();
+        array.add(null);
+
+        assertTrue(array.contains(null));
+    }
 }