Merge branch 'add_option_scientificnotation' into dev. Add in question level option "scientificnotation".

Author: sangwinc

api/config_sample.txt

@@ -80,6 +80,7 @@ $CFG->logicsymbol = 'lang';
 $CFG->inversetrig = 'cos-1';
 $CFG->matrixparens = "[";
 $CFG->decimals = ".";
+$CFG->scientificnotation = "*10";
 
 $CFG->inputtype = 'algebraic';
 $CFG->inputboxsize = 30;

api/util/StackQuestionLoader.php

@@ -149,6 +149,10 @@ public static function loadxml($xml) {
             'decimals',
             isset($xmldata->question->decimals) ? (string) $xmldata->question->decimals : get_config('qtype_stack', 'decimals')
         );
+        $question->options->set_option(
+            'scientificnotation',
+            isset($xmldata->question->scientificnotation) ? (string) $xmldata->question->scientificnotation : get_config('qtype_stack', 'scientificnotation')
+        );
 
         $inputmap = [];
         foreach ($xmldata->question->input as $input) {

backup/moodle2/backup_qtype_stack_plugin.class.php

@@ -49,7 +49,10 @@ protected function define_question_plugin_structure() {
                     'stackversion', 'questionvariables', 'specificfeedback', 'specificfeedbackformat',
                     'questionnote', 'questionsimplify', 'assumepositive', 'assumereal',
                     'prtcorrect', 'prtcorrectformat', 'prtpartiallycorrect', 'prtpartiallycorrectformat',
-                    'prtincorrect', 'prtincorrectformat', 'decimals', 'multiplicationsign', 'sqrtsign',
+                    'prtincorrect', 'prtincorrectformat',
+                    'decimals',
+                    'scientificnotation',
+                    'multiplicationsign', 'sqrtsign',
                     'complexno', 'inversetrig', 'logicsymbol', 'matrixparens', 'variantsselectionseed',
                 ]);
 

db/install.xml

@@ -26,6 +26,7 @@
         <FIELD NAME="prtincorrect" TYPE="text" NOTNULL="true" SEQUENCE="false" COMMENT="Standard feedback displayed for any PRT that returns a score of 0."/>
         <FIELD NAME="prtincorrectformat" TYPE="int" LENGTH="2" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="Text format for the prtincorrect field."/>
         <FIELD NAME="decimals" TYPE="char" LENGTH="8" NOTNULL="true" DEFAULT="." SEQUENCE="false" COMMENT="The symbol to use for the decimal separator."/>
+        <FIELD NAME="scientificnotation" TYPE="char" LENGTH="8" NOTNULL="true" DEFAULT="*10" SEQUENCE="false" COMMENT="Controls display of numbers written in scientific notation."/>
         <FIELD NAME="multiplicationsign" TYPE="char" LENGTH="8" NOTNULL="true" DEFAULT="dot" SEQUENCE="false" COMMENT="The symbol to use for multiplication."/>
         <FIELD NAME="sqrtsign" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="1" SEQUENCE="false" COMMENT="Whether to display square roots as surds."/>
         <FIELD NAME="complexno" TYPE="char" LENGTH="8" NOTNULL="true" DEFAULT="i" SEQUENCE="false" COMMENT="How complex numbers should be displayed and represented."/>

db/upgrade.php

