Source code for easyvvuq.sampling.random

from .base import BaseSamplingElement, Vary

__copyright__ = """
    Copyright 2018 Robin A. Richardson, David W. Wright
    This file is part of EasyVVUQ
    EasyVVUQ is free software: you can redistribute it and/or modify
    it under the terms of the Lesser GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    EasyVVUQ is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    Lesser GNU General Public License for more details.
    You should have received a copy of the Lesser GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.
"""
__license__ = "LGPL"


class RandomSampler(BaseSamplingElement, sampler_name="random_sampler"):

    def __init__(self, vary=None, count=0, max_num=0, analysis_class=None):
        """
            Expects dict of var names, and their corresponding distributions
        """
        self.vary = Vary(vary)
        self.count = count
        self.max_num = max_num
        if analysis_class is not None:
            self.analysis_class_ = analysis_class

    def element_version(self):
        return "0.1"

    def is_finite(self):
        if self.max_num > 0:
            return True
        return False

    @property
    def analysis_class(self):
        """Return a corresponding analysis class.
        """
        if self.analysis_class_ is not None:
            return self.analysis_class_
        else:
            raise NotImplementedError

    def n_samples(self):
        """Returns the number of samples in this sampler.
        Returns
        -------
        if the user specifies maximum number of samples than return that, otherwise - error
        """
        if self.is_finite():
            return self.max_num
        else:
            raise RuntimeError("You can't get the number of samples in an infinite sampler")

    def __next__(self):

        if self.is_finite():
            if self.count >= self.max_num:
                raise StopIteration

        run_dict = {}
        for param_name, dist in self.vary.get_items():
            run_dict[param_name] = dist.sample(1)[0]

        self.count += 1
        return run_dict