phyelds 1.1.0__py3-none-any.whl

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Aguzzi Gianluca, Domini Davide
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

phyelds/__init__.py

@@ -0,0 +1,18 @@
+"""
+phyelds: A Python library for aggregate computing system with a pythonic interface.
+
+This library provides a set of tools for building and running aggregate computing systems.
+
+A global engine is used to manage the state and message passing between different contexts.
+In order to use it, you should:
+1. Call `engine.setup(messages, id, state)` to initialize the engine with the current context.
+2. Call an aggregate script
+3. Call `engine.cooldown()` to reset the engine state and get the messages to send.
+4. Store the state for the next iteration.
+
+"""
+
+from phyelds.internal import MutableEngine
+
+
+engine = MutableEngine()

phyelds/abstractions/__init__.py

@@ -0,0 +1,92 @@
+"""
+Engine interface: how to implement an aggregate computing engine.
+"""
+from abc import ABC
+
+
+class Engine(ABC):
+    """
+    Abstract base class for the engine. This class should be implemented by the user.
+    """
+
+    def __init__(self):
+        self.node_id = None
+
+    def setup(
+        self, node_id: int, messages: dict[int, dict[str, any]], state=None
+    ) -> None:
+        """
+        Setup the engine with the current context.
+        :param node_id:
+        :param messages: The messages to send.
+        :param state: The state of the engine.
+        """
+
+    def enter(self, name: str) -> None:
+        """
+        Enter a new context.
+        :param name: The name of the context.
+        """
+
+    def exit(self) -> None:
+        """
+        Exit the current context.
+        """
+
+    def current_path(self) -> list[str]:
+        """
+        Get the current path of the engine.
+        :return: The current path.
+        """
+
+    def write_state(self, value: any, stack: list[str]) -> None:
+        """
+        Write the state of the engine.
+        :param value: The value to write.
+        :param stack: The stack of the engine.
+        """
+
+    def read_state(self, stack: list[str]) -> any:
+        """
+        Read the state of the engine.
+        :param stack: The stack of the engine.
+        :return: The value of the state.
+        """
+
+    def state_trace(self) -> dict[str, any]:
+        """
+        Get the state trace of the engine.
+        :return: The state trace.
+        """
+
+    def forget(self, _self_path):
+        """
+        Forget the value store in the engine.
+        :param _self_path:
+        :return:
+        """
+
+    def send(self, data: any) -> None:
+        """
+        Send data to the engine.
+        :param data: The data to send.
+        """
+
+    def aligned(self) -> list[int]:
+        """
+        Get the aligned ids.
+        :return: The aligned ids.
+        """
+
+    def aligned_values(self, path: list[str]) -> dict[int, any]:
+        """
+        Get the aligned values.
+        :param path: The path of the values.
+        :return: The aligned values.
+        """
+
+    def cooldown(self) -> None:
+        """
+        Cooldown the engine.
+        :return:
+        """

phyelds/calculus/__init__.py

