PooledArray
===========

.. cpp:class:: numpy::PooledArray

   numpy C++ class.

Example
-------

.. code-block:: cpp

   #include <numpy/np_ndarray.h>
   using namespace numpy;

   // Use PooledArray
   PooledArray obj;
   // ... operations ...

Constructors
------------

.. list-table::
   :widths: 55 25 20
   :header-rows: 1

   * - Signature
     - Location
     - Example
   * - ``PooledArray(size_tsize)``
     - NP_MEMORY_POOL.H:219
     - 
   * - ``PooledArray(const PooledArray &)``
     - NP_MEMORY_POOL.H:227
     - 
   * - ``noexcept PooledArray(PooledArray &&other)``
     - NP_MEMORY_POOL.H:230
     - 

Operators
---------

.. list-table::
   :widths: 40 25 15 20
   :header-rows: 1

   * - Signature
     - Return Type
     - Location
     - Example
   * - ``PooledArray & operator=(const PooledArray &)``
     - PooledArray &
     - NP_MEMORY_POOL.H:228
     - 
   * - ``PooledArray & noexcept operator=(PooledArray &&other)``
     - PooledArray & noexcept
     - NP_MEMORY_POOL.H:236
     - 
   * - ``T & operator[](size_tindex)``
     - T &
     - NP_MEMORY_POOL.H:253
     - 
   * - ``const T & operator[](size_tindex)``
     - const T &
     - NP_MEMORY_POOL.H:254
     - 

Other Methods
-------------

.. list-table::
   :widths: 40 20 15 25
   :header-rows: 1

   * - Signature
     - Return Type
     - Location
     - Example
   * - ``T \* begin()``
     - T \*
     - NP_MEMORY_POOL.H:256
     - :ref:`View <example-pooledarray-begin-0>`
   * - ``const T \* begin()``
     - const T \*
     - NP_MEMORY_POOL.H:258
     - :ref:`View <example-pooledarray-begin-1>`
   * - ``T \* data()``
     - T \*
     - NP_MEMORY_POOL.H:249
     - :ref:`View <example-pooledarray-data-2>`
   * - ``const T \* data()``
     - const T \*
     - NP_MEMORY_POOL.H:250
     - :ref:`View <example-pooledarray-data-3>`
   * - ``T \* end()``
     - T \*
     - NP_MEMORY_POOL.H:257
     - :ref:`View <example-pooledarray-end-4>`
   * - ``const T \* end()``
     - const T \*
     - NP_MEMORY_POOL.H:259
     - :ref:`View <example-pooledarray-end-5>`
   * - ``size_t size()``
     - size_t
     - NP_MEMORY_POOL.H:251
     - :ref:`View <example-pooledarray-size-6>`


Code Examples
-------------

The following examples are extracted from the test suite.

.. _example-pooledarray-begin-0:

.. dropdown:: begin (np_test_1_all.cpp:6171)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 6161
      :emphasize-lines: 11

          // Test sorted data generation
          std::vector<int> data = gen.generate(50, DataPattern::SORTED);
      
          if (!(data.size() == 50)) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(data.size() == 50)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // Verify data is sorted
          if (!(std::is_sorted(data.begin(), data.end()))) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(std::is_sorted(data.begin(), data.end()))";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // std::cout << "Sorted data generation test passed" << std::endl;
      
          std::cout << " -> tests passed" << std::endl;
      }
      

.. _example-pooledarray-begin-1:

.. dropdown:: begin (np_test_1_all.cpp:6171)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 6161
      :emphasize-lines: 11

          // Test sorted data generation
          std::vector<int> data = gen.generate(50, DataPattern::SORTED);
      
          if (!(data.size() == 50)) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(data.size() == 50)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // Verify data is sorted
          if (!(std::is_sorted(data.begin(), data.end()))) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(std::is_sorted(data.begin(), data.end()))";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // std::cout << "Sorted data generation test passed" << std::endl;
      
          std::cout << " -> tests passed" << std::endl;
      }
      

.. _example-pooledarray-data-2:

.. dropdown:: data (np_test_1_all.cpp:2084)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 2074
      :emphasize-lines: 11

          }
          if (!(derived_ptr->extra == 2)) {
              std::string description = std::string("testObjectHolderEdgeCases():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(derived_ptr->extra == 2)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // Test 6: Large object handling
          struct LargeObject {
              std::vector<double> data;
              LargeObject() : data(10000, 3.14159) {}  // Large object
          };
      
          LargeObject large;
          object_ large_obj(large);  // Should handle large objects
          if (!(!large_obj.is_null())) {
              std::string description = std::string("testObjectHolderEdgeCases():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(!large_obj.is_null())";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
          if (!(large_obj.is_type<LargeObject>())) {

.. _example-pooledarray-data-3:

.. dropdown:: data (np_test_1_all.cpp:2084)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 2074
      :emphasize-lines: 11

          }
          if (!(derived_ptr->extra == 2)) {
              std::string description = std::string("testObjectHolderEdgeCases():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(derived_ptr->extra == 2)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // Test 6: Large object handling
          struct LargeObject {
              std::vector<double> data;
              LargeObject() : data(10000, 3.14159) {}  // Large object
          };
      
          LargeObject large;
          object_ large_obj(large);  // Should handle large objects
          if (!(!large_obj.is_null())) {
              std::string description = std::string("testObjectHolderEdgeCases():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(!large_obj.is_null())";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
          if (!(large_obj.is_type<LargeObject>())) {

.. _example-pooledarray-end-4:

.. dropdown:: end (np_test_1_all.cpp:6171)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 6161
      :emphasize-lines: 11

          // Test sorted data generation
          std::vector<int> data = gen.generate(50, DataPattern::SORTED);
      
          if (!(data.size() == 50)) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(data.size() == 50)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // Verify data is sorted
          if (!(std::is_sorted(data.begin(), data.end()))) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(std::is_sorted(data.begin(), data.end()))";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // std::cout << "Sorted data generation test passed" << std::endl;
      
          std::cout << " -> tests passed" << std::endl;
      }
      

.. _example-pooledarray-end-5:

.. dropdown:: end (np_test_1_all.cpp:6171)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 6161
      :emphasize-lines: 11

          // Test sorted data generation
          std::vector<int> data = gen.generate(50, DataPattern::SORTED);
      
          if (!(data.size() == 50)) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(data.size() == 50)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // Verify data is sorted
          if (!(std::is_sorted(data.begin(), data.end()))) {
              std::string description = std::string("test_data_generator_sortedBenchmarkSorting():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(std::is_sorted(data.begin(), data.end()))";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
      
          // std::cout << "Sorted data generation test passed" << std::endl;
      
          std::cout << " -> tests passed" << std::endl;
      }
      

.. _example-pooledarray-size-6:

.. dropdown:: size (np_test_1_all.cpp:47)
   :class-title: example-dropdown

   .. code-block:: cpp
      :linenos:
      :lineno-start: 37
      :emphasize-lines: 11

      
      using namespace numpy;
      using namespace numpy::benchmark;
      using namespace numpy::char_;
      
      // Helper functions for array comparison tests
      namespace {
          const double TOLERANCE = 1e-10;
      
          bool allTrue(const NDArray<bool>& arr) {
              std::vector<size_t> indices(arr.getShape().size(), 0);
              do {
                  if (!arr.getElementAt(indices)) {
                      return false;
                  }
              } while (incrementIndices(indices, arr.getShape()));
              return true;
          }
      
          bool allFalse(const NDArray<bool>& arr) {
              std::vector<size_t> indices(arr.getShape().size(), 0);