Module `OpamSolver`Source

Entry point to the solver, conversion of opam package universes to Cudf, dependencies computation. Front-end to Dose.

Sourcemodule Action : OpamActionGraph.ACTION with type package = OpamTypes.package

Sourcemodule ActionGraph : OpamActionGraph.SIG with type package = OpamTypes.package

Sourcetype solution

Sourceval empty_universe : OpamTypes.universe

Solver

Sourceval string_of_request : OpamTypes.atom OpamTypes.request -> string

Convert a request to a string

Sourceval stats : solution -> OpamTypes.stats

Compute statistics about a solution

Sourceval new_packages : solution -> OpamTypes.package_set

Return the new packages in the solution

Sourceval all_packages : solution -> OpamTypes.package_set

Return all packages appearing in the solution

Sourceval string_of_stats : OpamTypes.stats -> string

Pretty-printing of statistics

Sourceval solution_is_empty : solution -> bool

Is the solution empty?

Source

val print_solution : 
  messages:(OpamTypes.package -> string list) ->
  append:(OpamTypes.package -> string) ->
  requested:OpamTypes.name_set ->
  reinstall:OpamTypes.package_set ->
  solution ->
  unit

Display a solution

Sourceval solution_to_json : solution OpamJson.encoder

Serialize a solution

Sourceval solution_of_json : solution OpamJson.decoder

Source

val cudf_versions_map : 
  OpamTypes.universe ->
  OpamTypes.package_set ->
  int OpamPackage.Map.t

Computes an opam->cudf version map from a set of package

Source

val load_cudf_universe : 
  OpamTypes.universe ->
  ?version_map:int OpamTypes.package_map ->
  ?add_invariant:bool ->
  OpamTypes.package_set ->
  ?depopts:bool ->
  build:bool ->
  post:bool ->
  unit ->
  Cudf.universe

Creates a CUDF universe from an OPAM universe, including the given packages. Evaluation of the first 4 arguments is staged. Warning: when depopts is true, the optional dependencies may become strong dependencies.

Use add_invariant if you expect to call the solver and need the switch invariants to be respected; remember in that case to call Cudf.remove_package universe OpamCudf.opam_invariant_package before exporting the results

Source

val request : 
  ?criteria:OpamTypes.solver_criteria ->
  ?install:OpamTypes.atom list ->
  ?upgrade:OpamTypes.atom list ->
  ?remove:OpamTypes.atom list ->
  unit ->
  OpamTypes.atom OpamTypes.request

Build a request

Source

val resolve : 
  OpamTypes.universe ->
  orphans:OpamTypes.package_set ->
  OpamTypes.atom OpamTypes.request ->
  (solution, OpamCudf.conflict) OpamTypes.result

Given a description of packages, return a solution preserving the consistency of the initial description.

Sourceval get_atomic_action_graph : solution -> ActionGraph.t

Returns the graph of atomic actions (rm, inst) from a solution

Sourceval installable : OpamTypes.universe -> OpamTypes.package_set

Keep only the packages that are installable.

Source

val installable_subset : 
  OpamTypes.universe ->
  OpamTypes.package_set ->
  OpamTypes.package_set

Like installable, but within a subset and potentially much faster

Source

val dependencies : 
  depopts:bool ->
  build:bool ->
  post:bool ->
  installed:bool ->
  ?unavailable:bool ->
  OpamTypes.universe ->
  OpamTypes.package_set ->
  OpamTypes.package list

Return the topological sort of the transitive dependency closures of a collection of packages.

Source

val reverse_dependencies : 
  depopts:bool ->
  build:bool ->
  post:bool ->
  installed:bool ->
  ?unavailable:bool ->
  OpamTypes.universe ->
  OpamTypes.package_set ->
  OpamTypes.package list

Same as dependencies but for reverse dependencies

Sourcemodule PkgGraph : Graph.Sig.I with type V.t = OpamPackage.t

Source

val dependency_graph : 
  depopts:bool ->
  build:bool ->
  post:bool ->
  installed:bool ->
  ?unavailable:bool ->
  OpamTypes.universe ->
  PkgGraph.t

Sourceval check_for_conflicts : OpamTypes.universe -> OpamCudf.conflict option

Check the current set of installed packages in a universe for inconsistencies

Source

val coinstallability_check : 
  OpamTypes.universe ->
  OpamTypes.package_set ->
  OpamCudf.conflict option

Checks the given package set for complete installability ; returns None if they can all be installed together

Source

val atom_coinstallability_check : 
  OpamTypes.universe ->
  OpamTypes.atom list ->
  bool

Checks if the given atoms can be honored at the same time in the given universe

Source

val coinstallable_subset : 
  OpamTypes.universe ->
  OpamTypes.package_set ->
  OpamTypes.package_set ->
  OpamTypes.package_set

coinstallable_subset univ set packages returns the subset of packages which are individually co-installable with set, i.e. that can be installed if set while set remains installed. This returns the empty set if set is already not coinstallable.

Sourceval dump_universe : OpamTypes.universe -> out_channel -> unit

Dumps a cudf file containing all available packages in the given universe, plus version bindings (as '#v2v' comments) for the other ones.

Sourceval filter_solution : (OpamTypes.package -> bool) -> solution -> solution

Filters actions in a solution. Dependents of a removed actions are removed to keep consistency

Install

Dune Dependency

Authors

Maintainers

Sources

doc/opam-solver/OpamSolver/index.html

Module `OpamSolver`Source

Solver

package opam-solver

Install

Dune Dependency

Authors

Maintainers

Sources

doc/opam-solver/OpamSolver/index.html

Module OpamSolverSource

Solver

Module `OpamSolver`Source