Merge pull request #617 from PhilippCo/eng_notation

Eng notation

Author: splitbrain

_test/Type_Decimal.test.php

@@ -101,7 +101,7 @@ public function test_validate_success($value, $min, $max, $decpoint = '.')
     public function valueProvider()
     {
         return array(
-            // $value, $expect, $roundto, $decpoint, $thousands, $trimzeros, $prefix='', $postfix=''
+            // $value, $expect, $roundto, $decpoint, $thousands, $trimzeros, $prefix='', $postfix='', $engineering = false
             array('5000', '5 000,00', '2', ',', ' ', false),
             array('5000', '5 000', '2', ',', ' ', true),
             array('5000', '5 000', '0', ',', ' ', false),
@@ -117,21 +117,46 @@ public function valueProvider()
 
             array('-0.55600', '$ -0,556', '4', ',', ' ', true, '$ '),
             array('-0.55600', '-0,556 EUR', '4', ',', ' ', true, '', ' EUR'),
+
+            //engineering notation
+            array('1e-18', '1'."\xE2\x80\xAF".'a', '-1', ',', ' ', true, '', '', true),
+            array('1e-15', '1'."\xE2\x80\xAF".'f', '-1', ',', ' ', true, '', '', true),
+            array('1e-12', '1'."\xE2\x80\xAF".'p', '-1', ',', ' ', true, '', '', true),
+            array('1e-9',  '1'."\xE2\x80\xAF".'n', '-1', ',', ' ', true, '', '', true),
+            array('1e-6',  '1'."\xE2\x80\xAF".'µ', '-1', ',', ' ', true, '', '', true),
+            array('1e-3',  '1'."\xE2\x80\xAF".'m', '-1', ',', ' ', true, '', '', true),
+
+            array('1e3',  '1'."\xE2\x80\xAF".'k', '-1', ',', ' ', true, '', '', true),
+            array('1e6',  '1'."\xE2\x80\xAF".'M', '-1', ',', ' ', true, '', '', true),
+            array('1e9',  '1'."\xE2\x80\xAF".'G', '-1', ',', ' ', true, '', '', true),
+            array('1e12', '1'."\xE2\x80\xAF".'T', '-1', ',', ' ', true, '', '', true),
+
+            array('1e4', '10'. "\xE2\x80\xAF".'k', '-1', ',', ' ', true, '', '', true),
+            array('1e5', '100'."\xE2\x80\xAF".'k', '-1', ',', ' ', true, '', '', true),
+
+            array('1e-4', '100'."\xE2\x80\xAF".'µ', '-1', ',', ' ', true, '', '', true),
+            array('1e-5', '10'. "\xE2\x80\xAF".'µ', '-1', ',', ' ', true, '', '', true),
+            
+            //test behaviour if number exceeds prefix array
+            array('1e15',  '1000'. "\xE2\x80\xAF".'T', '-1', ',', ' ', true, '', '', true),
+            array('1e-21', '0.001'."\xE2\x80\xAF".'a', '-1', ',', ' ', true, '', '', true),
+            
         );
     }
 
     /**
      * @dataProvider valueProvider
      */
-    public function test_renderValue($value, $expect, $roundto, $decpoint, $thousands, $trimzeros, $prefix = '', $postfix = '')
+    public function test_renderValue($value, $expect, $roundto, $decpoint, $thousands, $trimzeros, $prefix = '', $postfix = '', $engineering = false)
     {
         $decimal = new Decimal(array(
             'roundto' => $roundto,
             'decpoint' => $decpoint,
             'thousands' => $thousands,
             'trimzeros' => $trimzeros,
             'prefix' => $prefix,
-            'postfix' => $postfix
+            'postfix' => $postfix,
+            'engineering' => $engineering
         ));
         $R = new \Doku_Renderer_xhtml();
         $R->doc = '';

types/Decimal.php

@@ -23,7 +23,8 @@ class Decimal extends AbstractMultiBaseType
         'thousands' => "\xE2\x80\xAF", // narrow no-break space
         'trimzeros' => true,
         'prefix' => '',
-        'postfix' => ''
+        'postfix' => '',
+        'engineering' => false
     );
 
     /**
@@ -36,6 +37,31 @@ class Decimal extends AbstractMultiBaseType
      */
     public function renderValue($value, \Doku_Renderer $R, $mode)
     {
+
+        if ($this->config['engineering']) {
+            $unitsh = array('', 'k', 'M', 'G', 'T');
+            $unitsl = array('', 'm', 'µ', 'n', 'p', 'f', 'a');
+
+            $exp   = floor(log10($value)/3);
+
+            if ($exp < 0) {
+                    $units = $unitsl;
+                    $pfkey = -1 * $exp;
+            } else {
+                    $units = $unitsh;
+                    $pfkey = $exp; 
+            }
+
+            if (count($units) <= ($pfkey+1)) { //check if number is within prefixes
+                $pfkey = sizeof($units)-1;
+                $exp   = $pfkey * $exp/abs($exp);
+            }
+
+            $R->cdata($this->config['prefix'] . $value / 10**($exp*3) . "\xE2\x80\xAF" . $units[$pfkey] . $this->config['postfix'] );
+            return true;
+        }
+
+
         if ($this->config['roundto'] == -1) {
             $value = $this->formatWithoutRounding(
                 $value,
@@ -56,7 +82,8 @@ public function renderValue($value, \Doku_Renderer $R, $mode)
             $value = rtrim($value, $this->config['decpoint']);
         }
 
-        $R->cdata($this->config['prefix'] . $value . $this->config['postfix']);
+
+        $R->cdata($this->config['prefix'] . $value . $this->config['postfix'] );
         return true;
     }