Merge pull request #1224 from mathics/release-2.1.0

Update 2.1.0 release notes; bump version

Author: rocky

CHANGES.rst

@@ -21,22 +21,23 @@ Enhancements
 
 * The Mathics version is checked for builtin modules at load time. A message is given when a builtin doesn't load.
 * Automatic detection for the best strategy to numeric evaluation of constants.
-* ``FileNameJoin`` - implement ``OperatingSystem`` option
-* Mathics functions are accepted by ``Compile[]``. The return value or type will be
-  ``Compile[] and CompiledFunction[]``  every expression can have a compiled form,
-  as a Python function.
+* ``FileNameJoin`` now implements ``OperatingSystem`` option
+* Mathics functions are accepted by ``Compile[]``. The return value or
+  type will be ``Compile[] and CompiledFunction[]``.  Every Mathics
+  Expression can have a compiled form, which may be implemented as a
+  Python function.
 * ``Equal[]`` now compares complex against other numbers properly.
 * Improvements in handling products with infinite factors: ``0 Infinity``-> ``Indeterminate``, and ``expr Infinity``-> ``DirectedInfinite[expr]``
-* ``$Path`` is now Unprotected by default
-* Improving the reading of expressions from files.
-* ``StringSplit`` now accepts a list in the first argument.
-* ``SetDelayed`` now accepts several conditions imposed both at LHS as well as RHS.
+* ``$Path`` is now ``Unprotected`` by default
+* ``Read[]`` handles expressions better.
+* ``StringSplit[]`` now accepts a list in the first argument.
+* ``SetDelayed[]`` now accepts several conditions imposed both at LHS as well as RHS.
 
 
 Bug fixes
 +++++++++
 
-* TeXForm for integrals are now properly formatted.
+* ``TeXForm[]`` for integrals are now properly formatted.
 
 
 Pymathics Modules
@@ -53,18 +54,27 @@ Pymathics Modules
 Miscellanea
 +++++++++++
 
-* A pass was made to improve Microsoft Windows compatability and testing
-Windows under MSYS.
+* A pass was made to improve Microsoft Windows compatability and testing Windows under MSYS.
 * Include numpy version in version string. Show in CLI
 * Small CLI tweaks ``--colors=None`` added to match mathicsscript.
 * In the ``BaseExpression`` and derivated classes, the method ``boxes_to_xml`` now are called ``boxes_to_mathml``.
 * In the ``format`` method of the class ``Evaluation``,  the builtin ``ToString`` is called instead of  ``boxes_to_text``
-  In order to control the final form of boxes from the user space in specific symbols and contexts.
-* ``GraphicsBox`` now have two methods:  ``to_svg`` and  ``to_mathml``. The first produces SVG plain text while the second produces ``<mglyph ...>``
-  tags with base64 encoded svgs.
+* In order to control the final form of boxes from the user space in specific symbols and contexts.
+* ``GraphicsBox`` now have two methods:  ``to_svg`` and  ``to_mathml``. The first produces SVG plain text while the second produces ``<mglyph ...>`` tags with base64 encoded svgs.
 * Improving the support for ``Inset`` and  ``InsetBox``.
 
 
+What's to expect in a Future Release
+++++++++++++++++++++++++++++++++++++
+
+* Improved ``Equal`` See `PR #1209 <https://github.com/mathics/Mathics/pull/1209/>`_
+* Better Unicode support, especially for Mathics operators
+* Improved ``D[]`` and ``Derivative[]`` See `PR #1220 <https://github.com/mathics/Mathics/pull/1209/>`_.
+* Improved performance
+* ``Collect[]`` See `Issue #1194 <https://github.com/mathics/Mathics/issues/1194>`_.
+* ``Series[]`` See `Issue #1193 <https://github.com/mathics/Mathics/issues/1194>`_.
+
+
 2.0.0
 -----
 

mathics/builtin/assignment.py

@@ -550,7 +550,7 @@ class SetDelayed(Set):
      = p[3]
     >> f[-3]
      = f[-3]
-    It also works if the condition is set in the LHS
+    It also works if the condition is set in the LHS:
     >> F[x_, y_] /; x < y /; x>0  := x / y;
     >> F[x_, y_] := y / x;
     >> F[2, 3]

mathics/builtin/compilation.py

@@ -23,6 +23,10 @@ class Compile(Builtin):
       <dd>Compiles assuming each $xi$ matches type $ti$.
     </dl>
 
+    Compilation is performed using llvmlite , or Python's builtin
+    "compile" function.
+
+
     >> cf = Compile[{x, y}, x + 2 y]
      = CompiledFunction[{x, y}, x + 2 y, -CompiledCode-]
     >> cf[2.5, 4.3]
@@ -59,8 +63,7 @@ class Compile(Builtin):
     #> cf[0, -2]
      = 0.5
 
