Skip to content

Go over comparision doctests and text #1390

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

Merged
rocky merged 1 commit into from
May 24, 2021
Merged

Go over comparision doctests and text #1390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 43 additions & 34 deletions mathics/builtin/comparison.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,10 +652,9 @@ def _op(x):


class Unequal(_EqualityOperator, SympyComparison):
"""
u"""
<dl>
<dt>'Unequal[$x$, $y$]'
<dt>'$x$ != $y$'
<dt>'Unequal[$x$, $y$]' or $x$ != $y$ or $x$ \u2260 $y$
<dd>is 'False' if $x$ and $y$ are known to be equal, or
'True' if $x$ and $y$ are known to be unequal.
Commutative properties apply so if $x$ != $y$ then
Expand All @@ -667,15 +666,19 @@ class Unequal(_EqualityOperator, SympyComparison):
>> 1 != 1.
= False

Comparsion can be chained:
>> 1 != 2 != 3
= True

>> 1 != 2 != x
= 1 != 2 != x

Strings are allowed:
Unequal["11", "11"]
= False

Equal["121", "11"]
= True

Comparision to mismatched types is True:
Equal[11, "11"]
Unequal[11, "11"]
= True

Lists are compared based on their elements:
Expand Down Expand Up @@ -723,49 +726,57 @@ def _op(x):
class Less(_ComparisonOperator, SympyComparison):
"""
<dl>
<dt>'Less[$x$, $y$]'
<dt>'$x$ < $y$'
<dd>yields 'True' if $x$ is known to be less than $y$.
<dt>'$lhs$ < $rhs$'
<dd>represents the inequality $lhs$ < $rhs$.
<dt>'Less[$x$, $y$]' or $x$ < $y$
<dd>yields 'True' if $x$ is known to be less than $y$.
</dl>

#> {Less[], Less[x], Less[1]}
= {True, True, True}
LessEqual operator can be chained:
>> LessEqual[1, 3, 3, 2]
= False

>> 1 < 3 < 3
= False

>> 1 < 3 < x < 2
= 1 < 3 < x < 2
"""

operator = "<"
sympy_name = "StrictLessThan"


class LessEqual(_ComparisonOperator, SympyComparison):
"""
<dl>
<dt>'LessEqual[$x$, $y$]'
<dt>'$x$ <= $y$'
<dd>yields 'True' if $x$ is known to be less than or equal to $y$.
<dt>'$lhs$ <= $rhs$'
<dd>represents the inequality $lhs$ $rhs$.
</dl>
u"""
<dl>
<dt>'LessEqual[$x$, $y$, ...]' or $x$ <= $y$ or $x$ \u2264 $y$
<dd>yields 'True' if $x$ is known to be less than or equal to $y$.
</dl>

LessEqual operator can be chained:
>> LessEqual[1, 3, 3, 2]
= False

>> 1 <= 3 <= 3
= True

"""

operator = "<="
sympy_name = "LessThan"
sympy_name = "LessThan" # in contrast to StrictLessThan


class Greater(_ComparisonOperator, SympyComparison):
"""
<dl>
<dt>'Greater[$x$, $y$]'
<dt>'$x$ > $y$'
<dd>yields 'True' if $x$ is known to be greater than $y$.
<dt>'$lhs$ > $rhs$'
<dd>represents the inequality $lhs$ > $rhs$.
<dt>'Greater[$x$, $y$]' or '$x$ > $y$'
<dd>yields 'True' if $x$ is known to be greater than $y$.
</dl>

Greater operator can be chained:
>> a > b > c //FullForm
= Greater[a, b, c]
>> Greater[3, 2, 1]

>> 3 > 2 > 1
= True
"""

Expand All @@ -776,12 +787,10 @@ class Greater(_ComparisonOperator, SympyComparison):
class GreaterEqual(_ComparisonOperator, SympyComparison):
"""
<dl>
<dt>'GreaterEqual[$x$, $y$]'
<dt>'$x$ >= $y$'
<dd>yields 'True' if $x$ is known to be greater than or equal
<dt>'GreaterEqual[$x$, $y$]'
<dt>$x$ \u2256 $y$ or '$x$ >= $y$'
<dd>yields 'True' if $x$ is known to be greater than or equal
to $y$.
<dt>'$lhs$ >= $rhs$'
<dd>represents the inequality $lhs$ $rhs$.
</dl>
"""

Expand Down