Improvements to pl-matrix-output element

ChangeLog.md

@@ -151,6 +151,10 @@
 
   * Remove old temporary upgrade flag `tmp_upgraded_iq_status` (Matt West).
 
+  * Add Mathematica tab to `pl-matrix-output` (Liz Livingston)
+
+  * Add comment and local digit control for `pl-matrix-output`, optional `params-comment` and `params-digits` (Liz Livingston)
+
 * __3.1.0__ - 2018-10-08
 
   * Add string input element (Mariana Silva).

doc/elements.md

@@ -213,19 +213,26 @@ Attributes for `<variable>` (one of these for each variable to display):
 Attribute | Type | Default | Description
 --- | --- | --- | ---
 `params-name` | string | — | Name of variable in `data['params']` to display.
+`params-comment` | string | — | Name of variable in `data['params']` to display.
+`params-digits` | integer | — | Number of digits to display after the decimal for the variable.
 
-This element displays a list of variables inside `<pre>` tags that are formatted for import into either MATLAB or python (the user can switch between the two). Each variable must be either a scalar or a 2D numpy array (expressed as a list). Each variable will be prefixed by the text that appears between the `<variable>` and `</variable>` tags, followed by ` = `.
+This element displays a list of variables inside `<pre>` tags that are formatted for import into either MATLAB, Mathematica, or python (the user can switch between the two). Each variable must be either a scalar or a 2D numpy array (expressed as a list). Each variable will be prefixed by the text that appears between the `<variable>` and `</variable>` tags, followed by ` = `.
 
 Here is an example of MATLAB format:
 ```
-A = [1.23; 4.56];
+A = [1.23; 4.56]; % matrix
+```
+
+Here is an example of the Mathematica format:
+```
+A = [1.23; 4.56]; (* matrix *)
 ```
 
 Here is an example of python format:
 ```
 import numpy as np
 
-A = np.array([[1.23], [4.56]])
+A = np.array([[1.23], [4.56]]) # matrix
 ```
 
 If a variable `v` is a complex object, you should use `import prairielearn as pl` and `data['params'][params-name] = pl.to_json(v)`.

elements/pl-matrix-output/pl-matrix-output.mustache

@@ -8,6 +8,7 @@
     <div class="card-header">
         <ul class="nav nav-tabs card-header-tabs" role="tablist">
             <li class="nav-item" role="presentation"><a class="nav-link{{#default_is_matlab}} active{{/default_is_matlab}}" href="#matlab-{{uuid}}" aria-controls="matlab-{{uuid}}" role="tab" data-toggle="pill">matlab</a></li>
+            <li class="nav-item" role="presentation"><a class="nav-link{{#default_is_mathematica}} active{{/default_is_mathematica}}" href="#mathematica-{{uuid}}" aria-controls="mathematica-{{uuid}}" role="tab" data-toggle="pill">mathematica</a></li>
             <li class="nav-item" role="presentation"><a class="nav-link{{#default_is_python}} active{{/default_is_python}}" href="#python-{{uuid}}" aria-controls="python-{{uuid}}" role="tab" data-toggle="pill">python</a></li>
         </ul>
     </div>
@@ -19,6 +20,12 @@
                     copy this text
                 </button>
             </div>
+            <div role="tabpanel" class="tab-pane {{#default_is_mathematica}}active{{/default_is_mathematica}}" id="mathematica-{{uuid}}">
+                <pre class="bg-dark text-white rounded p-2" id="mathematica-data-{{uuid}}">{{mathematica_data}}</pre>
+                <button type="button" class="btn btn-secondary btn-sm copy-button" data-clipboard-target="#mathematica-data-{{uuid}}">
+                    copy this text
+                </button>
+            </div>
             <div role="tabpanel" class="tab-pane {{#default_is_python}}active{{/default_is_python}}" id="python-{{uuid}}">
                 <pre class="bg-dark text-white rounded p-2" id="python-data-{{uuid}}">{{python_data}}</pre>
                 <button type="button" class="btn btn-secondary btn-sm copy-button" data-clipboard-target="#python-data-{{uuid}}">

elements/pl-matrix-output/pl-matrix-output.py

@@ -14,11 +14,12 @@ def render(element_html, data):
     digits = pl.get_integer_attrib(element, 'digits', 2)
 
     matlab_data = ''
+    mathematica_data = ''
     python_data = 'import numpy as np\n\n'
     for child in element:
         if child.tag == 'variable':
             # Raise exception of variable does not have a name
-            pl.check_attribs(child, required_attribs=['params-name'], optional_attribs=[])
+            pl.check_attribs(child, required_attribs=['params-name'], optional_attribs=['params-comment', 'params-digits'])
 
             # Get name of variable
             var_name = pl.get_string_attrib(child, 'params-name')
@@ -32,6 +33,19 @@ def render(element_html, data):
             # back to a standard type (otherwise, do nothing)
             var_data = pl.from_json(var_data)
 
+            # Get comment, if it exists
+            if pl.has_attrib(child, 'params-comment') is False:
+                commentExists = 0
+            else:
+                var_comment = pl.get_string_attrib(child, 'params-comment')
+                commentExists = 1
+
+            # Get digit for child, if it exists
+            if pl.has_attrib(child, 'params-digits') is False:
+                var_digits = digits
+            else:
+                var_digits = pl.get_string_attrib(child, 'params-digits')
+
             if np.isscalar(var_data):
                 prefix = ''
                 suffix = ''
@@ -45,13 +59,27 @@ def render(element_html, data):
                 prefix = 'np.array('
                 suffix = ')'
 
+            # Mathematica reserved letters: C D E I K N O
+            mathematica_reserved = ['C', 'D', 'E', 'I', 'K', 'N', 'O']
+            if pl.inner_html(child) in mathematica_reserved:
+                mathematica_suffix = 'm'
+            else:
+                mathematica_suffix = ''
+
             # Create string for matlab and python format
-            matlab_data += pl.inner_html(child) + ' = ' + pl.string_from_2darray(var_data, language='matlab', digits=digits) + ';\n'
-            python_data += pl.inner_html(child) + ' = ' + prefix + pl.string_from_2darray(var_data, language='python', digits=digits) + suffix + '\n'
+            if commentExists == 0:
+                matlab_data += pl.inner_html(child) + ' = ' + pl.string_from_2darray(var_data, language='matlab', digits=var_digits) + ';\n'
+                mathematica_data += pl.inner_html(child) + ' = ' + pl.string_from_2darray(var_data, language='matlab', digits=var_digits) + ';\n'
+                python_data += pl.inner_html(child) + ' = ' + prefix + pl.string_from_2darray(var_data, language='python', digits=var_digits) + suffix + '\n'
+            else:
+                matlab_data += pl.inner_html(child) + ' = ' + pl.string_from_2darray(var_data, language='matlab', digits=var_digits) + '; % ' + var_comment + '\n'
+                mathematica_data += pl.inner_html(child) + mathematica_suffix + ' = ' + pl.string_from_2darray(var_data, language='matlab', digits=var_digits) + '; (* ' + var_comment + ' *)\n'
+                python_data += pl.inner_html(child) + ' = ' + prefix + pl.string_from_2darray(var_data, language='python', digits=var_digits) + suffix + ' # ' + var_comment + '\n'
 
     html_params = {
         'default_is_matlab': True,
         'matlab_data': matlab_data,
+        'mathematica_data': mathematica_data,
         'python_data': python_data,
         'uuid': pl.get_uuid()
     }