Skip to content

Commit 458deea

Browse files
InterdisciplinaryPhysicsTeamClaudMorpitmonticone
committed
Update API.md
Co-Authored-By: Claudio Moroni <[email protected]> Co-Authored-By: Pietro Monticone <[email protected]>
1 parent db64e20 commit 458deea

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/src/API.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,27 @@ metadata(e::AbstractMultilayerEdge)
3737
```@docs
3838
Layer{T <: Integer, U <: Real, G <: AbstractGraph{T}}
3939
Layer(
40-
descriptor::LayerDescriptor{T},
41-
vertices::Union{<:Vector{<:MultilayerVertex},Vector{Node}},
42-
edge_list::Union{Vector{<:MultilayerEdge},Vector{NTuple{2,MultilayerVertex{nothing}}}},
43-
)
40+
name::Symbol,
41+
vertices::Union{Vector{MultilayerVertex{nothing}},Vector{Node}},
42+
edge_list::Union{Vector{<:MultilayerEdge},Vector{NTuple{2,MultilayerVertex{nothing}}}},
43+
null_graph::G,
44+
weighttype::Type{U};
45+
default_vertex_metadata::Function = mv -> NamedTuple(),
46+
default_edge_weight::Function = (src, dst) -> one(U),
47+
default_edge_metadata::Function = (src, dst) -> NamedTuple()
48+
) where {T <: Integer, U <: Real, G <: AbstractGraph{T}}
4449
4550
Layer(
4651
name::Symbol,
4752
vertices::Union{Vector{MultilayerVertex{nothing}},Vector{Node}},
48-
edge_list::Union{Vector{<:MultilayerEdge},Vector{NTuple{2,MultilayerVertex{nothing}}}},
53+
ne::Int64,
4954
null_graph::G,
5055
weighttype::Type{U};
51-
default_vertex_metadata::Function=mv -> NamedTuple(),
52-
default_edge_weight::Function=(src, dst) -> one(U),
53-
default_edge_metadata::Function=(src, dst) -> NamedTuple(),
54-
) where {T<:Integer,U<:Real,G<:AbstractGraph{T}}
56+
default_vertex_metadata::Function = mv -> NamedTuple(),
57+
default_edge_weight::Function = (src, dst) -> nothing,
58+
default_edge_metadata::Function = (src, dst) -> NamedTuple(),
59+
allow_self_loops::Bool = false
60+
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
5561
5662
layer_simplegraph
5763
layer_simpledigraph

0 commit comments

Comments
 (0)