jijmodeling 1.0.0rc3__cp37-cp37m-macosx_10_7_x86_64.whl → 1.0.0rc4__cp37-cp37m-macosx_10_7_x86_64.whl

jijmodeling/__init__.pyi

@@ -343,8 +343,9 @@ class ArrayLength:
     
     The ArrayLength class is to refer to the number of elements of an axis in an array.
     
-    This class is not intended to be instantiated directly. Instead, you can use
-    the `len_at` method in of `Placeholder`, `Element` or `Subscript`.
+    This class is not intended to be constructed directly. Instead, we
+    recommend using the `len_at` method of `Placeholder`, `Element` or
+    `Subscript`.
     
     Attributes:
         array: A variable with `ndim >= 1`.
@@ -361,7 +362,7 @@ class ArrayLength:
         >>> a = jm.Placeholder("a", ndim=2)
         >>> N = a.len_at(0, latex="N")
     """
-    def __new__(cls):
+    def __new__(cls, array, axis, *, latex=None, description=None):
         pass
 
     def __add__(self, value, /):
@@ -1157,10 +1158,13 @@ class Element:
     - an index of product $\displaystyle \prod$ (:obj:`ProdOp`)
     - a bound variable of the universal quantifier $\forall$ (:obj:`Forall`)
     
-    It has a set that it belongs to.
-    There are two options for this set:
-    1. A half-open range, where the lower bound is included and the upper bound is excluded
-    2. A `Placeholder`, `Element`, or `Subscript` variable with `ndim` >= 1
+    Elements specify a set to which they belong. The set can be:
+    1. A half-open range, where the lower bound is included and the upper bound is excluded.
+    2. A `Placeholder`, `Element`, or `Subscript` object with `ndim` >= 1.
+    
+    Ranges are generally specified with tuples as `(start, end)`. For
+    convenience, passing a single number or scalar object as the argument is
+    interpreted as the `end` of a range starting from zero.
     
     The index operator (`[]`) of an element with `ndim >= 1` returns a :obj:`Subscript` object.
     
@@ -1178,32 +1182,43 @@ class Element:
         description (str, optional): A description of the element.
     
     Examples:
+        Note that `belong_to` is a positional argument, not a keyword
+        argument, and so does not need to be written out. This is done in some
+        of these examples for clarity.
+    
         Create an element that belongs to a half-open range.
     
         >>> import jijmodeling as jm
         >>> i = jm.Element("i", belong_to=(0,10))
     
-        If you pass an object with `ndim` as the `belong_to` argument, the set that the element belongs to is a range with a start of 0 and an end of the object.
+        If you pass a scalar as the `belong_to` argument, the set that the element belongs to is a range starting at 0 going up to that value.
     
         >>> import jijmodeling as jm
-        >>> i = jm.Element("i", belong_to=10)
+        >>> i = jm.Element("i", 10)
         >>> assert jm.is_same(i, jm.Element("i", belong_to=(0,10)))
     
+        The applies not just to numbers, but certain scalars, like `Placeholder` (with `ndim == 0`).
+    
+        >>> import jijmodeling as jm
+        >>> n = jm.Placeholder("N")
+        >>> i = jm.Element("i", n)
+        >>> assert jm.is_same(i, jm.Element("i", belong_to=(0,n)))
+    
         Create an element that belongs to a 1-dimensional placeholder.
     
         >>> import jijmodeling as jm
         >>> E = jm.Placeholder("E", ndim=1)
-        >>> e = jm.Element("e", belong_to=E)
+        >>> e = jm.Element("e", E)
     
         Create a 1-dimensional element with the index of `123`.
     
         >>> import jijmodeling as jm
         >>> a = jm.Placeholder("a", ndim=2)
-        >>> e = jm.Element("e", belong_to=a)
+        >>> e = jm.Element("e", a)
         >>> e[123]
         Element(name='e', belong_to=Placeholder(name='a', ndim=2))[NumberLit(value=123)]
     """
-    def __new__(cls, name: str, *, belong_to, latex=None, description=None):
+    def __new__(cls, name: str, belong_to, *, latex=None, description=None):
         pass
 
     def __add__(self, value, /):
