-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
519 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
# divide() | ||
<code>divide()</code> returns the quotient of the division of two numbers. There is a method function and a static method function. | ||
|
||
#### Syntax | ||
##### method function | ||
```javascript | ||
ba.divide(n); | ||
``` | ||
|
||
##### static method function | ||
```javascript | ||
BigArith.divide(a, b); | ||
``` | ||
|
||
### Parameters | ||
#### method function | ||
##### n - Required - {string|number|BigArith} | ||
The divisor with the value of the BigArith object as the dividend. This could be a string of digits, a number, or a BigArith object. | ||
|
||
#### static method function | ||
##### a - Required - {string|number|BigArith} | ||
The dividend: this could be a string of digits, a number, or a BigArith object. | ||
|
||
##### b - Required - {string|number|BigArith} | ||
The divisor: this could be a string of digits, a number, or a BigArith object. | ||
|
||
### Return value | ||
#### method function - {BigArith} | ||
A BigArith object with its value equals to the quotient of the division of the value of the BigArith object it is called on (the dividend) and n (the divisor). | ||
|
||
#### static method function - {BigArith} | ||
A BigArith object with its value equals to the quotient of the division of a (the dividend) and b (the divisor). | ||
|
||
##### Description | ||
There are two functions which could be used, the *method function*, and the *static method function*. The method function takes one parameter (n) as the divisor and returns the quotient of the division of the value of the BigArith object it is called on and n. | ||
|
||
The static method function takes two parameters (a, b) and is always used as <code>BigArith.divide()</code>. It returns the quotient of the division of a as the dividend and b as the divisor. | ||
|
||
The quotient returned will be to maximum of 200 decimal places *when necessary*. | ||
|
||
If n (in case of method function) or b (in case of static method function) is equivalent to zero, a <code>RangeError("Division by zero")</code> will be thrown. | ||
|
||
> Any number parameter (that is not strings of digits or a BigArith), it should be between the <code>Number.MIN_SAFE_INTEGER</code> and <code>Number.MAX_SAFE_INTEGER</code> limits. | ||
|
||
### Examples | ||
> In the server-side, always remember to add the line `var BigArith = require('bigarith.js');` and every other thing remains the same in both server-side and client-side code. | ||
#### Using method function | ||
|
||
```javascript | ||
var ba = new BigArith("-17031986"); | ||
ba = ba.divide("24011985"); //BigArith object with value "-0.70931187071789358522421199246959382991451977002317800881518125219551819643398911002151633861173909612220730605986968590893256013611536072507125087742641851558711201926871102076733764409731223803446487" | ||
|
||
ba = new BigArith("4"); | ||
ba = ba.divide("0.5"); //BigArith object with value "8" | ||
|
||
ba = new BigArith("8888888888888888888888888888888888888888888888888888888"); | ||
ba = ba.divide("99999999999999999999999999999999999999999999999999999999999999"); //BigArith object with value "0.00000008888888888888888888888888888888888888888888888888888888000000088888888888888888888888888888888888888888888888888888880000000888888888888888888888888888888888888888888888888888888800000008888889" | ||
``` | ||
|
||
#### Using the static method function | ||
|
||
```javascript | ||
var ba = BigArith.divide("-17031986", "24011985"); //BigArith object with value "-0.70931187071789358522421199246959382991451977002317800881518125219551819643398911002151633861173909612220730605986968590893256013611536072507125087742641851558711201926871102076733764409731223803446487" | ||
ba = BigArith.divide("4", "0.5"); //BigArith object with value "8" | ||
ba = BigArith.divide("8888888888888888888888888888888888888888888888888888888", "99999999999999999999999999999999999999999999999999999999999999"); //BigArith object with value "0.00000008888888888888888888888888888888888888888888888888888888000000088888888888888888888888888888888888888888888888888888880000000888888888888888888888888888888888888888888888888888888800000008888889" | ||
``` | ||
|
||
#### Method chaining | ||
Since the method returns a BigArith objects, [method chaining](method_chaining.html) is possible. | ||
```javascript | ||
var ba = new BigArith("-17031986"); | ||
ba = ba.divide("+17031986").add("24011985").multiply("456785564"); //BigArith object with value "10968327654198976" | ||
``` | ||
|
||
More examples [here](https://github.com/osofem/BigArith.js/tree/master/examples/) | ||
|
||
### See also | ||
* [subtract()](https://osofem.github.io/BigArith.js/documentation/subtract.html) | ||
* [multiply()](https://osofem.github.io/BigArith.js/documentation/multiply.html) | ||
* [add()](https://osofem.github.io/BigArith.js/documentation/add.html) | ||
* [modulus()](https://osofem.github.io/BigArith.js/documentation/modulus.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# floor() | ||
<code>floor()</code> returns the largest integer less than or equal to a given number. There is a method function and a static method function. | ||
|
||
#### Syntax | ||
##### method function | ||
```javascript | ||
ba.floor(); | ||
``` | ||
|
||
##### static method function | ||
```javascript | ||
BigArith.floor(n); | ||
``` | ||
|
||
### Parameters | ||
#### method function | ||
*none* | ||
|
||
#### static method function | ||
##### n - Required - {string|number|BigArith} | ||
The number to floor. This could be a string of digits, a number, or a BigArith object. | ||
|
||
### Return value | ||
#### method function - {BigArith} | ||
A BigArith object with its value equals to the <code>floor</code>ed value of the BigArith object it is called on. | ||
|
||
#### static method function - {BigArith} | ||
A BigArith object with its value equals to the <code>floor</code>ed value of n. | ||
|
||
##### Description | ||
There are two functions which could be used, the *method function*, and the *static method function*. The method function takes no parameter and returns a BigArith whose value equals the largest integer less than or equal to that of the BigArith object it is called on. | ||
|
||
The static method function takes one parameter (n) and is always used as <code>BigArith.floor()</code>. It returns the largest integer less than or equal to n. | ||
|
||
> Any number parameter (that is not strings of digits or a BigArith), it should be between the <code>Number.MIN_SAFE_INTEGER</code> and <code>Number.MAX_SAFE_INTEGER</code> limits. | ||
|
||
### Examples | ||
|
||
> In the server-side, always remember to add the line `var BigArith = require('bigarith.js');` and every other thing remains the same in both server-side and client-side code. | ||
#### Using method function | ||
|
||
```javascript | ||
var ba = new BigArith("-17031986.001"); | ||
ba = ba.floor(); //BigArith object with value "-17031987" | ||
|
||
ba = new BigArith("+17031986.001"); | ||
ba = ba.floor(); //BigArith object with value "17031986" | ||
|
||
ba = new BigArith("999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999.999"); | ||
ba = ba.floor(); //BigArith object with value "999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999" | ||
|
||
ba = new BigArith(); | ||
ba = ba.floor(); //BigArith object with value "0" | ||
|
||
ba = new BigArith(null); | ||
ba = ba.floor(); //BigArith object with value "0" | ||
|
||
ba = new BigArith(NaN); | ||
ba = ba.floor(); //NaN | ||
``` | ||
|
||
#### Using the static method function | ||
|
||
```javascript | ||
var ba = BigArith.floor("-17031986.001"); //BigArith object with value "-17031987" | ||
ba = BigArith.floor("+17031986.001"); //BigArith object with value "17031986" | ||
ba = BigArith.floor("999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999.999"); //BigArith object with value "999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999" | ||
ba = BigArith.floor(); //BigArith object with value "0" | ||
ba = BigArith.floor(null); //BigArith object with value "0" | ||
ba = BigArith.floor(NaN); //NaN | ||
``` | ||
|
||
More examples [here](https://github.com/osofem/BigArith.js/tree/master/examples/) | ||
|
||
### See also | ||
* [abs()](https://osofem.github.io/BigArith.js/documentation/abs.html) | ||
* [ceil()](https://osofem.github.io/BigArith.js/documentation/ceil.html) | ||
* [round()](https://osofem.github.io/BigArith.js/documentation/round.html) | ||
* [isNegative()](https://osofem.github.io/BigArith.js/documentation/isnegative.html) | ||
* [isPositive()](https://osofem.github.io/BigArith.js/documentation/ispositive.html) | ||
* [truncate()](https://osofem.github.io/BigArith.js/documentation/truncate.html) | ||
* [negate()](https://osofem.github.io/BigArith.js/documentation/negate.html) |
Oops, something went wrong.