jijmodeling 1.4.0__cp310-cp310-manylinux_2_28_x86_64.whl → 1.5.0__cp310-cp310-manylinux_2_28_x86_64.whl

jijmodeling/dataset.pyi

@@ -6,21 +6,36 @@ from enum import Enum, auto
 @final
 class Miplib:
     r"""
-    MIPLIB dataset
+    Automatically load problems from the MIPLIB dataset.
+    
+    Warning: the whole dataset is downloaded and cached in your filesystem when
+    first used. It is quite large (~300MB download, ~600MB extracted), so the
+    time it takes to download will likely be significant. We recommend first
+    trying to use this class in a REPL to assure the dataset has been cached.
+    
+    The dataset is stored at `{data_dir}/jijmodeling/miplib`, where
+    `{data_dir}` depends on your operating system:
+    
+    |Platform| {data_dir} location                    | Example/System Default                   |
+    |:-------|:---------------------------------------|:-----------------------------------------|
+    |Linux   |`$XDG_DATA_HOME` or `$HOME/.local/share`|`/home/alice/.local/share`                |
+    |macOS   |`$HOME/Library/Application Support`     |`/Users/Alice/Library/Application Support`|
+    |Windows |`%AppData%                              |`C:\Users\Alice\AppData\Roaming`          |
+    
     
     Examples
     ---------
     ```python
     >>> import jijmodeling.dataset
     
-    Download if not cached in your filesystem. It will take several minutes.
+    Initialize the dataset. If not cached in your filesystem, this will take several minutes.
     >>> miplib = jijmodeling.dataset.Miplib()
     
-    Show names of each dataset
+    Show names of each available instance.
     >>> miplib.available_names  # doctest: +ELLIPSIS
     [...]
     
-    Dict of name to instance statistics defined in https://miplib.zib.de/statistics.html
+    Get basic statistics of a specific instance.
     >>> miplib.instance_statistics["unitcal_7"]
     {'variable': 25755, 'constraint': 48939, 'binary': 2856, 'integer': 0, 'continuous': 22899, 'non_zero': 127595}
     
@@ -34,7 +49,58 @@ class Miplib:
     def __new__(cls,verbose = ...): ...
     def load(self, name) -> Any:
         r"""
