From ec483fb8749670ff9d5716302621be5363d17f3e Mon Sep 17 00:00:00 2001 From: Christoph Ruegg Date: Sat, 6 Apr 2013 17:52:39 +0200 Subject: [PATCH] LA: clarify 'column-major' in xml docs --- src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs | 6 +++--- src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs | 2 +- src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs | 6 +++--- src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs | 2 +- src/Numerics/LinearAlgebra/Double/DenseMatrix.cs | 6 +++--- src/Numerics/LinearAlgebra/Double/SparseMatrix.cs | 2 +- src/Numerics/LinearAlgebra/Single/DenseMatrix.cs | 6 +++--- src/Numerics/LinearAlgebra/Single/SparseMatrix.cs | 2 +- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs index b1bfa986..1860380b 100644 --- a/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex/DenseMatrix.cs @@ -41,7 +41,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex using System.Numerics; /// - /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order. + /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). /// [Serializable] [DebuggerDisplay("DenseMatrix {RowCount}x{ColumnCount}-Complex")] @@ -120,7 +120,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - /// The array is assumed to be in column-major order and is used directly without copying. + /// The array is assumed to be in column-major order (column by column) and is used directly without copying. /// Very efficient, but changes to the array and the matrix will affect each other. /// /// @@ -148,7 +148,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Create a new dense matrix as a copy of the given enumerable. - /// The enumerable is assumed to be in column-major order. + /// The enumerable is assumed to be in column-major order (column by column). /// This new matrix will be independent from the enumerable. /// A new memory block will be allocated for storing the vector. /// diff --git a/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs index f88b6b4b..9ee45cf1 100644 --- a/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex/SparseMatrix.cs @@ -133,7 +133,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex /// /// Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - /// The array is assumed to be in column-major order. + /// The array is assumed to be in column-major order (column by column). /// This new matrix will be independent from the provided array. /// A new memory block will be allocated for storing the matrix. /// diff --git a/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs index ccc4b224..b9f085c4 100644 --- a/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex32/DenseMatrix.cs @@ -41,7 +41,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 using System.Diagnostics; /// - /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order. + /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). /// [Serializable] [DebuggerDisplay("DenseMatrix {RowCount}x{ColumnCount}-Complex32")] @@ -120,7 +120,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - /// The array is assumed to be in column-major order and is used directly without copying. + /// The array is assumed to be in column-major order (column by column) and is used directly without copying. /// Very efficient, but changes to the array and the matrix will affect each other. /// /// @@ -148,7 +148,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Create a new dense matrix as a copy of the given enumerable. - /// The enumerable is assumed to be in column-major order. + /// The enumerable is assumed to be in column-major order (column by column). /// This new matrix will be independent from the enumerable. /// A new memory block will be allocated for storing the vector. /// diff --git a/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs index 6d7e4ad2..5518af2b 100644 --- a/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Complex32/SparseMatrix.cs @@ -133,7 +133,7 @@ namespace MathNet.Numerics.LinearAlgebra.Complex32 /// /// Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - /// The array is assumed to be in column-major order. + /// The array is assumed to be in column-major order (column by column). /// This new matrix will be independent from the provided array. /// A new memory block will be allocated for storing the matrix. /// diff --git a/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs index 4524a03b..5722cd5e 100644 --- a/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Double/DenseMatrix.cs @@ -41,7 +41,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double using Threading; /// - /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order. + /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). /// [Serializable] [DebuggerDisplay("DenseMatrix {RowCount}x{ColumnCount}-Double")] @@ -120,7 +120,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - /// The array is assumed to be in column-major order and is used directly without copying. + /// The array is assumed to be in column-major order (column by column) and is used directly without copying. /// Very efficient, but changes to the array and the matrix will affect each other. /// /// @@ -148,7 +148,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Create a new dense matrix as a copy of the given enumerable. - /// The enumerable is assumed to be in column-major order. + /// The enumerable is assumed to be in column-major order (column by column). /// This new matrix will be independent from the enumerable. /// A new memory block will be allocated for storing the vector. /// diff --git a/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs index 9a0f91a5..b322a908 100644 --- a/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Double/SparseMatrix.cs @@ -132,7 +132,7 @@ namespace MathNet.Numerics.LinearAlgebra.Double /// /// Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - /// The array is assumed to be in column-major order. + /// The array is assumed to be in column-major order (column by column). /// This new matrix will be independent from the provided array. /// A new memory block will be allocated for storing the matrix. /// diff --git a/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs b/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs index ea57ee8b..c7e886a3 100644 --- a/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Single/DenseMatrix.cs @@ -41,7 +41,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single using Threading; /// - /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order. + /// A Matrix class with dense storage. The underlying storage is a one dimensional array in column-major order (column by column). /// [Serializable] [DebuggerDisplay("DenseMatrix {RowCount}x{ColumnCount}-Single")] @@ -120,7 +120,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Create a new dense matrix with the given number of rows and columns directly binding to a raw array. - /// The array is assumed to be in column-major order and is used directly without copying. + /// The array is assumed to be in column-major order (column by column) and is used directly without copying. /// Very efficient, but changes to the array and the matrix will affect each other. /// /// @@ -148,7 +148,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Create a new dense matrix as a copy of the given enumerable. - /// The enumerable is assumed to be in column-major order. + /// The enumerable is assumed to be in column-major order (column by column). /// This new matrix will be independent from the enumerable. /// A new memory block will be allocated for storing the vector. /// diff --git a/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs b/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs index b4a6924c..74405fc3 100644 --- a/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs +++ b/src/Numerics/LinearAlgebra/Single/SparseMatrix.cs @@ -132,7 +132,7 @@ namespace MathNet.Numerics.LinearAlgebra.Single /// /// Create a new sparse matrix with the given number of rows and columns as a copy of the given array. - /// The array is assumed to be in column-major order. + /// The array is assumed to be in column-major order (column by column). /// This new matrix will be independent from the provided array. /// A new memory block will be allocated for storing the matrix. ///