.. _l-methods: Methods ======= .. contents:: :local: :depth: 1 Summary +++++++ +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | method | class parent | truncated documentation | +================================================================================================================+========================+===================================================================================================================================================+ | :py:meth:`__add__ ` | WeightedArray | Addition | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__enter__ ` | WithEventProfiler | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__exit__ ` | WithEventProfiler | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__getattr__ ` | WeightedSeries | Tries first to see if class *Series* has this attribute and then tries @see cl WeightedDoubleAccessor. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | WeightedArray | Overwrites the constructor to force *dtype* to be @see cl WeightedSeriesDtype. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | WeightedDoubleAccessor | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | WeightedSeries | Overwrites the constructor to force dtype to be @see cl WeightedSeriesDtype. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | EventProfiler | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | EventProfilerDebug | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | WithEventProfiler | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__len__ ` | WeightedDoubleAccessor | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__mul__ ` | WeightedArray | Multiplication | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | WeightedSeriesDtype | usual | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__str__ ` | WeightedSeriesDtype | usual | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__sub__ ` | WeightedArray | Soustraction | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`__truediv__ ` | WeightedArray | Division | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_choose ` | EventProfiler | Returns a string which represents the called function. When the function is built-in, frame contains the function ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_choose ` | EventProfilerDebug | Returns a string which represents the called function. When the function is built-in, frame contains the function ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_choose_mod ` | EventProfiler | Returns a string which represents the module of the called function. When the function is built-in, frame contains ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_choose_mod ` | EventProfilerDebug | Returns a string which represents the module of the called function. When the function is built-in, frame contains ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_empty_cache ` | EventProfiler | Empties the cache. This function logs a couple of events. The cache must contains enough place to log them. ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_empty_cache ` | EventProfilerDebug | Empties the cache. This function logs a couple of events. The cache must contains enough place to log them. ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_new_series ` | WeightedDoubleAccessor | | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_restore_profiler ` | EventProfiler | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_restore_profiler ` | EventProfilerDebug | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_setup_profiler ` | EventProfiler | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :py:meth:`_setup_profiler ` | EventProfilerDebug | This relies on :func:`sys.setprofile` and :func:`sys.getprofile`. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`isna ` | WeightedArray | is nan? | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`isnan ` | WeightedDoubleAccessor | Tells if values are missing. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`kill ` | KThread | Kills the thread if not alreayd finished. Source: `Python-Kill-Thread-Extension `_. ... | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`log_event ` | EventProfiler | Logs an event in the database. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`log_event ` | EventProfilerDebug | Logs an event in the database. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_raw_results ` | EventProfiler | Retrieves the raw results. Difficult to interpret. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_raw_results ` | EventProfilerDebug | Retrieves the raw results. Difficult to interpret. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_results ` | EventProfiler | Retrieves the raw results. Difficult to interpret. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`retrieve_results ` | EventProfilerDebug | Retrieves the raw results. Difficult to interpret. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`start ` | EventProfiler | Starts the profiling. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`start ` | EventProfilerDebug | Starts the profiling without enabling it. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`stop ` | EventProfiler | Stops the profiling. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | :meth:`stop ` | EventProfilerDebug | Stops the unstarted profiling. | +----------------------------------------------------------------------------------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+