CUQIpy 1.2.0.post0.dev333__py3-none-any.whl → 1.2.0.post0.dev342__py3-none-any.whl

{CUQIpy-1.2.0.post0.dev333.dist-info → CUQIpy-1.2.0.post0.dev342.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: CUQIpy
-Version: 1.2.0.post0.dev333
+Version: 1.2.0.post0.dev342
 Summary: Computational Uncertainty Quantification for Inverse problems in Python
 Maintainer-email: "Nicolai A. B. Riis" <nabr@dtu.dk>, "Jakob S. Jørgensen" <jakj@dtu.dk>, "Amal M. Alghamdi" <amaal@dtu.dk>, Chao Zhang <chaz@dtu.dk>
-License: Apache License
+License:                                  Apache License
                                    Version 2.0, January 2004
                                 http://www.apache.org/licenses/
         

{CUQIpy-1.2.0.post0.dev333.dist-info → CUQIpy-1.2.0.post0.dev342.dist-info}/RECORD

@@ -1,6 +1,6 @@
 cuqi/__init__.py,sha256=LsGilhl-hBLEn6Glt8S_l0OJzAA1sKit_rui8h-D-p0,488
 cuqi/_messages.py,sha256=fzEBrZT2kbmfecBBPm7spVu7yHdxGARQB4QzXhJbCJ0,415
-cuqi/_version.py,sha256=qPKK2uUFBvtSRlgd2DlR8troFnOrSR3hAOTup08CdOY,510
+cuqi/_version.py,sha256=3ljcYFr3ZS-sk3bvctKBFOKTMiiZYLbPdoHP03jbCfk,510
 cuqi/config.py,sha256=wcYvz19wkeKW2EKCGIKJiTpWt5kdaxyt4imyRkvtTRA,526
 cuqi/diagnostics.py,sha256=5OrbJeqpynqRXOe5MtOKKhe7EAVdOEpHIqHnlMW9G_c,3029
 cuqi/array/__init__.py,sha256=-EeiaiWGNsE3twRS4dD814BIlfxEsNkTCZUc5gjOXb0,30
@@ -34,7 +34,9 @@ cuqi/distribution/_posterior.py,sha256=zAfL0GECxekZ2lBt1W6_LN0U_xskMwK4VNce5xAF7
 cuqi/distribution/_smoothed_laplace.py,sha256=p-1Y23mYA9omwiHGkEuv3T2mwcPAAoNlCr7T8osNkjE,2925
 cuqi/distribution/_truncated_normal.py,sha256=sZkLYgnkGOyS_3ZxY7iw6L62t-Jh6shzsweRsRepN2k,4240
 cuqi/distribution/_uniform.py,sha256=KA8yQ6ZS3nQGS4PYJ4hpDg6Eq8EQKQvPsIpYfR8fj2w,1967
-cuqi/experimental/__init__.py,sha256=vhZvyMX6rl8Y0haqCzGLPz6PSUKyu75XMQbeDHqTTrw,83
+cuqi/experimental/__init__.py,sha256=iStrmEy4ZMnGpEyd6QNlC6RK83lrS9iRkxQS0u-s8cU,105
+cuqi/experimental/algebra/__init__.py,sha256=3d4Bfx1upcHhEubNn6-Sa3WFpuksPQJif4OptcNDe_s,31
+cuqi/experimental/algebra/_ast.py,sha256=SAlqqQkW_559fyiM66S3dWgfACR7jdSZkomJm1mKix0,8698
 cuqi/experimental/mcmc/__init__.py,sha256=zSqLZmxOqQ-F94C9-gPv7g89TX1XxlrlNm071Eb167I,4487
 cuqi/experimental/mcmc/_conjugate.py,sha256=VNPQkGity0mposcqxrx4UIeXm35EvJvZED4p2stffvA,9924
 cuqi/experimental/mcmc/_conjugate_approx.py,sha256=uEnY2ea9su5ivcNagyRAwpQP2gBY98sXU7N0y5hTADo,3653
@@ -87,8 +89,8 @@ cuqi/testproblem/_testproblem.py,sha256=x769LwwRdJdzIiZkcQUGb_5-vynNTNALXWKato7s
 cuqi/utilities/__init__.py,sha256=H7xpJe2UinjZftKvE2JuXtTi4DqtkR6uIezStAXwfGg,428
 cuqi/utilities/_get_python_variable_name.py,sha256=QwlBVj2koJRA8s8pWd554p7-ElcI7HUwY32HknaR92E,1827
 cuqi/utilities/_utilities.py,sha256=Jc4knn80vLoA7kgw9FzXwKVFGaNBOXiA9kgvltZU3Ao,11777
-CUQIpy-1.2.0.post0.dev333.dist-info/LICENSE,sha256=kJWRPrtRoQoZGXyyvu50Uc91X6_0XRaVfT0YZssicys,10799
-CUQIpy-1.2.0.post0.dev333.dist-info/METADATA,sha256=01FrLb_xnRL-lDXDLU48mtTy--nELMrPyY_rX0deLUg,18496
-CUQIpy-1.2.0.post0.dev333.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-CUQIpy-1.2.0.post0.dev333.dist-info/top_level.txt,sha256=AgmgMc6TKfPPqbjV0kvAoCBN334i_Lwwojc7HE3ZwD0,5
-CUQIpy-1.2.0.post0.dev333.dist-info/RECORD,,
+CUQIpy-1.2.0.post0.dev342.dist-info/LICENSE,sha256=kJWRPrtRoQoZGXyyvu50Uc91X6_0XRaVfT0YZssicys,10799
+CUQIpy-1.2.0.post0.dev342.dist-info/METADATA,sha256=gzSVkU5NkQHKRqldZB3uQ9m1ef9_2ZFmAIt1Q0wDeYo,18529
+CUQIpy-1.2.0.post0.dev342.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+CUQIpy-1.2.0.post0.dev342.dist-info/top_level.txt,sha256=AgmgMc6TKfPPqbjV0kvAoCBN334i_Lwwojc7HE3ZwD0,5
+CUQIpy-1.2.0.post0.dev342.dist-info/RECORD,,

{CUQIpy-1.2.0.post0.dev333.dist-info → CUQIpy-1.2.0.post0.dev342.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.5.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

cuqi/_version.py

@@ -8,11 +8,11 @@ import json
 
 version_json = '''
 {
- "date": "2024-11-20T12:41:18+0100",
+ "date": "2024-11-25T09:18:51+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "e495208f39ca278465cb4819799b22c942a1b863",
- "version": "1.2.0.post0.dev333"
+ "full-revisionid": "63395d14f6c3f964633b20200ada13b8a213da20",
+ "version": "1.2.0.post0.dev342"
 }
 '''  # END VERSION_JSON
 

cuqi/experimental/__init__.py

@@ -1,2 +1,3 @@
 """ Experimental module for testing new features and ideas. """
 from . import mcmc
+from . import algebra

cuqi/experimental/algebra/__init__.py

@@ -0,0 +1 @@
+from ._ast import VariableNode

cuqi/experimental/algebra/_ast.py

@@ -0,0 +1,325 @@
+"""
+CUQIpy specific implementation of an abstract syntax tree (AST) for algebra on variables.
+
+The AST is used to record the operations applied to variables allowing a delayed evaluation
+of said operations when needed by traversing the tree with the __call__ method.
+
+For example, the following code
+
+    x = VariableNode('x')
+    y = VariableNode('y')
+    z = 2*x + 3*y
+
+will create the following AST:
+
+z = AddNode(
+        MultiplyNode(
+            ValueNode(2),
+            VariableNode('x')
+        ),
+        MultiplyNode(
+            ValueNode(3),
+            VariableNode('y')
+        )
+    )
+
+which can be evaluated by calling the __call__ method:
+
+    z(x=1, y=2) # returns 8
+
+"""
+
+from abc import ABC, abstractmethod
+
+convert_to_node = lambda x: x if isinstance(x, Node) else ValueNode(x)
+""" Converts any non-Node object to a ValueNode object. """
+
+# ====== Base classes for the nodes ======
+
+
+class Node(ABC):
+    """Base class for all nodes in the abstract syntax tree.
+
+    Responsible for building the AST by creating nodes that represent the operations applied to variables.
+
+    Each subclass must implement the __call__ method that will evaluate the node given the input parameters.
+
+    """
+
+    @abstractmethod
+    def __call__(self, **kwargs):
+        """Evaluate node at a given parameter value. This will traverse the sub-tree originated at this node and evaluate it given the recorded operations."""
+        pass
+
+    @abstractmethod
+    def __repr__(self):
+        """String representation of the node. Used for printing the AST."""
+        pass
+
+    def __add__(self, other):
+        return AddNode(self, convert_to_node(other))
+
+    def __radd__(self, other):
+        return AddNode(convert_to_node(other), self)
+
+    def __sub__(self, other):
+        return SubtractNode(self, convert_to_node(other))
+
+    def __rsub__(self, other):
+        return SubtractNode(convert_to_node(other), self)
+
+    def __mul__(self, other):
+        return MultiplyNode(self, convert_to_node(other))
+
+    def __rmul__(self, other):
+        return MultiplyNode(convert_to_node(other), self)
+
+    def __truediv__(self, other):
+        return DivideNode(self, convert_to_node(other))
+
+    def __rtruediv__(self, other):
+        return DivideNode(convert_to_node(other), self)
+
+    def __pow__(self, other):
+        return PowerNode(self, convert_to_node(other))
+
+    def __rpow__(self, other):
+        return PowerNode(convert_to_node(other), self)
+
+    def __neg__(self):
+        return NegateNode(self)
+
+    def __abs__(self):
+        return AbsNode(self)
+
+    def __getitem__(self, i):
+        return GetItemNode(self, convert_to_node(i))
+
+    def __matmul__(self, other):
+        return MatMulNode(self, convert_to_node(other))
+
+    def __rmatmul__(self, other):
+        return MatMulNode(convert_to_node(other), self)
+
+
+class UnaryNode(Node, ABC):
+    """Base class for all unary nodes in the abstract syntax tree.
+
+    Parameters
+    ----------
+    child : Node
+        The direct child node on which the unary operation is performed.
+
+    """
+
+    def __init__(self, child: Node):
+        self.child = child
+
+
+class BinaryNode(Node, ABC):
+    """Base class for all binary nodes in the abstract syntax tree.
+
+    The op_symbol attribute is used for printing the operation in the __repr__ method.
+
+    Parameters
+    ----------
+    left : Node
+        Left child node to the binary operation.
+
+    right : Node
+        Right child node to the binary operation.
+
+    """
+
+    @property
+    @abstractmethod
+    def op_symbol(self):
+        """Symbol used to represent the operation in the __repr__ method."""
+        pass
+
+    def __init__(self, left: Node, right: Node):
+        self.left = left
+        self.right = right
+
+    def __repr__(self):
+        return f"{self.left} {self.op_symbol} {self.right}"
+
+
+class BinaryNodeWithParenthesis(BinaryNode, ABC):
+    """Base class for all binary nodes in the abstract syntax tree that should be printed with parenthesis."""
+
+    def __repr__(self):
+        left = f"({self.left})" if isinstance(self.left, BinaryNode) else str(self.left)
+        right = (
+            f"({self.right})" if isinstance(self.right, BinaryNode) else str(self.right)
+        )
+        return f"{left} {self.op_symbol} {right}"
+
+class BinaryNodeWithParenthesisNoSpace(BinaryNode, ABC):
+    """Base class for all binary nodes in the abstract syntax tree that should be printed with parenthesis but no space."""
+
+    def __repr__(self):
+        left = f"({self.left})" if isinstance(self.left, BinaryNode) else str(self.left)
+        right = (
+            f"({self.right})" if isinstance(self.right, BinaryNode) else str(self.right)
+        )
+        return f"{left}{self.op_symbol}{right}"
+
+
+# ====== Specific implementations of the "leaf" nodes ======
+
+
+class VariableNode(Node):
+    """Node that represents a generic variable, e.g. "x" or "y".
+
+    Parameters
+    ----------
+    name : str
+        Name of the variable. Used for printing and to retrieve the given input value
+        of the variable in the kwargs dictionary when evaluating the tree.
+
+    """
+
+    def __init__(self, name):
+        self.name = name
+
+    def __call__(self, **kwargs):
+        """Retrieves the value of the variable from the passed kwargs. If no value is found, it raises a KeyError."""
+        if not self.name in kwargs:
+            raise KeyError(
+                f"Variable '{self.name}' not found in the given input parameters. Unable to evaluate the expression."
+            )
+        return kwargs[self.name]
+
+    def __repr__(self):
+        return self.name
+
+
+class ValueNode(Node):
+    """Node that represents a constant value. The value can be any python object that is not a Node.
+
+    Parameters
+    ----------
+    value : object
+        The python object that represents the value of the node.
+
+    """
+
+    def __init__(self, value):
+        self.value = value
+
+    def __call__(self, **kwargs):
+        """Returns the value of the node."""
+        return self.value
+
+    def __repr__(self):
+        return str(self.value)
+
+
+# ====== Specific implementations of the "internal" nodes ======
+
+
+class AddNode(BinaryNode):
+    """Node that represents the addition operation."""
+
+    @property
+    def op_symbol(self):
+        return "+"
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs) + self.right(**kwargs)
+
+
+class SubtractNode(BinaryNode):
+    """Node that represents the subtraction operation."""
+
+    @property
+    def op_symbol(self):
+        return "-"
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs) - self.right(**kwargs)
+
+
+class MultiplyNode(BinaryNodeWithParenthesis):
+    """Node that represents the multiplication operation."""
+
+    @property
+    def op_symbol(self):
+        return "*"
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs) * self.right(**kwargs)
+
+
+class DivideNode(BinaryNodeWithParenthesis):
+    """Node that represents the division operation."""
+
+    @property
+    def op_symbol(self):
+        return "/"
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs) / self.right(**kwargs)
+
+
+class PowerNode(BinaryNodeWithParenthesisNoSpace):
+    """Node that represents the power operation."""
+
+    @property
+    def op_symbol(self):
+        return "^"
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs) ** self.right(**kwargs)
+
+
+class GetItemNode(BinaryNode):
+    """Node that represents the get item operation. Here the left node is the object and the right node is the index."""
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs)[self.right(**kwargs)]
+
+    def __repr__(self):
+        left = f"({self.left})" if isinstance(self.left, BinaryNode) else str(self.left)
+        return f"{left}[{self.right}]"
+    
+    @property
+    def op_symbol(self):
+        pass
+
+
+class NegateNode(UnaryNode):
+    """Node that represents the arithmetic negation operation."""
+
+    def __call__(self, **kwargs):
+        return -self.child(**kwargs)
+
+    def __repr__(self):
+        child = (
+            f"({self.child})"
+            if isinstance(self.child, (BinaryNode, UnaryNode))
+            else str(self.child)
+        )
+        return f"-{child}"
+
+
+class AbsNode(UnaryNode):
+    """Node that represents the absolute value operation."""
+
+    def __call__(self, **kwargs):
+        return abs(self.child(**kwargs))
+
+    def __repr__(self):
+        return f"abs({self.child})"
+
+
+class MatMulNode(BinaryNodeWithParenthesis):
+    """Node that represents the matrix multiplication operation."""
+
+    @property
+    def op_symbol(self):
+        return "@"
+
+    def __call__(self, **kwargs):
+        return self.left(**kwargs) @ self.right(**kwargs)