polish python doc
This commit is contained in:
Laurent Perron
2595
docs/python/ortools/linear_solver/pywraplp.html
Normal file
2595
docs/python/ortools/linear_solver/pywraplp.html
Normal file
File diff suppressed because it is too large
Load Diff
@@ -29,29 +29,30 @@ a:link { color: #46641e; text-decoration: none}
|
||||
<p>The following two sections describe the main
|
||||
methods for building and solving CP-SAT models.</p>
|
||||
<ul>
|
||||
<li><a href="#ortools.sat.python.cp_model.CpModel"><code>CpModel</code></a>: Methods for creating
|
||||
<li><a href="#cp_model.CpModel"><code>CpModel</code></a>: Methods for creating
|
||||
models, including variables and constraints.</li>
|
||||
<li><a href="#ortools.sat.python.cp_model.CpSolver"><code>CPSolver</code></a>: Methods for solving
|
||||
<li><a href="#cp_model.CpSolver"><code>CPSolver</code></a>: Methods for solving
|
||||
a model and evaluating solutions.</li>
|
||||
</ul>
|
||||
<p>The following methods implement callbacks that the
|
||||
solver calls each time it finds a new solution.</p>
|
||||
<ul>
|
||||
<li><a href="#cpsolversolutioncallback"><code>CpSolverSolutionCallback</code></a>: A general method for
|
||||
implementing callbacks.</li>
|
||||
<li><a href="#objectivesolutionprinter"><code>ObjectiveSolutionPrinter</code></a>: Print objective
|
||||
values and elapsed time for intermediate solutions.</li>
|
||||
<li><a href="#vararraysolutionprinter"><code>VarArraySolutionPrinter</code></a>: Print intermediate
|
||||
solutions (variable values, time).</li>
|
||||
<li><a href="#vararrayandobjectivesolutionprinter"><code>VarArrayAndObjectiveSolutionPrinter</code></a>:
|
||||
<li><a href="#cp_model.CpSolverSolutionCallback"><code>CpSolverSolutionCallback</code></a>:
|
||||
A general method for implementing callbacks.</li>
|
||||
<li><a href="#cp_model.ObjectiveSolutionPrinter"><code>ObjectiveSolutionPrinter</code></a>:
|
||||
Print objective values and elapsed time for intermediate solutions.</li>
|
||||
<li><a href="#cp_model.VarArraySolutionPrinter"><code>VarArraySolutionPrinter</code></a>:
|
||||
Print intermediate solutions (variable values, time).</li>
|
||||
<li>[<code>VarArrayAndObjectiveSolutionPrinter</code>]
|
||||
(#cp_model.VarArrayAndObjectiveSolutionPrinter):
|
||||
Print both intermediate solutions and objective values.</li>
|
||||
</ul>
|
||||
<p>Additional methods for solving CP-SAT models:</p>
|
||||
<ul>
|
||||
<li><a href="#constraint"><code>Constraint</code></a>: A few utility methods for modifying
|
||||
<li><a href="#cp_model.Constraint"><code>Constraint</code></a>: A few utility methods for modifying
|
||||
contraints created by <a title="cp_model.CpModel" href="#cp_model.CpModel"><code>CpModel</code></a>.</li>
|
||||
<li><a href="#linearexpr"><code>LinearExpr</code></a>: Methods for creating constraints and the
|
||||
objective from large arrays.</li>
|
||||
<li><a href="#lineacp_model.LinearExpr"><code>LinearExpr</code></a>: Methods for creating constraints
|
||||
and the objective from large arrays of coefficients.</li>
|
||||
</ul>
|
||||
<p>Other methods and functions listed are primarily used for developing OR-Tools,
|
||||
rather than for solving specific optimization problems.</p>
|
||||
@@ -74,29 +75,30 @@ rather than for solving specific optimization problems.</p>
|
||||
The following two sections describe the main
|
||||
methods for building and solving CP-SAT models.
|
||||
|
||||
* [`CpModel`](#ortools.sat.python.cp_model.CpModel): Methods for creating
|
||||
* [`CpModel`](#cp_model.CpModel): Methods for creating
|
||||
models, including variables and constraints.
|
||||
* [`CPSolver`](#ortools.sat.python.cp_model.CpSolver): Methods for solving
|
||||
* [`CPSolver`](#cp_model.CpSolver): Methods for solving
|
||||
a model and evaluating solutions.
|
||||
|
||||
The following methods implement callbacks that the
|
||||
solver calls each time it finds a new solution.
|
||||
|
||||
* [`CpSolverSolutionCallback`](#cpsolversolutioncallback): A general method for
|
||||
implementing callbacks.
|
||||
* [`ObjectiveSolutionPrinter`](#objectivesolutionprinter): Print objective
|
||||
values and elapsed time for intermediate solutions.
|
||||
* [`VarArraySolutionPrinter`](#vararraysolutionprinter): Print intermediate
|
||||
solutions (variable values, time).
|
||||
* [`VarArrayAndObjectiveSolutionPrinter`](#vararrayandobjectivesolutionprinter):
|
||||
* [`CpSolverSolutionCallback`](#cp_model.CpSolverSolutionCallback):
|
||||
A general method for implementing callbacks.
|
||||
* [`ObjectiveSolutionPrinter`](#cp_model.ObjectiveSolutionPrinter):
|
||||
Print objective values and elapsed time for intermediate solutions.
|
||||
* [`VarArraySolutionPrinter`](#cp_model.VarArraySolutionPrinter):
|
||||
Print intermediate solutions (variable values, time).
|
||||
* [`VarArrayAndObjectiveSolutionPrinter`]
|
||||
(#cp_model.VarArrayAndObjectiveSolutionPrinter):
|
||||
Print both intermediate solutions and objective values.
|
||||
|
||||
Additional methods for solving CP-SAT models:
|
||||
|
||||
* [`Constraint`](#constraint): A few utility methods for modifying
|
||||
* [`Constraint`](#cp_model.Constraint): A few utility methods for modifying
|
||||
contraints created by `CpModel`.
|
||||
* [`LinearExpr`](#linearexpr): Methods for creating constraints and the
|
||||
objective from large arrays.
|
||||
* [`LinearExpr`](#lineacp_model.LinearExpr): Methods for creating constraints
|
||||
and the objective from large arrays of coefficients.
|
||||
|
||||
Other methods and functions listed are primarily used for developing OR-Tools,
|
||||
rather than for solving specific optimization problems.
|
||||
@@ -120,6 +122,8 @@ from ortools.util import sorted_interval_list
|
||||
Domain = sorted_interval_list.Domain
|
||||
|
||||
# Documentation cleaning.
|
||||
# Remove the documentation of some functions.
|
||||
# See https://pdoc3.github.io/pdoc/doc/pdoc/#overriding-docstrings-with-
|
||||
__pdoc__ = {}
|
||||
__pdoc__['DisplayBounds'] = False
|
||||
__pdoc__['EvaluateLinearExpr'] = False
|
||||
|
||||
@@ -34,6 +34,8 @@ a:link { color: #46641e; text-decoration: none}
|
||||
# the SWIG interface file instead.
|
||||
|
||||
|
||||
# Remove the documentation of some functions.
|
||||
# See https://pdoc3.github.io/pdoc/doc/pdoc/#overriding-docstrings-with-
|
||||
__pdoc__ = {}
|
||||
__pdoc__['Domain_AllValues'] = False
|
||||
__pdoc__['Domain_FromFlatIntervals'] = False
|
||||
@@ -130,98 +132,65 @@ class _SwigNonDynamicMeta(type):
|
||||
|
||||
|
||||
class Domain(object):
|
||||
r""" We call "domain" any subset of Int64 = [kint64min, kint64max]. This class can be used to represent such set efficiently as a sorted and non-adjacent list of intervals. This is efficient as long as the size of such list stays reasonable. In the comments below, the domain of *this will always be written 'D'. Note that all the functions are safe with respect to integer overflow."""
|
||||
|
||||
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
|
||||
__repr__ = _swig_repr
|
||||
|
||||
def __init__(self, *args):
|
||||
r"""
|
||||
*Overload 1:*
|
||||
By default, Domain will be empty.
|
||||
|
||||
|
|
||||
|
||||
*Overload 2:*
|
||||
Constructor for the common case of a singleton domain.
|
||||
|
||||
|
|
||||
|
||||
*Overload 3:*
|
||||
Constructor for the common case of a single interval [left, right]. If left > right, this will result in the empty domain.
|
||||
"""
|
||||
_sorted_interval_list.Domain_swiginit(self, _sorted_interval_list.new_Domain(*args))
|
||||
|
||||
@staticmethod
|
||||
def AllValues() -> "operations_research::Domain":
|
||||
r""" Returns the full domain Int64."""
|
||||
return _sorted_interval_list.Domain_AllValues()
|
||||
|
||||
@staticmethod
|
||||
def FromValues(values: 'std::vector< int64 >') -> "operations_research::Domain":
|
||||
r""" Creates a domain from the union of an unsorted list of integer values. Input values may be repeated, with no consequence on the output"""
|
||||
return _sorted_interval_list.Domain_FromValues(values)
|
||||
|
||||
@staticmethod
|
||||
def FromIntervals(intervals: 'std::vector< std::vector< int64 > > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a list of intervals (long[][] in Java and .NET, [[0, 2], [5, 5], [8, 10]] in python)."""
|
||||
return _sorted_interval_list.Domain_FromIntervals(intervals)
|
||||
|
||||
@staticmethod
|
||||
def FromFlatIntervals(flat_intervals: 'std::vector< int64 > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a flattened list of intervals (long[] in Java and .NET, [0, 2, 5, 5, 8, 10] in python)."""
|
||||
return _sorted_interval_list.Domain_FromFlatIntervals(flat_intervals)
|
||||
|
||||
def FlattenedIntervals(self) -> "std::vector< int64 >":
|
||||
r""" This method returns the flattened list of interval bounds of the domain. Thus the domain {0, 1, 2, 5, 8, 9, 10} will return [0, 2, 5, 5, 8, 10] (as a C++ std::vector<int64>, as a java or C# long[], as a python list of integers)."""
|
||||
return _sorted_interval_list.Domain_FlattenedIntervals(self)
|
||||
|
||||
def IsEmpty(self) -> "bool":
|
||||
r""" Returns true if this is the empty set."""
|
||||
return _sorted_interval_list.Domain_IsEmpty(self)
|
||||
|
||||
def Size(self) -> "int64":
|
||||
r""" Returns the number of elements in the domain. It is capped at kint64max."""
|
||||
return _sorted_interval_list.Domain_Size(self)
|
||||
|
||||
def Min(self) -> "int64":
|
||||
r""" Returns the domain min value. It checks that the domain is not empty."""
|
||||
return _sorted_interval_list.Domain_Min(self)
|
||||
|
||||
def Max(self) -> "int64":
|
||||
r""" Returns the domain max value. It checks that the domain is not empty."""
|
||||
return _sorted_interval_list.Domain_Max(self)
|
||||
|
||||
def Contains(self, value: 'int64') -> "bool":
|
||||
r""" Returns true iff value is in Domain."""
|
||||
return _sorted_interval_list.Domain_Contains(self, value)
|
||||
|
||||
def Complement(self) -> "operations_research::Domain":
|
||||
r""" Returns the set Int64 ∖ D."""
|
||||
return _sorted_interval_list.Domain_Complement(self)
|
||||
|
||||
def Negation(self) -> "operations_research::Domain":
|
||||
r""" Returns {x ∈ Int64, ∃ e ∈ D, x = -e}. Note in particular that if the negation of Int64 is not Int64 but Int64 \ {kint64min} !!"""
|
||||
return _sorted_interval_list.Domain_Negation(self)
|
||||
|
||||
def IntersectionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns the set D ∩ domain."""
|
||||
return _sorted_interval_list.Domain_IntersectionWith(self, domain)
|
||||
|
||||
def UnionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns the set D ∪ domain."""
|
||||
return _sorted_interval_list.Domain_UnionWith(self, domain)
|
||||
|
||||
def AdditionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns {x ∈ Int64, ∃ a ∈ D, ∃ b ∈ domain, x = a + b}."""
|
||||
return _sorted_interval_list.Domain_AdditionWith(self, domain)
|
||||
|
||||
def __str__(self) -> "std::string":
|
||||
r""" Returns a compact std::string of a vector of intervals like "[1,4][6][10,20]"."""
|
||||
return _sorted_interval_list.Domain___str__(self)
|
||||
|
||||
def __lt__(self, other: 'Domain') -> "bool":
|
||||
r""" Lexicographic order on the intervals() representation."""
|
||||
return _sorted_interval_list.Domain___lt__(self, other)
|
||||
|
||||
def __eq__(self, other: 'Domain') -> "bool":
|
||||
@@ -235,19 +204,15 @@ class Domain(object):
|
||||
_sorted_interval_list.Domain_swigregister(Domain)
|
||||
|
||||
def Domain_AllValues() -> "operations_research::Domain":
|
||||
r""" Returns the full domain Int64."""
|
||||
return _sorted_interval_list.Domain_AllValues()
|
||||
|
||||
def Domain_FromValues(values: 'std::vector< int64 >') -> "operations_research::Domain":
|
||||
r""" Creates a domain from the union of an unsorted list of integer values. Input values may be repeated, with no consequence on the output"""
|
||||
return _sorted_interval_list.Domain_FromValues(values)
|
||||
|
||||
def Domain_FromIntervals(intervals: 'std::vector< std::vector< int64 > > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a list of intervals (long[][] in Java and .NET, [[0, 2], [5, 5], [8, 10]] in python)."""
|
||||
return _sorted_interval_list.Domain_FromIntervals(intervals)
|
||||
|
||||
def Domain_FromFlatIntervals(flat_intervals: 'std::vector< int64 > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a flattened list of intervals (long[] in Java and .NET, [0, 2, 5, 5, 8, 10] in python)."""
|
||||
return _sorted_interval_list.Domain_FromFlatIntervals(flat_intervals)
|
||||
|
||||
|
||||
@@ -269,110 +234,69 @@ def __lshift__(*args) -> "std::ostream &":
|
||||
<span>(</span><span>*args)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>We call "domain" any subset of Int64 = [kint64min, kint64max]. This class can be used to represent such set efficiently as a sorted and non-adjacent list of intervals. This is efficient as long as the size of such list stays reasonable. In the comments below, the domain of *this will always be written 'D'. Note that all the functions are safe with respect to integer overflow.</p>
|
||||
<p><em>Overload 1:</em>
|
||||
By default, Domain will be empty.</p>
|
||||
<p>|</p>
|
||||
<p><em>Overload 2:</em>
|
||||
Constructor for the common case of a singleton domain.</p>
|
||||
<p>|</p>
|
||||
<p><em>Overload 3:</em>
|
||||
Constructor for the common case of a single interval [left, right]. If left > right, this will result in the empty domain.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">class Domain(object):
|
||||
r""" We call "domain" any subset of Int64 = [kint64min, kint64max]. This class can be used to represent such set efficiently as a sorted and non-adjacent list of intervals. This is efficient as long as the size of such list stays reasonable. In the comments below, the domain of *this will always be written 'D'. Note that all the functions are safe with respect to integer overflow."""
|
||||
|
||||
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
|
||||
__repr__ = _swig_repr
|
||||
|
||||
def __init__(self, *args):
|
||||
r"""
|
||||
*Overload 1:*
|
||||
By default, Domain will be empty.
|
||||
|
||||
|
|
||||
|
||||
*Overload 2:*
|
||||
Constructor for the common case of a singleton domain.
|
||||
|
||||
|
|
||||
|
||||
*Overload 3:*
|
||||
Constructor for the common case of a single interval [left, right]. If left > right, this will result in the empty domain.
|
||||
"""
|
||||
_sorted_interval_list.Domain_swiginit(self, _sorted_interval_list.new_Domain(*args))
|
||||
|
||||
@staticmethod
|
||||
def AllValues() -> "operations_research::Domain":
|
||||
r""" Returns the full domain Int64."""
|
||||
return _sorted_interval_list.Domain_AllValues()
|
||||
|
||||
@staticmethod
|
||||
def FromValues(values: 'std::vector< int64 >') -> "operations_research::Domain":
|
||||
r""" Creates a domain from the union of an unsorted list of integer values. Input values may be repeated, with no consequence on the output"""
|
||||
return _sorted_interval_list.Domain_FromValues(values)
|
||||
|
||||
@staticmethod
|
||||
def FromIntervals(intervals: 'std::vector< std::vector< int64 > > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a list of intervals (long[][] in Java and .NET, [[0, 2], [5, 5], [8, 10]] in python)."""
|
||||
return _sorted_interval_list.Domain_FromIntervals(intervals)
|
||||
|
||||
@staticmethod
|
||||
def FromFlatIntervals(flat_intervals: 'std::vector< int64 > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a flattened list of intervals (long[] in Java and .NET, [0, 2, 5, 5, 8, 10] in python)."""
|
||||
return _sorted_interval_list.Domain_FromFlatIntervals(flat_intervals)
|
||||
|
||||
def FlattenedIntervals(self) -> "std::vector< int64 >":
|
||||
r""" This method returns the flattened list of interval bounds of the domain. Thus the domain {0, 1, 2, 5, 8, 9, 10} will return [0, 2, 5, 5, 8, 10] (as a C++ std::vector<int64>, as a java or C# long[], as a python list of integers)."""
|
||||
return _sorted_interval_list.Domain_FlattenedIntervals(self)
|
||||
|
||||
def IsEmpty(self) -> "bool":
|
||||
r""" Returns true if this is the empty set."""
|
||||
return _sorted_interval_list.Domain_IsEmpty(self)
|
||||
|
||||
def Size(self) -> "int64":
|
||||
r""" Returns the number of elements in the domain. It is capped at kint64max."""
|
||||
return _sorted_interval_list.Domain_Size(self)
|
||||
|
||||
def Min(self) -> "int64":
|
||||
r""" Returns the domain min value. It checks that the domain is not empty."""
|
||||
return _sorted_interval_list.Domain_Min(self)
|
||||
|
||||
def Max(self) -> "int64":
|
||||
r""" Returns the domain max value. It checks that the domain is not empty."""
|
||||
return _sorted_interval_list.Domain_Max(self)
|
||||
|
||||
def Contains(self, value: 'int64') -> "bool":
|
||||
r""" Returns true iff value is in Domain."""
|
||||
return _sorted_interval_list.Domain_Contains(self, value)
|
||||
|
||||
def Complement(self) -> "operations_research::Domain":
|
||||
r""" Returns the set Int64 ∖ D."""
|
||||
return _sorted_interval_list.Domain_Complement(self)
|
||||
|
||||
def Negation(self) -> "operations_research::Domain":
|
||||
r""" Returns {x ∈ Int64, ∃ e ∈ D, x = -e}. Note in particular that if the negation of Int64 is not Int64 but Int64 \ {kint64min} !!"""
|
||||
return _sorted_interval_list.Domain_Negation(self)
|
||||
|
||||
def IntersectionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns the set D ∩ domain."""
|
||||
return _sorted_interval_list.Domain_IntersectionWith(self, domain)
|
||||
|
||||
def UnionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns the set D ∪ domain."""
|
||||
return _sorted_interval_list.Domain_UnionWith(self, domain)
|
||||
|
||||
def AdditionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns {x ∈ Int64, ∃ a ∈ D, ∃ b ∈ domain, x = a + b}."""
|
||||
return _sorted_interval_list.Domain_AdditionWith(self, domain)
|
||||
|
||||
def __str__(self) -> "std::string":
|
||||
r""" Returns a compact std::string of a vector of intervals like "[1,4][6][10,20]"."""
|
||||
return _sorted_interval_list.Domain___str__(self)
|
||||
|
||||
def __lt__(self, other: 'Domain') -> "bool":
|
||||
r""" Lexicographic order on the intervals() representation."""
|
||||
return _sorted_interval_list.Domain___lt__(self, other)
|
||||
|
||||
def __eq__(self, other: 'Domain') -> "bool":
|
||||
@@ -388,12 +312,11 @@ Constructor for the common case of a single interval [left, right]. If left >
|
||||
<span>def <span class="ident">AllValues</span></span>(<span>)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the full domain Int64.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">@staticmethod
|
||||
def AllValues() -> "operations_research::Domain":
|
||||
r""" Returns the full domain Int64."""
|
||||
return _sorted_interval_list.Domain_AllValues()</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -401,12 +324,11 @@ def AllValues() -> "operations_research::Domain":
|
||||
<span>def <span class="ident">FromFlatIntervals</span></span>(<span>flat_intervals)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>This method is available in Python, Java and .NET. It allows building a Domain object from a flattened list of intervals (long[] in Java and .NET, [0, 2, 5, 5, 8, 10] in python).</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">@staticmethod
|
||||
def FromFlatIntervals(flat_intervals: 'std::vector< int64 > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a flattened list of intervals (long[] in Java and .NET, [0, 2, 5, 5, 8, 10] in python)."""
|
||||
return _sorted_interval_list.Domain_FromFlatIntervals(flat_intervals)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -414,12 +336,11 @@ def FromFlatIntervals(flat_intervals: 'std::vector< int64 > const &
|
||||
<span>def <span class="ident">FromIntervals</span></span>(<span>intervals)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>This method is available in Python, Java and .NET. It allows building a Domain object from a list of intervals (long[][] in Java and .NET, [[0, 2], [5, 5], [8, 10]] in python).</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">@staticmethod
|
||||
def FromIntervals(intervals: 'std::vector< std::vector< int64 > > const &') -> "operations_research::Domain":
|
||||
r""" This method is available in Python, Java and .NET. It allows building a Domain object from a list of intervals (long[][] in Java and .NET, [[0, 2], [5, 5], [8, 10]] in python)."""
|
||||
return _sorted_interval_list.Domain_FromIntervals(intervals)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -427,12 +348,11 @@ def FromIntervals(intervals: 'std::vector< std::vector< int64 > >
|
||||
<span>def <span class="ident">FromValues</span></span>(<span>values)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Creates a domain from the union of an unsorted list of integer values. Input values may be repeated, with no consequence on the output</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">@staticmethod
|
||||
def FromValues(values: 'std::vector< int64 >') -> "operations_research::Domain":
|
||||
r""" Creates a domain from the union of an unsorted list of integer values. Input values may be repeated, with no consequence on the output"""
|
||||
return _sorted_interval_list.Domain_FromValues(values)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -443,11 +363,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">AdditionWith</span></span>(<span>self, domain)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns {x ∈ Int64, ∃ a ∈ D, ∃ b ∈ domain, x = a + b}.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def AdditionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns {x ∈ Int64, ∃ a ∈ D, ∃ b ∈ domain, x = a + b}."""
|
||||
return _sorted_interval_list.Domain_AdditionWith(self, domain)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -455,11 +374,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">Complement</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the set Int64 ∖ D.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def Complement(self) -> "operations_research::Domain":
|
||||
r""" Returns the set Int64 ∖ D."""
|
||||
return _sorted_interval_list.Domain_Complement(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -467,11 +385,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">Contains</span></span>(<span>self, value)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns true iff value is in Domain.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def Contains(self, value: 'int64') -> "bool":
|
||||
r""" Returns true iff value is in Domain."""
|
||||
return _sorted_interval_list.Domain_Contains(self, value)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -479,11 +396,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">FlattenedIntervals</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>This method returns the flattened list of interval bounds of the domain. Thus the domain {0, 1, 2, 5, 8, 9, 10} will return [0, 2, 5, 5, 8, 10] (as a C++ std::vector<int64>, as a java or C# long[], as a python list of integers).</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def FlattenedIntervals(self) -> "std::vector< int64 >":
|
||||
r""" This method returns the flattened list of interval bounds of the domain. Thus the domain {0, 1, 2, 5, 8, 9, 10} will return [0, 2, 5, 5, 8, 10] (as a C++ std::vector<int64>, as a java or C# long[], as a python list of integers)."""
|
||||
return _sorted_interval_list.Domain_FlattenedIntervals(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -491,11 +407,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">IntersectionWith</span></span>(<span>self, domain)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the set D ∩ domain.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def IntersectionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns the set D ∩ domain."""
|
||||
return _sorted_interval_list.Domain_IntersectionWith(self, domain)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -503,11 +418,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">IsEmpty</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns true if this is the empty set.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def IsEmpty(self) -> "bool":
|
||||
r""" Returns true if this is the empty set."""
|
||||
return _sorted_interval_list.Domain_IsEmpty(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -515,11 +429,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">Max</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the domain max value. It checks that the domain is not empty.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def Max(self) -> "int64":
|
||||
r""" Returns the domain max value. It checks that the domain is not empty."""
|
||||
return _sorted_interval_list.Domain_Max(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -527,11 +440,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">Min</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the domain min value. It checks that the domain is not empty.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def Min(self) -> "int64":
|
||||
r""" Returns the domain min value. It checks that the domain is not empty."""
|
||||
return _sorted_interval_list.Domain_Min(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -539,11 +451,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">Negation</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns {x ∈ Int64, ∃ e ∈ D, x = -e}. Note in particular that if the negation of Int64 is not Int64 but Int64 \ {kint64min} !!</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def Negation(self) -> "operations_research::Domain":
|
||||
r""" Returns {x ∈ Int64, ∃ e ∈ D, x = -e}. Note in particular that if the negation of Int64 is not Int64 but Int64 \ {kint64min} !!"""
|
||||
return _sorted_interval_list.Domain_Negation(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -551,11 +462,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">Size</span></span>(<span>self)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the number of elements in the domain. It is capped at kint64max.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def Size(self) -> "int64":
|
||||
r""" Returns the number of elements in the domain. It is capped at kint64max."""
|
||||
return _sorted_interval_list.Domain_Size(self)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
@@ -563,11 +473,10 @@ def FromValues(values: 'std::vector< int64 >') -> "operatio
|
||||
<span>def <span class="ident">UnionWith</span></span>(<span>self, domain)</span>
|
||||
</code></dt>
|
||||
<dd>
|
||||
<section class="desc"><p>Returns the set D ∪ domain.</p></section>
|
||||
<section class="desc"></section>
|
||||
<details class="source">
|
||||
<summary>Source code</summary>
|
||||
<pre><code class="python">def UnionWith(self, domain: 'Domain') -> "operations_research::Domain":
|
||||
r""" Returns the set D ∪ domain."""
|
||||
return _sorted_interval_list.Domain_UnionWith(self, domain)</code></pre>
|
||||
</details>
|
||||
</dd>
|
||||
|
||||
Reference in New Issue
Block a user