Return tuple named

Author: Affie

src/DistributedFactorGraphs.jl

@@ -103,7 +103,6 @@ export exists, addVariable!, addFactor!, getVariable, getFactor, updateVariable!
 export getVariables, getVariableIds, getFactors, getFactorIds, ls, lsf
 export isFullyConnected, hasOrphans
 export getNeighbors, _getDuplicatedEmptyDFG, getSubgraphAroundNode, getSubgraph
-# export getIncidenceMatrix, getIncidenceMatrixSparse
 export getBiadjacencyMatrix
 
 export toDot, toDotFile

src/LightDFG/services/LightDFG.jl

@@ -326,7 +326,8 @@ end
 
 #TODO This is just way too strange to call a function  getIncidenceMatrix that calls adjacency_matrix internally,
 # So I'm going with Biadjacency Matrix https://en.wikipedia.org/wiki/Adjacency_matrix#Of_a_bipartite_graph
-function getBiadjacencyMatrix(dfg::LightDFG; solvable::Int=0)::Tuple{LightGraphs.SparseMatrixCSC, Vector{Symbol}, Vector{Symbol}}
+# TODO biadjacencyMatrix
+function getBiadjacencyMatrix(dfg::LightDFG; solvable::Int=0)::NamedTuple{(:B, :varLabels, :facLabels),Tuple{LightGraphs.SparseMatrixCSC,Vector{Symbol}, Vector{Symbol}}}
     varLabels = getVariableIds(dfg, solvable=solvable)
     factLabels = getFactorIds(dfg, solvable=solvable)
     varIndex = [dfg.g.labels[s] for s in varLabels]
@@ -335,7 +336,7 @@ function getBiadjacencyMatrix(dfg::LightDFG; solvable::Int=0)::Tuple{LightGraphs
     adj = adjacency_matrix(dfg.g)
 
     adjvf = adj[factIndex, varIndex]
-    return adjvf, varLabels, factLabels
+    return (B=adjvf, varLabels=varLabels, facLabels=factLabels)
 end
 
 # this would be an incidence matrix

src/entities/AbstractDFGSummary.jl

@@ -2,6 +2,7 @@
 $(TYPEDEF)
 Structure for a graph summary.
 """
+# TODO why is this called Abstract...
 struct AbstractDFGSummary
   variables::Dict{Symbol, DFGVariableSummary}
   factors::Dict{Symbol, DFGFactorSummary}

src/services/AbstractDFG.jl

@@ -760,7 +760,8 @@ a tuple: adjmat::SparseMatrixCSC{Int}, var_labels::Vector{Symbol)
 fac_labels::Vector{Symbol). Rows are the factors, columns are the variables,
 with the corresponding labels in fac_labels,var_labels.
 """
-function getBiadjacencyMatrix(dfg::G; solvable::Int=0)::Tuple{SparseMatrixCSC, Vector{Symbol}, Vector{Symbol}} where G <: AbstractDFG
+# TODO API name get seems wrong maybe just biadjacencyMatrix
+function getBiadjacencyMatrix(dfg::AbstractDFG; solvable::Int=0)::NamedTuple{(:B, :varLabels, :facLabels), Tuple{SparseMatrixCSC, Vector{Symbol}, Vector{Symbol}}}
     varLabels = map(v->v.label, getVariables(dfg, solvable=solvable))
     factLabels = map(f->f.label, getFactors(dfg, solvable=solvable))
 
@@ -772,11 +773,10 @@ function getBiadjacencyMatrix(dfg::G; solvable::Int=0)::Tuple{SparseMatrixCSC, V
         factVars = getNeighbors(dfg, getFactor(dfg, factLabel), solvable=solvable)
         map(vLabel -> adjMat[fIndex,vDict[vLabel]] = 1, factVars)
     end
-    return adjMat, varLabels, factLabels
+    return (B=adjMat, varLabels=varLabels, facLabels=factLabels)
 end
 
-function getAdjacencyMatrixSparse(dfg::G; solvable::Int=0)::Tuple{SparseMatrixCSC, Vector{Symbol}, Vector{Symbol}} where G <: AbstractDFG
-    @warn "Deprecated function, please use getBiadjacencyMatrix as this will be removed in v0.6.1"
+function getAdjacencyMatrixSparse(dfg::AbstractDFG; solvable::Int=0)
     return getBiadjacencyMatrix(dfg, solvable)
 end
 # -------------------------