Skip to content

Commit 9257c82

Browse files
committed
Document method parameters in CompressedColumnStorage class. Also catch the method I copied from while I'm here.
1 parent 0e6c53c commit 9257c82

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

CSparse/Storage/CompressedColumnStorage.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,9 @@ public static CompressedColumnStorage<T> OfIndexed(CoordinateStorage<T> coordina
146146
/// <summary>
147147
/// Create a new sparse matrix as a copy of the given indexed enumerable.
148148
/// </summary>
149+
/// <param name="rows">The number of rows.</param>
150+
/// <param name="columns">The number of columns.</param>
151+
/// <param name="enumerable">Tuples with the three elements of row, column, and the value that belongs at that position.</param>
149152
public static CompressedColumnStorage<T> OfIndexed(int rows, int columns, IEnumerable<Tuple<int, int, T>> enumerable)
150153
{
151154
var c = Converter.FromEnumerable<T>(enumerable, rows, columns);
@@ -156,6 +159,9 @@ public static CompressedColumnStorage<T> OfIndexed(int rows, int columns, IEnume
156159
/// <summary>
157160
/// Create a new sparse matrix as a copy of the given indexed enumerable using a value tuple.
158161
/// </summary>
162+
/// <param name="rows">The number of rows.</param>
163+
/// <param name="columns">The number of columns.</param>
164+
/// <param name="enumerable">Value tuples with the three elements of row, column, and the value that belongs at that position.</param>
159165
public static CompressedColumnStorage<T> OfIndexed(int rows, int columns, IEnumerable<(int row, int column, T value)> enumerable)
160166
{
161167
var c = Converter.FromEnumerable<T>(enumerable, rows, columns);

0 commit comments

Comments
 (0)