@@ -0,0 +1,117 @@
+"""
+Core syntax for phyelds.
+It exposes a set of functions that are used to create and manipulate fields,
+as well as to manage the state of the system.
+@aggregate is a decorator that marks a function as an aggregate function,
+Example:
+@aggregate
+def my_function():
+    # do something
+    return result
+
+Then, there is the core syntax of phyelds:
+- remember: used to remember a value across iterations.
+- neighbors: used to get the neighbors of a node.
+- neighbors_distances: used to get the distances to the neighbors.
+"""
+
+from phyelds import engine
+from phyelds.calculus.align import AlignContext
+from phyelds.data import State, Field
+
+
+def aggregate(func):
+    """
+    A decorator for aggregate functions,
+    namely each function that is called in the context of a field.
+    You can use it in the following way:
+    @aggregate
+    def my_function():
+        # do something
+        return result
+    """
+
+    def wrapper(*args, **kwargs):
+        engine.enter(func.__name__)
+        result = func(*args, **kwargs)
+        engine.exit()
+        return result
+
+    return wrapper
+
+
+@aggregate
+def remember(init):
+    """
+    One of the main operator of phyelds TODO
+    :param init:
+    :return:
+    """
+    return State(init, engine.current_path(), engine)
+
+
+@aggregate
+def neighbors(value):
+    """
+    Get the `value` of the neighbors from the current node.
+    Example:
+    neighbors(context.data["temperature"]) // returns the temperature of the neighbors
+    :param value: used to query the neighbors.
+    :return: the field representing this value
+    """
+    if isinstance(value, Field):
+        raise TypeError("Field is not supported as a value")
+    engine.send(value)
+    values = engine.aligned_values(engine.current_path())
+    values[engine.node_id] = value
+    return Field(values, engine.node_id)
+
+
+@aggregate
+def neighbors_distances(position):
+    """
+    Get the distances to the neighbors from the current node.
+    :param position: the current node position
+    :return: the field representing the distances to the neighbors
+    """
+    positions = neighbors(position)
+    x, y = position
+    distances = {}
+    for node_id, pos in positions.data.items():
+        # pos are x, y tuples
+        n_x, n_y = pos
+        distances[node_id] = ((x - n_x) ** 2 + (y - n_y) ** 2) ** 0.5
+    return Field(distances, engine.node_id)
+
+
+def align(name: str):
+    """
+    Used to align a part of the code with the current context,
+    creating different non communicating zones
+    :param name: what you would like to align on
+    :return: the context
+    """
+    return AlignContext(name)
+
+
+def align_right():
+    """
+    Typically used in if statements to align the code
+    Example:
+    if condition:
+        with align_left():
+            # do something
+    else:
+        with align_right():
+            # do something else
+    :return:
+    """
+    return align("left")
+
+
+def align_left():
+    """
+    Typically used in if statements to align the code
+    See align_right
+    """
+    return align("right")

phyelds/calculus/align.py

@@ -0,0 +1,27 @@
+"""
+Alignment context manager for phyelds.
+
+"""
+
+from phyelds import engine
+
+
+class AlignContext:
+    """
+    Context manager for alignment in phyelds.
+    This context manager is used to align the state of the engine with the
+    current context. It should be used in the following way:
+    with AlignContext("context_name"):
+        # do something
+        pass
+
+    """
+    def __init__(self, name: str):
+        self.name = name
+
+    def __enter__(self):
+        engine.enter(self.name)
+        return self
+
+    def __exit__(self, exception_type, exception_value, traceback):
+        engine.exit()

phyelds/data/__init__.py

