Source code for banditpylib.learners.thresholding_bandit_learner.utils

from typing import Optional, Union, List

from banditpylib.bandits import ThresholdingBandit
from banditpylib.learners import SinglePlayerLearner


class ThresholdingBanditLearner(SinglePlayerLearner):
  """Abstract class for learners playing with thresholding bandit

  :param int arm_num: number of arms
  :param Optional[str] name: alias name
  """
  def __init__(self, arm_num: int, name: Optional[str]):
    super().__init__(name)
    if arm_num < 2:
      raise ValueError('Number of arms is expected at least 2. Got %d.' %
                       arm_num)
    self.__arm_num = arm_num

  @property
  def running_environment(self) -> Union[type, List[type]]:
    return ThresholdingBandit

  @property
  def arm_num(self) -> int:
    """Number of arms"""
    return self.__arm_num