:mod:`paramonte._dfutils`
=========================

.. py:module:: paramonte._dfutils


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

Classes
~~~~~~~

.. autoapisummary::

   paramonte._dfutils.Struct



Functions
~~~~~~~~~

.. autoapisummary::

   paramonte._dfutils.nam2num
   paramonte._dfutils.getColNamesIndex
   paramonte._dfutils.getMaxLogFunc


.. py:class:: Struct


.. function:: nam2num(nameList, names)


.. function:: getColNamesIndex(dfColumns, columns=None)


.. function:: getMaxLogFunc(dataFrame, column='SampleLogFunc')

   Returns a structure with components containing the properties of the 
   input ``dataFrame``, corresponding to the mode (maximum) of the data 
   in the column of the dataFrame that is identified by ``column``. 

       **Parameters**

           dataFrame

               A Pandas dataframe containing the output sample data 
               from a ParaMonte simulation.

           column

               A string containing the name of the column of the input 
               ``dataFrame`` that contains values of the objective 
               function (or its logarithm).

       **Returns**

           maxLogFunc

               A structure with the following components:

                   idrow

                       The ID of the row of ``dataFrame`` corresponding 
                       to the mode of ``column``, 

                   value

                       The value of ``column`` at maximum, 

                   dfrow

                       The entire row of ``dataFrame`` corresponding to 
                       the mode of ``column``, 

                   state

                       The location (state) within the domain of the objective 
                       function where the maximum of ``column`` occurs.