PandasOptions
=============

.. cpp:class:: numpy::PandasOptions

   numpy C++ class.

Example
-------

.. code-block:: cpp

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

   // Use PandasOptions
   PandasOptions obj;
   // ... operations ...

Indexing / Selection
--------------------

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

   * - Signature
     - Return Type
     - Location
     - Example
   * - ``T get(const std::string& key) const``
     - T
     - df_top_level.h:182
     - :ref:`View <example-pandasoptions-get-0>`

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

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

   * - Signature
     - Return Type
     - Location
     - Example
   * - ``std::string describe(const std::string& pattern = "") const``
     - std::string
     - df_top_level.h:219
     - :ref:`View <example-pandasoptions-describe-1>`
   * - ``static PandasOptions& instance()``
     - static PandasOptions&
     - df_top_level.h:176
     - 
   * - ``std::vector<std::string> list_options() const``
     - std::vector<std::string>
     - df_top_level.h:260
     - 
   * - ``void reset(const std::string& key)``
     - void
     - df_top_level.h:207
     - :ref:`View <example-pandasoptions-reset-2>`
   * - ``void reset_all()``
     - void
     - df_top_level.h:215
     - :ref:`View <example-pandasoptions-reset_all-3>`
   * - ``void set(const std::string& key, const T& value)``
     - void
     - df_top_level.h:195
     - :ref:`View <example-pandasoptions-set-4>`


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

The following examples are extracted from the test suite.

.. _example-pandasoptions-get-0:

.. dropdown:: get (np_test_1_all.cpp:28526)
   :class-title: example-dropdown

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

            std::cout << " -> tests passed" << std::endl;
          }
      
          void np_test_indexing_mask_indices() {
            std::cout << "========= mask_indices: triangular mask indices =======================";
      
            // Get upper triangular indices for 3x3 matrix
            auto triu_idx = numpy::mask_indices(3, "triu", 0);
      
            // Should return tuple of 2 arrays
            bool passed = (std::get<0>(triu_idx).getSize() > 0);
            passed = passed && (std::get<1>(triu_idx).getSize() > 0);
            passed = passed && (std::get<0>(triu_idx).getSize() == std::get<1>(triu_idx).getSize());
      
            // Get lower triangular indices
            auto tril_idx = numpy::mask_indices(3, "tril", 0);
            passed = passed && (std::get<0>(tril_idx).getSize() > 0);
            passed = passed && (std::get<1>(tril_idx).getSize() > 0);
      
            if (!passed) {
              std::cout << "  [FAIL] : in np_test_indexing_mask_indices() : Mask indices incorrect";

.. _example-pandasoptions-describe-1:

.. dropdown:: describe (np_test_1_all.cpp:11448)
   :class-title: example-dropdown

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

          auto moment2_result = moment(normal_data, 2);
          // std::cout << "2nd moment: " << moment2_result.getElementAt({ 0 }) << std::endl;
          if (!(moment2_result.getElementAt({ 0 }) > 0)) {
              std::string description = std::string("testDistributionShapeMeasures():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(moment2_result.getElementAt({ 0 }) > 0)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }
          // std::cout << "[OK] Moment calculation\n";
      
          // Test describe
          auto desc_result = describe(normal_data);
          // std::cout << "Describe result:" << std::endl;
          // std::cout << "  nobs: " << desc_result.nobs << std::endl;
          // std::cout << "  min: " << desc_result.minmax.first << ", max: " << desc_result.minmax.second << std::endl;
          // std::cout << "  mean: " << desc_result.mean << std::endl;
          // std::cout << "  variance: " << desc_result.variance << std::endl;
          if (!(desc_result.nobs == 5)) {
              std::string description = std::string("testDistributionShapeMeasures():") + __FILE__ + ":" + std::to_string(__LINE__) + ": !(desc_result.nobs == 5)";
              std::cout << std::string("[FAIL] ") + description << std::endl;
              throw std::runtime_error(description);
          }

.. _example-pandasoptions-reset-2:

.. dropdown:: reset (np_test_2_all.cpp:22610)
   :class-title: example-dropdown

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

            // Count iterations
            size_t outer_count = 0;
            size_t total_inner_count = 0;
            for (; !outer.is_finished(); ++outer) {
              size_t inner_count = 0;
              for (; !inner.is_finished(); ++inner) {
                inner_count++;
                total_inner_count++;
              }
              outer_count++;
              inner.reset();
            }
      
            if (outer_count != 3 || total_inner_count != 12) {
              std::cout << "  [FAIL] : Iteration counts incorrect";
              throw std::runtime_error("np_test_nested_iters_basic failed");
            }
      
            std::cout << " -> tests passed" << std::endl;
          }
      

.. _example-pandasoptions-reset_all-3:

.. dropdown:: reset_all (np_test_2_all.cpp:22742)
   :class-title: example-dropdown

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

            // Reset outer
            outer.reset();
            if (outer.iteration() != 0 || outer.is_finished()) {
              std::cout << "  [FAIL] : Outer reset failed";
              throw std::runtime_error("np_test_nested_iters_reset failed");
            }
      
            // Test reset_all on NestedIters object
            ++outer;
            ++inner;
            iters.reset_all();
            if (outer.iteration() != 0 || inner.iteration() != 0) {
              std::cout << "  [FAIL] : reset_all() failed";
              throw std::runtime_error("np_test_nested_iters_reset failed");
            }
      
            std::cout << " -> tests passed" << std::endl;
          }
      
          // ============================================================================
          // VALUE ACCESS TESTS

.. _example-pandasoptions-set-4:

.. dropdown:: set (np_test_1_all.cpp:6747)
   :class-title: example-dropdown

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

          std::cout << "========= testArrayPrinting =======================";
      
          // Test 1D array printing
          std::vector<std::string> words = {"Hello", "World", "Test"};
          auto arr_1d = array<16>(words);
          // std::cout << "1D CharArray:" << std::endl;
          // arr_1d.print();
      
          // Test 2D array printing
          chararray16 arr_2d({2, 2}, "test");
          arr_2d.set({0, 0}, "A");
          arr_2d.set({0, 1}, "B");
          arr_2d.set({1, 0}, "C");
          arr_2d.set({1, 1}, "D");
      
          // std::cout << "2D CharArray:" << std::endl;
          // arr_2d.print();
      
          std::cout << " -> tests passed" << std::endl;
      }