Mandd/multipleknapsack models #17
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| # Copyright 2020, Battelle Energy Alliance, LLC | ||
| # ALL RIGHTS RESERVED | ||
| """ | ||
| Created on February 7, 2021 | ||
|
|
||
| @author: mandd | ||
| """ | ||
|
|
||
| #External Modules--------------------------------------------------------------- | ||
| import numpy as np | ||
| import math | ||
| import copy | ||
| #External Modules End----------------------------------------------------------- | ||
|
|
||
| #Internal Modules--------------------------------------------------------------- | ||
| from PluginsBaseClasses.ExternalModelPluginBase import ExternalModelPluginBase | ||
| from utils import InputData, InputTypes | ||
| #Internal Modules End----------------------------------------------------------- | ||
|
|
||
|
|
||
| class MultipleKnapsackModel(ExternalModelPluginBase): | ||
|
There was a problem hiding this comment. Can you inherit directly from BaseKnapsackModel? There was a problem hiding this comment. There is a subset of elements that are in common between these two classes. |
||
| """ | ||
| This class is designed to create the MultipleKnapsack model | ||
| """ | ||
|
|
||
| @classmethod | ||
| def getInputSpecs(cls): | ||
| """ | ||
| Collects input specifications for this class. | ||
| @ In, None | ||
| @ Out, inputSpecs, InputData, input specifications | ||
| """ | ||
| inputSpecs = InputData.parameterInputFactory('ExternalModel') | ||
| inputSpecs.addParam('name' , param_type=InputTypes.StringType, required=True) | ||
| inputSpecs.addParam('subType', param_type=InputTypes.StringType, required=True) | ||
|
|
||
| inputSpecs.addSub(InputData.parameterInputFactory('penaltyFactor', contentType=InputTypes.FloatType)) | ||
| inputSpecs.addSub(InputData.parameterInputFactory('outcome' , contentType=InputTypes.StringType)) | ||
| inputSpecs.addSub(InputData.parameterInputFactory('choiceValue' , contentType=InputTypes.StringType)) | ||
|
|
||
| knapsack = InputData.parameterInputFactory('knapsack', contentType=InputTypes.StringType) | ||
| knapsack.addParam('ID', param_type=InputTypes.StringType, required=True) | ||
| inputSpecs.addSub(knapsack) | ||
|
|
||
| mapping = InputData.parameterInputFactory('map', contentType=InputTypes.StringType) | ||
| mapping.addParam('value', param_type=InputTypes.StringType, required=True) | ||
| mapping.addParam('cost', param_type=InputTypes.StringType, required=True) | ||
| inputSpecs.addSub(mapping) | ||
|
There was a problem hiding this comment. If you inherit directly from BaseKnapsackModel, most of these lines can be removed There was a problem hiding this comment. yes, having a base class would simplify the structure of getInputSpecs and _readMoreXML methods. |
||
|
|
||
| inputSpecs.addSub(InputData.parameterInputFactory('variables', contentType=InputTypes.StringListType)) | ||
| map = InputData.parameterInputFactory('map', contentType=InputTypes.StringType) | ||
| map.addParam('value', param_type=InputTypes.StringType, required=True) | ||
| map.addParam('cost', param_type=InputTypes.StringType, required=True) | ||
| inputSpecs.addSub(map) | ||
|
|
||
| return inputSpecs | ||
|
|
||
| def __init__(self): | ||
| """ | ||
| Constructor | ||
| @ In, None | ||
| @ Out, None | ||
| """ | ||
| ExternalModelPluginBase.__init__(self) | ||
|
|
||
| self.penaltyFactor = 1.0 # penalty factor that is used when the capacity constraint is not satisfied | ||
| self.outcome = None # ID of the variable which indicates if the chosen elements satisfy the capacity constraint | ||
| self.choiceValue = None # ID of the variable which indicates the sum of the values of the chosen project elements | ||
|
|
||
| def _readMoreXML(self, container, xmlNode): | ||
| """ | ||
| Method to read the portion of the XML that belongs to the MultipleKnapsack model | ||
| @ In, container, object, self-like object where all the variables can be stored | ||
| @ In, xmlNode, xml.etree.ElementTree.Element, XML node that needs to be read | ||
| @ Out, None | ||
| """ | ||
| container.mapping = {} | ||
| self.knapsackSet = {} | ||
|
|
||
| specs = self.getInputSpecs()() | ||
| specs.parseNode(xmlNode) | ||
|
|
||
| for node in specs.subparts: | ||
| name = node.getName() | ||
| val = node.value | ||
| if name == 'penaltyFactor': | ||
| self.penaltyFactor = val | ||
| elif name == 'outcome': | ||
| self.outcome = val | ||
| elif name == 'choiceValue': | ||
| self.choiceValue = val | ||
| elif name == 'knapsack': | ||
| self.knapsackSet[node.parameterValues['ID']] = val | ||
| elif name == 'map': | ||
| container.mapping[val] = [node.parameterValues['value'],node.parameterValues['cost']] | ||
| elif name == 'variables': | ||
| variables = val | ||
| else: | ||
| raise IOError("MultipleKnapsackModel: xml node " + str(name) + " is not allowed") | ||
|
|
||
|
|
||
| def initialize(self, container, runInfoDict, inputFiles): | ||
| """ | ||
| Method to initialize the MultipleKnapsack model | ||
| @ In, container, object, self-like object where all the variables can be stored | ||
| @ In, runInfoDict, dict, dictionary containing all the RunInfo parameters (XML node <RunInfo>) | ||
| @ In, inputFiles, list, list of input files (if any) | ||
| @ Out, None | ||
| """ | ||
| pass | ||
|
|
||
|
|
||
| def run(self, container, inputDict): | ||
| """ | ||
| This method calculates the sum of the chosen element values and check if the capacity constraints | ||
| for all knapsacks are satisfied | ||
| @ In, container, object, self-like object where all the variables can be stored | ||
| @ In, inputDict, dict, dictionary of inputs from RAVEN | ||
| """ | ||
| totalValue = 0.0 | ||
| knapsackSetValues={} | ||
|
|
||
| # knapsackSetValues is a dictionary in the form {knapsackID: knapsackValue} | ||
| for knapsack in self.knapsackSet.keys(): | ||
|
There was a problem hiding this comment. check if self.knapsackSet[knapsack] in inputDict first? |
||
| if self.knapsackSet[knapsack] in inputDict.keys(): | ||
| knapsackSetValues[knapsack] = inputDict[self.knapsackSet[knapsack]][0] | ||
| else: | ||
| raise IOError("MultipleKnapsackModel: variable " + str(self.knapsackSet[knapsack]) + " has not been found in the input dataObject.") | ||
|
|
||
| # List of allowed knapsack IDs | ||
| elementAllowedValues = list(map(float, self.knapsackSet.keys())) | ||
| # Add 0.0 which implies that the element has not been assigned to any knapsack | ||
| elementAllowedValues.append(0.0) | ||
|
|
||
| numberUnsatConstraints = 0.0 | ||
|
|
||
| for key in container.mapping: | ||
| if key in inputDict.keys() and inputDict[key] in elementAllowedValues: | ||
| if inputDict[key] > 0.0: | ||
| knapsackChosen = str(int(inputDict[key][0])) | ||
| knapsackSetValues[knapsackChosen] = knapsackSetValues[knapsackChosen] - inputDict[container.mapping[key][1]][0] | ||
| if knapsackSetValues[knapsackChosen] >= 0: | ||
| totalValue = totalValue + inputDict[container.mapping[key][0]] | ||
| else: | ||
| totalValue = totalValue - inputDict[container.mapping[key][0]] * self.penaltyFactor | ||
| numberUnsatConstraints = numberUnsatConstraints + 1. | ||
| else: | ||
| raise IOError("MultipleKnapsackModel: variable " + str(key) + " is either not found in the set of input variables or its values is not allowed.") | ||
|
|
||
| if numberUnsatConstraints > 0.0 : | ||
| container.__dict__[self.outcome] = 1. | ||
| else: | ||
| container.__dict__[self.outcome] = 0. | ||
|
|
||
| container.__dict__[self.choiceValue] = totalValue | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You do not need to import BaseKnapsackModel since this model can not be directly used by RAVEN.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point fixed