Skip to content

Commit

Permalink
Update docs for Commons
Browse files Browse the repository at this point in the history
  • Loading branch information
@Azzaare
Azzaare committed Jul 25, 2024
1 parent 0f2ce45 commit 189f0ca
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 30 deletions.
34 changes: 17 additions & 17 deletions docs/Manifest.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ version = "0.4.5"

[[deps.Accessors]]
deps = ["CompositionsBase", "ConstructionBase", "Dates", "InverseFunctions", "LinearAlgebra", "MacroTools", "Markdown", "Test"]
git-tree-sha1 = "c0d491ef0b135fd7d63cbc6404286bc633329425"
git-tree-sha1 = "f61b15be1d76846c0ce31d3fcfac5380ae53db6a"
uuid = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
version = "0.1.36"
version = "0.1.37"

[deps.Accessors.extensions]
AccessorsAxisKeysExt = "AxisKeys"
Expand Down Expand Up @@ -236,7 +236,7 @@ weakdeps = ["InverseFunctions"]

[[deps.ConstraintCommons]]
deps = ["Dictionaries", "TestItems"]
git-tree-sha1 = "0315696eba806ffadc01fbca79cf198dcd2f2655"
git-tree-sha1 = "ca8e5cfedb33fc75c5ba0a52d3e222d3d3c2b9e9"
repo-rev = "main"
repo-url = "https://github.com/JuliaConstraints/ConstraintCommons.jl.git"
uuid = "e37357d9-0691-492f-a822-e5ea6a920954"
Expand All @@ -260,11 +260,11 @@ version = "0.1.8"

[[deps.ConstraintModels]]
deps = ["CBLS", "Constraints", "Dictionaries", "JuMP", "LocalSearchSolvers", "MathOptInterface"]
git-tree-sha1 = "c60bcdfa5a427e64f4c67bb2b4cc698bb57eb857"
git-tree-sha1 = "266f336395341b5f532d56e075011a0700740f7a"
repo-rev = "main"
repo-url = "https://github.com/JuliaConstraints/ConstraintModels.jl.git"
uuid = "841a6ec5-cac3-4c42-9a0a-4b21c9553698"
version = "0.2.0"
version = "0.3.0"

[[deps.Constraints]]
deps = ["CompositionalNetworks", "ConstraintCommons", "ConstraintDomains", "DataFrames", "Dictionaries", "MacroTools", "PrettyTables", "TestItems"]
Expand All @@ -276,9 +276,9 @@ version = "0.5.6"

[[deps.ConstructionBase]]
deps = ["LinearAlgebra"]
git-tree-sha1 = "260fd2400ed2dab602a7c15cf10c1933c59930a2"
git-tree-sha1 = "d8a9c0b6ac2d9081bf76324b39c78ca3ce4f0c98"
uuid = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
version = "1.5.5"
version = "1.5.6"

[deps.ConstructionBase.extensions]
ConstructionBaseIntervalSetsExt = "IntervalSets"
Expand Down Expand Up @@ -519,9 +519,9 @@ uuid = "9fa8497b-333b-5362-9e8d-4d0656e87820"

[[deps.GPUArrays]]
deps = ["Adapt", "GPUArraysCore", "LLVM", "LinearAlgebra", "Printf", "Random", "Reexport", "Serialization", "Statistics"]
git-tree-sha1 = "04661708f5301394a1f1be86a07a89e835900db6"
git-tree-sha1 = "a74c3f1cf56a3dfcdef0605f8cdb7015926aae30"
uuid = "0c68f7d7-f131-5f86-a1c3-88cf8149b2d7"
version = "10.2.3"
version = "10.3.0"

[[deps.GPUArraysCore]]
deps = ["Adapt"]
Expand Down Expand Up @@ -642,9 +642,9 @@ version = "1.22.2"

[[deps.JuliaFormatter]]
deps = ["CSTParser", "CommonMark", "DataStructures", "Glob", "Pkg", "PrecompileTools", "Tokenize"]
git-tree-sha1 = "b101a476705594c2a8ba106d731497058874bcf4"
git-tree-sha1 = "0b50446cd3e52a51a7d48b52d49ec1a875aaf6e8"
uuid = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
version = "1.0.57"
version = "1.0.58"

[[deps.JuliaVariables]]
deps = ["MLStyle", "NameResolution"]
Expand Down Expand Up @@ -840,9 +840,9 @@ uuid = "a63ad114-7e13-5084-954f-fe012c677804"

[[deps.Mocking]]
deps = ["Compat", "ExprTools"]
git-tree-sha1 = "bf17d9cb4f0d2882351dfad030598f64286e5936"
git-tree-sha1 = "c74e5e7c5f83ccb0bca0377d316d966d296106d4"
uuid = "78c3b35d-d492-501b-9361-3d52fe80e533"
version = "0.7.8"
version = "0.7.9"

[[deps.MozillaCACerts_jll]]
uuid = "14a3606d-f60d-562e-9121-12d972cd8159"
Expand All @@ -862,9 +862,9 @@ version = "7.8.3"

