jijmodeling 1.7.0__cp39-cp39-manylinux_2_28_x86_64.whl → 1.8.0__cp39-cp39-manylinux_2_28_x86_64.whl

jijmodeling/__init__.pyi

@@ -7,6 +7,7 @@ import typing
 from . import experimental
 from enum import Enum, auto
 
+__version__: str
 class AbsOp:
     r"""
     A class for representing the absolute value
@@ -1628,6 +1629,146 @@ class IntegerVar:
         ...
 
 
+class Interpreter:
+    r"""
+    Interpreter of the JijModeling AST
+    
+    This class is responsible for
+    
+    - Creating OMMX instance from the AST.
+      - This means this module also has responsible to register decision variable ID for each decision variables in AST.
+    - Manage instance data to be substituted into the `Placeholder`.
+    
+    Examples
+    --------
+    
+    ```python
+    >>> import jijmodeling as jm
+    >>> import numpy as np
+    
+    Create a new interpreter with scalar instance data
+    >>> interpreter = jm.Interpreter({"a": 1})
+    
+    Insert instance data after creating the interpreter
+    >>> interpreter.insert_instance_data("b", 2) # scalar
+    
+    Python list and numpy array are supported
+    >>> interpreter.insert_instance_data("c", [3, 4])
+    >>> interpreter.insert_instance_data("d", [[1, 2], [3, 4]])
+    >>> interpreter.insert_instance_data("e", np.array([3, 4]))
+    
+    JaggedArray, non-uniform multi-dimensional array is also supported
+    >>> interpreter.insert_instance_data("f", [[[1, 2]], [[3, 4, 5]], [[6]]])
+    >>> interpreter.insert_instance_data("g", jm.JaggedArray([[[1, 2]], [[3, 4, 5]], [[6]]]))
+    
+    You can get the instance data by using get_instance_data method
+    >>> interpreter.get_instance_data("a")
+    1.0
+    
+    Array are normalized to numpy array
+    >>> interpreter.get_instance_data("c")
+    array([3., 4.])
+    >>> interpreter.get_instance_data("e")
+    array([3., 4.])
+    >>> interpreter.get_instance_data("f")  # doctest: +ELLIPSIS
+    <jijmodeling.JaggedArray object at 0x...>
+    
+    ```
+    """
+    num_decision_variables: int
+    def __new__(cls,instance_data:dict): ...
+    def insert_instance_data(self, key:str, value:float | numpy.typing.NDArray[numpy.float64] | JaggedArray | typing.Sequence[float] | typing.Sequence[typing.Sequence[float]] | typing.Sequence[typing.Sequence[typing.Sequence[float]]] | typing.Sequence[typing.Sequence[typing.Sequence[typing.Sequence[float]]]]) -> None:
+        ...
+
+    def get_instance_data(self, key:str) -> float | numpy.typing.NDArray[numpy.float64] | JaggedArray:
+        ...
+
+    def instance_data(self) -> dict[str, float | numpy.typing.NDArray[numpy.float64] | JaggedArray]:
+        ...
+
+    def __str__(self) -> str:
+        ...
+
+    def get_decision_variable_by_id(self, id:int) -> typing.Any:
+        ...
+
+    def get_decision_variable_by_name(self, name,subscript = ...) -> typing.Any:
+        ...
+
+    def eval_scalar(self, expr:typing.Any) -> float:
+        ...
+
+    def eval_expr(self, expr:typing.Any) -> typing.Any:
+        ...
+
+    def eval_constraints(self, constraints:Constraint) -> list[typing.Any]:
+        ...
+
+    def eval_problem(self, problem:Problem) -> typing.Any:
+        ...
+
+
+class JaggedArray:
+    r"""
+    Jagged array, a multi-dimensional array where each element can be an array of different length.
+    
+    Examples
+    --------
+    
+    ```python
+    >>> import jijmodeling as jm
+    >>> arr = jm.JaggedArray([[[1, 2], [3, 4, 5]], [[6]]])
+    
+    # Three dimensional
+    >>> assert arr.dim == 3
+    
+    # __getitem__ works
+    >>> assert arr[0, 0, 0] == 1.0
+    >>> assert arr[0, 0, 1] == 2.0
+    >>> assert arr[0, 1, 0] == 3.0
+    >>> assert arr[0, 1, 1] == 4.0
+    >>> assert arr[0, 1, 2] == 5.0
+    >>> assert arr[1, 0, 0] == 6.0
+    
+    # out of range
+    >>> arr[0, 0, 2]
+    Traceback (most recent call last):
+     ...
+    IndexError: Invalid index
+    
+    # dimension mismatch
+    >>> arr[0, 0]
+    Traceback (most recent call last):
+     ...
+    IndexError: Invalid index
+    
+    >>> assert arr.size_at([]) == 2  # [[1, 2], [3, 4, 5]] and [[6]]
+    >>> assert arr.size_at([0]) == 2  # [1, 2] and [3, 4, 5]
+    >>> assert arr.size_at([1]) == 1  # [[6]]
+    >>> assert arr.size_at([0, 0]) == 2  # [1, 2]
+    >>> assert arr.size_at([0, 1]) == 3  # [3, 4, 5]
+    >>> assert arr.size_at([1, 0]) == 1  # [6]
+    
+    ```
+    """
+    dim: int
+    def __new__(cls,obj:typing.Any): ...
+    def __str__(self) -> str:
+        ...
+
+    def __eq__(self, other:typing.Any) -> bool:
+        ...
+
+    def get(self, index:typing.Sequence[int]) -> float:
+        ...
+
+    def __getitem__(self, index:typing.Sequence[int]) -> float:
+        ...
+
+    def size_at(self, index:typing.Sequence[int]) -> int:
+        ...
+
+
 class LessThanEqualOp:
     r"""
     A class for representing the less than equal operator
