Method generate_multi

pyfair/model/model_input.py:181–265

Generates aggregate risk data for multiple targets .. deprecated:: 0.1-alpha.1 `generate_multi()` will be removed in future versions because it was a terrible idea to begin with. This function essentially creates a small simulation for each key in the

(self, prefixed_target, count, kwargs_dict)

        return results

    def generate_multi(self, prefixed_target, count, kwargs_dict):
        """Generates aggregate risk data for multiple targets

        .. deprecated:: 0.1-alpha.1
           `generate_multi()` will be removed in future versions because
           it was a terrible idea to begin with.

        This function essentially creates a small simulation for each key
        in the dictionary. For example, with the following data:

        .. code:: python

            {
                'Reputational': {
                    'Secondary Loss Event Frequency': {'constant': 4000}, 
                    'Secondary Loss Event Magnitude': {
                        'low': 10, 'mode': 20, 'high': 100
                    },
                },
                'Legal': {
                    'Secondary Loss Event Frequency': {'constant': 2000}, 
                    'Secondary Loss Event Magnitude': {
                        'low': 10, 'mode': 20, 'high': 100
                    },   
                }
            }

        Two separate simulations for "Reputational" and "Legal" will be run
        using the information supplied. Each of these simulations will be
        composed of random values with distributions based on the
        parameters supplied. Those simulations are then calculated
        independently, and then summed to yield aggregate risk.

        .. warning:: unlike other functions, this does not take **kwargs--
           rather it takes a dictionary

        Parameters
        ----------
        prefixed_target : str
            The node for which the data is being generated (e.g. "Loss
            Event Frequency").
        count : int
            The number of random numbers generated (or alternatively, the
            length of the Series returned).
        kwargs_dict : dict
            This is an actual dictionary (and not an expanded **kwargs)
            keyword list.

        Raises
        ------
        pyfair.utility.fair_exception.FairException
            Raised if subroutine errors bubble up for reasons such as: 1)
            parameters are missing/incompatible, 2) parameters do not fall
            within proscribed value ranges, or 3) numbers supplied cannot
            be used to create meaningful distributions.

        Returns
        -------