Merge pull request #272 from olekscode/267-Remove-equalsTo-because-it-is-closeTo-and-not-equalsTo

Fixed #267. Deprecated equalsTo: and changed all senders to use closeTo: instead

Author: olekscode

src/Math-AutomaticDifferenciation/PMDualNumber.class.st

@@ -133,6 +133,13 @@ PMDualNumber >> asInteger [
 	^ value asInteger
 ]
 
+{ #category : #comparing }
+PMDualNumber >> closeTo: aDualNumber [
+
+	^ (value closeTo: aDualNumber value) and: [ 
+		  eps closeTo: aDualNumber eps ]
+]
+
 { #category : #'mathematical functions' }
 PMDualNumber >> conjugated [
 	^ self class
@@ -157,7 +164,12 @@ PMDualNumber >> eps: aNumber [
 
 { #category : #comparing }
 PMDualNumber >> equalsTo: aDualNumber [
-	^ (value equalsTo: aDualNumber value) and: [ eps equalsTo: aDualNumber eps ]
+
+	self
+		deprecated: 'Use closeTo: instead'
+		transformWith: '`@rec equalsTo: `@arg' -> '`@rec closeTo: `@arg'.
+
+	^ self closeTo: aDualNumber 
 ]
 
 { #category : #testing }

src/Math-AutomaticDifferenciation/PMHyperDualNumber.class.st

@@ -96,6 +96,14 @@ PMHyperDualNumber >> arcTan [
 		yourself
 ]
 
+{ #category : #comparing }
+PMHyperDualNumber >> closeTo: aHyperDualNumber [
+
+	^ (super closeTo: aHyperDualNumber) and: [ 
+		  (eps2 closeTo: aHyperDualNumber eps2) and: [ 
+			  eps1eps2 closeTo: aHyperDualNumber eps1eps2 ] ]
+]
+
 { #category : #'mathematical functions' }
 PMHyperDualNumber >> cos [
 	^ super cos
@@ -126,9 +134,12 @@ PMHyperDualNumber >> eps2: anEps2 [
 
 { #category : #comparing }
 PMHyperDualNumber >> equalsTo: aHyperDualNumber [
-	^ (super equalsTo: aHyperDualNumber)
-		and: [ (eps2 equalsTo: aHyperDualNumber eps2)
-				and: [ eps1eps2 equalsTo: aHyperDualNumber eps1eps2 ] ] 
+
+	self
+		deprecated: 'Use closeTo: instead'
+		transformWith: '`@rec equalsTo: `@arg' -> '`@rec closeTo: `@arg'.
+
+	^ self closeTo: aHyperDualNumber
 ]
 
 { #category : #'mathematical functions' }

src/Math-Core/SequenceableCollection.extension.st

@@ -1,9 +1,20 @@
 Extension { #name : #SequenceableCollection }
 
+{ #category : #'*Math-Core' }
+SequenceableCollection >> closeTo: aSequenceableCollection [
+
+	self
+		with: aSequenceableCollection
+		do: [ :a :b | (a closeTo: b) ifFalse: [ ^ false ] ].
+	^ true
+]
+
 { #category : #'*Math-Core' }
 SequenceableCollection >> equalsTo: aSequenceableCollection [
+	
+	self
+		deprecated: 'Use closeTo: instead'
+		transformWith: '`@rec equalsTo: `@arg' -> '`@rec closeTo: `@arg'.
 
-"^ self = aSequenceableCollection "
-self with: aSequenceableCollection do: [:a :b| (a equalsTo: b) ifFalse: [^false]   ].
-^true
+	^ self closeTo: aSequenceableCollection
 ]

src/Math-FunctionFit/PMFunctionFit.class.st

@@ -9,7 +9,7 @@ fit result parameters .   --->  #(1.9999999999999998 0.39999999999999863)
 Class {
 	#name : #PMFunctionFit,
 	#superclass : #PMLeastSquareFit,
-	#category : 'Math-FunctionFit'
+	#category : #'Math-FunctionFit'
 }
 
 { #category : #creation }
@@ -78,9 +78,12 @@ PMFunctionFit >> parameters [
 
 { #category : #initialization }
 PMFunctionFit >> parameters: indexableCollection [
-indexableCollection do:[ :e|(e equalsTo: 0.0)ifTrue: [ self error:'parameters shouldnt be set to practically zero' ] ].
-result parameters: indexableCollection.
-self finalizeIterations .
+
+	indexableCollection do: [ :e | 
+		(e closeTo: 0.0) ifTrue: [ 
+			self error: 'parameters shouldnt be set to practically zero' ] ].
+	result parameters: indexableCollection.
+	self finalizeIterations
 ]
 
 { #category : #printing }

src/Math-Matrix/PMMatrix.class.st

@@ -483,10 +483,12 @@ PMMatrix >> elementwiseProductWithMatrix: aMatrix [
 
 { #category : #'as yet unclassified' }
 PMMatrix >> equalsTo: aMatrix [
-	self rows 
-			with: aMatrix rows  
-			do: [:a :b| (a equalsTo: b) ifFalse: [ ^false ] ].
-	^ true 
+
+	self
+		deprecated: 'Use closeTo: instead'
+		transformWith: '`@rec equalsTo: `@arg' -> '`@rec closeTo: `@arg'.
+	
+	^ self closeTo: aMatrix
 ]
 
 { #category : #'as yet unclassified' }
@@ -746,35 +748,50 @@ PMMatrix >> productWithVector: aVector [
 
 { #category : #'as yet unclassified' }
 PMMatrix >> qrFactorization [
-	|identMat q r hh colSize i|
-	self numberOfRows < self numberOfColumns ifTrue:[ self error: 'numberOfRows<numberOfColumns' ]. 
-	r :=PMMatrix rows: (rows deepCopy).
+
+	| identMat q r hh colSize i |
+	self numberOfRows < self numberOfColumns ifTrue: [ 
+		self error: 'numberOfRows<numberOfColumns' ].
+	r := PMMatrix rows: rows deepCopy.
 	colSize := self numberOfRows.
-	q := PMSymmetricMatrix identity: colSize.  
+	q := PMSymmetricMatrix identity: colSize.
 	identMat := q deepCopy.
-	1 to: self numberOfColumns do: [:col| 
+	1 to: self numberOfColumns do: [ :col | 
 		hh := ((r columnAt: col) copyFrom: col to: colSize) householder.
-		i := (PMVector new: col-1withAll: 0) , (hh at:2 ).
-		q := q* (identMat - ((hh at: 1)*i tensorProduct: i ))."not really necessary, should be simplified"
-		i := PMMatrix rows:  ( (r rows allButFirst: (col -1)) collect: [:aRow| aRow allButFirst: (col -1)]  ).
-		i := i - ((hh at: 2) tensorProduct: ( (hh at: 1)*(hh at: 2)*i  ) ) .
-		i rows withIndexDo: [ :aRow :index |
-			aRow  withIndexDo: [ :n :c| r rowAt: (col + index -1) columnAt: (col +c -1) put: ((n equalsTo: 0) ifTrue: [0] ifFalse:  [n]  )  ]  ] .
-	"col <colSize ifTrue: [i :=(hh at: 2) copyFrom: 2 to: colSize -col +1.  i withIndexDo: [:n :index| r rowAt: col columnAt: index put: n  ]  ]""and this part is not correct, dont uncomment before the bug is corrected! useful if q is not explicitely necessary" ].
-"r rows allButFirst withIndexDo: [:aRow :ri|1 to: (ri min: self numberOfColumns ) do: [:ci|aRow at: ci put:0  ]   ]  ""not necessary with equalsTo:0"  
-	i :=0.
-	[(r rowAt: colSize) allSatisfy: [:n| n=0]  ]whileTrue: [i :=i+1.colSize :=colSize -1].
-	i>0 ifTrue: [ r :=PMMatrix rows: (r rows copyFrom: 1 to:  colSize). 
-					i := q numberOfColumns - i. 
-					q := PMMatrix rows:  ( q rows collect: [:row| row copyFrom: 1 to: i]) ].  
-	^Array with: q with: r
+		i := (PMVector new: col - 1 withAll: 0) , (hh at: 2).
+		q := q * (identMat - ((hh at: 1) * i tensorProduct: i)). "not really necessary, should be simplified"
+		i := PMMatrix rows:
+			     ((r rows allButFirst: col - 1) collect: [ :aRow | 
+				      aRow allButFirst: col - 1 ]).
+		i := i - ((hh at: 2) tensorProduct: (hh at: 1) * (hh at: 2) * i).
+		i rows withIndexDo: [ :aRow :index | 
+			aRow withIndexDo: [ :n :c | 
+				r
+					rowAt: col + index - 1
+					columnAt: col + c - 1
+					put: ((n closeTo: 0)
+							 ifTrue: [ 0 ]
+							 ifFalse: [ n ]) ] ]
+		"col <colSize ifTrue: [i :=(hh at: 2) copyFrom: 2 to: colSize -col +1.  i withIndexDo: [:n :index| r rowAt: col columnAt: index put: n  ]  ]""and this part is not correct, dont uncomment before the bug is corrected! useful if q is not explicitely necessary" ].
+	"r rows allButFirst withIndexDo: [:aRow :ri|1 to: (ri min: self numberOfColumns ) do: [:ci|aRow at: ci put:0  ]   ]  ""not necessary with equalsTo:0"
+	i := 0.
+	[ (r rowAt: colSize) allSatisfy: [ :n | n = 0 ] ] whileTrue: [ 
+		i := i + 1.
+		colSize := colSize - 1 ].
+	i > 0 ifTrue: [ 
+		r := PMMatrix rows: (r rows copyFrom: 1 to: colSize).
+		i := q numberOfColumns - i.
+		q := PMMatrix rows:
+			     (q rows collect: [ :row | row copyFrom: 1 to: i ]) ].
+	^ Array with: q with: r
 ]
 
 { #category : #'as yet unclassified' }
 PMMatrix >> qrFactorizationWithPivoting [
+
 	| identMat q r hh colSize i lengthArray rank mx pivot |
-	self numberOfRows < self numberOfColumns
-		ifTrue: [ self error: 'numberOfRows<numberOfColumns' ].
+	self numberOfRows < self numberOfColumns ifTrue: [ 
+		self error: 'numberOfRows<numberOfColumns' ].
 	lengthArray := self columnsCollect: [ :col | col * col ].
 	mx := lengthArray indexOf: lengthArray max.
 	pivot := Array new: lengthArray size.
@@ -791,41 +808,41 @@ PMMatrix >> qrFactorizationWithPivoting [
 	hh := ((r columnAt: rank) copyFrom: rank to: colSize) householder.
 	i := (PMVector new: rank - 1 withAll: 0) , (hh at: 2).
 	q := q * (identMat - ((hh at: 1) * i tensorProduct: i)).
-	i := PMMatrix rows: ((r rows allButFirst: rank - 1) collect: [ :aRow | aRow allButFirst: rank - 1 ]).
+	i := PMMatrix rows:
+		     ((r rows allButFirst: rank - 1) collect: [ :aRow | 
+			      aRow allButFirst: rank - 1 ]).
 	i := i - ((hh at: 2) tensorProduct: (hh at: 1) * (hh at: 2) * i).
-	i rows
-		withIndexDo: [ :aRow :index | 
-			aRow
-				withIndexDo: [ :n :c | 
-					r
-						rowAt: rank + index - 1
-						columnAt: rank + c - 1
-						put:
-							((n equalsTo: 0)
-								ifTrue: [ 0 ]
-								ifFalse: [ n ]) ] ].
-	rank + 1 to: lengthArray size do: [ :ind | lengthArray at: ind put: (lengthArray at: ind) - (r rowAt: rank columnAt: ind) squared ].
+	i rows withIndexDo: [ :aRow :index | 
+		aRow withIndexDo: [ :n :c | 
+			r
+				rowAt: rank + index - 1
+				columnAt: rank + c - 1
+				put: ((n closeTo: 0)
+						 ifTrue: [ 0 ]
+						 ifFalse: [ n ]) ] ].
+	rank + 1 to: lengthArray size do: [ :ind | 
+		lengthArray
+			at: ind
+			put: (lengthArray at: ind) - (r rowAt: rank columnAt: ind) squared ].
 	rank < lengthArray size
 		ifTrue: [ 
 			mx := (lengthArray copyFrom: rank + 1 to: lengthArray size) max.
-			(mx equalsTo: 0)
-				ifTrue: [ mx := 0 ].
+			(mx closeTo: 0) ifTrue: [ mx := 0 ].
 			mx := mx > 0
-				ifTrue: [ lengthArray indexOf: mx startingAt: rank + 1 ]
-				ifFalse: [ 0 ] ]
+				      ifTrue: [ lengthArray indexOf: mx startingAt: rank + 1 ]
+				      ifFalse: [ 0 ] ]
 		ifFalse: [ mx := 0 ].
 	mx > 0 ] whileTrue.
 	i := 0.
-	[ (r rowAt: colSize) allSatisfy: [ :n | n = 0 ] ]
-		whileTrue: [ 
-			i := i + 1.
-			colSize := colSize - 1 ].
-	i > 0
-		ifTrue: [ 
-			r := PMMatrix rows: (r rows copyFrom: 1 to: colSize).
-			i := q numberOfColumns - i.
-			pivot := pivot copyFrom: 1 to: i.
-			q := PMMatrix rows: (q rows collect: [ :row | row copyFrom: 1 to: i ]) ].
+	[ (r rowAt: colSize) allSatisfy: [ :n | n = 0 ] ] whileTrue: [ 
+		i := i + 1.
+		colSize := colSize - 1 ].
+	i > 0 ifTrue: [ 
+		r := PMMatrix rows: (r rows copyFrom: 1 to: colSize).
+		i := q numberOfColumns - i.
+		pivot := pivot copyFrom: 1 to: i.
+		q := PMMatrix rows:
+			     (q rows collect: [ :row | row copyFrom: 1 to: i ]) ].
 	^ Array with: q with: r with: pivot
 ]
 

src/Math-Numerical/Number.extension.st

@@ -19,8 +19,12 @@ Number >> dividingPolynomial: aPolynomial [
 
 { #category : #'*Math-Numerical' }
 Number >> equalsTo: aNumber [
-		"compare to Float>>closeTo:"
-	^self relativelyEqualsTo: aNumber upTo: PMFloatingPointMachine new defaultNumericalPrecision
+		
+	self
+		deprecated: 'Use closeTo: instead'
+		transformWith: '`@rec equalsTo: `@arg' -> '`@rec closeTo: `@arg'.
+		
+	^ self closeTo: aNumber
 ]
 
 { #category : #'*Math-Numerical' }

src/Math-Numerical/PMNewtonZeroFinder.class.st

@@ -49,7 +49,7 @@ PMNewtonZeroFinder >> computeInitialValues [
 	derivativeBlock isNil
 		ifTrue: [ derivativeBlock := self defaultDerivativeBlock].
 	n := 0.
-	[ (derivativeBlock value: result) equalsTo: 0]
+	[ (derivativeBlock value: result) closeTo: 0]
 		whileTrue: [ n := n + 1.
 					 n > maximumIterations
 						ifTrue: [ self error: 'Function''s derivative seems to be zero everywhere'].

src/Math-ODE/PMAB2Solver.class.st

@@ -34,7 +34,7 @@ PMAB2Solver >> firstStepperClass [
 { #category : #solving }
 PMAB2Solver >> lastStepPrevState: prevState endTime: endTime [
 	"catch partial or full step at end"
-	(lastTime equalsTo: endTime )
+	(lastTime closeTo: endTime )
 	ifFalse:
 		[state := stepper 
 			lastStep: state 

src/Math-ODE/PMAB3Solver.class.st

@@ -21,7 +21,7 @@ PMAB3Solver class >> stepperClass [
 { #category : #'as yet unclassified' }
 PMAB3Solver >> lastStepPrevState: prevState prevPrevState: prevPrevState endTime: endTime [
 	"catch partial or full step at end"
-	(lastTime equalsTo: endTime )
+	(lastTime closeTo: endTime )
 	ifFalse:
 		[state := stepper 
 			lastStep: state 

src/Math-ODE/PMAB4Solver.class.st

@@ -21,7 +21,7 @@ PMAB4Solver class >> thirdStepperClass [
 { #category : #'as yet unclassified' }
 PMAB4Solver >> lastStepPrevState: prevState prevPrevState: prevPrevState initState:initState endTime: endTime [
 	"catch partial or full step at end"
-	(lastTime equalsTo: endTime )
+	(lastTime closeTo: endTime )
 	ifFalse:
 		[state := stepper 
 			lastStep: state