Skip to content

Commit db64e20

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

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/src/API.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,22 @@ metadata(e::AbstractMultilayerEdge)
3636

3737
```@docs
3838
Layer{T <: Integer, U <: Real, G <: AbstractGraph{T}}
39-
Layer(name::Symbol, vertices::Vector{<: MultilayerVertex}, edge_list::Vector{ <: MultilayerEdge}, null_graph::G, weighttype::Type{U}; default_vertex_metadata::Function = mv -> NamedTuple(), default_edge_weight::Function = (src, dst) -> one(U), default_edge_metadata::Function = (src, dst) -> NamedTuple()) where {T <: Integer, U <: Real, G <: AbstractGraph{T}}
39+
Layer(
40+
descriptor::LayerDescriptor{T},
41+
vertices::Union{<:Vector{<:MultilayerVertex},Vector{Node}},
42+
edge_list::Union{Vector{<:MultilayerEdge},Vector{NTuple{2,MultilayerVertex{nothing}}}},
43+
)
4044
4145
Layer(
4246
name::Symbol,
43-
vertices::Vector{ <: MultilayerVertex},
44-
ne::Int64,
47+
vertices::Union{Vector{MultilayerVertex{nothing}},Vector{Node}},
48+
edge_list::Union{Vector{<:MultilayerEdge},Vector{NTuple{2,MultilayerVertex{nothing}}}},
4549
null_graph::G,
4650
weighttype::Type{U};
47-
default_vertex_metadata::Function = mv -> NamedTuple(),
48-
default_edge_weight::Function = (src, dst) -> nothing,
49-
default_edge_metadata::Function = (src, dst) -> NamedTuple(),
50-
allow_self_loops::Bool = false
51-
) where {T<:Integer, U <: Real, G<:AbstractGraph{T}}
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}}
5255
5356
layer_simplegraph
5457
layer_simpledigraph

0 commit comments

Comments
 (0)