most-queue 2.2__tar.gz → 2.3__tar.gz

{most_queue-2.2 → most_queue-2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: most_queue
-Version: 2.2
+Version: 2.3
 Summary: Software package for calculation and simulation of queuing systems
 Project-URL: Homepage, https://github.com/xabarov/most-queue
 Author-email: Xabarov Roman <xabarov1985@gmail.com>
@@ -50,31 +50,12 @@ A Python package for simulating and analyzing queueing systems (QS) and networks
 ---
 ### Most-Queue 2.0 Release Notes
 
-New unified API for both simulation and calculation classes:
+1. New similar API for both simulation and calculation classes:
 
 ```python
-from most_queue.general.distribution_fitting import gamma_moments_by_mean_and_cv
-from most_queue.general.tables import probs_print, times_print
-from most_queue.rand_distribution import GammaDistribution
-from most_queue.sim.base import QsSim
-from most_queue.theory.fifo.mgn_takahasi import MGnCalc
+# ... initialize NUM_OF_CHANNELS and other parameters ...
 
-# initialize constatants
-NUM_OF_CHANNELS = 3
-
-ARRIVAL_RATE = 1.0
-SERVICE_TIME_CV = 1.2
-
-NUM_OF_JOBS = 300_000 # number of jobs to simulate
-
-UTILIZATION_FACTOR = 0.7
-
-# calc service time moments using gamma distribution fitting
-b1 = NUM_OF_CHANNELS * UTILIZATION_FACTOR / ARRIVAL_RATE  # average service time
-b = gamma_moments_by_mean_and_cv(b1, SERVICE_TIME_CV)
-gamma_params = GammaDistribution.get_params([b[0], b[1]]) # gamma distribution parameters
-
-# run Takahasi-Takami calc method
+# run calculation
 tt = MGnCalc(n=NUM_OF_CHANNELS)
 
 tt.set_sources(l=ARRIVAL_RATE)
@@ -90,18 +71,11 @@ qs.set_servers(gamma_params, "Gamma")
 
 sim_results = qs.run(NUM_OF_JOBS)
 
-print(f"Simulation duration: {sim_results.duration:.5f} sec")
-print(f"Calculation duration: {calc_results.duration:.5f} sec")
-
-probs_print(sim_results.p, calc_results.p, 10)
-times_print(sim_results.v, calc_results.v, False)
-times_print(sim_results.w, calc_results.w, True)
-
 ```
 
 See more examples in [tests](https://github.com/xabarov/most-queue/blob/main/tests/) and [tutorials](https://github.com/xabarov/most-queue/tree/main/tutorials/) folders.
 
-
+2. Refactored code for better readability and maintainability.
 
 ---
 

{most_queue-2.2 → most_queue-2.3}/README.md

@@ -9,31 +9,12 @@ A Python package for simulating and analyzing queueing systems (QS) and networks
 ---
 ### Most-Queue 2.0 Release Notes
 
-New unified API for both simulation and calculation classes:
+1. New similar API for both simulation and calculation classes:
 
 ```python
-from most_queue.general.distribution_fitting import gamma_moments_by_mean_and_cv
-from most_queue.general.tables import probs_print, times_print
-from most_queue.rand_distribution import GammaDistribution
-from most_queue.sim.base import QsSim
-from most_queue.theory.fifo.mgn_takahasi import MGnCalc
+# ... initialize NUM_OF_CHANNELS and other parameters ...
 
-# initialize constatants
-NUM_OF_CHANNELS = 3
-
-ARRIVAL_RATE = 1.0
-SERVICE_TIME_CV = 1.2
-
-NUM_OF_JOBS = 300_000 # number of jobs to simulate
-
-UTILIZATION_FACTOR = 0.7
-
-# calc service time moments using gamma distribution fitting
-b1 = NUM_OF_CHANNELS * UTILIZATION_FACTOR / ARRIVAL_RATE  # average service time
-b = gamma_moments_by_mean_and_cv(b1, SERVICE_TIME_CV)
-gamma_params = GammaDistribution.get_params([b[0], b[1]]) # gamma distribution parameters
-
-# run Takahasi-Takami calc method
+# run calculation
 tt = MGnCalc(n=NUM_OF_CHANNELS)
 
 tt.set_sources(l=ARRIVAL_RATE)
@@ -49,18 +30,11 @@ qs.set_servers(gamma_params, "Gamma")
 
 sim_results = qs.run(NUM_OF_JOBS)
 
-print(f"Simulation duration: {sim_results.duration:.5f} sec")
-print(f"Calculation duration: {calc_results.duration:.5f} sec")
-
-probs_print(sim_results.p, calc_results.p, 10)
-times_print(sim_results.v, calc_results.v, False)
-times_print(sim_results.w, calc_results.w, True)
-
 ```
 
 See more examples in [tests](https://github.com/xabarov/most-queue/blob/main/tests/) and [tutorials](https://github.com/xabarov/most-queue/tree/main/tutorials/) folders.
 
-
+2. Refactored code for better readability and maintainability.
 
 ---
 

{most_queue-2.2 → most_queue-2.3}/most_queue/misc/approx_cdf_make.py

@@ -4,7 +4,7 @@ import matplotlib.pyplot as plt
 import numpy as np
 from tqdm import tqdm
 
-from most_queue.distributions import GammaDistribution, H2Distribution
+from most_queue.random.distributions import GammaDistribution, H2Distribution
 
 if __name__ == "__main__":
 

{most_queue-2.2 → most_queue-2.3}/most_queue/misc/calc_v_pls.py

@@ -9,7 +9,7 @@ from functools import lru_cache
 import numpy as np
 from scipy.misc import derivative
 
-from most_queue.distributions import H2Distribution, H2Params
+from most_queue.random.distributions import H2Distribution, H2Params
 from most_queue.theory.fifo.mgn_takahasi import MGnCalc, TakahashiTakamiParams
 from most_queue.theory.utils.conv import conv_moments
 from most_queue.theory.utils.transforms import lst_exp

{most_queue-2.2 → most_queue-2.3}/most_queue/misc/flow_sum.py

@@ -5,7 +5,7 @@ Test summation of flows.
 
 import matplotlib.pyplot as plt
 
-from most_queue.distributions import GammaDistribution
+from most_queue.random.distributions import GammaDistribution
 from most_queue.sim.flow_sum import FlowSumSim
 from most_queue.theory.utils.flow_sum import SummatorNumeric
 

{most_queue-2.2 → most_queue-2.3}/most_queue/misc/run_mgn_with_h2_delay_cold_warm.py

@@ -8,7 +8,6 @@ import time
 
 import numpy as np
 
-from most_queue.distributions import GammaDistribution
 from most_queue.misc.vacations_paper_utils import (
     calc_moments_by_mean_and_cv,
     dump_stat,
@@ -16,6 +15,7 @@ from most_queue.misc.vacations_paper_utils import (
     make_plot,
     print_table,
 )
+from most_queue.random.distributions import GammaDistribution
 from most_queue.sim.vacations import VacationQueueingSystemSimulator
 from most_queue.theory.vacations.mgn_with_h2_delay_cold_warm import (
     MGnH2ServingColdWarmDelay,

{most_queue-2.2/most_queue/misc → most_queue-2.3/most_queue/misc/tests}/test_fj_delta.py

@@ -7,8 +7,8 @@ import os
 import numpy as np
 import yaml
 
-from most_queue.distributions import GammaDistribution
-from most_queue.general.tables import times_print
+from most_queue.io.tables import times_print
+from most_queue.random.distributions import GammaDistribution
 from most_queue.sim.fork_join_delta import ForkJoinSimDelta
 from most_queue.theory.fork_join.split_join import SplitJoinCalc
 

{most_queue-2.2/most_queue/misc → most_queue-2.3/most_queue/misc/tests}/test_network_opt_approx.py

@@ -4,7 +4,7 @@ Test the NetworkOptimizerWithApprox class.
 
 import numpy as np
 
-from most_queue.distributions import ExpDistribution
+from most_queue.random.distributions import ExpDistribution
 from most_queue.theory.networks.open_network import OpenNetworkCalc
 from most_queue.theory.networks.opt.transition_approx import NetworkOptimizerWithApprox
 

{most_queue-2.2/most_queue/misc → most_queue-2.3/most_queue/misc/tests}/test_network_opt_plus.py

@@ -4,7 +4,7 @@ Test the NetworkOptimizerPlus class.
 
 import numpy as np
 
-from most_queue.distributions import ExpDistribution
+from most_queue.random.distributions import ExpDistribution
 from most_queue.theory.networks.open_network import OpenNetworkCalc
 from most_queue.theory.networks.opt.transition_plus import NetworkOptimizerPlus, Strategy
 

{most_queue-2.2 → most_queue-2.3}/most_queue/misc/vacations_paper_utils.py

@@ -7,7 +7,7 @@ import math
 
 import matplotlib.pyplot as plt
 
-from most_queue.general.tables import probs_print, times_print
+from most_queue.io.tables import probs_print, times_print
 
 
 def print_table(experiments_stat):

{most_queue-2.2/most_queue → most_queue-2.3/most_queue/random}/distributions.py

@@ -4,13 +4,16 @@ Random distributions for simulation.
 """
 
 import math
+import os
 
 import numpy as np
 import scipy.special as sp
+import yaml
+from colorama import Fore, Style
 from scipy import stats
 
-from most_queue.distr_utils.base_distribution import Distribution
-from most_queue.distr_utils.distribution_fitting import (
+from most_queue.random.utils.base import Distribution
+from most_queue.random.utils.fit import (
     FittingParams,
     calc_gamma_func,
     fit_cox,
@@ -23,7 +26,7 @@ from most_queue.distr_utils.distribution_fitting import (
     fit_weibull,
     gamma_moments_by_mean_and_cv,
 )
-from most_queue.distr_utils.distribution_params import (
+from most_queue.random.utils.params import (
     Cox2Params,
     ErlangParams,
     GammaParams,
@@ -35,6 +38,41 @@ from most_queue.distr_utils.distribution_params import (
 )
 
 
+def print_supported_distributions():
+    """Prints supported distributions loaded from a YAML file."""
+    print(f"{Fore.GREEN}Supported distributions:{Style.RESET_ALL}")
+    separator = f"{Fore.BLUE}{'-' * 80}{Style.RESET_ALL}"
+
+    dist_path = os.path.join(os.path.dirname(__file__), "distributions.yaml")
+    try:
+        with open(dist_path, "r", encoding="utf-8") as file:
+            distributions = yaml.safe_load(file)
+    except FileNotFoundError:
+        print(f"{Fore.RED}Error: distributions.yaml not found.{Style.RESET_ALL}")
+        return
+    except yaml.YAMLError as e:
+        print(f"{Fore.RED}Error parsing distributions.yaml: {e}{Style.RESET_ALL}")
+        return
+
+    header = (
+        f"{separator}\n"
+        f"{Fore.CYAN}Distribution{'-':20}"
+        f"{Fore.GREEN}Kendall notation{'-':15}"
+        f"{Fore.RED}Parameters{Style.RESET_ALL}\n"
+        f"{separator}"
+    )
+    print(header)
+
+    for dist in distributions:
+        name = dist.get("name", "N/A")
+        kendall = dist.get("kendall_notation", "N/A")
+        params = dist.get("params", "N/A")
+        print(f"{Fore.MAGENTA}{name:<38}" f"{Fore.GREEN}{kendall:<19}" f"{Fore.RED}{params}{Style.RESET_ALL}")
+    print(separator)
+
+    print(f"{Fore.BLUE}See params dataclasses in most_queue.random.utils.params {Style.RESET_ALL}")
+
+
 class Weibull(Distribution):
     """
     Class for working with the Weibull distribution
@@ -1022,3 +1060,7 @@ class GammaDistribution(Distribution):
         gamma = sp.gamma(x)
         fraction = -math.pi / (x * math.sin(math.pi * x))
         return fraction / gamma
+
+
+if __name__ == "__main__":
+    print_supported_distributions()

{most_queue-2.2/most_queue/sim/utils → most_queue-2.3/most_queue/random}/distributions.yaml

@@ -6,19 +6,22 @@
   params: H2Params dataclass
 - name: Erlang
   kendall_notation: E
-  params: r, mu
+  params: ErlangParams dataclass
 - name: Cox 2nd order
   kendall_notation: C
   params: Cox2Params dataclass
 - name: Pareto
   kendall_notation: Pa
-  params: alpha, K
+  params: ParetoParams dataclass
+- name: Gamma
+  kendall_notation: G
+  params: GammaParams dataclass
 - name: Deterministic
   kendall_notation: D
   params: b
 - name: Uniform
   kendall_notation: Uniform
-  params: mean, half_interval
+  params: UniformParams dataclass
 - name: Gaussian
   kendall_notation: Norm
-  params: mean, standard_deviation
+  params: GaussianParams dataclass

most_queue-2.3/most_queue/random/utils/create.py

@@ -0,0 +1,71 @@
+"""
+Utils for distribution from random_distributions
+
+"""
+
+from most_queue.random.distributions import (
+    CoxDistribution,
+    DeterministicDistribution,
+    ErlangDistribution,
+    ExpDistribution,
+    GammaDistribution,
+    H2Distribution,
+    NormalDistribution,
+    ParetoDistribution,
+    UniformDistribution,
+)
+
+
+def create_distribution(params, kendall_notation: str, generator):
+    """Creates distribution from random_distributions
+
+    --------------------------------------------------------------------
+    Distribution                    kendall_notation    params
+    --------------------------------------------------------------------
+    Exponential                           'М'             [mu]
+    Hyperexponential of the 2nd order     'Н'         H2Params dataclass
+    Erlang                                'E'           [r, mu]
+    Cox 2nd order                         'C'         Cox2Params dataclass
+    Pareto                                'Pa'         [alpha, K]
+    Deterministic                         'D'         [b]
+    Uniform                            'Uniform'     [mean, half_interval]
+    Gaussian                             'Norm'    [mean, standard_deviation]
+
+    Args:
+        params (_type_): params of distribution.
+                         For "M": one single value "mu".
+                         For "H": H2Params
+        kendall_notation (str): like "M", "H", "E"
+        generator (_type_): random numbers generator, for ex np.random.default_rng()
+
+    Raises:
+        QsSourseSettingException: Incorrect distribution type specified
+
+    Returns:
+        _type_: distribution from random_distributions
+    """
+    dist = None
+    if kendall_notation == "M":
+        dist = ExpDistribution(params, generator=generator)
+    elif kendall_notation == "H":
+        dist = H2Distribution(params, generator=generator)
+    elif kendall_notation == "E":
+        dist = ErlangDistribution(params, generator=generator)
+    elif kendall_notation == "Gamma":
+        dist = GammaDistribution(params, generator=generator)
+    elif kendall_notation == "C":
+        dist = CoxDistribution(params, generator=generator)
+    elif kendall_notation == "Pa":
+        dist = ParetoDistribution(params, generator=generator)
+    elif kendall_notation == "Uniform":
+        dist = UniformDistribution(params, generator=generator)
+    elif kendall_notation == "Norm":
+        dist = NormalDistribution(params, generator=generator)
+    elif kendall_notation == "D":
+        dist = DeterministicDistribution(params)
+    else:
+        raise ValueError(
+            "Incorrect distribution type specified. See most_queue.random.distributions.print_supported_distributions() for list of supported distributions"
+        )
+
+    return dist

most_queue-2.2/most_queue/distr_utils/distribution_fitting.py → most_queue-2.3/most_queue/random/utils/fit.py

@@ -8,7 +8,7 @@ from dataclasses import dataclass
 
 import numpy as np
 
-from most_queue.distr_utils.distribution_params import (
+from most_queue.random.utils.params import (
     Cox2Params,
     ErlangParams,
     GammaParams,

most_queue-2.3/most_queue/random/utils/load.py

@@ -0,0 +1,100 @@
+"""
+Calculates the utilization (load factor) of the QS
+"""
+
+
+def calc_qs_load(source_kendall_notation: str, source_params, server_kendall_notation: str, server_params, n) -> float:
+    """Calculates the utilization (load factor) of the QS
+
+    Args:
+        source_kendall_notation: str,  Kendall notation of source
+        server_kendall_notation: str, Kendall notation of source
+        n (int): number of QS channels
+
+    Returns:
+        float: utilization (load factor) of the QS
+    """
+
+    l = 0
+    if source_kendall_notation == "M":
+        l = source_params
+    elif source_kendall_notation == "D":
+        l = 1.00 / source_params
+    elif source_kendall_notation == "Uniform":
+        l = 1.00 / source_params.mean
+    elif source_kendall_notation == "H":
+        y1 = source_params.p1
+        y2 = 1.0 - y1
+        mu1 = source_params.mu1
+        mu2 = source_params.mu2
+
+        f1 = y1 / mu1 + y2 / mu2
+        l = 1.0 / f1
+
+    elif source_kendall_notation == "E":
+        r = source_params.r
+        mu = source_params.mu
+        l = mu / r
+
+    elif source_kendall_notation == "Gamma":
+        mu = source_params.mu
+        alpha = source_params.alpha
+        l = mu / alpha
+
+    elif source_kendall_notation == "C":
+        y1 = source_params.p1
+        y2 = 1.0 - y1
+        mu1 = source_params.mu1
+        mu2 = source_params.mu2
+
+        f1 = y2 / mu1 + y1 * (1.0 / mu1 + 1.0 / mu2)
+        l = 1.0 / f1
+    elif source_kendall_notation == "Pa":
+        if source_params[0] < 1:
+            return None
+
+        a = source_params.alpha
+        k = source_params.K
+        f1 = a * k / (a - 1)
+        l = 1.0 / f1
+
+    b1 = 0
+    if server_kendall_notation == "M":
+        mu = server_params
+        b1 = 1.0 / mu
+    elif server_kendall_notation == "D":
+        b1 = server_params
+    elif server_kendall_notation == "Uniform":
+        b1 = server_params.mean
+
+    elif server_kendall_notation == "H":
+        y1 = server_params.p1
+        y2 = 1.0 - y1
+        mu1 = server_params.mu1
+        mu2 = server_params.mu2
+
+        b1 = y1 / mu1 + y2 / mu2
+
+    elif server_kendall_notation == "Gamma":
+        mu = server_params.mu
+        alpha = server_params.alpha
+        b1 = alpha / mu
+
+    elif server_kendall_notation == "E":
+        r = server_params.r
+        mu = server_params.mu
+        b1 = r / mu
+
+    elif server_kendall_notation == "C":
+        y1 = server_params.p1
+        y2 = 1.0 - y1
+        mu1 = server_params.mu1
+        mu2 = server_params.mu2
+
+        b1 = y2 / mu1 + y1 * (1.0 / mu1 + 1.0 / mu2)
+    elif server_kendall_notation == "Pa":
+        a = server_params.alpha
+        k = server_params.K
+        b1 = a * k / (a - 1)
+
+    return l * b1 / n

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/base.py

@@ -8,13 +8,13 @@ import numpy as np
 from colorama import Fore, Style, init
 from tqdm import tqdm
 
-from most_queue.general.results_structs import QueueResults
-from most_queue.sim.utils.distribution_utils import calc_qs_load, create_distribution
-from most_queue.sim.utils.exceptions import QsWrongQueueTypeException
+from most_queue.random.utils.create import create_distribution
+from most_queue.random.utils.load import calc_qs_load
 from most_queue.sim.utils.qs_queue import QsQueueDeque, QsQueueList
 from most_queue.sim.utils.servers import Server
 from most_queue.sim.utils.stats_update import refresh_moments_stat
 from most_queue.sim.utils.tasks import Task
+from most_queue.structs import QueueResults
 
 init()
 
@@ -69,7 +69,7 @@ class QsSim:
         elif buffer_type == "deque":
             self.queue = QsQueueDeque()
         else:
-            raise QsWrongQueueTypeException("Unknown queue type")
+            raise ValueError("Unknown queue type")
 
         self.servers = []  # service channels, list of Server's
 

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/finite_source.py

@@ -5,8 +5,8 @@ Simulating a queueing system with finite number of sources.
 import numpy as np
 from colorama import Fore, Style, init
 
+from most_queue.random.utils.create import create_distribution
 from most_queue.sim.base import QsSim, Task
-from most_queue.sim.utils.distribution_utils import create_distribution
 
 init()
 

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/flow_sum.py

@@ -7,7 +7,7 @@ import math
 
 from tqdm import tqdm
 
-from most_queue.distributions import (
+from most_queue.random.distributions import (
     ErlangDistribution,
     GammaDistribution,
     H2Distribution,

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/fork_join_delta.py

@@ -4,7 +4,7 @@ ForkJoin Queue with delta
 
 from colorama import Fore, Style, init
 
-from most_queue.distributions import GammaDistribution
+from most_queue.random.distributions import GammaDistribution
 from most_queue.sim.fork_join import ForkJoinSim
 from most_queue.sim.utils.tasks import ForkJoinTask
 from most_queue.theory.utils.conv import get_self_conv_moments

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/impatient.py

@@ -4,8 +4,8 @@ Simulation model for queueing systems with impatient tasks
 
 from colorama import Fore, Style, init
 
+from most_queue.random.utils.create import create_distribution
 from most_queue.sim.base import QsSim
-from most_queue.sim.utils.distribution_utils import create_distribution
 from most_queue.sim.utils.tasks import ImpatientTask
 
 init()

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/negative.py

@@ -7,10 +7,11 @@ from enum import Enum
 
 import numpy as np
 
-from most_queue.general.results_structs import NegativeArrivalsResults
+from most_queue.random.utils.create import create_distribution
+from most_queue.random.utils.load import calc_qs_load
 from most_queue.sim.base import QsSim
-from most_queue.sim.utils.distribution_utils import calc_qs_load, create_distribution
 from most_queue.sim.utils.stats_update import refresh_moments_stat
+from most_queue.structs import NegativeArrivalsResults
 
 
 class NegativeServiceType(Enum):

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/networks/base_network_sim.py

@@ -4,7 +4,7 @@ Base class for queueing networks simulation
 
 from abc import ABC, abstractmethod
 
-from most_queue.general.results_structs import NetworkResults, NetworkResultsPriority
+from most_queue.structs import NetworkResults, NetworkResultsPriority
 
 
 class BaseSimNetwork(ABC):

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/networks/network.py

@@ -9,7 +9,7 @@ import numpy as np
 from colorama import Fore, init
 from tqdm import tqdm
 
-from most_queue.distributions import ExpDistribution
+from most_queue.random.distributions import ExpDistribution
 from most_queue.sim.base import QsSim
 from most_queue.sim.networks.base_network_sim import BaseSimNetwork, NetworkResults
 from most_queue.sim.utils.tasks import Task

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/networks/priority_network.py

@@ -9,7 +9,7 @@ import numpy as np
 from colorama import Fore, init
 from tqdm import tqdm
 
-from most_queue.distributions import ExpDistribution
+from most_queue.random.distributions import ExpDistribution
 from most_queue.sim.networks.base_network_sim import (
     BaseSimNetworkPriority,
     NetworkResultsPriority,

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/priority.py

@@ -9,10 +9,10 @@ import numpy as np
 from colorama import Fore, Style, init
 from tqdm import tqdm
 
-from most_queue.general.results_structs import PriorityResults
-from most_queue.sim.utils.distribution_utils import create_distribution
+from most_queue.random.utils.create import create_distribution
 from most_queue.sim.utils.servers import ServerPriority
 from most_queue.sim.utils.tasks import TaskPriority
+from most_queue.structs import PriorityResults
 
 init()
 

{most_queue-2.2 → most_queue-2.3}/most_queue/sim/utils/servers.py

@@ -4,7 +4,7 @@ QS channels or servers
 
 from colorama import Fore, Style
 
-from most_queue.distributions import (
+from most_queue.random.distributions import (
     CoxDistribution,
     ErlangDistribution,
     ExpDistribution,
@@ -13,7 +13,7 @@ from most_queue.distributions import (
     NormalDistribution,
     ParetoDistribution,
 )
-from most_queue.sim.utils.distribution_utils import create_distribution
+from most_queue.random.utils.create import create_distribution
 from most_queue.sim.utils.phase import QsPhase
 from most_queue.sim.utils.tasks import Task
 from most_queue.theory.utils.conv import conv_moments