jijmodeling 2.0.0a10__cp38-abi3-win_amd64.whl → 2.0.0a11__cp38-abi3-win_amd64.whl

jijmodeling/__init__.pyi

@@ -858,6 +858,33 @@ class Problem:
     - `name` (`str`): A name of the optimization problem.
     - `sense` (optional): Sense of the optimization problem. Defaults to `ProblemSense.MINIMIZE`.
     """
+    @property
+    def objective(self) -> Expression: ...
+    @property
+    def constraints(self) -> builtins.dict[builtins.str, builtins.list[Constraint]]: ...
+    @property
+    def used_placeholders(self) -> builtins.list[Placeholder]: ...
+    @property
+    def decision_vars(self) -> builtins.dict[builtins.str, DecisionVar]:
+        r"""
+        Returns a dictionary of decision variables in the problem.
+        The dictionary may contain decision variables that are not used in the problem.
+        
+        Returns
+        --------
+        `dict[str, DecisionVar]`: Dictionary mapping variable names to DecisionVar objects.
+        """
+    @property
+    def placeholders(self) -> builtins.dict[builtins.str, Placeholder]:
+        r"""
+        Returns a dictionary of placeholders in the problem.
+        The dictionary may contain placeholders that are not used in the problem;
+        to get only used placeholders, use `used_placeholders` method.
+        
+        Returns
+        --------
+        `dict[str, Placeholder]`: Dictionary mapping placeholder names to Placeholder objects.
+        """
     def __iadd__(self, other:typing.Any) -> Problem: ...
     def __repr__(self) -> builtins.str: ...
     def _repr_latex_(self) -> builtins.str: ...
@@ -1108,7 +1135,6 @@ class Problem:
         >>> instance = problem.eval(instance_data)
         ```
         """
-    def used_placeholders(self) -> builtins.list[Placeholder]: ...
     def get_problem_schema(self) -> dict:
         r"""
         Returns the schema of the problem.
@@ -1248,25 +1274,6 @@ class Problem:
         """
     def type_of(self, name:builtins.str) -> Type: ...
     def infer(self, expr:Expression | builtins.int | builtins.float | DecisionVar | Placeholder | list | tuple | typing.Callable[[Expression], typing.Any] | typing.Callable[[Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression, Expression], typing.Any]) -> Type: ...
