Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated Docstring of "is_subset()" #22731

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Updated Docstring of "is_subset()" #22731

wants to merge 6 commits into from

Conversation

ejcohe22
Copy link

References to other Issues or PRs

Fixes #9855

Brief description of what is fixed or changed

Added a useful docstring to explain the fuzzy bool returned in the "is_subset()" method. This is caused by intervals defined with variables. In the case (1, x) where x is a symbol in the real number domain, if x < 1 the set is empty, leading to unclear truth tables. This leads to confusion because the current docstring only describes True/False bools being returned.

Other comments

Please accept part of a class assignment due 12/20/21 11:59:00 PM EST

Release Notes

NO ENTRY

@sympy-bot
Copy link

✅

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

  • No release notes entry will be added for this pull request.
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 #9855


#### Brief description of what is fixed or changed
Added a useful docstring to explain the fuzzy bool returned in the "is_subset()" method. This is caused by intervals defined with variables. In the case (1, x) where x is a symbol in the real number domain, if x < 1 the set is empty, leading to unclear truth tables. This leads to confusion because the current docstring only describes True/False bools being returned.


#### Other comments
Please accept part of a class assignment due 12/20/21 11:59:00 PM EST

#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers.

or if no release note(s) should be included use:

NO ENTRY

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 -->
NO ENTRY
<!-- END RELEASE NOTES -->

@github-actions
Copy link

github-actions bot commented Dec 20, 2021 •
edited
Loading

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

Significantly changed benchmark results (PR vs master)



Significantly changed benchmark results (master vs previous release)


       before           after         ratio
     [907895ac]       [5d4477c8]
-         215±1ms        131±0.4ms     0.61  large_exprs.TimeLargeExpressionOperations.time_subs
-       226±0.3μs        104±0.2μs     0.46  matrices.TimeMatrixExpression.time_MatMul
-     14.1±0.02ms      7.55±0.03ms     0.53  matrices.TimeMatrixExpression.time_MatMul_doit
-      4.20±0.01s          317±1ms     0.08  polygon.PolygonArbitraryPoint.time_bench01
+     3.31±0.01ms      5.68±0.02ms     1.71  solve.TimeMatrixOperations.time_det(4, 2)
+     3.32±0.01ms      5.75±0.03ms     1.73  solve.TimeMatrixOperations.time_det_bareiss(4, 2)
+      37.7±0.4ms       70.4±0.6ms     1.87  solve.TimeMatrixSolvePyDySlow.time_linsolve(1)
+      38.6±0.5ms       70.1±0.5ms     1.82  solve.TimeMatrixSolvePyDySlow.time_solve(1)



Full benchmark results can be found as artifacts in GitHub Actions

(click on checks at the top of the PR).

      		
    

  





        


            

            

              
            

        

      


      

            
  

    
  
    
    

  

  



    












      

  
            











  
  

    

      

  




    


    

      

              

  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment


  



      

    

  




  
    




      

  

    
    

    
  

    Reviewers
  


    

    No reviews






    

  


      
  

    Assignees
  



        

    No one assigned







      


  


  

    Labels
  



    

      

    sets









      

  

    

        

    Projects
  


        




    None yet




  



      


  

    
  

    Milestone
  


      No milestone





    
      
          


  

    
      

        
    

    Development
  



          


Successfully merging this pull request may close these issues.


  
    
            
        bad subset evaluation


  


    
  




      

    

  
      

  

    

      3 participants
    

    

        
          @ejcohe22 
        
          @sympy-bot 
        
          @oscarbenjamin