Update docstrings

Co-Authored-By: Claudio Moroni <[email protected]>
Co-Authored-By: Pietro Monticone <[email protected]>

Author: 3 people

src/graphofgraphs/abstractgraphofgraphs.jl

@@ -1,14 +1,14 @@
 """
     AbstractMatrixRepresentation{T,U}
 
-An abstrac type encoding a generic matricial representation of the links and metadata of a multilayer graph. 
+An abstract type encoding a generic matrix representation of the links and metadata of a multilayer graph. 
 
 Concrete subtypes must have an `array` field (a matrix of eltype U) and a `v_V_associations` (a `Bijection{T, Union{MissingVertex, MultilayerVertex}}`).
 
 # PARAMETRIC TYPES
 
-- `T`: the type of the internal represrntation of vertices;
-- `U`: the weight type of the multilayer graph;
+- `T`: the type of the internal representation of vertices;
+- `U`: the weight type of the multilayer graph.
 """
 abstract type AbstractMatrixRepresentation end
 
@@ -32,7 +32,6 @@ function Base.getindex(amr::AbstractMatrixRepresentation, src_tup::Tuple{String,
     return amr.array[src_idx, dst_idx]
 end
 
-
 """
     array(amr::AbstractMatrixRepresentation) 
 

src/graphofgraphs/digraphofgraphs.jl

@@ -1,13 +1,13 @@
 """
     AbstractTensorRepresentation{U}
 
-An abstrac type encoding a generic tensorial representation of the links and metadata of a multilayer graph. 
+An abstract type encoding a generic tensorial representation of the links and metadata of a multilayer graph. 
 
-Concrete subtypes must have an `array` field (a 4-dimaensional tensor of eltype U, indexes as [source_node_idx, destination_node_idx, source_layer_idx, destination_layer_idx ]), a .
+Concrete subtypes must have an `array` field (a 4-dimensional tensor of eltype U, indexes as [source_node_idx, destination_node_idx, source_layer_idx, destination_layer_idx ]).
 
 # PARAMETRIC TYPES
 
-- `U`: the weight type of the multilayer graph;
+- `U`: the weight type of the multilayer graph.
 """
 abstract type AbstractTensorRepresentation end
 
@@ -16,25 +16,31 @@ abstract type AbstractTensorRepresentation end
     getindex(atr::AbstractTensorRepresentation, src_mv::MultilayerVertex, dst_mv::MultilayerVertex)
 """
 function Base.getindex(atr::AbstractTensorRepresentation, src_mv::MultilayerVertex, dst_mv::MultilayerVertex)
+    # Find the index of the source node in the array of node
     src_n_idx = atr.idx_N_associations(src_mv.node)
+    # Find the index of the destination node in the array of node
     dst_n_idx = atr.idx_N_associations(dst_mv.node)
-
+    # Find the index of the source layer in the array of layers
     src_layer_idx = findfirst(name -> name == src_mv.layer, atr.layers_names)
+    # Find the index of the destination layer in the array of layers
     dst_layer_idx = findfirst(name -> name == dst_mv.layer, atr.layers_names)
-
+    # Return the value in the array at the position of the source node, destination node, source layer, and destination layer
     return atr.array[src_n_idx, dst_n_idx, src_layer_idx, dst_layer_idx]
 end
 
 """
     getindex(atr::AbstractTensorRepresentation, src_tup::Tuple{String, Symbol}, dst_tup::Tuple{String, Symbol})
 """
 function Base.getindex(atr::AbstractTensorRepresentation, src_tup::Tuple{String, Symbol}, dst_tup::Tuple{String, Symbol})
+    # Find the index of the source node in the adjacency tensor
     src_n_idx = atr.idx_N_associations(Node(src_tup[1]))
+    # Find the index of the destination node in the adjacency tensor
     dst_n_idx = atr.idx_N_associations(Node(dst_tup[1]))
-
+    # Find the index of the source layer in the adjacency tensor
     src_layer_idx = findfirst(name -> name == src_tup[2], atr.layers_names)
+    # Find the index of the destination layer in the adjacency tensor
     dst_layer_idx = findfirst(name -> name == dst_tup[2], atr.layers_names)
-
+    # Return the value of the adjacency tensor at the given indices
     return atr.array[src_n_idx, dst_n_idx, src_layer_idx, dst_layer_idx]
 end
 

src/graphofgraphs/graphofgraphs.jl

@@ -13,7 +13,10 @@ mt[mv1, mv2]
 ```
 """
 struct MetadataTensor <: AbstractTensorRepresentation
-    array::Array{ <: Union{Nothing,Tuple, NamedTuple},4}
+    # Create a new Array of the appropriate size
+    array::Array{<: Union{Nothing,Tuple, NamedTuple},4}
+    # Create an array of Symbol names for each layer
     layers_names::Vector{Symbol}
+    # Create a bijection between the integer index and the node index
     idx_N_associations::Bijection{Int64, Node}
 end

src/representations/abstractmatrixrepresentation.jl

@@ -22,8 +22,6 @@ Check whether `g` is weighted.
 """
 is_weighted(g::G) where {G<:Type{<:AbstractGraph}} = istrait(IsWeighted{g})
 
-
-
 """
     IsMeta{X}
 

src/representations/abstracttensorrepresentation.jl

@@ -34,10 +34,6 @@ function check_unique(vec::Union{Missing,<:Vector,<:Tuple})
     return ismissing(vec) ? true : length(setdiff(unique(vec), vec)) == 0
 end
 
-
-
-
-
 """
     multilayer_kronecker_delta(dims...)