{"action":"created","comment":{"url":"https://api.github.com/repos/sympy/sympy/pulls/comments/36655830","id":36655830,"diff_hunk":"@@ -1,12 +1,317 @@\n Solveset\n-==========\n+========\n \n .. module:: sympy.solvers.solveset\n \n-This module contains functions to solve a single equation for a single variable.\n+This is the official documentation of the `solveset` module in solvers.\n+It contains the Frequently asked Questions about our new module to solve\n+equations.\n+\n+What's wrong with solve():\n+--------------------------\n+\n+SymPy already has a pretty powerful `solve` function. But it has a lot of major\n+issues\n+\n+1. It doesn't have a consistent output for various types of solutions\n+   It needs to return a lot of types of solutions consistently:\n+\n+   * single solution : ` x == 1`\n+   * Multiple solutions: `x^2 == 1`\n+   * No Solution: `x^2 + 1 == 0` ; x is real\n+   * Interval of solution: `floor(x) == 0`\n+   * Infinitely many solutions: `sin(x) == 0`\n+   * Multivariate functions with point solutions: `x^2 + y^2 == 0`\n+   * Multivariate functions with non point solution: `x^2 + y^2 == 1`\n+   * System of equations: `x + y == 1` and `x - y == 0`\n+   * Relational: `x > 0`\n+   * And the most important case \"We don't Know\"\n+\n+2. The input API is also a mess, there are a lot of parameters. Many of them\n+   are not needed and they make it hard for the user and the developers to\n+   work on solvers.\n+\n+3. There are cases like finding the maxima and minima of function using\n+   critical points where it is important to know if it has returned all the\n+   solutions. `solve` does not guarantee this.\n+\n+\n+Why Solveset?\n+-------------\n+\n+* `solveset` has a cleaner input and output interface: `solveset` returns a set\n+  object and a set object take care of all the types of the output. For cases\n+  where it doesn't \"know\" all the solutions a `NotImplementedError` is raised.","path":"doc/src/modules/solvers/solveset.rst","position":46,"original_position":46,"commit_id":"dfe1dc8bd0262f86400962dd225eb4a3e472ccf0","original_commit_id":"dfe1dc8bd0262f86400962dd225eb4a3e472ccf0","user":{"login":"gxyd","id":7712241,"avatar_url":"https://avatars.githubusercontent.com/u/7712241?v=3","gravatar_id":"","url":"https://api.github.com/users/gxyd","html_url":"https://github.com/gxyd","followers_url":"https://api.github.com/users/gxyd/followers","following_url":"https://api.github.com/users/gxyd/following{/other_user}","gists_url":"https://api.github.com/users/gxyd/gists{/gist_id}","starred_url":"https://api.github.com/users/gxyd/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gxyd/subscriptions","organizations_url":"https://api.github.com/users/gxyd/orgs","repos_url":"https://api.github.com/users/gxyd/repos","events_url":"https://api.github.com/users/gxyd/events{/privacy}","received_events_url":"https://api.github.com/users/gxyd/received_events","type":"User","site_admin":false},"body":"It has now been replaced by `ConditionSet` everywhere (i guess) ?","created_at":"2015-08-10T17:04:48Z","updated_at":"2015-08-10T17:04:48Z","html_url":"https://github.com/sympy/sympy/pull/9500#discussion_r36655830","pull_request_url":"https://api.github.com/repos/sympy/sympy/pulls/9500","_links":{"self":{"href":"https://api.github.com/repos/sympy/sympy/pulls/comments/36655830"},"html":{"href":"https://github.com/sympy/sympy/pull/9500#discussion_r36655830"},"pull_request":{"href":"https://api.github.com/repos/sympy/sympy/pulls/9500"}}},"pull_request":{"url":"https://api.github.com/repos/sympy/sympy/pulls/9500","id":37337778,"html_url":"https://github.com/sympy/sympy/pull/9500","diff_url":"https://github.com/sympy/sympy/pull/9500.diff","patch_url":"https://github.com/sympy/sympy/pull/9500.patch","issue_url":"https://api.github.com/repos/sympy/sympy/issues/9500","number":9500,"state":"open","locked":false,"title":"[WIP] Documenting Solveset","user":{"login":"aktech","id":5647941,"avatar_url":"https://avatars.githubusercontent.com/u/5647941?v=3","gravatar_id":"","url":"https://api.github.com/users/aktech","html_url":"https://github.com/aktech","followers_url":"https://api.github.com/users/aktech/followers","following_url":"https://api.github.com/users/aktech/following{/other_user}","gists_url":"https://api.github.com/users/aktech/gists{/gist_id}","starred_url":"https://api.github.com/users/aktech/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aktech/subscriptions","organizations_url":"https://api.github.com/users/aktech/orgs","repos_url":"https://api.github.com/users/aktech/repos","events_url":"https://api.github.com/users/aktech/events{/privacy}","received_events_url":"https://api.github.com/users/aktech/received_events","type":"User","site_admin":false},"body":"As lot of people are not aware of the purpose of `solveset` , to answer questions like *why we are doing, what we are doing*,  We decided to open a PR , to document it. Where the community can participate and give their views and suggestions.\r\n\r\n**TODO**\r\n- [x] Move docs to sphinx docs\r\n\r\nThe documentation should answer the following questions either explicitly or implicitly:\r\n- [x] What was the need of a new solvers module?\r\n- [x] Why do we use sets as an output type?\r\n- [x] What is this `domain` argument about?\r\n- [x] What will you do with the old `solve`?\r\n- [x] What are the general design principles behind the development of solveset?\r\n- [x] What are the general methods employed by solveset to solve an equation?\r\n- [x] How do we manipulate and return an infinite solutions?\r\n- [x] How does solveset ensures that it is not returning any wrong solution?\r\n- [x] How are symbolic parameters handled in solveset?\r\n- [ ] What is future direction of the development of solveset?\r\n- [x] How do we deal with cases where only some of the solutions are known?","created_at":"2015-06-10T09:05:54Z","updated_at":"2015-08-10T17:04:48Z","closed_at":null,"merged_at":null,"merge_commit_sha":"7d7ec68c1564586324177dcb5fd84adb82d9d244","assignee":{"login":"aktech","id":5647941,"avatar_url":"https://avatars.githubusercontent.com/u/5647941?v=3","gravatar_id":"","url":"https://api.github.com/users/aktech","html_url":"https://github.com/aktech","followers_url":"https://api.github.com/users/aktech/followers","following_url":"https://api.github.com/users/aktech/following{/other_user}","gists_url":"https://api.github.com/users/aktech/gists{/gist_id}","starred_url":"https://api.github.com/users/aktech/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aktech/subscriptions","organizations_url":"https://api.github.com/users/aktech/orgs","repos_url":"https://api.github.com/users/aktech/repos","events_url":"https://api.github.com/users/aktech/events{/privacy}","received_events_url":"https://api.github.com/users/aktech/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/sympy/sympy/milestones/44","html_url":"https://github.com/sympy/sympy/milestones/GSoC%202015%20Solveset%20/%20Sets%20Infrastructure","labels_url":"https://api.github.com/repos/sympy/sympy/milestones/44/labels","id":1185328,"number":44,"title":"GSoC 2015 Solveset / Sets Infrastructure","description":"This includes all the work related to this proposal: https://github.com/sympy/sympy/wiki/GSoC-2015-Application-AMiT-Kumar--Solvers-:-Extending-Solveset","creator":{"login":"aktech","id":5647941,"avatar_url":"https://avatars.githubusercontent.com/u/5647941?v=3","gravatar_id":"","url":"https://api.github.com/users/aktech","html_url":"https://github.com/aktech","followers_url":"https://api.github.com/users/aktech/followers","following_url":"https://api.github.com/users/aktech/following{/other_user}","gists_url":"https://api.github.com/users/aktech/gists{/gist_id}","starred_url":"https://api.github.com/users/aktech/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aktech/subscriptions","organizations_url":"https://api.github.com/users/aktech/orgs","repos_url":"https://api.github.com/users/aktech/repos","events_url":"https://api.github.com/users/aktech/events{/privacy}","received_events_url":"https://api.github.com/users/aktech/received_events","type":"User","site_admin":false},"open_issues":8,"closed_issues":22,"state":"open","created_at":"2015-06-29T14:03:27Z","updated_at":"2015-08-08T19:52:27Z","due_on":"2015-08-27T18:30:00Z","closed_at":null},"commits_url":"https://api.github.com/repos/sympy/sympy/pulls/9500/commits","review_comments_url":"https://api.github.com/repos/sympy/sympy/pulls/9500/comments","review_comment_url":"https://api.github.com/repos/sympy/sympy/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sympy/sympy/issues/9500/comments","statuses_url":"https://api.github.com/repos/sympy/sympy/statuses/dfe1dc8bd0262f86400962dd225eb4a3e472ccf0","head":{"label":"aktech:document-solveset","ref":"document-solveset","sha":"dfe1dc8bd0262f86400962dd225eb4a3e472ccf0","user":{"login":"aktech","id":5647941,"avatar_url":"https://avatars.githubusercontent.com/u/5647941?v=3","gravatar_id":"","url":"https://api.github.com/users/aktech","html_url":"https://github.com/aktech","followers_url":"https://api.github.com/users/aktech/followers","following_url":"https://api.github.com/users/aktech/following{/other_user}","gists_url":"https://api.github.com/users/aktech/gists{/gist_id}","starred_url":"https://api.github.com/users/aktech/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aktech/subscriptions","organizations_url":"https://api.github.com/users/aktech/orgs","repos_url":"https://api.github.com/users/aktech/repos","events_url":"https://api.github.com/users/aktech/events{/privacy}","received_events_url":"https://api.github.com/users/aktech/received_events","type":"User","site_admin":false},"repo":{"id":28193645,"name":"sympy","full_name":"aktech/sympy","owner":{"login":"aktech","id":5647941,"avatar_url":"https://avatars.githubusercontent.com/u/5647941?v=3","gravatar_id":"","url":"https://api.github.com/users/aktech","html_url":"https://github.com/aktech","followers_url":"https://api.github.com/users/aktech/followers","following_url":"https://api.github.com/users/aktech/following{/other_user}","gists_url":"https://api.github.com/users/aktech/gists{/gist_id}","starred_url":"https://api.github.com/users/aktech/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aktech/subscriptions","organizations_url":"https://api.github.com/users/aktech/orgs","repos_url":"https://api.github.com/users/aktech/repos","events_url":"https://api.github.com/users/aktech/events{/privacy}","received_events_url":"https://api.github.com/users/aktech/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/aktech/sympy","description":"A computer algebra system written in pure Python","fork":true,"url":"https://api.github.com/repos/aktech/sympy","forks_url":"https://api.github.com/repos/aktech/sympy/forks","keys_url":"https://api.github.com/repos/aktech/sympy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/aktech/sympy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/aktech/sympy/teams","hooks_url":"https://api.github.com/repos/aktech/sympy/hooks","issue_events_url":"https://api.github.com/repos/aktech/sympy/issues/events{/number}","events_url":"https://api.github.com/repos/aktech/sympy/events","assignees_url":"https://api.github.com/repos/aktech/sympy/assignees{/user}","branches_url":"https://api.github.com/repos/aktech/sympy/branches{/branch}","tags_url":"https://api.github.com/repos/aktech/sympy/tags","blobs_url":"https://api.github.com/repos/aktech/sympy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/aktech/sympy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/aktech/sympy/git/refs{/sha}","trees_url":"https://api.github.com/repos/aktech/sympy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/aktech/sympy/statuses/{sha}","languages_url":"https://api.github.com/repos/aktech/sympy/languages","stargazers_url":"https://api.github.com/repos/aktech/sympy/stargazers","contributors_url":"https://api.github.com/repos/aktech/sympy/contributors","subscribers_url":"https://api.github.com/repos/aktech/sympy/subscribers","subscription_url":"https://api.github.com/repos/aktech/sympy/subscription","commits_url":"https://api.github.com/repos/aktech/sympy/commits{/sha}","git_commits_url":"https://api.github.com/repos/aktech/sympy/git/commits{/sha}","comments_url":"https://api.github.com/repos/aktech/sympy/comments{/number}","issue_comment_url":"https://api.github.com/repos/aktech/sympy/issues/comments{/number}","contents_url":"https://api.github.com/repos/aktech/sympy/contents/{+path}","compare_url":"https://api.github.com/repos/aktech/sympy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/aktech/sympy/merges","archive_url":"https://api.github.com/repos/aktech/sympy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/aktech/sympy/downloads","issues_url":"https://api.github.com/repos/aktech/sympy/issues{/number}","pulls_url":"https://api.github.com/repos/aktech/sympy/pulls{/number}","milestones_url":"https://api.github.com/repos/aktech/sympy/milestones{/number}","notifications_url":"https://api.github.com/repos/aktech/sympy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/aktech/sympy/labels{/name}","releases_url":"https://api.github.com/repos/aktech/sympy/releases{/id}","created_at":"2014-12-18T17:24:39Z","updated_at":"2015-04-24T19:03:04Z","pushed_at":"2015-08-10T14:46:58Z","git_url":"git://github.com/aktech/sympy.git","ssh_url":"git@github.com:aktech/sympy.git","clone_url":"https://github.com/aktech/sympy.git","svn_url":"https://github.com/aktech/sympy","homepage":"http://sympy.org/","size":72609,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":1,"default_branch":"master"}},"base":{"label":"sympy:master","ref":"master","sha":"a91ba26c6d639980a4b3351a443548c629447cf9","user":{"login":"sympy","id":260832,"avatar_url":"https://avatars.githubusercontent.com/u/260832?v=3","gravatar_id":"","url":"https://api.github.com/users/sympy","html_url":"https://github.com/sympy","followers_url":"https://api.github.com/users/sympy/followers","following_url":"https://api.github.com/users/sympy/following{/other_user}","gists_url":"https://api.github.com/users/sympy/gists{/gist_id}","starred_url":"https://api.github.com/users/sympy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sympy/subscriptions","organizations_url":"https://api.github.com/users/sympy/orgs","repos_url":"https://api.github.com/users/sympy/repos","events_url":"https://api.github.com/users/sympy/events{/privacy}","received_events_url":"https://api.github.com/users/sympy/received_events","type":"Organization","site_admin":false},"repo":{"id":640534,"name":"sympy","full_name":"sympy/sympy","owner":{"login":"sympy","id":260832,"avatar_url":"https://avatars.githubusercontent.com/u/260832?v=3","gravatar_id":"","url":"https://api.github.com/users/sympy","html_url":"https://github.com/sympy","followers_url":"https://api.github.com/users/sympy/followers","following_url":"https://api.github.com/users/sympy/following{/other_user}","gists_url":"https://api.github.com/users/sympy/gists{/gist_id}","starred_url":"https://api.github.com/users/sympy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sympy/subscriptions","organizations_url":"https://api.github.com/users/sympy/orgs","repos_url":"https://api.github.com/users/sympy/repos","events_url":"https://api.github.com/users/sympy/events{/privacy}","received_events_url":"https://api.github.com/users/sympy/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sympy/sympy","description":"A computer algebra system written in pure Python","fork":false,"url":"https://api.github.com/repos/sympy/sympy","forks_url":"https://api.github.com/repos/sympy/sympy/forks","keys_url":"https://api.github.com/repos/sympy/sympy/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sympy/sympy/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sympy/sympy/teams","hooks_url":"https://api.github.com/repos/sympy/sympy/hooks","issue_events_url":"https://api.github.com/repos/sympy/sympy/issues/events{/number}","events_url":"https://api.github.com/repos/sympy/sympy/events","assignees_url":"https://api.github.com/repos/sympy/sympy/assignees{/user}","branches_url":"https://api.github.com/repos/sympy/sympy/branches{/branch}","tags_url":"https://api.github.com/repos/sympy/sympy/tags","blobs_url":"https://api.github.com/repos/sympy/sympy/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sympy/sympy/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sympy/sympy/git/refs{/sha}","trees_url":"https://api.github.com/repos/sympy/sympy/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sympy/sympy/statuses/{sha}","languages_url":"https://api.github.com/repos/sympy/sympy/languages","stargazers_url":"https://api.github.com/repos/sympy/sympy/stargazers","contributors_url":"https://api.github.com/repos/sympy/sympy/contributors","subscribers_url":"https://api.github.com/repos/sympy/sympy/subscribers","subscription_url":"https://api.github.com/repos/sympy/sympy/subscription","commits_url":"https://api.github.com/repos/sympy/sympy/commits{/sha}","git_commits_url":"https://api.github.com/repos/sympy/sympy/git/commits{/sha}","comments_url":"https://api.github.com/repos/sympy/sympy/comments{/number}","issue_comment_url":"https://api.github.com/repos/sympy/sympy/issues/comments{/number}","contents_url":"https://api.github.com/repos/sympy/sympy/contents/{+path}","compare_url":"https://api.github.com/repos/sympy/sympy/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sympy/sympy/merges","archive_url":"https://api.github.com/repos/sympy/sympy/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sympy/sympy/downloads","issues_url":"https://api.github.com/repos/sympy/sympy/issues{/number}","pulls_url":"https://api.github.com/repos/sympy/sympy/pulls{/number}","milestones_url":"https://api.github.com/repos/sympy/sympy/milestones{/number}","notifications_url":"https://api.github.com/repos/sympy/sympy/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sympy/sympy/labels{/name}","releases_url":"https://api.github.com/repos/sympy/sympy/releases{/id}","created_at":"2010-04-30T20:37:14Z","updated_at":"2015-08-10T08:23:45Z","pushed_at":"2015-08-10T17:04:38Z","git_url":"git://github.com/sympy/sympy.git","ssh_url":"git@github.com:sympy/sympy.git","clone_url":"https://github.com/sympy/sympy.git","svn_url":"https://github.com/sympy/sympy","homepage":"http://sympy.org/","size":153326,"stargazers_count":2273,"watchers_count":2273,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1113,"mirror_url":null,"open_issues_count":1963,"forks":1113,"open_issues":1963,"watchers":2273,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sympy/sympy/pulls/9500"},"html":{"href":"https://github.com/sympy/sympy/pull/9500"},"issue":{"href":"https://api.github.com/repos/sympy/sympy/issues/9500"},"comments":{"href":"https://api.github.com/repos/sympy/sympy/issues/9500/comments"},"review_comments":{"href":"https://api.github.com/repos/sympy/sympy/pulls/9500/comments"},"review_comment":{"href":"https://api.github.com/repos/sympy/sympy/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/sympy/sympy/pulls/9500/commits"},"statuses":{"href":"https://api.github.com/repos/sympy/sympy/statuses/dfe1dc8bd0262f86400962dd225eb4a3e472ccf0"}}}}