pepflow 0.1.3a1__py3-none-any.whl → 0.1.4a1__py3-none-any.whl

pepflow/scalar_test.py

@@ -0,0 +1,207 @@
+# Copyright: 2025 The PEPFlow Developers
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+from typing import Iterator
+
+import numpy as np
+import pytest
+
+from pepflow import expression_manager as exm
+from pepflow import pep as pep
+from pepflow import pep_context as pc
+from pepflow import point, scalar
+
+
+@pytest.fixture
+def pep_context() -> Iterator[pc.PEPContext]:
+    """Prepare the pep context and reset the context to None at the end."""
+    ctx = pc.PEPContext("test").set_as_current()
+    yield ctx
+    pc.set_current_context(None)
+
+
+def test_scalar_add_tag(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s1"])
+    s2 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s2"])
+
+    s_add = s1 + s2
+    assert s_add.tag == "s1+s2"
+
+    s_add = s1 + 0.1
+    assert s_add.tag == "s1+0.1"
+
+    s_radd = 0.1 + s1
+    assert s_radd.tag == "0.1+s1"
+
+    s_sub = s1 - s2
+    assert s_sub.tag == "s1-s2"
+
+    s_sub = s1 - (s2 + s1)
+    assert s_sub.tag == "s1-(s2+s1)"
+
+    s_sub = s1 - (s2 - s1)
+    assert s_sub.tag == "s1-(s2-s1)"
+
+    s_sub = s1 - 0.1
+    assert s_sub.tag == "s1-0.1"
+
+    s_rsub = 0.1 - s1
+    assert s_rsub.tag == "0.1-s1"
+
+
+def test_scalar_mul_tag(pep_context: pc.PEPContext):
+    s = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s"])
+
+    s_mul = s * 0.1
+    assert s_mul.tag == "s*0.1"
+
+    s_rmul = 0.1 * s
+    assert s_rmul.tag == "0.1*s"
+
+    s_neg = -s
+    assert s_neg.tag == "-s"
+
+    s_truediv = s / 0.1
+    assert s_truediv.tag == "1/0.1*s"
+
+
+def test_scalar_add_and_mul_tag(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s1"])
+    s2 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s2"])
+
+    s_add_mul = (s1 + s2) * 0.1
+    assert s_add_mul.tag == "(s1+s2)*0.1"
+
+    s_add_mul = s1 + s2 * 0.1
+    assert s_add_mul.tag == "s1+s2*0.1"
+
+    s_neg_add = -(s1 + s2)
+    assert s_neg_add.tag == "-(s1+s2)"
+
+    s_rmul_add = 0.1 * (s1 + s2)
+    assert s_rmul_add.tag == "0.1*(s1+s2)"
+
+
+def test_scalar_hash_different(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, eval_expression=None)
+    s2 = scalar.Scalar(is_basis=True, eval_expression=None)
+    assert s1.uid != s2.uid
+
+
+def test_scalar_tag(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, eval_expression=None)
+    s1.add_tag(tag="my_tag")
+    assert s1.tags == ["my_tag"]
+    assert s1.tag == "my_tag"
+
+
+def test_scalar_repr(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, tags=["s1"])
+    print(s1)  # it should be fine without tag
+    s1.add_tag("my_tag")
+    assert str(s1) == "my_tag"
+
+
+def test_scalar_in_a_list(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, eval_expression=None)
+    s2 = scalar.Scalar(is_basis=True, eval_expression=None)
+    s3 = scalar.Scalar(is_basis=True, eval_expression=None)
+    assert s1 in [s1, s2]
+    assert s3 not in [s1, s2]
+
+
+def test_expression_manager_on_basis_scalar(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s1"])
+    s2 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s2"])
+    pm = exm.ExpressionManager(pep_context)
+
+    np.testing.assert_allclose(pm.eval_scalar(s1).vector, np.array([1, 0]))
+    np.testing.assert_allclose(pm.eval_scalar(s2).vector, np.array([0, 1]))
+
+    s3 = scalar.Scalar(is_basis=True, eval_expression=None, tags=["s3"])  # noqa: F841
+    pm = exm.ExpressionManager(pep_context)
+
+    np.testing.assert_allclose(pm.eval_scalar(s1).vector, np.array([1, 0, 0]))
+    np.testing.assert_allclose(pm.eval_scalar(s2).vector, np.array([0, 1, 0]))
+
+
+def test_expression_manager_eval_scalar(pep_context: pc.PEPContext):
+    s1 = scalar.Scalar(is_basis=True, tags=["s1"])
+    s2 = scalar.Scalar(is_basis=True, tags=["s2"])
+    s3 = 2 * s1 + s2 / 4 + 5
+    s4 = s3 + s1
+    s5 = s4 + 5
+
+    p1 = point.Point(is_basis=True, tags=["p1"])
+    p2 = point.Point(is_basis=True, tags=["p2"])
+    s6 = p1 * p2
+
+    p3 = point.Point(is_basis=True, tags=["p3"])
+    p4 = point.Point(is_basis=True, tags=["p4"])
+    s7 = 5 * p3 * p4
+
+    s8 = s6 + s7
+
+    pm = exm.ExpressionManager(pep_context)
+
+    np.testing.assert_allclose(pm.eval_scalar(s3).vector, np.array([2, 0.25]))
+    np.testing.assert_allclose(pm.eval_scalar(s3).constant, 5)
+    np.testing.assert_allclose(pm.eval_scalar(s4).vector, np.array([3, 0.25]))
+    np.testing.assert_allclose(pm.eval_scalar(s5).vector, np.array([3, 0.25]))
+    np.testing.assert_allclose(pm.eval_scalar(s5).constant, 10)
+
+    np.testing.assert_allclose(pm.eval_point(p1).vector, np.array([1, 0, 0, 0]))
+    np.testing.assert_allclose(pm.eval_point(p2).vector, np.array([0, 1, 0, 0]))
+    np.testing.assert_allclose(pm.eval_point(p3).vector, np.array([0, 0, 1, 0]))
+    np.testing.assert_allclose(pm.eval_point(p4).vector, np.array([0, 0, 0, 1]))
+
+    np.testing.assert_allclose(
+        pm.eval_scalar(s6).matrix,
+        np.array(
+            [
+                [0.0, 0.5, 0.0, 0.0],
+                [0.5, 0.0, 0.0, 0.0],
+                [0.0, 0.0, 0.0, 0.0],
+                [0.0, 0.0, 0.0, 0.0],
+            ]
+        ),
+    )
+    np.testing.assert_allclose(
+        pm.eval_scalar(s7).matrix,
+        np.array(
+            [
+                [0.0, 0.0, 0.0, 0.0],
+                [0.0, 0.0, 0.0, 0.0],
+                [0.0, 0.0, 0.0, 2.5],
+                [0.0, 0.0, 2.5, 0.0],
+            ]
+        ),
+    )
+
+    np.testing.assert_allclose(
+        pm.eval_scalar(s8).matrix,
+        np.array(
+            [
+                [0.0, 0.5, 0.0, 0.0],
+                [0.5, 0.0, 0.0, 0.0],
+                [0.0, 0.0, 0.0, 2.5],
+                [0.0, 0.0, 2.5, 0.0],
+            ]
+        ),
+    )

pepflow/solver_test.py

@@ -27,8 +27,8 @@ from pepflow import solver as ps
 def test_cvx_solver_case1():
     pep_builder = pep.PEPBuilder()
     with pep_builder.make_context("test"):
-        p1 = pp.Point(is_basis=True)
-        s1 = pp.Scalar(is_basis=True)
+        p1 = pp.Point(is_basis=True, tags=["p1"])
+        s1 = pp.Scalar(is_basis=True, tags=["s1"])
         s2 = -(1 + p1 * p1)
         constraints = [(p1 * p1).gt(1, name="x^2 >= 1"), s1.gt(0, name="s1 > 0")]
 
@@ -50,9 +50,9 @@ def test_cvx_solver_case1():
 def test_cvx_solver_case2():
     pep_builder = pep.PEPBuilder()
     with pep_builder.make_context("test"):
-        p1 = pp.Point(is_basis=True)
-        s1 = pp.Scalar(is_basis=True)
-        s2 = -(p1 - 1) * (p1 - 2)
+        p1 = pp.Point(is_basis=True, tags=["p1"])
+        s1 = pp.Scalar(is_basis=True, tags=["s1"])
+        s2 = -p1 * p1 + 2
         constraints = [(p1 * p1).lt(1, name="x^2 <= 1"), s1.gt(0, name="s1 > 0")]
 
     solver = ps.CVXSolver(
@@ -61,10 +61,10 @@ def test_cvx_solver_case2():
         context=pep_builder.get_context("test"),
     )
 
-    # It is a simple `min_x (x-1)(x-2); s.t. x^2 <= 1` problem.
+    # It is a simple `min_x x^2-2; s.t. x^2 <= 1` problem.
     problem = solver.build_problem()
     result = problem.solve()
-    assert abs(-result) < 1e-6
+    assert abs(-result + 2) < 1e-6
 
     assert np.isclose(solver.dual_var_manager.dual_value("x^2 <= 1"), 0)
     assert solver.dual_var_manager.dual_value("s1 > 0") == 0

pepflow/utils.py

@@ -21,10 +21,15 @@ from __future__ import annotations
 
 import enum
 import numbers
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 import numpy as np
 
+if TYPE_CHECKING:
+    from pepflow.function import Function
+    from pepflow.point import Point
+    from pepflow.scalar import Scalar
+
 
 def SOP(v, w):
     """Symmetric Outer Product."""
@@ -50,3 +55,11 @@ class Comparator(enum.Enum):
 
 def is_numerical(val: Any) -> bool:
     return isinstance(val, numbers.Number)
+
+
+def parenthesize_tag(val: Point | Scalar | Function) -> str:
+    tmp_tag = val.tag
+    if not val.is_basis:
+        if val.eval_expression.op == Op.ADD or val.eval_expression.op == Op.SUB:
+            tmp_tag = f"({val.tag})"
+    return tmp_tag

{pepflow-0.1.3a1.dist-info → pepflow-0.1.4a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pepflow
-Version: 0.1.3a1
+Version: 0.1.4a1
 Summary: PEPFlow: A framework for Performance Estimation Problem (PEP) Workflow
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
@@ -53,4 +53,22 @@ We use `pytest` framework to do the test. To run all unit tests, run the followi
 pytest -s -vv pepflow
 ```
 
+### Build doc website
+
+Install the required library (one-time) and `pandoc` in order to build ipynb.
+```bash
+pip install -r docs/requirements.txt
+```
+
+To build the website, run
+```bash
+cd docs; make html
+```
+Make sure it succeeded, then examine it locally through
+```bash
+cd build/html; python -m http.server
+```
+
+
+
 

pepflow-0.1.4a1.dist-info/RECORD

@@ -0,0 +1,26 @@
+pepflow/__init__.py,sha256=xvtX_jzS-wEqjHicdWWRp-lL71VbGv3vhuvfKncRFsQ,1985
+pepflow/constants.py,sha256=t29CDRE8kw773zgKS0ZZCYGegwagaDDdLfpSaeDpK14,871
+pepflow/constraint.py,sha256=n-01dcQplvsXB7V4fceJBImbwSr-Wa9k9tE7ZcVmi3o,1153
+pepflow/constraint_test.py,sha256=6MF__r67NooqOVXHtkeOVcg_ebycMF_xI9OpFDFiV4c,2676
+pepflow/e2e_test.py,sha256=7FDFUe-TfxiJ5LN57gxO1OzdqnGHgRJe_Eoega6TpMI,2193
+pepflow/expression_manager.py,sha256=94G1PyD-W1uS72AgyeCMwDEcLWwuhdIimuZ1nXjMNJA,7680
+pepflow/expression_manager_test.py,sha256=1NmFZUoxZ3Lf0qP10uYQplWMX4-OYSAnvhiVLBXvt3U,4164
+pepflow/function.py,sha256=bhL8cVX_KctJC9JyT_fgxXM-9HjnNJ0b6SlTBkwdzOw,16305
+pepflow/function_test.py,sha256=RBBm_Z6SKD3Vd03eUAO4XPONyXXueT8w1eiRLeA4IuI,8263
+pepflow/interactive_constraint.py,sha256=mB3AQt21kIdRR0yqtvUksoELSLSoTDkMeu07ThKPerE,12757
+pepflow/pep.py,sha256=cEFhnY-81OZTJ-1rwVReIBehH4S8qF5TOHkYiy02trk,6380
+pepflow/pep_context.py,sha256=p1cN4THwH8WKQfkzp8nw8PiQMRIzhCtSd3lkZqsGBPg,4804
+pepflow/pep_context_test.py,sha256=iNbsr1PRlVBBoKpgmochmdOjpHCNDlY86NPTwSqJrt4,3392
+pepflow/pep_test.py,sha256=-diI87sk10417oBnPRgWxY6XhiKOPoK7m5-MTkmlTcw,2788
+pepflow/point.py,sha256=vSKCuivJL3zyUCnV48rfM5XpAGsVbdQ8YWdO3fKrViI,8514
+pepflow/point_test.py,sha256=vuG8GbEU9vLf-btyax0XWEgiQm5hZMxscYk8HdyKjSE,5270
+pepflow/scalar.py,sha256=8E-D5pgZCDpyEX13VwrFARo87v-HWAUs4gAD_-Ty_g8,9653
+pepflow/scalar_test.py,sha256=mzLJOtNdZd54wJir5uiaEoMtcwEWiYh9C-oRWxbeb_A,6472
+pepflow/solver.py,sha256=WzeN_IWNBs9IpE212jenhYMWFuuwH890h0vaFmJRM6I,4312
+pepflow/solver_test.py,sha256=-aCEe-oQ26xJUWR64b-CIIfFOK_pNJnMlOly2bagk68,2457
+pepflow/utils.py,sha256=Xd-DwtUoUSMw_i6xjYsOxsHmn8l3ZbYCyptXEBfoyZk,1718
+pepflow-0.1.4a1.dist-info/licenses/LICENSE,sha256=na5oVXAps-5f1hLGG4SYnwFdavQeXgYUeN-E3MxOA_s,11361
+pepflow-0.1.4a1.dist-info/METADATA,sha256=NR2LXX5TJWYrEmHVTIIiUrre_n896lnnH0ffbx74Cyc,1752
+pepflow-0.1.4a1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pepflow-0.1.4a1.dist-info/top_level.txt,sha256=0YEPCZQQa6yIAIwMumzDg4pj7AME8aXu2sXkuq8xM6M,8
+pepflow-0.1.4a1.dist-info/RECORD,,

pepflow-0.1.3a1.dist-info/RECORD

@@ -1,22 +0,0 @@
-pepflow/__init__.py,sha256=tLnOlZ1y_mIodRl5Fr5HMLPP5M7h_ad76s4in5OgiHE,1930
-pepflow/constants.py,sha256=t29CDRE8kw773zgKS0ZZCYGegwagaDDdLfpSaeDpK14,871
-pepflow/constraint.py,sha256=n-01dcQplvsXB7V4fceJBImbwSr-Wa9k9tE7ZcVmi3o,1153
-pepflow/expression_manager.py,sha256=64FbdMjcUrIqtbFZyJoxoDZ42j1bl1CeGxhJnKcGTD8,5222
-pepflow/function.py,sha256=dTEGK65JGTYyKzb7sD4TbbcfTNdDclkl4M_OJr5boXk,13423
-pepflow/function_test.py,sha256=947Jv0i7HtQ-LOi9-Hd7YsIGbX6BjnHsW3N4Q9HZE-A,4833
-pepflow/interactive_constraint.py,sha256=HMwAo80tJyCKwWKryxNGk1LAh-qlnQk5OeULLwKZUOQ,9826
-pepflow/pep.py,sha256=IKrYW6DBIekKOjGfL7rc6t1xU06VJEyL_gxj1sH_m_Q,5824
-pepflow/pep_context.py,sha256=RmEPMLqzP3o5wdqE-jGYV36STYb5ssqTaKd_ucw3VdA,4544
-pepflow/pep_context_test.py,sha256=1kFkmG56JVkmjaT9ic9byV-F9WOs9ZNQz5P1P5v5lLw,3092
-pepflow/pep_test.py,sha256=aWwP3CqXNJzQUhJqC5sNcsM83i_asJaZewpGNqC1G7M,2504
-pepflow/point.py,sha256=sVQ8txNTNvLDEAIXXgH4bBnsE66s-b5nn3Ns5Vjkp8A,7125
-pepflow/point_test.py,sha256=jwbvjfwHP_9oY7KLp4UE_uSEbAVlDTXAQjr8d0z-eME,12602
-pepflow/scalar.py,sha256=Dj-kQlXHLhQopTkleFBTanTCQImHXFjGrEJx-RJjEEA,8259
-pepflow/solver.py,sha256=WzeN_IWNBs9IpE212jenhYMWFuuwH890h0vaFmJRM6I,4312
-pepflow/solver_test.py,sha256=BC37ggL_S8NDtnq8nPwRR2xItMCYMLs-n931u7f34YE,2414
-pepflow/utils.py,sha256=tYcpOOWAieNay5Ly7v7dRll69RPYCUGMEuW-Bwp2z68,1321
-pepflow-0.1.3a1.dist-info/licenses/LICENSE,sha256=na5oVXAps-5f1hLGG4SYnwFdavQeXgYUeN-E3MxOA_s,11361
-pepflow-0.1.3a1.dist-info/METADATA,sha256=0XSqgCb63395I2lgwMPAwKbX17oHOQLsloc0utws0eQ,1436
-pepflow-0.1.3a1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pepflow-0.1.3a1.dist-info/top_level.txt,sha256=0YEPCZQQa6yIAIwMumzDg4pj7AME8aXu2sXkuq8xM6M,8
-pepflow-0.1.3a1.dist-info/RECORD,,