NDIterRange
===========

.. cpp:class:: numpy::NDIterRange

   numpy C++ class.

Example
-------

.. code-block:: cpp

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

   // Use NDIterRange
   NDIterRange obj;
   // ... operations ...

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

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

   * - Signature
     - Location
     - Example
   * - ``NDIterRange(const NDArray<T>&array, boolc_order = true)``
     - NP_NDITER.H:394
     - 

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

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

   * - Signature
     - Return Type
     - Location
     - Example
   * - ``NDIter<T> begin()``
     - NDIter<T>
     - NP_NDITER.H:397
     - :ref:`View <example-nditerrange-begin-0>`
   * - ``NDIter<T> end()``
     - NDIter<T>
     - NP_NDITER.H:401
     - :ref:`View <example-nditerrange-end-1>`


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

The following examples are extracted from the test suite.

.. _example-nditerrange-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-nditerrange-end-1:

.. 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;
      }