Merge pull request #41 from codisart/add-cosec-method

[TECH] Add the cosec method for the Decimal class and the test.

Author: castarco

src/Decimal.php

@@ -713,6 +713,25 @@ function ($i) {
         );
     }
 
+    /**
+     * Calculates the cosecant of this with the highest possible accuracy
+     * Note that accuracy is limited by the accuracy of predefined PI;
+     *
+     * @param integer $scale
+     * @return Decimal
+     */
+    public function cosec($scale = null)
+    {
+        $sin = $this->sin($scale + 2);
+        if ($sin->isZero()) {
+            throw new \DomainException(
+                "The cosecant of this 'angle' is undefined."
+            );
+        }
+
+        return Decimal::fromInteger(1)->div($sin)->round($scale);
+    }
+
     /**
      * Calculates the cosine of this method with the highest possible accuracy
      * Note that accuracy is limited by the accuracy of predefined PI;

src/InfiniteDecimal.php

@@ -311,6 +311,20 @@ public function sin($scale = null)
         );
     }
 
+    /**
+     * Throws exception because cosecant is undefined in the infinite.
+     *
+     * @param integer $scale
+     * @return null
+     */
+    public function cosec($scale = null)
+    {
+        throw new \DomainException(($this === self::$pInf) ?
+            "Cosecant function hasn't limit in the positive infinite." :
+            "Cosecant function hasn't limit in the negative infinite."
+        );
+    }
+
     /**
      * Throws exception because cosine is undefined in the infinite.
      *

tests/Decimal/DecimalCosecTest.php

@@ -0,0 +1,32 @@
+<?php
+
+use Litipk\BigNumbers\Decimal as Decimal;
+
+/**
+ * @group cosec
+ */
+class DecimalCosecTest extends PHPUnit_Framework_TestCase
+{
+    public function cosecProvider() {
+        // Some values provided by Mathematica
+        return [
+            ['1', '1.18839510577812', 14],
+            ['123.123', '-1.76874094322450309', 17],
+            ['15000000000', '1.44570405082842149818', 20]
+        ];
+    }
+
+    /**
+     * @dataProvider cosecProvider
+     */
+    public function testSimple($nr, $answer, $digits)
+    {
+        $x = Decimal::fromString($nr);
+        $cosecX = $x->cosec((int)$digits);
+
+        $this->assertTrue(
+            Decimal::fromString($answer)->equals($cosecX),
+            "The answer must be " . $answer . ", but was " . $cosecX
+        );
+    }
+}

tests/InfiniteDecimal/InfiniteDecimalCosecTest.php

@@ -0,0 +1,27 @@
+<?php
+
+use Litipk\BigNumbers\InfiniteDecimal as InfiniteDecimal;
+
+/**
+ * @group cos
+ */
+class InfiniteDecimalCosecTest extends PHPUnit_Framework_TestCase
+{
+    /**
+     * @expectedException \DomainException
+     * @expectedExceptionMessage Cosecant function hasn't limit in the positive infinite.
+     */
+    public function testFinitePositiveInfiniteCosec()
+    {
+        InfiniteDecimal::getPositiveInfinite()->cosec();
+    }
+
+    /**
+     * @expectedException \DomainException
+     * @expectedExceptionMessage Cosecant function hasn't limit in the negative infinite.
+     */
+    public function testFiniteNegativeInfiniteCosec()
+    {
+        InfiniteDecimal::getNegativeInfinite()->cosec();
+    }
+}