[NeoML] CDnnSparseMatrix ctor (#1103)

Signed-off-by: Kirill Golikov <kirill.golikov@abbyy.com>

Author: favorart

NeoML/include/NeoML/Dnn/DnnSparseMatrix.h

@@ -1,4 +1,4 @@
-/* Copyright © 2017-2020 ABBYY Production LLC
+/* Copyright © 2017-2024 ABBYY
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -23,14 +23,13 @@ limitations under the License.
 namespace NeoML {
 
 // A sparse matrix for IMathEngine
-class NEOML_API CDnnSparseMatrix {
+class NEOML_API CDnnSparseMatrix final {
 public:
 	CDnnSparseMatrix( IMathEngine& _mathEngine, int rowCount, int columnCount );
 	~CDnnSparseMatrix();
 
 	// Creates a matrix from the specified problem
 	void Create( const IProblem* problem, int startVectorIndex, int batchCount );
-
 	// Destroys the matrix; the allocated memory is kept
 	void Destroy();
 
@@ -41,24 +40,27 @@ class NEOML_API CDnnSparseMatrix {
 	CSparseMatrixDesc GetBatchDesc( int index ) const;
 
 private:
-	struct CMatrix {
+	struct CMatrix final {
 		int ElementCount;
 		int RowPos;
 		int ElementPos;
+
+		CMatrix( int elementCount, int rowPos, int elementPos ) :
+			ElementCount( elementCount ), RowPos( rowPos ), ElementPos( elementPos ) {}
 	};
 
 	IMathEngine& mathEngine; // the math engine
 	const int rowCount; // the number of rows
 	const int columnCount; // the number of columns
 	CArray<CFloatVectorDesc> vectors; // the vectors (matrix columns)
 	CArray<CMatrix> matrixes; // the matrix descriptions
-	int totalElementSize; // the size of matrix elements (aligned)
-	int totalRowSize; // the size of matrix rows (aligned)
+	int totalElementSize = 0; // the size of matrix elements (aligned)
+	int totalRowSize = 0; // the size of matrix rows (aligned)
 	CIntHandle mathEngineData; // the data allocated for the matrix by IMathEngine
-	size_t mathEngineDataSize; // the size of the data allocated by IMathEngine
+	size_t mathEngineDataSize = 0; // the size of the data allocated by IMathEngine
 
-	CDnnSparseMatrix( const CDnnSparseMatrix& );
-	CDnnSparseMatrix& operator=( const CDnnSparseMatrix& );
+	CDnnSparseMatrix( const CDnnSparseMatrix& ) = delete;
+	CDnnSparseMatrix& operator=( const CDnnSparseMatrix& ) = delete;
 };
 
 } // namespace NeoML

NeoML/src/Dnn/DnnSparseMatrix.cpp

@@ -1,4 +1,4 @@
-/* Copyright © 2017-2020 ABBYY Production LLC
+/* Copyright © 2017-2024 ABBYY
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -25,10 +25,7 @@ namespace NeoML {
 CDnnSparseMatrix::CDnnSparseMatrix( IMathEngine& _mathEngine, int _rowCount, int _columnCount ) :
 	mathEngine( _mathEngine ),
 	rowCount( _rowCount ),
-	columnCount( _columnCount ),
-	totalElementSize( 0 ),
-	totalRowSize( 0 ),
-	mathEngineDataSize( 0 )
+	columnCount( _columnCount )
 {
 	NeoAssert( rowCount > 0 );
 	NeoAssert( columnCount > 0 );
@@ -64,12 +61,7 @@ void CDnnSparseMatrix::Create( const IProblem* problem, int startVectorIndex, in
 				totalRowSize++;
 			}
 			totalRowSize = CeilTo( totalRowSize, 4 );
-
-			CMatrix matrix;
-			matrix.ElementCount = 0;
-			matrix.RowPos = totalRowSize;
-			matrix.ElementPos = totalElementSize;
-			matrixes.Add( matrix );
+			matrixes.Add( CMatrix( /*elementCount*/0, totalRowSize, totalElementSize ) );
 		}
 		matrixes.Last().ElementCount += vectors.Last().Size;
 		totalElementSize += vectors.Last().Size;
@@ -141,12 +133,10 @@ CSparseMatrixDesc CDnnSparseMatrix::GetBatchDesc( int index ) const
 	NeoAssert( !vectors.IsEmpty() );
 	NeoAssert( !matrixes.IsEmpty() );
 
-	CSparseMatrixDesc result;
-	result.ElementCount = matrixes[index].ElementCount;
-	result.Rows = mathEngineData + matrixes[index].RowPos;
-	result.Columns = mathEngineData + totalRowSize + matrixes[index].ElementPos;
-	result.Values = CFloatHandle( mathEngineData ) + totalRowSize + totalElementSize + matrixes[index].ElementPos;
-	return result;
+	return CSparseMatrixDesc( matrixes[index].ElementCount,
+		mathEngineData + matrixes[index].RowPos,
+		mathEngineData + totalRowSize + matrixes[index].ElementPos,
+		CFloatHandle( mathEngineData ) + totalRowSize + totalElementSize + matrixes[index].ElementPos );
 }
 
 } // namespace NeoML