@@ -1429,7 +1444,7 @@ class Evaluation:
         constraint_values (numpy.ndarray): The constraint value of each sample.
         penalty (dict[str, numpy.ndarray]): The penalty of each sample.
     """
-    def __new__(cls, energy=Ellipsis, objective=Ellipsis, constraint_violations=Ellipsis, constraint_forall=Ellipsis, constraint_values=Ellipsis, penalty=Ellipsis):
+    def __new__(cls, energy=None, objective=None, constraint_violations=None, constraint_forall=None, constraint_values=None, penalty=None):
         pass
 
     constraint_expr_values: typing.Any
@@ -2618,7 +2633,7 @@ class MeasuringTime:
         system (SystemTime): Time to measure system time.
         total (float, optional): Total time to solve the problem. Defaults to None.
     """
-    def __new__(cls, solve=Ellipsis, system=Ellipsis, total=None):
+    def __new__(cls, solve=None, system=None, total=None):
         pass
 
     @staticmethod
@@ -3924,7 +3939,7 @@ class Record:
     
     As an example, consider the following solutions:
     
-    ```python
+    ```
     {
         "x": [np.array([[0.0, 1.0, 0.0], [2.0, 0.0, 3.0]]), np.array([[1.0, 0.0, 0.0], [2.0, 3.0, 4.0]])],
         "y": [np.array([0.0, 0.0, 1.0]), np.array([0.0, 1.0, 0.0])]
@@ -3933,7 +3948,7 @@ class Record:
     
     This is a dense solution. The corresponding sparse solution is as follows:
     
-    ```python
+    ```
     {
         "x": [(([0, 1, 1], [1, 0, 2]), [1.0, 2.0, 3.0], (2, 3)), (([0, 1, 1, 1], [0, 0, 1, 2]), [1.0, 2.0, 3.0, 4.0], (2, 3))],
         "y": [(([2],), [1.0], (3,)), (([1],), [1.0], (3,))]
@@ -5074,13 +5089,29 @@ def ceil(operand):
     pass
 
 
-def extract_nodes(obj, type):
+def concatenate(sample_sets):
+    """
+    Concatenate some SampleSet objects into a single SampleSet object.
+    
+    Args:
+        sample_sets (list[SampleSet]): A list of SampleSet objects.
+    
+    Returns:
+        SampleSet: A SampleSet object which is concatenated from the given SampleSet objects.
+    
+    Note:
+        This function will be deprecated in v1.1.0.
+    """
+    pass
+
+
+def extract_nodes(obj, class_or_tuple):
     """
     Extract all nodes from the given object.
     
     Args:
         obj: An expression defined by JijModeling's module, or a `Problem`, `Constraint`, `CustomPenaltyTerm`, or a list of forall object.
-        type: A type of node to extract.
+        class_or_tuple: A type or tuple of types of nodes to be extracted.
     
     Returns:
         list: A list of nodes whose type is `type`.
@@ -5088,7 +5119,7 @@ def extract_nodes(obj, type):
     Examples:
         Extract all placeholders from the given expression.
     
-        ```python
+        ```
         >>> from itertools import zip_longest
         >>> import jijmodeling as jm
         >>> a = jm.Placeholder("a")
@@ -5097,6 +5128,22 @@ def extract_nodes(obj, type):
         >>> for actual, expect in zip_longest(jm.extract_nodes(expr, jm.Placeholder), [a, b]):
         >>>     assert jm.is_same(actual, expect)
         ```
+    
+        Extract all BinaryVar objects and Placeholder objects from the given expression.
+    
+        ```
+        >>> from itertools import zip_longest
+        >>> import jijmodeling as jm
+        >>> a = jm.Placeholder("a")
+        >>> b = jm.Placeholder("b")
+        >>> x = jm.BinaryVar("x")
+        >>> y = jm.ContinuousVar("y", lower_bound=0, upper_bound=1)
+        >>> expr = a * x + b * y + 123
+        >>> actual = jm.extract_nodes(expr, (jm.BinaryVar, jm.Placeholder))
+        >>> expect = [a, x, b, y]
+        >>> for actual, expect in zip_longest(actual, expect):
+        >>>     assert jm.is_same(actual, expect)
+        ```
     """
     pass
 
@@ -5119,7 +5166,7 @@ def extract_variables(obj):
     Examples:
         Extract all variables from a problem without duplication.
     
-        ```python
+        ```
         >>> n = jm.Placeholder("n")
         >>> i = jm.Element("i", belong_to=n)
         >>> x = jm.BinaryVar("x", shape=[10])
@@ -5182,7 +5229,7 @@ def is_dynamic_degree(expr):
     Examples:
         Check if the degree of the following expression is determined dynamically.
     
-        ```python
+        ```
         a = jm.Placeholder("a", ndim=1)
         i = jm.Element("i", belong_to=a)
         x = jm.BinaryVar("x", shape=(a.len_at(0),))
@@ -5356,7 +5403,7 @@ def max(*operands):
     Examples:
         Create the `MaxOp` object whose operands are three placeholders.
     
-        ```python
+        ```
         >>> import jijmodeling as jm
         >>> a = jm.Placeholder("a")
         >>> b = jm.Placeholder("b")
@@ -5383,7 +5430,7 @@ def min(*operands):
     Examples:
         Create the `MinOp` object whose operands are three placeholders.
     
-        ```python
+        ```
         >>> import jijmodeling as jm
         >>> a = jm.Placeholder("a")
         >>> b = jm.Placeholder("b")
@@ -5449,7 +5496,7 @@ def replace(expr, replacer):
     Examples:
         Replace a placeholder with a binary variable.
     
-        ```python
+        ```
         >>> import jijmodeling as jm
         >>> ph = jm.Placeholder("placeholder")
         >>> var = jm.BinaryVar("x")
@@ -5459,7 +5506,7 @@ def replace(expr, replacer):
     
         Replace a subscripted variable with a binary variable if it is a placeholder.
     
-        ```python
+        ```
         >>> import jijmodeling as jm
         >>> ph = jm.Placeholder("ph", ndim=2)
         >>> x = jm.BinaryVar("x", shape=(1000, 1000))

{jijmodeling-1.0.0rc3.dist-info → jijmodeling-1.0.0rc4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: jijmodeling
-Version: 1.0.0rc3
+Version: 1.0.0rc4
 Classifier: Development Status :: 4 - Beta
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS

jijmodeling-1.0.0rc4.dist-info/RECORD

@@ -0,0 +1,8 @@
+jijmodeling-1.0.0rc4.dist-info/METADATA,sha256=k_KrVejU5x94BcU1s-9xuFAXCKWlpGM4f7MfqflfgJU,2878
+jijmodeling-1.0.0rc4.dist-info/WHEEL,sha256=qfKm3Ex4-Q73NpzCeX2lZnECVLrw38pdHocMBHEF4Gs,104
+jijmodeling-1.0.0rc4.dist-info/license_files/LICENSE.txt,sha256=T5HdEbP5NWG8fZbvF9pofeteW3HrS30V3_LvtPUHFYM,3400
+jijmodeling/__init__.py,sha256=dTz5lvd2qXlLmjsXX3Pq7v2_dptMkGNTWIf37gSrvwE,127
+jijmodeling/__init__.pyi,sha256=hrTWBclMxi__j6q3vbzF8Jj1rYJEWNtOUlLNoCl4IJA,125584
+jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jijmodeling/jijmodeling.cpython-37m-darwin.so,sha256=rSj5UBv74yl9diWB1cTd63VMTzMQeoXWM8D8dgK0dWA,2023392
+jijmodeling-1.0.0rc4.dist-info/RECORD,,

jijmodeling-1.0.0rc3.dist-info/RECORD

@@ -1,8 +0,0 @@
-jijmodeling-1.0.0rc3.dist-info/METADATA,sha256=TR-E7nhEmCa15lWGog7l71SwG6gCKw_jZpSzJQrrVmQ,2878
-jijmodeling-1.0.0rc3.dist-info/WHEEL,sha256=qfKm3Ex4-Q73NpzCeX2lZnECVLrw38pdHocMBHEF4Gs,104
-jijmodeling-1.0.0rc3.dist-info/license_files/LICENSE.txt,sha256=T5HdEbP5NWG8fZbvF9pofeteW3HrS30V3_LvtPUHFYM,3400
-jijmodeling/__init__.py,sha256=dTz5lvd2qXlLmjsXX3Pq7v2_dptMkGNTWIf37gSrvwE,127
-jijmodeling/__init__.pyi,sha256=XJ4h_bi-Yl4uZO6_Q3VSdPJp_s7wfKV6FLQMMPnP27s,123911
-jijmodeling/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-jijmodeling/jijmodeling.cpython-37m-darwin.so,sha256=mmn2gDIv85GQSEFGs6Vz8JiweFdIJ3mAucolG_iFObc,2006944
-jijmodeling-1.0.0rc3.dist-info/RECORD,,