Update docstrings

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

Author: 3 people

docs/src/API.md

@@ -129,8 +129,6 @@ get_symmetric_interlayer(
     interlayer::In;
     symmetric_interlayer_name::String = String(interlayer.name) * "_rev"
 ) where {T,U,G,In<:Interlayer{T,U,G}}
-
-
 ```
 
 ### Multilayer-Specific Methods
@@ -286,8 +284,6 @@ modularity(
 
 
 von_neumann_entropy(mg::M) where {T,U,M<:AbstractMultilayerUGraph{T,U}}
-
-
 ```
 
 ### Representations
@@ -300,7 +296,6 @@ metadata_tensor(mg::M) where {T,U, M <: AbstractMultilayerGraph{T,U}}
 array(amr::AbstractMatrixRepresentation)
 SupraWeightMatrix{T,U}
 supra_weight_matrix(mg::M) where {T,U, M <: AbstractMultilayerGraph{T,U}}
-
 ```
 
 ### Traits
@@ -312,6 +307,16 @@ is_meta(g::G) where {G <: AbstractGraph}
 is_meta(g::G) where {G<:Type{<:AbstractGraph}}
 ```
 
+### Utilities
+```@docs
+multilayer_kronecker_delta(dims::NTuple{4,Int64})
+δk{T}
+δk(N::Int64)
+δ_1{T<: Number}
+δ_2{T<:Number}
+δ_3{T<:Number}
+δ_Ω{T}
+```
 
 
 ----------------------------------------------------
@@ -374,12 +379,10 @@ AbstractInterlayer
 AbstractMultilayerGraph{T <: Integer, U <: Real}
 has_vertex(mg::M, v::T) where {T, M <: AbstractMultilayerGraph{T}}
 vertices(mg::AbstractMultilayerGraph)
-inneighbors(mg::AbstractMultilayerUGraph, v::T) where {T <: Integer, M <: AbstractMultilayerUGraph{T}}
-inneighbors(mg::M, v::T) where {T <: Integer, M <: AbstractMultilayerDiGraph{T}}
+inneighbors(mg::M, v::T) where {T,M<:AbstractMultilayerUGraph{T,<:Real}}
+inneighbors(mg::M, v::T) where {T, M<:AbstractMultilayerGraph{T,<:Real}}
 inneighbors(mg::AbstractMultilayerGraph, mv::MultilayerVertex)
-outneighbors(mg::M, v::T) where {M <: AbstractMultilayerGraph{T} } where { T <: Integer}
-outneighbors(mg::M, v::T) where {M <: AbstractMultilayerGraph{T} } where { T <: Integer}
-outneighbors(mg::M, v::T) where {M <: AbstractMultilayerGraph{T} } where { T <: Integer}
+outneighbors(mg::M, v::T) where {T, M<:AbstractMultilayerGraph{T}}
 neighbors(mg::AbstractMultilayerGraph, mv::MultilayerVertex)
 edgetype(::M) where {T,U,M<:AbstractMultilayerGraph{T,U}}
 has_edge(mg::M, src::T, dst::T) where { T, M <: AbstractMultilayerUGraph{T}}
@@ -399,8 +402,4 @@ AbstractMatrixRepresentation{T,U}
 ```@docs
 IsWeighted{X}
 IsMeta{X}
-```
-
-
-```@docs
-```
+```

src/abstractmultilayerdigraph.jl

@@ -373,12 +373,13 @@ Return `true` if `mg` is directed, `false` otherwise.
 Graphs.is_directed(mg::M) where {M<:Type{<:AbstractMultilayerDiGraph}} = true
 
 """
-    inneighbors(mg::M, v::T) where {M <: AbstractMultilayerDiGraph{T} } where { T <: Integer}
+    inneighbors(mg::M, v::T
+) where {T, M<:AbstractMultilayerGraph{T,<:Real}}
+
 
 Return the list of inneighbors of `v` within `mg`.
 """
-function Graphs.inneighbors(mg::M, v::T
-    ) where {M<:AbstractMultilayerGraph{T,<:Real}} where {T}
+function Graphs.inneighbors(mg::M, v::T) where {T, M<:AbstractMultilayerGraph{T,<:Real}}
 
     _inneighbors = T[]
 

src/abstractmultilayergraph.jl

@@ -524,13 +524,13 @@ Graphs.outneighbors( mg::AbstractMultilayerGraph, mv::MultilayerVertex) = outnei
 
 
 """
-    outneighbors(mg::M, v::T) where {M <: AbstractMultilayerGraph{T} } where { T <: Integer}
+    outneighbors(mg::M, v::T) where {T, M<:AbstractMultilayerGraph{T}}
 
 Return the list of outneighbors of `v` within `mg`.
 """
 function Graphs.outneighbors(
     mg::M, v::T
-) where {M<:AbstractMultilayerGraph{T,<:Real}} where {T}
+) where {T, M<:AbstractMultilayerGraph{T}}
 
     _outneighbors = T[]
 

src/abstractmultilayerugraph.jl

@@ -342,7 +342,7 @@ Return `true` if `mg` is directed, `false` otherwise.
 Graphs.is_directed(mg::M) where {M<:Type{<:AbstractMultilayerUGraph}} = false
 
 """
-    inneighbors(mg::M, v::T) where {M <: AbstractMultilayerUGraph{T} } where { T <: Integer}
+    inneighbors(mg::M, v::T) where {T,M<:AbstractMultilayerUGraph{T,<:Real}}
 
 Return the list of inneighbors of `v` within `mg`.
 """

src/utilities.jl

@@ -35,7 +35,7 @@ function check_unique(vec::Union{Missing,<:Vector,<:Tuple})
 end
 
 """
-    multilayer_kronecker_delta(dims...)
+    multilayer_kronecker_delta(dims::NTuple{4,Int64})
 
 Return a 4-dimensional Kronecker delta with size equal to `dims`.
 """
@@ -97,7 +97,8 @@ The Kronecker delta.
 - `representation::Matrix{Int64}`: the matrix representing the Kronecker delta;
 - `T`: the return type when called `δk[i,j]`.
 
-# CONSTRUCTORS
+### CONSTRUCTORS
+
 
     δk{T}(N::Int64) where {T <: Number}
 
@@ -108,6 +109,7 @@ mutable struct δk{T} <: AbstractVector{T}
     representation::Matrix{Int64}
 
     # Inner constructor that only requires N and the eltype.
+    
     function δk{T}(N::Int64) where {T<:Number}
         out = new{T}(N)
         representation = [out[h, k] for h in 1:N, k in 1:N]