-        Load a problem from MIPLIB dataset.
+        Load a problem from the MIPLIB dataset.
+        """
+        ...
+
+
+@final
+class Qplib:
+    r"""
+    Automatically load problems from the MIPLIB dataset.
+    
+    Warning: the whole dataset is downloaded and cached in your filesystem when
+    first used. It is quite large (~700MB download, ~1.5GB extracted), so the
+    time it takes to download will likely be significant. We recommend first
+    trying to use this class in a REPL to assure the dataset has been cached.
+    
+    The dataset is stored at `{data_dir}/jijmodeling/qplib`, where
+    `{data_dir}` depends on your operating system:
+    
+    |Platform| {data_dir} location                    | Example/System Default                   |
+    |:-------|:---------------------------------------|:-----------------------------------------|
+    |Linux   |`$XDG_DATA_HOME` or `$HOME/.local/share`|`/home/alice/.local/share`                |
+    |macOS   |`$HOME/Library/Application Support`     |`/Users/Alice/Library/Application Support`|
+    |Windows |`%AppData%                              |`C:\Users\Alice\AppData\Roaming`          |
+    
+    
+    Examples
+    ---------
+    ```python
+    >>> import jijmodeling.dataset
+    
+    Initialize the dataset. If not cached in your filesystem, this will take several minutes.
+    >>> qplib = jijmodeling.dataset.Qplib()
+    
+    Show the names of each available instance.
+    >>> qplib.available_names  # doctest: +ELLIPSIS
+    [...]
+    
+    Get basic statistics of a specific instance.
+    >>> qplib.instance_statistics["QPLIB_2205"]
+    {'variables': 2884, 'constraints': 2874, 'binary': 958, 'integer': 0, 'continuous': 1926, 'non_zero': 13013}
+    
+    Load a problem instance from QPLIB.
+    >>> problem, instance_data = qplib.load("QPLIB_1976")
+    
+    ```
+    """
+    available_names: List[str]
+    instance_statistics: Any
+    def __new__(cls,verbose = ...): ...
+    def load(self, name) -> Any:
+        r"""
+        Load a problem from the QPLIB dataset.
         """
         ...
 

jijmodeling/experimental.py

@@ -6,7 +6,7 @@
 # and exposes all the components in `jijmodeling.jijmodeling.experimental`
 #
 
-from ._jijmodeling import experimental as _experimental # type: ignore
+from ._jijmodeling import experimental as _experimental  # type: ignore
 import sys
 
 for component in _experimental.__all__:

jijmodeling/experimental.pyi

@@ -74,12 +74,37 @@ class Sample:
     def __repr__(self) -> str:
         ...
 
+    def __eq__(self, other) -> bool:
+        ...
+
     def is_feasible(self, epsilon = ...) -> bool:
         ...
 
     def to_dense(self) -> Dict[str, Any]:
         ...
 
+    @staticmethod
+    def from_dict(dict) -> Any:
+        r"""
+        Converts a python dictionary into a SampleSet.
+        
+        This is intended to be used primarily with dictionaries generated by
+        the `to_dict()` method. As such sparse value maps must be represented as
+        association lists.
+        """
+        ...
+
+    def to_dict(self) -> Any:
+        r"""
+        Converts this SampleSet into a regular python dictionary.
+        
+        Note that this dictionary has a slightly different structure to better support JSON
+        serialization of the output dictionary: sparse values are stored differently. Any mapping
+        with tuples as keys is transformed into an association list of key-value pairs,
+        that is, `[(k1, v1), (k2, v2), ...]`.
+        """
+        ...
+
 
 @final
 class SampleIter:

{jijmodeling-1.4.0.dist-info → jijmodeling-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: jijmodeling
-Version: 1.4.0
+Version: 1.5.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS

jijmodeling-1.5.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+jijmodeling-1.5.0.dist-info/METADATA,sha256=CewsMGcCQUNWBa6N9JIH3vPSgSqSjuM_vU3dXQXqJTs,12760
+jijmodeling-1.5.0.dist-info/WHEEL,sha256=kcrPAlYtt3cq3KZuqMkcb7ZkQEWrpAiQckydQ7yOoHw,108
+jijmodeling-1.5.0.dist-info/license_files/LICENSE.txt,sha256=T5HdEbP5NWG8fZbvF9pofeteW3HrS30V3_LvtPUHFYM,3400
+jijmodeling/experimental.py,sha256=Of-tUY3kfpFHpjGbIcclbMenCP2BMW07me895YH7tG8,575
+jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jijmodeling/experimental.pyi,sha256=D_ejdT0zxLXqe_8sx2_8cY84OaZwacEhJuuXDLm0l0g,8288
+jijmodeling/dataset.py,sha256=S4piVIiUGJMi8MlG3kFV-8JIkzvnktAS0IdkbJ655hw,185
+jijmodeling/__init__.pyi,sha256=jOljniwoDuLFMqYyDHh-VAQT9gtXmrhtfbZnXzfsTyc,114639
+jijmodeling/dataset.pyi,sha256=x77frITd2LuKQ_kG457wyBGG-Fi5K-Ym0hKFC_CNOxw,4022
+jijmodeling/__init__.py,sha256=43DV_WzDxS0n6FseNyfJZ6oQucO31T4qqbz3bx9JMtE,44
+jijmodeling/_jijmodeling.cpython-310-x86_64-linux-gnu.so,sha256=mvNiT2KZXftjKT7C8feqvzDsIN3hZyYpv1Ow6tJmF9Y,4608576
+jijmodeling-1.5.0.dist-info/RECORD,,

{jijmodeling-1.4.0.dist-info → jijmodeling-1.5.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: maturin (1.4.0)
+Generator: maturin (1.6.0)
 Root-Is-Purelib: false
 Tag: cp310-cp310-manylinux_2_28_x86_64

jijmodeling-1.4.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-jijmodeling-1.4.0.dist-info/METADATA,sha256=hBdT6bK2QBcQF27oINPPVEAABPldLJihdNA2d5l6cVA,12760
-jijmodeling-1.4.0.dist-info/WHEEL,sha256=OlWy9toj9UMJGQNIx8YvqfHZAn_YZ80c4Ju19X8fbSY,108
-jijmodeling-1.4.0.dist-info/license_files/LICENSE.txt,sha256=T5HdEbP5NWG8fZbvF9pofeteW3HrS30V3_LvtPUHFYM,3400
-jijmodeling/dataset.py,sha256=S4piVIiUGJMi8MlG3kFV-8JIkzvnktAS0IdkbJ655hw,185
-jijmodeling/dataset.pyi,sha256=b_RsiyIWQwvlOu1TmgA2inTBV-9Yua3klQlQB5IEEc4,1116
-jijmodeling/__init__.pyi,sha256=jOljniwoDuLFMqYyDHh-VAQT9gtXmrhtfbZnXzfsTyc,114639
-jijmodeling/__init__.py,sha256=43DV_WzDxS0n6FseNyfJZ6oQucO31T4qqbz3bx9JMtE,44
-jijmodeling/experimental.py,sha256=52Hhua5YkQjLtElzorBMPKSM5WWMzoJoIBmwPXj6qjI,574
-jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-jijmodeling/experimental.pyi,sha256=LadFGzSSdP4IX1_PF1DhAIdRvdCBorLu2k1mf88rpMk,7434
-jijmodeling/_jijmodeling.cpython-310-x86_64-linux-gnu.so,sha256=AfxVvPkwk3qpLdveupy00lb89vfcwibJAWzV3qTR5pM,4538832
-jijmodeling-1.4.0.dist-info/RECORD,,