Fixes #236 (#237)

* Fixes #236

* Renamed variables and added new accessors methods

Author: jordanmontt

src/Math-Matrix/PMSingularValueDecomposition.class.st

@@ -32,9 +32,9 @@ Class {
 	#name : #PMSingularValueDecomposition,
 	#superclass : #Object,
 	#instVars : [
-		'u',
-		's',
-		'v'
+		'diagonalSingularValueMatrix',
+		'leftSingularMatrix',
+		'rightSingularMatrix'
 	],
 	#category : #'Math-Matrix'
 }
@@ -44,6 +44,13 @@ PMSingularValueDecomposition class >> decompose: aMatrix [
 	^ self new initialize: aMatrix
 ]
 
+{ #category : #accessing }
+PMSingularValueDecomposition >> diagonalSingularValueMatrix [
+	"Diagonal matrix S in A = USV decomposition. All elements are 0 except those on the main diagonal. The values on the diagonal are singular values of matrix A. By convention, they are sorted in descending order"
+
+	^ diagonalSingularValueMatrix
+]
+
 { #category : #initialization }
 PMSingularValueDecomposition >> initialize: aMatrix [
 
@@ -56,26 +63,55 @@ PMSingularValueDecomposition >> initialize: aMatrix [
 	"Expensive computation"
 	eigenU := symU eigen.
 	eigenV := symV eigen.
-	u := (PMMatrix rows: eigenU vectors) transpose.
-	v := (PMMatrix rows: eigenV vectors) transpose.
+	leftSingularMatrix := (PMMatrix rows: eigenU vectors) transpose.
+	rightSingularMatrix := (PMMatrix rows: eigenV vectors) transpose.
 	diag := m < n
 		        ifTrue: [ eigenU values ]
 		        ifFalse: [ eigenV values ].
-	s := PMMatrix rows: m columns: n random: 0.
-	s setDiagonal: diag sqrt
+	diagonalSingularValueMatrix := PMMatrix rows: m columns: n random: 0.
+	diagonalSingularValueMatrix setDiagonal: diag sqrt
 ]
 
 { #category : #accessing }
 PMSingularValueDecomposition >> leftSingularForm [
-	^ u
+
+	self
+		deprecated: 'Use leftSingularMatrix instead'
+		transformWith:'`@receiver leftSingularForm' -> '`@receiver leftSingularMatrix'.
+
+	^ leftSingularMatrix
+]
+
+{ #category : #accessing }
+PMSingularValueDecomposition >> leftSingularMatrix [
+	"Matrix U in the A = USV decomposition. The columns of this matrix are the eigenvectors of the A * (A transposed) matrix (called left singular vectors). The columns of this matrix are orthonormal"
+
+	^ leftSingularMatrix
 ]
 
 { #category : #accessing }
 PMSingularValueDecomposition >> rightSingularForm [
-	^ v
+
+	self
+		deprecated: 'Use rightSingularMatrix instead'
+		transformWith: '`@receiver rightSingularForm' -> '`@receiver rightSingularMatrix'.
+
+	^ rightSingularMatrix
+]
+
+{ #category : #accessing }
+PMSingularValueDecomposition >> rightSingularMatrix [
+	"Matrix V in the A = USV decomposition. The columns of this matrix are the eigenvectors of the (A transposed) * A matrix (called right singular vectors). The columns of this matrix are orthonormal"
+
+	^ rightSingularMatrix
 ]
 
 { #category : #accessing }
 PMSingularValueDecomposition >> sForm [
-	^ s
+
+	self
+		deprecated: 'Use diagonalSingularValueMatrix instead'
+		transformWith: '`@receiver sForm' -> '`@receiver diagonalSingularValueMatrix'.
+	
+	^ diagonalSingularValueMatrix
 ]