NeoML/src/TraditionalML/PCA.cpp

@@ -70,11 +70,10 @@ static CSparseMatrixDesc getSparseMatrixDesc( IMathEngine& mathEngine, const CFl
 {
 	const int height = data.Height;
 	const int width = data.Width;
-	CSparseMatrixDesc desc;
-	desc.ElementCount = ( data.Columns == nullptr ) ? height * width : data.PointerE[height - 1];
-	columns = CDnnBlob::CreateVector( mathEngine, CT_Int, desc.ElementCount );
+	int elementCount = ( data.Columns == nullptr ) ? height * width : data.PointerE[height - 1];
+	columns = CDnnBlob::CreateVector( mathEngine, CT_Int, elementCount );
 	rows = CDnnBlob::CreateVector( mathEngine, CT_Int, height + 1 );
-	values = CDnnBlob::CreateVector( mathEngine, CT_Float, desc.ElementCount );
+	values = CDnnBlob::CreateVector( mathEngine, CT_Float, elementCount );
 	if( data.Columns != nullptr ) {
 		columns->CopyFrom( data.Columns );
 		int* rowBuffer = rows->GetBuffer<int>( 0, height + 1, false );
@@ -84,7 +83,7 @@ static CSparseMatrixDesc getSparseMatrixDesc( IMathEngine& mathEngine, const CFl
 		rowBuffer[height] = data.PointerE[height - 1];
 		rows->ReleaseBuffer( rowBuffer, true );
 	} else {
-		desc.ElementCount = height * width;
+		elementCount = height * width;
 		int* colBuffer = columns->GetBuffer<int>( 0, height * width, false );
 		int* rowBuffer = rows->GetBuffer<int>( 0, height + 1, false );
 		for( int i = 0; i < height; i++ ) {
@@ -97,11 +96,8 @@ static CSparseMatrixDesc getSparseMatrixDesc( IMathEngine& mathEngine, const CFl
 		rows->ReleaseBuffer( rowBuffer, true );
 		columns->ReleaseBuffer( colBuffer, true );
 	}
-	desc.Columns = columns->GetData<int>();
 	values->CopyFrom( data.Values );
-	desc.Values = values->GetData<float>();
-	desc.Rows = rows->GetData<int>();
-	return desc;
+	return CSparseMatrixDesc( elementCount, rows->GetData<int>(), columns->GetData<int>(), values->GetData<float>() );
 }
 
 // copy blob with reduced width

NeoMathEngine/include/NeoMathEngine/SparseMatrixDesc.h

@@ -1,4 +1,4 @@
-/* Copyright © 2017-2020 ABBYY Production LLC
+/* Copyright © 2017-2024 ABBYY
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -20,18 +20,19 @@ limitations under the License.
 namespace NeoML {
 
 // Sparse matrix descriptor (CSR format)
-struct CSparseMatrixDesc {
+struct CSparseMatrixDesc final {
 	// The number of elements
-	int ElementCount;
+	const int ElementCount;
 	// This array of (matrix height + 1) length stores the indices where the new row starts, as (Columns + Values)
 	// The last array element is equal to the number of elements in the matrix
-	CIntHandle Rows;
+	const CIntHandle Rows;
 	// This array of ElementCount length contains the indices of the columns to which the corresponding values belong
-	CIntHandle Columns;
+	const CIntHandle Columns;
 	// This array of ElementCount length contains the matrix elements' values
-	CFloatHandle Values;
+	const CFloatHandle Values;
 
-	CSparseMatrixDesc() : ElementCount( 0 ) {}
+	CSparseMatrixDesc( int count, const CIntHandle& rows, const CIntHandle& columns, const CFloatHandle& values ) :
+		ElementCount( count ), Rows( rows ), Columns( columns ), Values( values ) {}
 };
 
 } // namespace NeoML

NeoMathEngine/test/src/common/TestFixture.h

@@ -274,15 +274,7 @@ class CSparseMatrix final {
 		mathEngine.DataExchangeTyped<float>( values, _values.data(), _values.size() );
 	}
 
-	CSparseMatrixDesc Desc() const
-	{
-		CSparseMatrixDesc desc;
-		desc.ElementCount = elementCount;
-		desc.Rows = rows;
-		desc.Columns = columns;
-		desc.Values = values;
-		return desc;
-	}
+	CSparseMatrixDesc Desc() const { return CSparseMatrixDesc( elementCount, rows, columns, values ); }
 
 private:
 	int elementCount;