-    Loops and variable assignments are supported as python (not llvmlite)
-    functions
+    Loops and variable assignments are supported usinv Python builtin "compile" function:
     >> Compile[{{a, _Integer}, {b, _Integer}}, While[b != 0, {a, b} = {b, Mod[a, b]}]; a]       (* GCD of a, b *)
      =  CompiledFunction[{a, b}, a, -PythonizedCode-]
     """
@@ -163,6 +166,12 @@ def __str__(self):
             return "-PythonizedCode-"
         return "-CompiledCode-"
 
+    def boxes_to_text(self, leaves=None, **options):
+        from trepan.api import debug; debug()
+        if not leaves:
+            leaves = self._leaves
+        return "-CompiledCode-"
+
     def do_copy(self):
         return CompiledCode(self.cfunc, self.args)
 

mathics/builtin/files.py

@@ -796,7 +796,7 @@ def reader(stream, word_separators, accepted=None):
                         if word == "":
                             continue
                         if stream.seekable():
-                             # stream.seek(-1, 1) #Python3
+                            # stream.seek(-1, 1) #Python3
                             stream.seek(stream.tell() - 1)
                         last_word = word
                         word = ""
@@ -2597,19 +2597,22 @@ class ToFileName(Builtin):
 
 class FileNameJoin(Builtin):
     """
-    <dl>
-    <dt>'FileNameJoin[{"$dir_1$", "$dir_2$", ...}]'
-      <dd>joins the $dir_i$ togeather into one path.
-    </dl>
+        <dl>
+          <dt>'FileNameJoin[{"$dir_1$", "$dir_2$", ...}]'
+          <dd>joins the $dir_i$ together into one path.
 
-    >> FileNameJoin[{"dir1", "dir2", "dir3"}]
-     = ...
+          <dt>'FileNameJoin[..., OperatingSystem->"os"]'
+          <dd>yields a file name in the format for the specified operating system. Possible choices are "Windows", "MacOSX", and "Unix".
+        </dl>
+
+        >> FileNameJoin[{"dir1", "dir2", "dir3"}]
+         = ...
 
-    >> FileNameJoin[{"dir1", "dir2", "dir3"}, OperatingSystem -> "Unix"]
-     = dir1/dir2/dir3
+        >> FileNameJoin[{"dir1", "dir2", "dir3"}, OperatingSystem -> "Unix"]
+         = dir1/dir2/dir3
 
-    >> FileNameJoin[{"dir1", "dir2", "dir3"}, OperatingSystem -> "Windows"]
-     = dir1\\dir2\\dir3
+        >> FileNameJoin[{"dir1", "dir2", "dir3"}, OperatingSystem -> "Windows"]
+         = dir1\\dir2\\dir3
     """
 
     attributes = "Protected"
@@ -5090,12 +5093,12 @@ class FileNames(Builtin):
         <dd>Returns a list with the filenames in the current working folder.
     <dt>'FileNames[$form$]'
         <dd>Returns a list with the filenames in the current working folder that matches with $form$.
-    <dt>'FileNames[{$form_1$, $form_2$, $\ldots$}]'
-        <dd>Returns a list with the filenames in the current working folder that matches with one of $form_1$, $form_2$, $\ldots$.
-    <dt>'FileNames[{$form_1$, $form_2$, $\ldots$},{$dir_1$, $dir_2$, $\ldots$}]'
-        <dd>Looks into the directories $dir_1$, $dir_2$, $\ldots$.
-    <dt>'FileNames[{$form_1$, $form_2$, $\ldots$},{$dir_1$, $dir_2$, $\ldots$}]'
-        <dd>Looks into the directories $dir_1$, $dir_2$, $\ldots$.
+    <dt>'FileNames[{$form_1$, $form_2$, ...}]'
+        <dd>Returns a list with the filenames in the current working folder that matches with one of $form_1$, $form_2$, ....
+    <dt>'FileNames[{$form_1$, $form_2$, ...},{$dir_1$, $dir_2$, ...}]'
+        <dd>Looks into the directories $dir_1$, $dir_2$, ....
+    <dt>'FileNames[{$form_1$, $form_2$, ...},{$dir_1$, $dir_2$, ...}]'
+        <dd>Looks into the directories $dir_1$, $dir_2$, ....
     <dt>'FileNames[{$forms$, $dirs$, $n$]'
         <dd>Look for files up to the level $n$.
     </dl>

mathics/builtin/lists.py

@@ -198,8 +198,8 @@ class Normal(Builtin):
 class ByteArray(Builtin):
     r"""
     <dl>
-    <dt>'ByteArray[{$b_1$, $b_2$, $\ldots$}]'
-       <dd> Represents a sequence of Bytes $b_1$, $b_2$, $\ldots$
+    <dt>'ByteArray[{$b_1$, $b_2$, ...}]'
+       <dd> Represents a sequence of Bytes $b_1$, $b_2$, ...
     <dt>'ByteArray["string"]'
        <dd> Constructs a byte array where bytes comes from decode a b64 encoded String
     </dl>
