Skip to content
Snippets Groups Projects
Commit a7ed799f authored by Paul Nitzke's avatar Paul Nitzke
Browse files

Complete documentation for the IReader interface

* Accomodates the last minute changes that introduces ReadGraph
parent dc50e857
No related branches found
No related tags found
1 merge request!27Complete documentation and streamline coding style a bit
......@@ -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);
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment