Merge pull request #11 from SebKrantz/parameterized_graph

Parameterized graph

Author: SebKrantz

docs/src/api.md

@@ -30,9 +30,22 @@ remove_node
 
 # Documented Internal Functions
 
-```@autodocs
+```@docs
+dict_to_namedtuple
+namedtuple_to_dict
+create_map
+create_square
+create_triangle
+create_custom
+represent_edges
+create_auxdata
+get_model
+```
+
+<!-- ```@autodocs
+<!-- ```@autodocs
 Modules = [OptimalTransportNetworks]
 Public = false
 Private = true
 Order = [:function]
-```
+``` -->

src/main/annealing.jl

@@ -518,7 +518,6 @@ end
 # This function implements the rebranching algorithm described in the paper.
 # Links are reshuffled everywhere so that each node is better connected to its best neighbor
 # (those with the lowest price index for traded goods, i.e., more central places in the trading network).
-"""
 function rebranch_network(param, graph, I0, results, options)
     J = graph.J
 

src/main/create_graph.jl

@@ -253,10 +253,8 @@ Creates a triangular graph structure with width `w` and height `h`
 horizontal and along the two diagonals)
 
 # Arguments
-- `w`: Width of graph (i.e. the max number of nodes along horizontal dimension), 
-must be an integer
-- `h`: Height of graph (i.e. the max number of nodes along vertical dimension),  
-must be an odd integer
+- `w`: Width of graph (i.e. the max number of nodes along horizontal dimension), must be an integer
+- `h`: Height of graph (i.e. the max number of nodes along vertical dimension), must be an odd integer
 """
 function create_triangle(w, h)
     if h % 2 == 0
@@ -361,10 +359,8 @@ with width w and height h (nodes have 4 neighbors in total, along
 horizontal and vertical dimensions, NOT diagonals)
 
 # Arguments
-- `w`: width of graph (ie. the number of nodes along horizontal
-dimension), must be an integer 
-- `h`: height of graph (ie. the number of nodes along vertical
-dimension), must be an integer
+- `w`: width of graph (ie. the number of nodes along horizontal dimension), must be an integer 
+- `h`: height of graph (ie. the number of nodes along vertical dimension), must be an integer
 """
 function create_square(w, h)
     J = w * h