@@ -6274,10 +6274,10 @@ class Failure(Builtin):
 class FirstCase(Builtin):
     """
     <dl>
-    <dt> FirstCase[{$e1$, $e2$, $\\ldots$}, $pattern$]
+    <dt> FirstCase[{$e1$, $e2$, ...}, $pattern$]
         <dd>gives the first $ei$ to match $pattern$, or $Missing[\"NotFound\"]$ if none matching pattern is found.
 
-    <dt> FirstCase[{$e1$,$e2$, $\\ldots$}, $pattern$ -> $rhs$]
+    <dt> FirstCase[{$e1$,$e2$, ...}, $pattern$ -> $rhs$]
         <dd> gives the value of $rhs$ corresponding to the first $ei$ to match pattern.
     <dt> FirstCase[$expr$, $pattern$, $default$]
          <dd> gives $default$ if no element matching $pattern$ is found.

mathics/builtin/numeric.py

@@ -418,33 +418,37 @@ def ff(*z):
 class NIntegrate(Builtin):
     """
     <dl>
-    <dt>'NIntegrate[$expr$, $interval$]'
-        <dd>evaluates the definite integral of $expr$ numerically
-            with a precision of $prec$ digits.
+       <dt>'NIntegrate[$expr$, $interval$]'
+       <dd>returns a numeric approximation to the definite integral of $expr$ with limits $interval$ and with a precision of $prec$ digits.
+
+        <dt>'NIntegrate[$expr$, $interval1$, $interval2$, ...]'
+        <dd>returns a numeric approximation to the multiple integral of $expr$ with limits $interval1$, $interval2$ and with a precision of $prec$ digits.
     </dl>
 
-    >> Table[1./NIntegrate[x^k,{x,0,1},Tolerance->1*^-6], {k,0,6}]
-     : The especified method failed to return a number. Falling back into the internal evaluator.
-     = {1., 2., 3., 4., 5., 6., 7.}
     >> NIntegrate[Exp[-x],{x,0,Infinity},Tolerance->1*^-6]
      = 1.
     >> NIntegrate[Exp[x],{x,-Infinity, 0},Tolerance->1*^-6]
      = 1.
     >> NIntegrate[Exp[-x^2/2.],{x,-Infinity, Infinity},Tolerance->1*^-6]
      = 2.50663
 
+    >> Table[1./NIntegrate[x^k,{x,0,1},Tolerance->1*^-6], {k,0,6}]
+     : The specified method failed to return a number. Falling back into the internal evaluator.
+     = {1., 2., 3., 4., 5., 6., 7.}
+
     >> NIntegrate[1 / z, {z, -1 - I, 1 - I, 1 + I, -1 + I, -1 - I}, Tolerance->1.*^-4]
      : Integration over a complex domain is not implemented yet
      = NIntegrate[1 / z, {z, -1 - I, 1 - I, 1 + I, -1 + I, -1 - I}, Tolerance -> 0.0001]
      ## = 6.2832 I
 
     Integrate singularities with weak divergences:
-    >> Table[NIntegrate[x^(1./k-1.),{x,0,1.},Tolerance->1*^-6], {k,1,7.}]
+    >> Table[ NIntegrate[x^(1./k-1.), {x,0,1.}, Tolerance->1*^-6], {k,1,7.} ]
      = {1., 2., 3., 4., 5., 6., 7.}
 
-    Iterated Integral:
-    >> NIntegrate[x * y,{x, 0, 1},{y, 0, 1}]
+    Mutiple Integrals :
+    >> NIntegrate[x * y,{x, 0, 1}, {y, 0, 1}]
      = 0.25
+
     """
 
     messages = {
@@ -457,7 +461,7 @@ class NIntegrate(Builtin):
         "nlim": "`1` = `2` is not a valid limit of integration.",
         "ilim": "Invalid integration variable or limit(s) in `1`.",
         "mtdfail": (
-            "The especified method failed to return a "
+            "The specified method failed to return a "
             + "number. Falling back into the internal "
             + "evaluator."
         ),
@@ -1807,7 +1811,7 @@ class Hash(Builtin):
       <dd>returns an integer hash of the specified $type$ for the given $expr$.</dd>
       <dd>The types supported are "MD5", "Adler32", "CRC32", "SHA", "SHA224", "SHA256", "SHA384", and "SHA512".</dd>
     <dt>'Hash[$expr$, $type$, $format$]'
-      <dd>Returns the hash in the  especified format.</dd>
+      <dd>Returns the hash in the specified format.</dd>
     </dl>
 
     > Hash["The Adventures of Huckleberry Finn"]

mathics/core/expression.py

@@ -2032,7 +2032,7 @@ def __getnewargs__(self):
 SymbolMakeBoxes = Symbol("MakeBoxes")
 SymbolN = Symbol("N")
 SymbolRule = Symbol("Rule")
-SymbolSequence = Symbol("Sequence") 
+SymbolSequence = Symbol("Sequence")
 
 
 @lru_cache(maxsize=1024)

mathics/version.py

@@ -4,4 +4,4 @@
 # This file is suitable for sourcing inside POSIX shell as
 # well as importing into Python. That's why there is no
 # space around "=" below.
-__version__="2.0.1.dev"  # noqa
+__version__="2.1.0"  # noqa