@@ -938,7 +938,7 @@ function xmldb_qtype_stack_upgrade($oldversion) {
         $table = new xmldb_table('qtype_stack_options');
         $field = new xmldb_field('decimals', XMLDB_TYPE_CHAR, '8', null, XMLDB_NOTNULL, null, '.');
 
-        // Conditionally launch add field variantsselectionseed.
+        // Conditionally launch add field decimals.
         if (!$dbman->field_exists($table, $field)) {
             $dbman->add_field($table, $field);
         }
@@ -961,6 +961,18 @@ function xmldb_qtype_stack_upgrade($oldversion) {
         upgrade_plugin_savepoint(true, 2024032401, 'qtype', 'stack');
     }
 
+    if ($oldversion < 2024043000) {
+        $table = new xmldb_table('qtype_stack_options');
+        $field = new xmldb_field('scientificnotation', XMLDB_TYPE_CHAR, '8', null, XMLDB_NOTNULL, null, '*10');
+
+        // Conditionally launch add field scientificnotation.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // STACK savepoint reached.
+        upgrade_plugin_savepoint(true, 2024043000, 'qtype', 'stack');
+    }
     // Add new upgrade blocks just above here.
 
     // Check the version of the Maxima library code that comes with this version

doc/en/Authoring/Options.md

@@ -47,6 +47,13 @@ The design of this option is discussed further in the [developer docs](../Develo
 
 Teachers must always use strict Maxima syntax, which requires `.`, including in test case construction.
 
+### Scientific notation formal {#scientificnotation} ###
+
+Choose the format for display of scientific notation.
+
+* '*10', numbers will be displayed as \(3.14 \times 10^{3}\).
+* 'E', numbers will be displayed as \(3.14 E^{3}\).
+
 ### Multiplication Sign {#multiplication} ###
 
 * (none), e.g. \(x(x+1)\)

doc/en/Developer/Development_track.md

@@ -5,8 +5,6 @@ past development history is documented on [Development history](Development_hist
 
 ## Version 4.6.0
 
-TODO: merge back in https://github.com/maths/moodle-qtype_stack/tree/add_option_scientificnotation once the code tidy is confirmed.
-
 This version will require moodle 4.0+. Moodle 3.x is no longer supported.
 
 1. Alter list of acceptible expressions.  Unicode super/subscripts now are invalid.  Use 150_replace filter in students' input.
@@ -15,7 +13,7 @@ This version will require moodle 4.0+. Moodle 3.x is no longer supported.
 4. Fix display and simplification of binomial coefficients (issue #931).
 5. Add in the `CT:...` and `RAW:...` options for test case construction to enable tests of invalid input (e.g. missing stars).
 6. STACK now has an [API](../Installation/API.md) to provide STACK questions as a web service.
-7. Improve the display of floats.  Numbers of decimal places are now respected in all parts of expressions, and floats such as `1.7E-9` are displayed at \(1.7 \times 10^{-9}\).
+7. Improve the display of floats.  Numbers of decimal places are now respected in all parts of expressions, and floats such as `1.7E-9` are displayed at \(1.7 \times 10^{-9}\).   There is a new question option to choose between \(1.7 \times 10^{-9}\) and \(1.7E-9\).
 8. Release first version of the API for longer term support, and better support for ILIAS.
 
 TODO:

doc/en/Developer/Extracting_test_questions.md

@@ -110,6 +110,7 @@ echo "',<br>
     'itemid' => 0,<br>
 ];<br>
 \$formform->decimals = '{$fromform->decimals}';<br>
+\$formform->scientificnotation = '{$fromform->scientificnotation}';<br>
 \$formform->multiplicationsign = '{$fromform->multiplicationsign}';<br>
 \$formform->sqrtsign = '{$fromform->sqrtsign}';<br>
 \$formform->complexno = '{$fromform->complexno}';<br>
@@ -224,6 +225,7 @@ echo "<br>
                 ));<br>";
         }
         echo "\$q->options->set_option('decimals', '{$fromform->decimals}');<br>
+        \$q->options->set_option('scientificnotation', '{$fromform->scientificnotation}');<br>
         \$q->options->set_option('multiplicationsign', '{$fromform->multiplicationsign}');<br>
         \$q->options->set_option('complexno', '{$fromform->complexno}');<br>
         \$q->options->set_option('inversetrig', '{$fromform->inversetrig}');<br>

edit_stack_form.php

