Comparing matrix with object #20175

sidhu1012 · 2020-10-01T05:33:57Z

References to other Issues or PRs

Fixes #19361

Brief description of what is fixed or changed

Corrected eq() of Matrix

Other comments

Release Notes

matrices
- Changed behaviour of eq() of class DenseMatrix

sympy-bot · 2020-10-01T05:34:08Z

✅

Hi, I am the SymPy bot (v161). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

matrices
- Changed behaviour of eq() of class DenseMatrix (#20175 by @sidhu1012)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.8.

Click here to see the pull request description that was parsed.

<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->
Fixes #19361

#### Brief description of what is fixed or changed
Corrected __eq__() of Matrix

#### Other comments


#### Release Notes

<!-- Write the release notes for this release below. See
https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more information
on how to write release notes. The bot will check your release notes
automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
- matrices
       -  Changed behaviour of __eq__() of class DenseMatrix
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

sidhu1012 · 2020-10-01T05:35:56Z

@oscarbenjamin Does it seems right?

codecov · 2020-10-01T08:08:08Z

Codecov Report

Merging #20175 into master will decrease coverage by 0.080%.
The diff coverage is 80.000%.

@@              Coverage Diff              @@
##            master    #20175       +/-   ##
=============================================
- Coverage   75.855%   75.775%   -0.081%     
=============================================
  Files          671       674        +3     
  Lines       173793    174226      +433     
  Branches     41047     41117       +70     
=============================================
+ Hits        131832    132020      +188     
- Misses       36206     36485      +279     
+ Partials      5755      5721       -34

friyaz · 2020-10-01T18:34:06Z

Always add test cases that will fail without the changes you make. This ensures that the problem does not occur in the future.

oscarbenjamin · 2020-10-01T19:40:29Z

There is a decorator sympify_return for sympifying arguments or returning NotImplemented. It is used in sympy/core/expr.py.

sidhu1012 · 2020-10-02T07:43:09Z

Always add test cases that will fail without the changes you make. This ensures that the problem does not occur in the future.

Done

sidhu1012 · 2020-10-02T07:57:56Z

There is a decorator sympify_return for sympifying arguments or returning NotImplemented. It is used in sympy/core/expr.py.

Used it , decorator really easied it.

sidhu1012 · 2020-10-02T12:07:34Z

@oscarbenjamin pls review

sympy/matrices/tests/test_densearith.py

sidhu1012 · 2020-10-02T12:21:46Z

@friyaz Removed comments. Does everything else seems fine?

friyaz · 2020-10-02T12:26:08Z

Looks good to me.

sidhu1012 · 2020-10-02T13:48:50Z

There is a decorator sympify_return for sympifying arguments or returning NotImplemented. It is used in sympy/core/expr.py.

@oscarbenjamin @friyaz dont think using decorator is a good way because it is making other test fail

sidhu1012 · 2020-10-02T13:50:32Z

@oscarbenjamin @friyaz I dont think using decorator is a good way because it is making other test fail.
Is something missing in this PR or PR's first commit(ad3fa07) is a better solve for this.

sidhu1012 · 2020-10-03T04:17:57Z

@oscarbenjamin @friyaz So shall I drop the decorator and use the method of 1st commit?

sidhu1012 · 2020-10-03T07:30:05Z

This way is better as it doesn't break anything. Decorator breaks the code

sidhu1012 · 2020-10-03T09:45:47Z

@oscarbenjamin Does it seems right now??

oscarbenjamin · 2020-10-03T15:26:19Z

Why didn't the decorator work?

sidhu1012 · 2020-10-03T15:43:37Z

Why didn't the decorator work?

Decorator broke the code , and gave way too many failures

oscarbenjamin · 2020-10-03T16:25:13Z

Can you give an example of something that didn't work?

sidhu1012 · 2020-10-03T16:38:52Z

Can you give an example of something that didn't work?

https://travis-ci.org/github/sympy/sympy/builds/732235398

See the build at travis , all 4 test failed, test files and doc tests.

sidhu1012 · 2020-10-05T03:54:26Z

@oscarbenjamin Is it good without decorator?

oscarbenjamin · 2020-10-05T11:20:37Z

Yes, it should be fine but we should check why it didn't work with the decorator. Maybe the decorator can be improved or maybe it's just not suitable for this. Without investigating the failures we won't know.

sidhu1012 · 2020-10-05T12:26:33Z

Yes, it should be fine but we should check why it didn't work with the decorator. Maybe the decorator can be improved or maybe it's just not suitable for this. Without investigating the failures we won't know.

Okay , i'll look into it as much as I can

sidhu1012 · 2020-10-06T07:38:10Z

or maybe it's just not suitable for this.

The number of test failures suggest decorator isn't suitable for this. Because the number of failures are really high and are in almost every module

sidhu1012 · 2020-10-07T12:51:09Z

@oscarbenjamin What do you say? Is is good to go?

oscarbenjamin · 2020-10-07T19:23:06Z

Why doesn't the decorator work?

The error from the test logs is

    if not isinstance(other, expectedcls):
TypeError: isinstance() arg 2 must be a type or tuple of types

That suggests that the decorator wasn't used correctly.

sidhu1012 · 2020-10-08T03:15:37Z

I'll give it another try

sidhu1012 · 2020-10-09T14:24:53Z

@oscarbenjamin Is it good to go now??

oscarbenjamin · 2020-10-09T15:52:36Z

sympy/matrices/dense.py

    def __eq__(self, other):
-        other = sympify(other)
        self_shape = getattr(self, 'shape', None)
        other_shape = getattr(other, 'shape', None)
        if None in (self_shape, other_shape):


The conditions below suggest that sometimes other is not a DenseMatrix. Is that not ever the case?

It works for all cases .

sidhu1012 · 2020-10-10T08:44:10Z

@oscarbenjamin I have checked and updates test file with other Matrix types also. It works as expected.

sidhu1012 · 2020-10-10T11:07:38Z

@oscarbenjamin Please review.

sidhu1012 · 2020-10-11T05:42:04Z

Since @oscarbenjamin is busy with 1.7 update. Can someone else review please.I think it is good to go.

sidhu1012 · 2020-10-11T15:57:06Z

Can someone please review

sidhu1012 · 2020-10-14T12:27:17Z

@sylee957 Please review.

sidhu1012 · 2020-10-15T03:14:20Z

Since no one is reviewing, @oscarbenjamin please review it when free

sidhu1012 · 2020-10-16T08:00:22Z

Can someone please review this PR.

sylee957 · 2020-10-16T08:07:05Z

sympy/matrices/dense.py

 class DenseMatrix(MatrixBase):

    is_MatrixExpr = False  # type: bool

    _op_priority = 10.01
    _class_priority = 4

+    @sympify_return([('other', 'DenseMatrix')], NotImplemented)


Can't we add this to SparseMatrix such that it can be symmetric change?

okay , would do that.

The decorator can be used when sympifying code, since the SparseMatrix isn't sympifying , it shouldn't be added in SparseMatrix

I'd rather change that SparseMatrix to sympify the arguments before calls
It is problematic if operations supported in DenseMatrix is not supported by SparseMatrix only because of sympify
For example,

from sympy import * import mpmath m = mpmath.matrix([[1, 2], [3, 4]]) Matrix([[1, 2], [3, 4]]) == m # True SparseMatrix([[1, 2], [3, 4]]) == m # False

sidhu1012 · 2020-10-19T10:57:57Z

@sylee957 @oscarbenjamin I have removed the decorator and used _sympify instead .
@oscarbenjamin was right #20175 (comment) , the decorator would make Dense Matrix == Dense only and same goes to sparse, earlier it was working because changes weren't symmetric.

oscarbenjamin · 2020-10-20T13:06:30Z

@sidhu1012 we are having problems with CI (#20289). The tests are unlikely to pass for these PRs until that is resolved. I cancelled the previous run of the tests because because they were slowing down the tests for #20297

sidhu1012 · 2020-10-20T13:52:18Z

@oscarbenjamin Okay , please review this PR though

sidhu1012 · 2020-10-24T12:23:57Z

@oscarbenjamin @sylee957 Please review

Comparing matrix with obj

ad3fa07

friyaz added the matrices label Oct 1, 2020

Added test cases

480ed80

used sympify decorator

1098852

friyaz reviewed Oct 2, 2020

View reviewed changes

sympy/matrices/tests/test_densearith.py Outdated Show resolved Hide resolved

Remove unnecessary comments

7c6c6cd

Removed decorator

ff373bc

Fixed Decorator

62b40f9

oscarbenjamin reviewed Oct 9, 2020

View reviewed changes

Updated test cases

22498b8

friyaz requested a review from sylee957 October 11, 2020 18:56

friyaz approved these changes Oct 11, 2020

View reviewed changes

sylee957 reviewed Oct 16, 2020

View reviewed changes

Make symmetric changes to Sparse and Dense, removed decorator

1708a55

sidhu1012 closed this Oct 20, 2020

sidhu1012 reopened this Oct 20, 2020

sidhu1012 closed this Oct 20, 2020

sidhu1012 reopened this Oct 20, 2020

sylee957 merged commit 5b2eabb into sympy:master Oct 24, 2020

Uh oh!

Comparing matrix with object #20175

Comparing matrix with object #20175

Uh oh!

Conversation

sidhu1012 commented Oct 1, 2020

References to other Issues or PRs

Brief description of what is fixed or changed

Other comments

Release Notes

Uh oh!

sympy-bot commented Oct 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sidhu1012 commented Oct 1, 2020

Uh oh!

codecov bot commented Oct 1, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

friyaz commented Oct 1, 2020

Uh oh!

oscarbenjamin commented Oct 1, 2020

Uh oh!

sidhu1012 commented Oct 2, 2020

Uh oh!

sidhu1012 commented Oct 2, 2020

Uh oh!

sidhu1012 commented Oct 2, 2020

Uh oh!

Uh oh!

sidhu1012 commented Oct 2, 2020

Uh oh!

friyaz commented Oct 2, 2020

Uh oh!

sidhu1012 commented Oct 2, 2020

Uh oh!

sidhu1012 commented Oct 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sidhu1012 commented Oct 3, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sidhu1012 commented Oct 3, 2020

Uh oh!

sidhu1012 commented Oct 3, 2020

Uh oh!

oscarbenjamin commented Oct 3, 2020

Uh oh!

sidhu1012 commented Oct 3, 2020

Uh oh!

oscarbenjamin commented Oct 3, 2020

Uh oh!

sidhu1012 commented Oct 3, 2020

Uh oh!

sidhu1012 commented Oct 5, 2020

Uh oh!

oscarbenjamin commented Oct 5, 2020

Uh oh!

sidhu1012 commented Oct 5, 2020

Uh oh!

sidhu1012 commented Oct 6, 2020

Uh oh!

sidhu1012 commented Oct 7, 2020

Uh oh!

oscarbenjamin commented Oct 7, 2020

Uh oh!

sidhu1012 commented Oct 8, 2020

Uh oh!

sidhu1012 commented Oct 9, 2020

Uh oh!

oscarbenjamin Oct 9, 2020

Choose a reason for hiding this comment

Uh oh!

sidhu1012 Oct 10, 2020

Choose a reason for hiding this comment

Uh oh!

sidhu1012 commented Oct 10, 2020

Uh oh!

sidhu1012 commented Oct 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

sympy-bot commented Oct 1, 2020 •

edited

Loading

codecov bot commented Oct 1, 2020 •

edited

Loading

sidhu1012 commented Oct 2, 2020 •

edited

Loading

sidhu1012 commented Oct 3, 2020 •

edited

Loading

sidhu1012 commented Oct 10, 2020 •

edited

Loading

sidhu1012 commented Oct 11, 2020 •

edited

Loading

sidhu1012 commented Oct 19, 2020 •

edited

Loading