nolhs
=====

.. py:module:: nolhs

.. autoapi-nested-parse::

   Module for generating Nearly Orthogonal Latin Hypercube Samples (NOLHS).





Module Contents
---------------

.. py:class:: NOLHS(designs: list[tuple[float, float, int]] | pathlib.Path, num_stacks: int = 1)

   Bases: :py:obj:`simopt.data_farming.data_farming_core.DesignType`


   Class to generate Nearly Orthogonal Latin Hypercube Samples (NOLHS).

   Initialize the NOLHS class.

   :param designs: A list of tuples where each
                   tuple contains (min, max, precision) for a design variable, or a Path to
                   a file containing the design config.
   :type designs: list[tuple[float, float, int]] | Path
   :param num_stacks: The number of stacks to generate. Defaults to 1.
   :type num_stacks: int, optional


   .. py:property:: num_stacks
      :type: int


      Number of stacks in the design.


   .. py:method:: design_table() -> dict[int, numpy.ndarray]

      The NOLHS design table.

      :returns:

                A dictionary mapping the number of variables to
                    the corresponding NOLHS design matrix.
      :rtype: dict[int, np.ndarray]



   .. py:method:: generate_design() -> list[list[float]]

      Generate the scaled NOLHS design as a 2D list.

      :returns: A 2D list containing the scaled design points.
      :rtype: list[list[float]]