folivo/PINA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc collector

Browse Source
This commit is contained in:
FilippoOlivo
2025-03-12 09:38:40 +01:00
committed by Nicola Demo
parent fbf6fbb9b9
commit 3ca503044e
1 changed files with 17 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
pina/collector.py
View File

@@ -8,13 +8,15 @@ from .utils import check_consistency
class Collector: class Collector:
""" """
Collector class for collecting data from the problem. Collector class for retrieving data from different conditions in the
problem.
""" """
def __init__(self, problem): def __init__(self, problem):
""" " """
Initialize the Collector class, by creating a hook between the collector Initialize the Collector class, by creating a hook between the collector
and the problem and initializing the data collections. and the problem and initializing the data collections (dictionary where
data will be stored).
:param AbstractProblem problem: The problem to collect data from. :param AbstractProblem problem: The problem to collect data from.
""" """
@@ -34,7 +36,10 @@ class Collector:
@property @property
def full(self): def full(self):
""" """
Return True if all conditions are ready. Whether all conditions are ready or not.
:return: True if all conditions are ready.
:rtype: bool
""" """
return all(self._is_conditions_ready.values()) return all(self._is_conditions_ready.values())
@@ -42,7 +47,7 @@ class Collector:
@full.setter @full.setter
def full(self, value): def full(self, value):
""" """
Set the full property of the collector. Admit only boolean values. Check the consistency of the value and set the full property.
:param bool value: The value to set the full property to. :param bool value: The value to set the full property to.
""" """
@@ -52,10 +57,9 @@ class Collector:
@property @property
def data_collections(self): def data_collections(self):
""" """
Return the data collections, created by combining together all condition Return the data collections.
in the problem.
:return: The data collections. :return: The data collections where the data is stored.
:rtype: dict :rtype: dict
""" """
@@ -64,9 +68,9 @@ class Collector:
@property @property
def problem(self): def problem(self):
""" """
Property that return the problem connected to the collector. Problem connected to the collector.
:return: The problem connected to the collector. :return: The problem from which the data is collected.
:rtype: AbstractProblem :rtype: AbstractProblem
""" """
return self._problem return self._problem
@@ -74,10 +78,9 @@ class Collector:
@problem.setter @problem.setter
def problem(self, value): def problem(self, value):
""" """
Return the problem connected to the collector. Ser the problem connected to the collector.
return: The problem connected to the collector. :param AbstractProblem value: The problem to connect to the collector.
rtype: AbstractProblem
""" """
self._problem = value self._problem = value
@@ -111,6 +114,7 @@ class Collector:
Store inside data collections the sampled data of the problem. These Store inside data collections the sampled data of the problem. These
comes from the conditions that require sampling. comes from the conditions that require sampling.
""" """
for condition_name in self.problem.conditions: for condition_name in self.problem.conditions:
condition = self.problem.conditions[condition_name] condition = self.problem.conditions[condition_name]
if not hasattr(condition, "domain"): if not hasattr(condition, "domain"):