lib/tests/mathslib_test.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Unit tests of mathslib wrapper and underlying EvalMath library.
  19  *
  20  * @package    core
  21  * @category   phpunit
  22  * @copyright  2007 Petr Skoda {@link http://skodak.org}
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 global $CFG;
  29 require_once($CFG->libdir . '/mathslib.php');
  30
  31
  32 class core_mathslib_testcase extends basic_testcase {
  33
  34     /**
  35      * Tests the basic formula evaluation.
  36      */
  37     public function test__basic() {
  38         $formula = new calc_formula('=1+2');
  39         $res = $formula->evaluate();
  40         $this->assertSame($res, 3, '3+1 is: %s');
  41     }
  42
  43     /**
  44      * Tests the formula params.
  45      */
  46     public function test__params() {
  47         $formula = new calc_formula('=a+b+c', array('a'=>10, 'b'=>20, 'c'=>30));
  48         $res = $formula->evaluate();
  49         $this->assertSame(60, $res, '10+20+30 is: %s');
  50     }
  51
  52     /**
  53      * Tests the changed params.
  54      */
  55     public function test__changing_params() {
  56         $formula = new calc_formula('=a+b+c', array('a'=>10, 'b'=>20, 'c'=>30));
  57         $res = $formula->evaluate();
  58         $this->assertSame(60, $res, '10+20+30 is: %s');
  59         $formula->set_params(array('a'=>1, 'b'=>2, 'c'=>3));
  60         $res = $formula->evaluate();
  61         $this->assertSame(6, $res, 'changed params 1+2+3 is: %s');
  62     }
  63
  64     /**
  65      * Tests the spreadsheet emulation function in formula.
  66      */
  67     public function test__calc_function() {
  68         $formula = new calc_formula('=sum(a, b, c)', array('a'=>10, 'b'=>20, 'c'=>30));
  69         $res = $formula->evaluate();
  70         $this->assertSame(60, $res, 'sum(a, b, c) is: %s');
  71     }
  72
  73     public function test_other_functions() {
  74         $formula = new calc_formula('=average(1,2,3)');
  75         $this->assertSame(2, $formula->evaluate());
  76
  77         $formula = new calc_formula('=mod(10,3)');
  78         $this->assertSame(1, $formula->evaluate());
  79
  80         $formula = new calc_formula('=power(2,3)');
  81         $this->assertSame(8, $formula->evaluate());
  82     }
  83
  84     /**
  85      * Tests the min and max functions.
  86      */
  87     public function test__minmax_function() {
  88         $formula = new calc_formula('=min(a, b, c)', array('a'=>10, 'b'=>20, 'c'=>30));
  89         $res = $formula->evaluate();
  90         $this->assertSame(10, $res, 'minimum is: %s');
  91         $formula = new calc_formula('=max(a, b, c)', array('a'=>10, 'b'=>20, 'c'=>30));
  92         $res = $formula->evaluate();
  93         $this->assertSame(30, $res, 'maximum is: %s');
  94     }
  95
  96     /**
  97      * Tests special chars.
  98      */
  99     public function test__specialchars() {
 100         $formula = new calc_formula('=gi1 + gi2 + gi11', array('gi1'=>10, 'gi2'=>20, 'gi11'=>30));
 101         $res = $formula->evaluate();
 102         $this->assertSame(60, $res, 'sum is: %s');
 103     }
 104
 105     /**
 106      * Tests some slightly more complex expressions.
 107      */
 108     public function test__more_complex_expressions() {
 109         $formula = new calc_formula('=pi() + a', array('a'=>10));
 110         $res = $formula->evaluate();
 111         $this->assertSame(pi()+10, $res);
 112         $formula = new calc_formula('=pi()^a', array('a'=>10));
 113         $res = $formula->evaluate();
 114         $this->assertSame(pow(pi(), 10), $res);
 115         $formula = new calc_formula('=-8*(5/2)^2*(1-sqrt(4))-8');
 116         $res = $formula->evaluate();
 117         $this->assertSame(-8*pow((5/2), 2)*(1-sqrt(4))-8, $res);
 118     }
 119
 120     /**
 121      * Tests some slightly more complex expressions.
 122      */
 123     public function test__error_handling() {
 124         $formula = new calc_formula('=pi( + a', array('a'=>10));
 125         $res = $formula->evaluate();
 126         $this->assertFalse($res);
 127         $this->assertSame(get_string('unexpectedoperator', 'mathslib', '+'), $formula->get_error());
 128
 129         $formula = new calc_formula('=pi(');
 130         $res = $formula->evaluate();
 131         $this->assertSame($res, false);
 132         $this->assertSame(get_string('expectingaclosingbracket', 'mathslib'), $formula->get_error());
 133
 134         $formula = new calc_formula('=pi()^');
 135         $res = $formula->evaluate();
 136         $this->assertSame($res, false);
 137         $this->assertSame(get_string('operatorlacksoperand', 'mathslib', '^'), $formula->get_error());
 138
 139     }
 140
 141     public function test_rounding_function() {
 142         // Rounding to the default number of decimal places.
 143         // The default == 0.
 144
 145         $formula = new calc_formula('=round(2.5)');
 146         $this->assertSame(3.0, $formula->evaluate());
 147
 148         $formula = new calc_formula('=round(1.5)');
 149         $this->assertSame(2.0, $formula->evaluate());
 150
 151         $formula = new calc_formula('=round(-1.49)');
 152         $this->assertSame(-1.0, $formula->evaluate());
 153
 154         $formula = new calc_formula('=round(-2.49)');
 155         $this->assertSame(-2.0, $formula->evaluate());
 156
 157         $formula = new calc_formula('=round(-1.5)');
 158         $this->assertSame(-2.0, $formula->evaluate());
 159
 160         $formula = new calc_formula('=round(-2.5)');
 161         $this->assertSame(-3.0, $formula->evaluate());
 162
 163         $formula = new calc_formula('=ceil(2.5)');
 164         $this->assertSame(3.0, $formula->evaluate());
 165
 166         $formula = new calc_formula('=ceil(1.5)');
 167         $this->assertSame(2.0, $formula->evaluate());
 168
 169         $formula = new calc_formula('=ceil(-1.49)');
 170         $this->assertSame(-1.0, $formula->evaluate());
 171
 172         $formula = new calc_formula('=ceil(-2.49)');
 173         $this->assertSame(-2.0, $formula->evaluate());
 174
 175         $formula = new calc_formula('=ceil(-1.5)');
 176         $this->assertSame(-1.0, $formula->evaluate());
 177
 178         $formula = new calc_formula('=ceil(-2.5)');
 179         $this->assertSame(-2.0, $formula->evaluate());
 180
 181         $formula = new calc_formula('=floor(2.5)');
 182         $this->assertSame(2.0, $formula->evaluate());
 183
 184         $formula = new calc_formula('=floor(1.5)');
 185         $this->assertSame(1.0, $formula->evaluate());
 186
 187         $formula = new calc_formula('=floor(-1.49)');
 188         $this->assertSame(-2.0, $formula->evaluate());
 189
 190         $formula = new calc_formula('=floor(-2.49)');
 191         $this->assertSame(-3.0, $formula->evaluate());
 192
 193         $formula = new calc_formula('=floor(-1.5)');
 194         $this->assertSame(-2.0, $formula->evaluate());
 195
 196         $formula = new calc_formula('=floor(-2.5)');
 197         $this->assertSame(-3.0, $formula->evaluate());
 198
 199         // Rounding to an explicit number of decimal places.
 200
 201         $formula = new calc_formula('=round(2.5, 1)');
 202         $this->assertSame(2.5, $formula->evaluate());
 203
 204         $formula = new calc_formula('=round(2.5, 0)');
 205         $this->assertSame(3.0, $formula->evaluate());
 206
 207         $formula = new calc_formula('=round(1.2345, 2)');
 208         $this->assertSame(1.23, $formula->evaluate());
 209
 210         $formula = new calc_formula('=round(123.456, -1)');
 211         $this->assertSame(120.0, $formula->evaluate());
 212     }
 213
 214     public function test_scientific_notation() {
 215         $formula = new calc_formula('=10e10');
 216         $this->assertEquals(1e11, $formula->evaluate(), '', 1e11*1e-15);
 217
 218         $formula = new calc_formula('=10e-10');
 219         $this->assertEquals(1e-9, $formula->evaluate(), '', 1e11*1e-15);
 220
 221         $formula = new calc_formula('=10e+10');
 222         $this->assertEquals(1e11, $formula->evaluate(), '', 1e11*1e-15);
 223
 224         $formula = new calc_formula('=10e10*5');
 225         $this->assertEquals(5e11, $formula->evaluate(), '', 1e11*1e-15);
 226
 227         $formula = new calc_formula('=10e10^2');
 228         $this->assertEquals(1e22, $formula->evaluate(), '', 1e22*1e-15);
 229     }
 230
 231     public function test_rand_float() {
 232         $formula = new calc_formula('=rand_float()');
 233         $result = $formula->evaluate();
 234         $this->assertTrue(is_float($result));
 235     }
 236 }