update

Author: GiggleLiu

docs/src/ref.md

@@ -16,6 +16,11 @@ set_packing
 ```
 
 #### Graph Problem Interfaces
+
+To subtype [`GraphProblem`](@ref), a new type must contain a `code` field to represent the (optimized) tensor network.
+Interfaces [`GraphTensorNetworks.generate_tensors`](@ref), [`symbols`](@ref), [`flavors`](@ref) and [`get_weights`](@ref) are required.
+[`nflavor`](@ref) is optional.
+
 ```@docs
 GraphTensorNetworks.generate_tensors
 symbols
@@ -24,10 +29,6 @@ get_weights
 nflavor
 ```
 
-To subtype [`GraphProblem`](@ref), the new type must contain a `code` field to represent the (optimized) tensor network.
-Interfaces [`GraphTensorNetworks.generate_tensors`](@ref), [`symbols`](@ref), [`flavors`](@ref) and [`get_weights`] are required.
-[`nflavor`] is optimal.
-
 #### Graph Problem Utilities
 ```@docs
 is_independent_set

examples/IndependentSet.jl

@@ -59,6 +59,8 @@ maximum_independent_set_size = solve(problem, SizeMax())[]
 # ##### counting all independent sets
 count_all_independent_sets = solve(problem, CountingAll())[]
 
+# Function [`solve`](@ref) takes two positional arguments, the problem instance and the wanted property.
+
 # ##### counting independent sets with sizes ``\alpha(G)`` and ``\alpha(G)-1``
 count_max2_independent_sets = solve(problem, CountingMax(2))[]
 

src/networks/IndependentSet.jl

@@ -81,7 +81,8 @@ end
     mis_compactify!(tropicaltensor)
 
 Compactify tropical tensor for maximum independent set problem. It will eliminate
-some entries by setting them to zero, by the criteria that even these entries are removed, the MIS size is not changed.
+some entries by setting them to zero, by the criteria that removing these entry
+does not change the MIS size of its parent graph (reference to be added).
 """
 function mis_compactify!(a::AbstractArray{T}) where T <: TropicalTypes
 	for (ind_a, val_a) in enumerate(a)

src/networks/MaxCut.jl

@@ -34,7 +34,7 @@ end
 """
     cut_assign(g::SimpleGraph, config)
 
-Returns a valid vertex configurations (a vector of size `nv(g)`) from `config` (an iterator) defined on edges:
+Returns a valid vertex cut configurations (a vector of size `nv(g)`) from `config` (an iterator) defined on edges:
 
 * assign two vertices with the same values if they are connected by an edge with configuration `0`.
 * assign two vertices with the different values if they are connected by an edge with configuration `1`.

src/networks/PaintShop.jl

@@ -71,7 +71,7 @@ end
 """
     num_paint_shop_color_switch(labels::AbstractVector, coloring::AbstractVector)
 
-Check the validity of the `coloring` and returns the number of color switches.
+Checks the validity of the painting and returns the number of color switches.
 """
 function num_paint_shop_color_switch(labels::AbstractVector, coloring::AbstractVector)
     # check validity of solution
@@ -90,7 +90,7 @@ end
 """
     paint_shop_coloring_from_config(config; initial=false)
 
-Return a valid painting from the paint shop configuration (given by the configuration solvers).
+Returns a valid painting from the paint shop configuration (given by the configuration solvers).
 The `config` is a sequence of 0 and 1, where 0 means the color changed, 1 mean color unchanged.
 """
 function paint_shop_coloring_from_config(config; initial::Bool=false)

src/visualize.jl

@@ -85,9 +85,9 @@ Other keyword arguments
     * scale::Float64 = 1.0
     * pad::Float64 = 1.5
 * vertex
-    * vertex_text_color::String = "black"
-    * vertex_stroke_color = "black"
-    * vertex_fill_color = "white"
+    * vertex\\_text\\_color::String = "black"
+    * vertex\\_stroke\\_color = "black"
+    * vertex\\_fill\\_color = "white"
 * edge
     * edge_color::String = "black"
 * image size in `cm`