---
layout: page
title: "JavaScript bcsub function"
comments: true
sharing: true
footer: true
alias:
- /functions/view/bcsub:875
- /functions/view/bcsub
- /functions/view/875
- /functions/bcsub:875
- /functions/875
---
<!-- Generated by Rakefile:build -->
A JavaScript equivalent of PHP's bcsub

{% codeblock bc/bcsub.js lang:js https://raw.github.com/kvz/phpjs/master/functions/bc/bcsub.js raw on github %}
function bcsub (left_operand, right_operand, scale) {
  // From: http://phpjs.org/functions
  // +   original by: lmeyrick (https://sourceforge.net/projects/bcmath-js/)
  // -    depends on: _phpjs_shared_bc
  // *     example 1: bcsub(1, 2);
  // *     returns 1: -1
  //  @todo: implement these testcases
  //        // set scale to zero
  //        bcscale(0);
  //
  //        bcmath.test.result('bcsub', 1, '-1', bcsub('1','2'));
  //        bcmath.test.result('bcsub', 2, '-6.0000', bcsub('-1','5', 4));
  //        bcmath.test.result('bcsub', 3, '8728932000054820705086578390258.00', bcsub('8728932001983192837219398127471','1928372132132819737213', 2));
  //        bcmath.test.result('bcsub', 4, '-1.111000', bcsub('1.123', '2.234', 6));
  //        bcmath.test.result('bcsub', 5, '-2.20', bcsub('1.123456', '3.333333', 2)); //-2.209877 note: rounding not applicable as bcmath truncates.
  var libbcmath = this._phpjs_shared_bc();

  var first, second, result;

  if (typeof scale === 'undefined') {
    scale = libbcmath.scale;
  }
  scale = ((scale < 0) ? 0 : scale);

  // create objects
  first = libbcmath.bc_init_num();
  second = libbcmath.bc_init_num();
  result = libbcmath.bc_init_num();

  first = libbcmath.php_str2num(left_operand.toString());
  second = libbcmath.php_str2num(right_operand.toString());

  result = libbcmath.bc_sub(first, second, scale);

  if (result.n_scale > scale) {
    result.n_scale = scale;
  }

  return result.toString();

}
{% endcodeblock %}

 - [Raw function on GitHub](https://github.com/kvz/phpjs/blob/master/functions/bc/bcsub.js)

Please note that php.js uses JavaScript objects as substitutes for PHP arrays, they are 
the closest match to this hashtable-like data structure. 

Please also note that php.js offers community built functions and goes by the 
[McDonald's Theory](https://medium.com/what-i-learned-building/9216e1c9da7d). We'll put online 
functions that are far from perfect, in the hopes to spark better contributions. 
Do you have one? Then please just: 

 - [Edit on GitHub](https://github.com/kvz/phpjs/edit/master/functions/bc/bcsub.js)

### Example 1
This code
{% codeblock lang:js example %}
bcsub(1, 2);
{% endcodeblock %}

Should return
{% codeblock lang:js returns %}
-1
{% endcodeblock %}


### Other PHP functions in the bc extension
{% render_partial _includes/custom/bc.html %}