forked from ocaml/opam
-
Notifications
You must be signed in to change notification settings - Fork 4
/
OpamSolver.html
93 lines (92 loc) · 6.9 KB
/
OpamSolver.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="OpamHeuristic.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="OpamClient" rel="Chapter" href="OpamClient.html">
<link title="OpamConfigCommand" rel="Chapter" href="OpamConfigCommand.html">
<link title="OpamSolution" rel="Chapter" href="OpamSolution.html">
<link title="OpamState" rel="Chapter" href="OpamState.html">
<link title="OpamSwitchCommand" rel="Chapter" href="OpamSwitchCommand.html">
<link title="OpamCompiler" rel="Chapter" href="OpamCompiler.html">
<link title="OpamFile" rel="Chapter" href="OpamFile.html">
<link title="OpamFilename" rel="Chapter" href="OpamFilename.html">
<link title="OpamFormat" rel="Chapter" href="OpamFormat.html">
<link title="OpamFormula" rel="Chapter" href="OpamFormula.html">
<link title="OpamMisc" rel="Chapter" href="OpamMisc.html">
<link title="OpamPackage" rel="Chapter" href="OpamPackage.html">
<link title="OpamParallel" rel="Chapter" href="OpamParallel.html">
<link title="OpamPath" rel="Chapter" href="OpamPath.html">
<link title="OpamProcess" rel="Chapter" href="OpamProcess.html">
<link title="OpamRepository" rel="Chapter" href="OpamRepository.html">
<link title="OpamRepositoryName" rel="Chapter" href="OpamRepositoryName.html">
<link title="OpamSwitch" rel="Chapter" href="OpamSwitch.html">
<link title="OpamSystem" rel="Chapter" href="OpamSystem.html">
<link title="OpamTypes" rel="Chapter" href="OpamTypes.html">
<link title="OpamVariable" rel="Chapter" href="OpamVariable.html">
<link title="OpamVersion" rel="Chapter" href="OpamVersion.html">
<link title="OpamCurl" rel="Chapter" href="OpamCurl.html">
<link title="OpamGit" rel="Chapter" href="OpamGit.html">
<link title="OpamRsync" rel="Chapter" href="OpamRsync.html">
<link title="OpamCudf" rel="Chapter" href="OpamCudf.html">
<link title="OpamHeuristic" rel="Chapter" href="OpamHeuristic.html">
<link title="OpamSolver" rel="Chapter" href="OpamSolver.html"><link title="Solver" rel="Section" href="#2_Solver">
<title>OpamSolver</title>
</head>
<body>
<div class="navbar"><a class="pre" href="OpamHeuristic.html" title="OpamHeuristic">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
</div>
<h1>Module <a href="type_OpamSolver.html">OpamSolver</a></h1>
<pre><span class="keyword">module</span> OpamSolver: <code class="code">sig</code> <a href="OpamSolver.html">..</a> <code class="code">end</code></pre><div class="info">
SAT-solver for package dependencies and conflicts<br>
</div>
<hr width="100%">
<br>
<h2 id="2_Solver">Solver</h2><br>
<pre><span id="VALstring_of_request"><span class="keyword">val</span> string_of_request</span> : <code class="type"><a href="OpamTypes.html#TYPEatom">OpamTypes.atom</a> <a href="OpamTypes.html#TYPErequest">OpamTypes.request</a> -> string</code></pre><div class="info">
Convert a request to a string<br>
</div>
<pre><span id="VALstats"><span class="keyword">val</span> stats</span> : <code class="type"><a href="OpamTypes.html#TYPEsolution">OpamTypes.solution</a> -> <a href="OpamTypes.html#TYPEstats">OpamTypes.stats</a></code></pre><div class="info">
Compute statistics about a solution<br>
</div>
<pre><span id="VALstring_of_stats"><span class="keyword">val</span> string_of_stats</span> : <code class="type"><a href="OpamTypes.html#TYPEstats">OpamTypes.stats</a> -> string</code></pre><div class="info">
Pretty-printing of statistics<br>
</div>
<pre><span id="VALsolution_is_empty"><span class="keyword">val</span> solution_is_empty</span> : <code class="type"><a href="OpamTypes.html#TYPEsolution">OpamTypes.solution</a> -> bool</code></pre><div class="info">
Is the solution empty ?<br>
</div>
<pre><span id="VALdelete_or_update"><span class="keyword">val</span> delete_or_update</span> : <code class="type"><a href="OpamTypes.html#TYPEsolution">OpamTypes.solution</a> -> bool</code></pre><div class="info">
Does the solution implies deleting or updating a package<br>
</div>
<pre><span id="VALprint_solution"><span class="keyword">val</span> print_solution</span> : <code class="type"><a href="OpamTypes.html#TYPEsolution">OpamTypes.solution</a> -> unit</code></pre><div class="info">
Display a solution<br>
</div>
<pre><span id="VALresolve"><span class="keyword">val</span> resolve</span> : <code class="type"><a href="OpamTypes.html#TYPEuniverse">OpamTypes.universe</a> -><br> <a href="OpamTypes.html#TYPEatom">OpamTypes.atom</a> <a href="OpamTypes.html#TYPErequest">OpamTypes.request</a> -><br> (<a href="OpamTypes.html#TYPEsolution">OpamTypes.solution</a>, string) <a href="OpamTypes.html#TYPEresult">OpamTypes.result</a></code></pre><div class="info">
Given a description of packages, return a solution preserving the
consistency of the initial description. An empty <code class="code">list</code> : No solution
found. The last argument is the set of installed packages.
<p>
Every element in the solution <code class="code">list</code> satisfies the problem given.
For the ordering, the first element in the list
is obtained by upgrading from its next element.<br>
</div>
<pre><span id="VALbackward_dependencies"><span class="keyword">val</span> backward_dependencies</span> : <code class="type">depopts:bool -><br> installed:bool -><br> <a href="OpamTypes.html#TYPEuniverse">OpamTypes.universe</a> -> <a href="OpamTypes.html#TYPEpackage_set">OpamTypes.package_set</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> list</code></pre><div class="info">
Return the topological sort of the transitive dependency closures
of a collection of packages.<br>
</div>
<pre><span id="VALforward_dependencies"><span class="keyword">val</span> forward_dependencies</span> : <code class="type">depopts:bool -><br> installed:bool -><br> <a href="OpamTypes.html#TYPEuniverse">OpamTypes.universe</a> -> <a href="OpamTypes.html#TYPEpackage_set">OpamTypes.package_set</a> -> <a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> list</code></pre><div class="info">
Same as <code class="code">backward_dependencies</code> but for forward dependencies<br>
</div>
<pre><span id="VALsequential_solution"><span class="keyword">val</span> sequential_solution</span> : <code class="type"><a href="OpamTypes.html#TYPEpackage">OpamTypes.package</a> <a href="OpamTypes.html#TYPEaction">OpamTypes.action</a> list -> <a href="OpamTypes.html#TYPEsolution">OpamTypes.solution</a></code></pre><div class="info">
Create a sequential solution from a list of actions<br>
</div>
</body></html>