Source code for perfsim.scenario.placement_scenario

#  Copyright (C) 2020 Michel Gokan Khan
#  This program is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2 of the License, or
#  (at your option) any later version.
#
#  This program 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
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License along
#  with this program; if not, write to the Free Software Foundation, Inc.,
#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
#  This file is a part of the PerfSim project, which is now open source and available under the GPLv2.
#  Written by Michel Gokan Khan, February 2020

from typing import Dict, Literal




class PlacementScenario:
    """
    This class represents a placement scenario.
    """

    #: The algorithm used for placement.
    algorithm: str

    #: The name of the placement scenario.
    name: str

    #: The options for the placement scenario.
    options: Dict

    def __init__(self,
                 name: str,
                 algorithm: Literal["least_fit", "first_fit", "first_fit_decreasing"],
                 options: dict = None):
        self.algorithm = algorithm
        self.name = name
        self.options = options