diff --git a/src/SparseTransform/Convert/IReader.cs b/src/SparseTransform/Convert/IReader.cs index 6ee68fe7df0818f67fce2641b56def2b4ad70abe..4728926f3a25ac00718018ddfecea8c44ba25083 100644 --- a/src/SparseTransform/Convert/IReader.cs +++ b/src/SparseTransform/Convert/IReader.cs @@ -2,15 +2,24 @@ namespace SparseTransform.Convert { + /// <summary> + /// Common interface for reader classes that transform a matrix input string into data structures from SparseTransform.DataStructures + /// </summary> interface IReader { /// <summary> - /// transforms the <c>matrix</c> in an IGraph (respectively in an bipartit graph or adjacency graph) + /// Transforms the <c>matrix</c> to an IGraph (respectively a Bipartite- or AdjacencyGraph) /// </summary> /// <param name="matrix"></param> /// <returns>transformed graph <c>IGraph</c></returns> public IGraph ReadGraph(String matrix); + /// <summary> + /// Transform the input matrix String into a matrix data structure. + /// This is needed since information from the input matrix is required for some conversions. + /// </summary> + /// <param name="matrix">matrix string to transform</param> + /// <returns>matrix object</returns> public DoubleMatrix ReadMatrix(String matrix); } }