@@ -0,0 +1,196 @@
+"""
+Internal state class used to manage the state of the system (namely `rep` of field calculus).
+"""
+
+from typing import Any, Dict, Optional, List
+import wrapt
+from phyelds.abstractions import Engine
+
+
+class Field:
+    """
+    Field class used to manage the interactions of between nodes (namely `nbr` of field calculus).
+    It provides methods to perform operations on the field, such as addition,
+    subtraction, multiplication, and division.
+    You should never use it directly, but rather use the `neighbors` function
+    """
+
+    def __init__(self, data: Dict[int, Any], node_id: int) -> None:
+        self.data = dict(sorted(data.items()))
+        self._iter_index: Optional[int] = None
+        self._iter_keys: Optional[List[int]] = None
+        self.node_id = node_id
+
+    def __iter__(self) -> "Field":
+        self._iter_index = 0
+        self._iter_keys = sorted(self.data.keys())
+        return self
+
+    def __next__(self) -> Any:
+        if self._iter_keys is None or self._iter_index is None:
+            raise StopIteration
+
+        if self._iter_index >= len(self._iter_keys):
+            self._iter_index = None
+            self._iter_keys = None
+            raise StopIteration
+
+        key = self._iter_keys[self._iter_index]
+        value = self.data[key]
+        self._iter_index += 1
+        return value
+
+    def exclude_self(self) -> dict[int, Any]:
+        """
+        Exclude the current node from the field.
+        :return:  A new Field object with the current node excluded.
+        """
+        to_return = self.data.copy()
+        to_return.pop(self.node_id, None)
+        return to_return
+
+    def local(self):
+        """
+        Get the local value of the current node.
+        :return:
+        """
+        return self.data.get(self.node_id, None)
+
+    def select(self, field) -> list:
+        """
+        Select the values from the field that are present in the current field.
+        :param field: The field to select from.
+        :return:  A list of values from the current field that are present in the given field.
+        """
+        return [
+            self.data[k] for k in self.data.keys() & field.data.keys() if field.data[k]
+        ]
+
+    # Helper method to apply binary operations
+    def _apply_binary_op(self, other, op):
+        if isinstance(other, Field):
+            return Field(
+                {
+                    k: op(self.data[k], other.data[k])
+                    for k in self.data.keys() & other.data.keys()
+                },
+                self.node_id,
+            )
+        return Field({k: op(v, other) for k, v in self.data.items()}, self.node_id)
+
+    def __add__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a + b)
+
+    def __sub__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a - b)
+
+    def __mul__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a * b)
+
+    def __truediv__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a / b)
+
+    def __mod__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a % b)
+
+    def __pow__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a**b)
+
+    def __floordiv__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a // b)
+
+    def __and__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a & b)
+
+    def __or__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a | b)
+
+    def __xor__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a ^ b)
+
+    def __invert__(self):
+        return Field({k: ~v for k, v in self.data.items()}, self.node_id)
+
+    def __lt__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a < b)
+
+    def __le__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a <= b)
+
+    def __gt__(self, other):
+        return self._apply_binary_op(other, lambda a, b: a > b)
+
+    def __str__(self):
+        """String representation of the field."""
+        return self.__repr__()
+
+    def __repr__(self):
+        """String representation of the field."""
+        return f"Field (id: {self.node_id}) -- data: {self.data} -- local: {self.local()}"
+
+
+class State(wrapt.ObjectProxy):
+    """
+    A wrapper class that delegates operations to the underlying value
+    while maintaining state management functionality.
+    """
+
+    def __init__(self, default: Any, path: List, engine: Engine):
+        self.__wrapped__ = default  # then it will be updated
+        state = engine.read_state(path)
+        if state is None:
+            value = default
+            engine.write_state(default, path)
+        else:
+            value = state
+        super().__init__(value)
+        self._self_path = list(path)
+        self._self_engine = engine
+
+    @property
+    def value(self) -> Any:
+        """Get the current value."""
+        return self.__wrapped__
+
+    def update(self, new_value: Any) -> Any:
+        """Update the stored value."""
+        if isinstance(new_value, State):
+            new_value = new_value.value
+        self._self_engine.write_state(new_value, self._self_path)
+        self.__wrapped__ = new_value
+        return self
+
+    def update_fn(self, fn: callable) -> Any:
+        """Update the stored value using a function."""
+        self.__wrapped__ = fn(self.__wrapped__)
+        self._self_engine.write_state(self.__wrapped__, self._self_path)
+        return self
+
+    def forget(self):
+        """Forget the stored value."""
+        self._self_engine.forget(self._self_path)
+        self.__wrapped__ = None
+
+    def __str__(self):
+        """String representation of the state."""
+        return str(self.__wrapped__)
+
+    def __repr__(self):
+        """String representation of the state."""
+        return f"State: {repr(self.__wrapped__)}"
+
+    def __copy__(self):
+        """Create a shallow copy of the state."""
+        return State(self.__wrapped__, self._self_path, self._self_engine)
+
+    def __deepcopy__(self, memo):
+        """Create a deep copy of the state."""
+        return self.__copy__()
+
+    def __reduce__(self):
+        """Reduce the state for pickling."""
+        return self.__wrapped__
+
+    def __reduce_ex__(self, protocol):
+        """Reduce the state for pickling."""
+        return self.__reduce__()