[[deps.NNlib]]
deps = ["Adapt", "Atomix", "ChainRulesCore", "GPUArraysCore", "KernelAbstractions", "LinearAlgebra", "Pkg", "Random", "Requires", "Statistics"]
git-tree-sha1 = "333cd68c28bb57ac23c50acd1036ecd7dd78bf57"
git-tree-sha1 = "190dcada8cf9520198058c4544862b1f88c6c577"
uuid = "872c559c-99b0-510c-b3b7-b6c96a88d5cd"
version = "0.9.20"
version = "0.9.21"

[deps.NNlib.extensions]
NNlibAMDGPUExt = "AMDGPU"
Expand Down Expand Up @@ -1299,9 +1299,9 @@ uuid = "0796e94c-ce3b-5d07-9a54-7f471281c624"
version = "0.5.29"

[[deps.TranscodingStreams]]
git-tree-sha1 = "60df3f8126263c0d6b357b9a1017bb94f53e3582"
git-tree-sha1 = "96612ac5365777520c3c5396314c8cf7408f436a"
uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa"
version = "0.11.0"
version = "0.11.1"
weakdeps = ["Random", "Test"]

[deps.TranscodingStreams.extensions]
Expand Down
14 changes: 8 additions & 6 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,11 @@ makedocs(;
"Contributing" => "cp/contribution.md",
],
],
"Constraints" => [
"Modeling Toolkit" => [
"Introduction" => "constraints/intro.md",
"ConstraintCommons.jl" => "constraints/constraint_commons.md",
"ConstraintDomains.jl" => "constraints/constraint_domains.md",
"Constraints.jl" => [
"Basic Tools" => "constraints/constraints.md",
"Variables and Domains" => "constraints/constraint_domains.md",
"Constraints" => [
"Basics" => "constraints/constraints.md",
"Generic Constraints" => "constraints/generic_constraints.md",
"Language Constraints" => "constraints/language_constraints.md",
"Comparison Constraints" => "constraints/comparison_constraints.md",
Expand All @@ -74,7 +73,10 @@ makedocs(;
"Graph Constraints" => "constraints/graph_constraints.md",
"Elementary Constraints" => "constraints/elementary_constraints.md",
],
"ConstraintModels.jl" => "constraints/constraint_models.md",
"Model Catalog" => "constraints/constraint_models.md",
"Internals" => [
"ConstraintCommons.jl" => "constraints/constraint_commons.md",
],
],
"Learning" => [
"Introduction" => "learning/intro.md",
Expand Down
9 changes: 4 additions & 5 deletions docs/src/constraints/constraint_commons.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ CurrentModule = ConstraintCommons

## Parameters

This section of the package list or extract parameters based on the *XCSP3-core* specifications. Note that, for the foreseeable future, the default constraints specification will follow the XCSP3 format.
This section of the package list or extract parameters based on the *XCSP3-core* specifications. Note that, for the foreseeable future, the default constraints specification will follow these specifications.

```@docs; canonical=false
USUAL_CONSTRAINT_PARAMETERS
Expand All @@ -35,7 +35,6 @@ AbstractMultivaluedDecisionDiagram
MDD
AbstractAutomaton
Automaton
Automaton(a::MDD)
accept
at_end
```
Expand Down Expand Up @@ -64,9 +63,9 @@ at_end
We extended some operations for `Nothing` and `Symbol`.

```@docs; canonical=false
Base.:*
Base.in(::Any, ::Nothing)
Base.isempty(::Nothing)
symcon
consin
consisempty
```

### Performances
Expand Down
22 changes: 20 additions & 2 deletions docs/src/constraints/intro.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# Introduction to basics cosntraints related tools
# Introduction to basics constraint-based modeling tools

About constraints.
Constraint programming (CP) is a powerful paradigm for solving combinatorial problems, and Julia Constraints provides an efficient and flexible framework for developing constraint-based models.

## Domain-defined variables

In CP, variables are defined through their domain. `ConstraintDomains.jl` supports various types of domains such as discrete ones (sets, range, etc.), or continuous intervals, and custom domains.

## `Constraints.jl`: A versatile API

It implements a wide range of generic and core constraints, ensuring compatibility with XCSP3-core standards and providing a user-friendly interface. It includes features extracted from the learning blocks of Julia Constraints to leverage most of each constraint characteristics.

## Models Through `ConstraintModels.jl`

The `ConstraintModels.jl` catalog offers a collection of predefined models and templates for constructing complex constraint satisfaction problems (CSPs) and optimization models. This resource provides reusable components to streamline the modeling process.

Contributions with new models are more than welcome!

## Internal Aspects

Several internal components are crucial for the efficient functioning of Julia Constraints. `ConstraintCommons.jl` provides shared functionalities and utilities used across different parts of the framework, contributing to its robust performance and extensibility. However, it is unlikely to be of direct use to most users.

0 comments on commit 189f0ca

Please sign in to comment.