@@ -4835,6 +4976,8 @@ def sum(index:typing.Any,operand:typing.Any) -> SumOp:
 def to_protobuf(obj:Problem | Constraint | CustomPenaltyTerm | typing.Any | typing.Any) -> bytes:
     ...
 
+class InterpreterError(RuntimeError): ...
+
 class ModelingError(Exception): ...
 
 class ProtobufDeserializationError(Exception): ...

{jijmodeling-1.7.0.dist-info → jijmodeling-1.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: jijmodeling
-Version: 1.7.0
+Version: 1.8.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS
@@ -18,6 +18,7 @@ Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: orjson >=3.8.0, <4.0.0
+Requires-Dist: ommx >=1.3.2, <2.0.0
 Requires-Dist: pyright ; extra == 'test'
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: twine ; extra == 'test'

jijmodeling-1.8.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+jijmodeling-1.8.0.dist-info/METADATA,sha256=Bve7uarIabLAq5hIzgJCo29-rOPeEaUgvqNupHCtO9I,12796
+jijmodeling-1.8.0.dist-info/WHEEL,sha256=9i5QB5gaFn7L0pK6HzPVEoYAUfpRFfwJ3XQr3jRScGg,106
+jijmodeling-1.8.0.dist-info/licenses/LICENSE.txt,sha256=T5HdEbP5NWG8fZbvF9pofeteW3HrS30V3_LvtPUHFYM,3400
+jijmodeling/experimental.py,sha256=Of-tUY3kfpFHpjGbIcclbMenCP2BMW07me895YH7tG8,575
+jijmodeling/__init__.py,sha256=43DV_WzDxS0n6FseNyfJZ6oQucO31T4qqbz3bx9JMtE,44
+jijmodeling/experimental.pyi,sha256=PBGw5LutDarKtaP3HTzByjV_FPRrPvv4NAZ_XWUZuGA,9018
+jijmodeling/dataset.py,sha256=S4piVIiUGJMi8MlG3kFV-8JIkzvnktAS0IdkbJ655hw,185
+jijmodeling/dataset.pyi,sha256=LSYVLeyvQRq-Xmql8zfjavbmQwFHjU5Ir_GGyeg0q2Y,4005
+jijmodeling/__init__.pyi,sha256=rF0EcrzJLgHqm-nGBcIGcZ6mk3WM7GE7dznVuLvGci0,133990
+jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jijmodeling/_jijmodeling.cpython-39-x86_64-linux-gnu.so,sha256=7rfiGAbmmmxTeOEyy8rj1r4jmGQs_xoBv1vwWQuGqw0,9192048
+jijmodeling-1.8.0.dist-info/RECORD,,

{jijmodeling-1.7.0.dist-info → jijmodeling-1.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.7.0)
+Generator: maturin (1.7.4)
 Root-Is-Purelib: false
 Tag: cp39-cp39-manylinux_2_28_x86_64

jijmodeling-1.7.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-jijmodeling-1.7.0.dist-info/METADATA,sha256=GXVGmRgC0yD064HGoDWB9cdxKI4KsDmQFjtbUKhKid8,12760
-jijmodeling-1.7.0.dist-info/WHEEL,sha256=IddfsyIU4--xsfOAffRZMDCAUBM4BTr9kplPmq3uImI,106
-jijmodeling-1.7.0.dist-info/license_files/LICENSE.txt,sha256=T5HdEbP5NWG8fZbvF9pofeteW3HrS30V3_LvtPUHFYM,3400
-jijmodeling/dataset.py,sha256=S4piVIiUGJMi8MlG3kFV-8JIkzvnktAS0IdkbJ655hw,185
-jijmodeling/dataset.pyi,sha256=LSYVLeyvQRq-Xmql8zfjavbmQwFHjU5Ir_GGyeg0q2Y,4005
-jijmodeling/__init__.pyi,sha256=fgbL7lNuAR6f3iF0murcGspACejjxthd0y7PeHhx1do,129647
-jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-jijmodeling/__init__.py,sha256=43DV_WzDxS0n6FseNyfJZ6oQucO31T4qqbz3bx9JMtE,44
-jijmodeling/experimental.pyi,sha256=PBGw5LutDarKtaP3HTzByjV_FPRrPvv4NAZ_XWUZuGA,9018
-jijmodeling/experimental.py,sha256=Of-tUY3kfpFHpjGbIcclbMenCP2BMW07me895YH7tG8,575
-jijmodeling/_jijmodeling.cpython-39-x86_64-linux-gnu.so,sha256=JBF0jDEBQHlUMiTmX7_3PzrwtCxJ4aubQZXj3RzcG3U,4821632
-jijmodeling-1.7.0.dist-info/RECORD,,