-    def decision_vars(self) -> builtins.dict[builtins.str, DecisionVar]:
-        r"""
-        Returns a dictionary of decision variables in the problem.
-        The dictionary may contain decision variables that are not used in the problem.
-        
-        Returns
-        --------
-        `dict[str, DecisionVar]`: Dictionary mapping variable names to DecisionVar objects.
-        """
-    def placeholders(self) -> builtins.dict[builtins.str, Placeholder]:
-        r"""
-        Returns a dictionary of placeholders in the problem.
-        The dictionary may contain placeholders that are not used in the problem;
-        to get only used placeholders, use `used_placeholders` method.
-        
-        Returns
-        --------
-        `dict[str, Placeholder]`: Dictionary mapping placeholder names to Placeholder objects.
-        """
     @typing.overload
     def Constraint(self, name:builtins.str, expression:Expression | builtins.int | builtins.float | DecisionVar | Placeholder | list | tuple | typing.Callable[[Expression], typing.Any] | typing.Callable[[Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression, Expression], typing.Any], domain:typing.Callable[[Expression], typing.Any] | typing.Callable[[Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression, Expression], typing.Any], description:typing.Optional[builtins.str]=None) -> Constraint:
         r"""
@@ -1345,6 +1352,59 @@ def flat_map(func:typing.Callable[[Expression], typing.Any] | typing.Callable[[E
 
 def floor(expr:Expression | builtins.int | builtins.float | DecisionVar | Placeholder | list | tuple | typing.Callable[[Expression], typing.Any] | typing.Callable[[Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression, Expression], typing.Any]) -> Expression: ...
 
+def is_same(src:typing.Any, dst:typing.Any) -> builtins.bool:
+    r"""
+    Return `true` if `src` and `dst` are the same object defined by Jijmodeling.
+    
+    
+    Args
+    -----
+    - `src`: An object defined by Jijmodeling module, or an iterable of Jijmodeling objects.
+    - `dst`: An object defined by Jijmodeling module, or an iterable of Jijmodeling objects.
+    
+    Returns
+    --------
+    `bool`: `true` if `src` and `dst` is the same object. Otherwise `false`.
+    
+    Examples
+    ---------
+    Check if the two placeholders are the same.
+    
+    ```python
+    >>> import jijmodeling as jm
+    >>> problem = jm.Problem("problem")
+    >>> a = problem.Placeholder("name")
+    >>> b = problem.Placeholder("name")
+    >>> assert jm.is_same(a, b)
+    >>> c = problem.Placeholder("name", ndim=2)
+    >>> assert not jm.is_same(a, c) # the value of `ndim` is different
+    ```
+    
+    Raises
+    -------
+    `TypeError`: Raises if
+    - `src` and `dst` are of different types which are not iterable
+    - called on a type not defined by Jijmodeling (e.g. `str`)
+    
+    Note
+    -----
+    This function does not check the following attributes:
+    - `description`
+    - `latex`
+    
+    For example,
+    
+    ```python
+    >>> import jijmodeling as jm
+    >>> problem = jm.Problem("problem")
+    >>> src = problem.Placeholder("placeholder", latex="src")
+    >>> dst = problem.Placeholder("placeholder", latex="dst")
+    >>> assert jm.is_same(src, dst)
+    ```
+    
+    this code works without any exception.
+    """
+
 def ln(expr:Expression | builtins.int | builtins.float | DecisionVar | Placeholder | list | tuple | typing.Callable[[Expression], typing.Any] | typing.Callable[[Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression, Expression], typing.Any]) -> Expression: ...
 
 def log10(expr:Expression | builtins.int | builtins.float | DecisionVar | Placeholder | list | tuple | typing.Callable[[Expression], typing.Any] | typing.Callable[[Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression], typing.Any] | typing.Callable[[Expression, Expression, Expression, Expression, Expression], typing.Any]) -> Expression: ...

{jijmodeling-2.0.0a10.dist-info → jijmodeling-2.0.0a11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jijmodeling
-Version: 2.0.0a10
+Version: 2.0.0a11
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS
@@ -21,6 +21,7 @@ Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: orjson>=3.8.0,<4.0.0
 Requires-Dist: ommx>=2.0.0,<3.0.0
+Requires-Dist: typing-extensions
 License-File: LICENSE.txt
 Summary: Mathematical modeling tool for optimization problem
 Author: Jij Inc.

jijmodeling-2.0.0a11.dist-info/RECORD

@@ -0,0 +1,9 @@
+jijmodeling-2.0.0a11.dist-info/METADATA,sha256=uuJyImUudg3CLo4qm4SNlUo3PPk5hLXSQ17PA7QhzUo,2529
+jijmodeling-2.0.0a11.dist-info/WHEEL,sha256=lvaVdaNOIbpDjZxhxQcXMmDSpIrmQUI6MiaH-nloUu8,94
+jijmodeling-2.0.0a11.dist-info/licenses/LICENSE.txt,sha256=yFkplSxnOyfXDNYhBo2F7XC3xIQdANn-tk9LZsDekW8,3495
+jijmodeling/__init__.py,sha256=jJ6o5wp3MPAP1uR3dqSvjaXG57t1IwcS8ojqPpZL-gU,45
+jijmodeling/__init__.pyi,sha256=8ioYgzObMHM_ArgNif8FmNmECr4R72MN1z7o9itm_iE,151703
+jijmodeling/_jijmodeling.pyd,sha256=di2OMlm4rrAR2qA24jsCi8GdmUWyfpL6Vb_5y7BNxNU,14270464
+jijmodeling/_jijmodeling.pyi,sha256=DNNHcMrqQWMefF5936RoeVtH9OEnw2kYlX_c6pZ7idU,175
+jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jijmodeling-2.0.0a11.dist-info/RECORD,,

jijmodeling-2.0.0a10.dist-info/RECORD

@@ -1,9 +0,0 @@
-jijmodeling-2.0.0a10.dist-info/METADATA,sha256=H7K1eWAPnsY1uxGaTSCIJrEAXMLMBqUBcAega1yG46w,2496
-jijmodeling-2.0.0a10.dist-info/WHEEL,sha256=lvaVdaNOIbpDjZxhxQcXMmDSpIrmQUI6MiaH-nloUu8,94
-jijmodeling-2.0.0a10.dist-info/licenses/LICENSE.txt,sha256=yFkplSxnOyfXDNYhBo2F7XC3xIQdANn-tk9LZsDekW8,3495
-jijmodeling/__init__.py,sha256=jJ6o5wp3MPAP1uR3dqSvjaXG57t1IwcS8ojqPpZL-gU,45
-jijmodeling/__init__.pyi,sha256=r4NcN9vXa4ZW70nFmf4TZ0nZDu1g1VY_sBGN1aUbxc0,149914
-jijmodeling/_jijmodeling.pyd,sha256=HsZVDVz9umhCfcjym_pybA6UQtlnHXYgv6S7XAFG9Fk,14277120
-jijmodeling/_jijmodeling.pyi,sha256=DNNHcMrqQWMefF5936RoeVtH9OEnw2kYlX_c6pZ7idU,175
-jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-jijmodeling-2.0.0a10.dist-info/RECORD,,