@@ -320,6 +320,11 @@ protected function definition_inner(/* MoodleQuickForm */ $mform) {
         $mform->setDefault('decimals', $this->stackconfig->decimals);
         $mform->addHelpButton('decimals', 'decimals', 'qtype_stack');
 
+        $mform->addElement('select', 'scientificnotation',
+            stack_string('scientificnotation'), stack_options::get_scientificnotation_options());
+        $mform->setDefault('scientificnotation', $this->stackconfig->scientificnotation);
+        $mform->addHelpButton('scientificnotation', 'scientificnotation', 'qtype_stack');
+
         $mform->addElement('select', 'multiplicationsign',
                 stack_string('multiplicationsign'), stack_options::get_multiplication_sign_options());
         $mform->setDefault('multiplicationsign', $this->stackconfig->multiplicationsign);
@@ -716,6 +721,7 @@ protected function data_preprocessing_options($question) {
         $question->prtincorrect          = $this->prepare_text_field('prtincorrect',
                                             $opt->prtincorrect, $opt->prtincorrectformat, $question->id);
         $question->decimals              = $opt->decimals;
+        $question->scientificnotation    = $opt->scientificnotation;
         $question->multiplicationsign    = $opt->multiplicationsign;
         $question->complexno             = $opt->complexno;
         $question->inversetrig           = $opt->inversetrig;

lang/en/qtype_stack.php

@@ -221,6 +221,11 @@
 $string['decimals'] = 'Decimal separator';
 $string['decimals_help'] = 'Choose the symbol, and options, for the decimal separator.';
 $string['decimals_link'] = '%%WWWROOT%%/question/type/stack/doc/doc.php/Authoring/Options.md#decimals';
+$string['scientificnotation'] = 'Scientific notation';
+$string['scientificnotation_help'] = 'Choose the format of scientific notation.';
+$string['scientificnotation_link'] = '%%WWWROOT%%/question/type/stack/doc/doc.php/Authoring/Options.md#scientificnotation';
+$string['scientificnotation_10'] = 'n * 10^m';
+$string['scientificnotation_E'] = 'n E m';
 $string['multcross'] = 'Cross';
 $string['multdot'] = 'Dot';
 $string['multonlynumbers'] = 'Only numbers';

questiontype.php

@@ -163,6 +163,7 @@ public function save_question_options($fromform) {
                     $context, 'qtype_stack', 'prtincorrect', $fromform->id);
         $options->prtincorrectformat        = $fromform->prtincorrect['format'];
         $options->decimals                  = $fromform->decimals;
+        $options->scientificnotation        = $fromform->scientificnotation;
         $options->multiplicationsign        = $fromform->multiplicationsign;
         $options->sqrtsign                  = $fromform->sqrtsign;
         $options->complexno                 = $fromform->complexno;
@@ -477,6 +478,7 @@ protected function initialise_question_instance(question_definition $question, $
 
         $question->options = new stack_options();
         $question->options->set_option('decimals',           $questiondata->options->decimals);
+        $question->options->set_option('scientificnotation', $questiondata->options->scientificnotation);
         $question->options->set_option('multiplicationsign', $questiondata->options->multiplicationsign);
         $question->options->set_option('complexno',          $questiondata->options->complexno);
         $question->options->set_option('inversetrig',        $questiondata->options->inversetrig);
@@ -1243,6 +1245,7 @@ public function export_to_xml($questiondata, qformat_xml $format, $notused = nul
         $output .= $this->export_xml_text($format, 'prtincorrect', $options->prtincorrect,
                         $options->prtincorrectformat, $contextid, 'prtincorrect', $questiondata->id);
         $output .= "    <decimals>{$options->decimals}</decimals>\n";
+        $output .= "    <scientificnotation>{$options->scientificnotation}</scientificnotation>\n";
         $output .= "    <multiplicationsign>{$options->multiplicationsign}</multiplicationsign>\n";
         $output .= "    <sqrtsign>{$options->sqrtsign}</sqrtsign>\n";
         $output .= "    <complexno>{$options->complexno}</complexno>\n";
@@ -1391,6 +1394,7 @@ public function import_from_xml($xml, $fromform, qformat_xml $format, $notused =
         $fromform->prtincorrect          = $this->import_xml_text($xml, 'prtincorrect', $format, $fformat);
         $fromform->penalty               = $format->getpath($xml, ['#', 'penalty', 0, '#'], 0.1);
         $fromform->decimals              = $format->getpath($xml, ['#', 'decimals', 0, '#'], '.');
+        $fromform->scientificnotation    = $format->getpath($xml, ['#', 'scientificnotation', 0, '#'], 'dot');
         $fromform->multiplicationsign    = $format->getpath($xml, ['#', 'multiplicationsign', 0, '#'], 'dot');
         $fromform->sqrtsign              = $format->getpath($xml, ['#', 'sqrtsign', 0, '#'], 1);
         $fromform->complexno             = $format->getpath($xml, ['#', 'complexno', 0, '#'], 'i');
@@ -1593,6 +1597,7 @@ public function validate_fromform($fromform, $errors) {
 
         $this->options = new stack_options();
         $this->options->set_option('decimals',           $fromform['decimals']);
+        $this->options->set_option('scientificnotation', $fromform['scientificnotation']);
         $this->options->set_option('multiplicationsign', $fromform['multiplicationsign']);
         $this->options->set_option('complexno',          $fromform['complexno']);
         $this->options->set_option('inversetrig',        $fromform['inversetrig']);

settings.php

@@ -253,6 +253,11 @@
         get_string('decimals_help', 'qtype_stack'), '.',
         stack_options::get_decimals_sign_options()));
 
+$settings->add(new admin_setting_configselect('qtype_stack/scientificnotation',
+    get_string('scientificnotation', 'qtype_stack'),
+    get_string('scientificnotation_help', 'qtype_stack'), '*10',
+    stack_options::get_scientificnotation_options()));
+
 $settings->add(new admin_setting_configselect('qtype_stack/multiplicationsign',
         get_string('multiplicationsign', 'qtype_stack'),
         get_string('multiplicationsign_help', 'qtype_stack'), 'dot',

stack/cas/security-map.json

@@ -7757,6 +7757,10 @@
       "function": "t",
       "contextvariable": "true"
   },
+  "texput_scientificnotation": {
+      "function": "t",
+      "contextvariable": "true"
+  },
   "texsub": {
       "function": "s",
       "built-in": true

stack/maxima/assessment.mac

@@ -832,7 +832,23 @@ displayscitex(ex):=block([ss, n, dp, tx],
   ),
   tx
 )$
-texput(displaysci, displayscitex)$
+
+displayscitexE(ex):=block([ss, n, dp, tx],
+  [n, dp, expo]:args(ex),
+  ss:sconcat("~,", string(dp), "fE{~a}"),
+  if is(equal(dp, 0)) then ss:"~dE{~a}",
+  tx:ev(printf(false, ss, ev(float(n)), expo), simp),
+  if is(stackfltsep = ",") then (
+    tx:ssubst("\\ ", ",", tx),
+    tx:ssubst("{,}", ".", tx)
+  ),
+  tx
+)$
+
+texput_scientificnotation(ex) := block(
+  if is(ex="*10") then texput(displaysci, displayscitex),
+  if is(ex="E") then texput(displaysci, displayscitexE)
+)$
 
 make_displayscivalue(ex):= block([n, d, expo, ss],
     if atom(ex) then return(ex),

stack/maxima/stackmaxima.mac

@@ -3334,4 +3334,4 @@ is_lang(code):=ev(is(%_STACK_LANG=code),simp=true)$
 
 /* Stack expects some output with the version number the output happens at */
 /* maximalocal.mac after additional library loading */
-stackmaximaversion:2024042200$
+stackmaximaversion:2024043000$

stack/options.class.php

@@ -45,6 +45,14 @@ public function __construct($settings = []) {
                 'caskey'     => 'texput_decimal',
                 'castype'    => 'fun',
             ],
+            'scientificnotation' => [
+                'type'       => 'list',
+                'value'      => '*10',
+                'strict'     => true,
+                'values'     => array('*10', 'E'),
+                'caskey'     => 'texput_scientificnotation',
+                'castype'    => 'fun',
+            ],
             'multiplicationsign'   => [
                 'type'       => 'list',
                 'value'      => 'dot',
@@ -137,6 +145,7 @@ public function set_site_defaults() {
         $stackconfig = stack_utils::get_config();
         // Display option does not match up to $stackconfig->mathsdisplay).
         $this->set_option('decimals', $stackconfig->decimals);
+        $this->set_option('scientificnotation', $stackconfig->scientificnotation);
         $this->set_option('multiplicationsign', $stackconfig->multiplicationsign);
         $this->set_option('complexno', $stackconfig->complexno);
         $this->set_option('inversetrig', $stackconfig->inversetrig);
@@ -264,6 +273,16 @@ public static function get_decimals_sign_options() {
         ];
     }
 
+    /**
+     * @return array of choices for the scientific notation select menu.
+     */
+    public static function get_scientificnotation_options() {
+        return array(
+            '*10'  => get_string('scientificnotation_10', 'qtype_stack'),
+            'E'    => get_string('scientificnotation_E', 'qtype_stack'),
+        );
+    }
+
     /**
      * @return array of choices for the multiplication sign select menu.
      */

tests/api_stackquestionloader_test.php

@@ -68,6 +68,8 @@ public function test_question_loader_use_defaults() {
         $ql = new StackQuestionLoader();
         $question = $ql->loadXML($xml);
         $this->assertEquals($question->options->get_option('decimals'), get_config('qtype_stack', 'decimals'));
+        $this->assertEquals($question->options->get_option('scientificnotation'),
+                get_config('qtype_stack', 'scientificnotation'));
         $this->assertEquals($question->options->get_option('assumepos'), get_config('qtype_stack', 'assumepositive'));
         $this->assertEquals($question->options->get_option('assumereal'), get_config('qtype_stack', 'assumereal'));
         $this->assertEquals($question->options->get_option('multiplicationsign'), get_config('qtype_stack', 'multiplicationsign'));
@@ -97,6 +99,7 @@ public function test_question_loader_do_not_use_defaults() {
         $ql = new StackQuestionLoader();
         $question = $ql->loadXML($xml);
         $this->assertEquals($question->options->get_option('decimals'), ',');
+        $this->assertEquals($question->options->get_option('scientificnotation'), '*10');
         $this->assertEquals($question->options->get_option('assumepos'), true);
         $this->assertEquals($question->options->get_option('assumereal'), true);
         $this->assertEquals($question->options->get_option('multiplicationsign'), 'cross');

tests/fixtures/apifixtures.class.php

@@ -415,6 +415,7 @@ class stack_api_test_data {
                 <assumepositive>1</assumepositive>
                 <assumereal>1</assumereal>
                 <decimals>,</decimals>
+                <scientificnotation>*10</scientificnotation>
                 <multiplicationsign>cross</multiplicationsign>
                 <sqrtsign>0</sqrtsign>
                 <complexno>j</complexno>
@@ -1272,6 +1273,7 @@ class stack_api_test_data {
               <text><![CDATA[<span style="font-size: 1.5em; color:red;"><i class="fa fa-times"></i></span> Incorrect answer.]]></text>
             </prtincorrect>
             <decimals>.</decimals>
+            <scientificnotation>*10</scientificnotation>
             <multiplicationsign>dot</multiplicationsign>
             <sqrtsign>1</sqrtsign>
             <complexno>i</complexno>