Add new Complex Number Functions introduced in MS Excel 2013 (#601)

* - Refactored Complex Engineering Functions to use external complex number library - Added calculation engine support for the new complex number functions that were added in MS Excel 2013 - IMCOSH() Returns the hyperbolic cosine of a complex number - IMCOT() Returns the cotangent of a complex number - IMCSC() Returns the cosecant of a complex number - IMCSCH() Returns the hyperbolic cosecant of a complex number - IMSEC() Returns the secant of a complex number - IMSECH() Returns the hyperbolic secant of a complex number - IMSINH() Returns the hyperbolic sine of a complex number - IMTAN() Returns the tangent of a complex number * Simplified the parseComplex() method in the PhpOffice\PhpSpreadsheet\Calculation\Engineering class, using Complex\Complex; and docblock flagged as deprecated
PHPOffice · Jul 25, 2018 · 1b96c95 · 1b96c95
1 parent 57a0297
commit 1b96c95
Show file tree

Hide file tree

Showing 23 changed files with 1,598 additions and 522 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,11 +13,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Support workbook view attributes for Xlsx format - [#523](https://github.com/PHPOffice/PhpSpreadsheet/issues/523)
 - Read and write hyperlink for drawing image - [#490](https://github.com/PHPOffice/PhpSpreadsheet/pull/490)
 - Added calculation engine support for the new bitwise functions that were added in MS Excel 2013
-  - BITAND()     Returns a Bitwise 'And' of two numbers
-  - BITOR()      Returns a Bitwise 'Or' of two number
-  - BITXOR()     Returns a Bitwise 'Exclusive Or' of two numbers
-  - BITLSHIFT()  Returns a number shifted left by a specified number of bits
-  - BITRSHIFT()  Returns a number shifted right by a specified number of bits
+  - BITAND()          Returns a Bitwise 'And' of two numbers
+  - BITOR()           Returns a Bitwise 'Or' of two number
+  - BITXOR()          Returns a Bitwise 'Exclusive Or' of two numbers
+  - BITLSHIFT()       Returns a number shifted left by a specified number of bits
+  - BITRSHIFT()       Returns a number shifted right by a specified number of bits
 - Added calculation engine support for other new functions that were added in MS Excel 2013 and MS Excel 2016
   - Text Functions
     - CONCAT()        Synonym for CONCATENATE()
@@ -46,6 +46,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
     - COTH()          Returns the hyperbolic cotangent of an angle
     - ACOT()          Returns the cotangent of an angle
     - ACOTH()         Returns the hyperbolic cotangent of an angle
+- Refactored Complex Engineering Functions to use external complex number library
+- Added calculation engine support for the new complex number functions that were added in MS Excel 2013
+    - IMCOSH()        Returns the hyperbolic cosine of a complex number
+    - IMCOT()         Returns the cotangent of a complex number
+    - IMCSC()         Returns the cosecant of a complex number
+    - IMCSCH()        Returns the hyperbolic cosecant of a complex number
+    - IMSEC()         Returns the secant of a complex number
+    - IMSECH()        Returns the hyperbolic secant of a complex number
+    - IMSINH()        Returns the hyperbolic sine of a complex number
+    - IMTAN()         Returns the tangent of a complex number 
 
 ### Fixed
 

diff --git a/composer.json b/composer.json
@@ -46,7 +46,8 @@
         "ext-xmlwriter": "*",
         "ext-zip": "*",
         "ext-zlib": "*",
-        "psr/simple-cache": "^1.0"
+        "psr/simple-cache": "^1.0",
+        "markbaker/complex": "^1.4.1"
     },
     "require-dev": {
         "tecnickcom/tcpdf": "^6.2",

diff --git a/composer.lock b/composer.lock
diff --git a/docs/references/function-list-by-category.md b/docs/references/function-list-by-category.md
@@ -86,6 +86,10 @@ IMAGINARY           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMAGINA
 IMARGUMENT          | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMARGUMENT
 IMCONJUGATE         | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCONJUGATE
 IMCOS               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOS
+IMCOSH              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOSH
+IMCOT               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOT
+IMCSC               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCSC
+IMCSCH              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCSCH
 IMDIV               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMDIV
 IMEXP               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMEXP
 IMLN                | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMLN
@@ -94,10 +98,14 @@ IMLOG2              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMLOG2
 IMPOWER             | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMPOWER
 IMPRODUCT           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMPRODUCT
 IMREAL              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMREAL
+IMSEC               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSEC
+IMSECH              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSECH
 IMSIN               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSIN
+IMSINH              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSINH
 IMSQRT              | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSQRT
 IMSUB               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSUB
 IMSUM               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSUM
+IMTAN               | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMTAN
 OCT2BIN             | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::OCTTOBIN
 OCT2DEC             | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::OCTTODEC
 OCT2HEX             | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::OCTTOHEX

diff --git a/docs/references/function-list-by-name.md b/docs/references/function-list-by-name.md
@@ -206,6 +206,10 @@ IMAGINARY           | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet
 IMARGUMENT          | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMARGUMENT
 IMCONJUGATE         | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCONJUGATE
 IMCOS               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOS
+IMCOSH              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOSH
+IMCOT               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCOT
+IMCSC               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCSC
+IMCSCH              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMCSCH
 IMDIV               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMDIV
 IMEXP               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMEXP
 IMLN                | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMLN
@@ -214,10 +218,14 @@ IMLOG2              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet
 IMPOWER             | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMPOWER
 IMPRODUCT           | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMPRODUCT
 IMREAL              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMREAL
+IMSEC               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSEC
+IMSECH              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSECH
 IMSIN               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSIN
+IMSINH              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSINH
 IMSQRT              | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSQRT
 IMSUB               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSUB
 IMSUM               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMSUM
+IMTAN               | CATEGORY_ENGINEERING           | \PhpOffice\PhpSpreadsheet\Calculation\Engineering::IMTAN
 INDEX               | CATEGORY_LOOKUP_AND_REFERENCE  | \PhpOffice\PhpSpreadsheet\Calculation\LookupRef::INDEX
 INDIRECT            | CATEGORY_LOOKUP_AND_REFERENCE  | \PhpOffice\PhpSpreadsheet\Calculation\LookupRef::INDIRECT
 INFO                | CATEGORY_INFORMATION           | **Not yet Implemented**

diff --git a/src/PhpSpreadsheet/Calculation/Calculation.php b/src/PhpSpreadsheet/Calculation/Calculation.php
@@ -1038,6 +1038,26 @@ class Calculation
             'functionCall' => [Engineering::class, 'IMCOS'],
             'argumentCount' => '1',
         ],
+        'IMCOSH' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMCOSH'],
+            'argumentCount' => '1',
+        ],
+        'IMCOT' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMCOT'],
+            'argumentCount' => '1',
+        ],
+        'IMCSC' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMCSC'],
+            'argumentCount' => '1',
+        ],
+        'IMCSCH' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMCSCH'],
+            'argumentCount' => '1',
+        ],
         'IMDIV' => [
             'category' => Category::CATEGORY_ENGINEERING,
             'functionCall' => [Engineering::class, 'IMDIV'],
@@ -1078,11 +1098,26 @@ class Calculation
             'functionCall' => [Engineering::class, 'IMREAL'],
             'argumentCount' => '1',
         ],
+        'IMSEC' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMSEC'],
+            'argumentCount' => '1',
+        ],
+        'IMSECH' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMSECH'],
+            'argumentCount' => '1',
+        ],
         'IMSIN' => [
             'category' => Category::CATEGORY_ENGINEERING,
             'functionCall' => [Engineering::class, 'IMSIN'],
             'argumentCount' => '1',
         ],
+        'IMSINH' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMSINH'],
+            'argumentCount' => '1',
+        ],
         'IMSQRT' => [
             'category' => Category::CATEGORY_ENGINEERING,
             'functionCall' => [Engineering::class, 'IMSQRT'],
@@ -1098,6 +1133,11 @@ class Calculation
             'functionCall' => [Engineering::class, 'IMSUM'],
             'argumentCount' => '1+',
         ],
+        'IMTAN' => [
+            'category' => Category::CATEGORY_ENGINEERING,
+            'functionCall' => [Engineering::class, 'IMTAN'],
+            'argumentCount' => '1',
+        ],
         'INDEX' => [
             'category' => Category::CATEGORY_LOOKUP_AND_REFERENCE,
             'functionCall' => [LookupRef::class, 'INDEX'],