thereadme/Equation.js
1
0
Fork 0
Code Issues 4 Pull Requests 3 Projects Releases Wiki Activity

Merge pull request #7 from mdibaiee/sigma

Browse Source 
Sigma
This commit is contained in:
Mahdi Dibaiee 2015-06-21 23:40:34 +04:30
commit db1726e6af
10 changed files with 205 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,8 +1,8 @@
Equation [![Build Status](https://travis-ci.org/mdibaiee/Equation.js.svg?branch=master)](https://travis-ci.org/mdibaiee/Equation.js)
Equation [![Build Status](https://travis-ci.org/mdibaiee/Equation.svg?branch=master)](https://travis-ci.org/mdibaiee/Equation.js)
========
Solve math expressions or create equations for repeated and complex Math tasks.
To use in browser, download [`equation.min.js`](https://raw.githubusercontent.com/mdibaiee/Equation.js/master/equation.min.js).
To use in browser, download [`equation.min.js`](https://raw.githubusercontent.com/mdibaiee/Equation/master/equation.min.js).
Install using npm:
@ -27,7 +27,7 @@ console.log(test(4, 3)).to.equal(8 + 18);
You can also register your own operators and constants.
```javascript
// these options are explained below
// these options are explained in [`operators.js`](https://github.com/mdibaiee/Equation/blob/master/lib/operators.js).
Equation.registerOperator('$', {
fn: a => 1/a,
format: '10',
@ -42,9 +42,12 @@ Equation.registerConstant('N', () => {
});
Equation.solve('N'); // a number between 10 and 20
// Complex operators
Equation.solve('sigma(0, 5, 2@ + 5)'); // 60
```
For a list of operators and constants see [`operators.js`](https://github.com/mdibaiee/Equation.js/blob/master/lib/operators.js) and [`constants.js`](https://github.com/mdibaiee/Equation.js/blob/master/lib/constants.js).
For a list of operators and constants see [`operators.js`](https://github.com/mdibaiee/Equation/blob/master/lib/operators.js) and [`constants.js`](https://github.com/mdibaiee/Equation/blob/master/lib/constants.js).
API
===

26
dist/index.js vendored
View File

@ -127,7 +127,13 @@ var solveStack = (function (_solveStack) {
return solveStack;
})(function (stack) {
if (stack.some(Array.isArray)) {
// if an operator takes an expression argument, we should not dive into it
// and solve the expression inside
var hasExpressionArgument = stack.some(function (a) {
return _operators2['default'][a] && _operators2['default'][a].hasExpression;
});
if (!hasExpressionArgument && stack.some(Array.isArray)) {
stack = stack.map(function (group) {
if (!Array.isArray(group)) {
return group;
@ -159,6 +165,12 @@ var MIN_PRECEDENCE = Math.min.apply(Math, _toConsumableArray(PRECEDENCES));
* The parsed array
*/
var parseExpression = function parseExpression(expression) {
// function arguments can be separated using comma,
// but we parse as groups, so this is the solution to getting comma to work
// sigma(0, 4, 2@) becomes sigma(0)(4)(2@) so every argument is parsed
// separately
expression = expression.replace(/,/g, ')(');
var stream = new _ReadStream2['default'](expression),
stack = [],
record = '',
@ -238,19 +250,19 @@ var parseExpression = function parseExpression(expression) {
*/
var parseGroups = function parseGroups(stack) {
// Parantheses become inner arrays which will then be processed first
var sub = 0;
var depth = 0;
return stack.reduce(function (a, b) {
if (b.indexOf('(') > -1) {
if (b.length > 1) {
_.dive(a, sub).push(b.replace('(', ''), []);
_.dive(a, depth).push(b.replace('(', ''), []);
} else {
_.dive(a, sub).push([]);
_.dive(a, depth).push([]);
}
sub++;
depth++;
} else if (b === ')') {
sub--;
depth--;
} else {
_.dive(a, sub).push(b);
_.dive(a, depth).push(b);
}
return a;
}, []);

29
dist/operators.js vendored
View File

@ -1,8 +1,15 @@
'use strict';
var _interopRequireWildcard = function (obj) { return obj && obj.__esModule ? obj : { 'default': obj }; };
Object.defineProperty(exports, '__esModule', {
value: true
});
var _Equation = require('./index');
var _Equation2 = _interopRequireWildcard(_Equation);
/*
* Operators and Functions
* fn: function used to evaluate value
@ -11,6 +18,11 @@ Object.defineProperty(exports, '__esModule', {
* e.g: factorial is 01, add is 010, like 2!, 2+2
* precedence: determines which operators should be evaluated first
* the lower the value, the higher the precedence
* hasExpression: determines if any of the operator arguments are an expression
* This way, arguments will not be solved by equation and instead
* you have to call solve on each argument yourself.
* You get the arguments as parsed arrays sigma(0, 5, 2@) becomes
* sigma(0, 5, [2, '*', '@']). See sigma operator for reference
*/
exports['default'] = {
'^': {
@ -119,6 +131,23 @@ exports['default'] = {
fn: Math.floor,
format: '10',
precedence: -1
},
sigma: {
fn: function fn(from, to, expression) {
var expr = expression.join('').replace(/,/g, '');
var regex = new RegExp(ITERATOR_SIGN, 'g');
var sum = 0;
for (var i = from; i <= to; i++) {
sum += _Equation2['default'].solve(expr.replace(regex, i));
}
return sum;
},
format: '1000',
hasExpression: true,
precedence: -1
}
};
var ITERATOR_SIGN = '@';
module.exports = exports['default'];

20
dist/tests/solve.js vendored
View File

@ -92,7 +92,25 @@ describe('Constats', function () {
_expect.expect(_M2['default'].solve('sin(PI/2)')).to.equal(1);
});
it('should work for functions as constants', function () {
it('should work for functions as constants - retry on fail', function () {
_expect.expect(_M2['default'].solve('RAND')).to.not.equal(_M2['default'].solve('RAND'));
});
});
describe('Sigma', function () {
it('should work with simple expressions', function () {
_expect.expect(_M2['default'].solve('sigma(0, 5, @)')).to.equal(15);
});
it('should work with more complex expressions', function () {
_expect.expect(_M2['default'].solve('sigma(0, 2, 2@+5)')).to.equal(21);
});
it('should work without an iterator sign', function () {
_expect.expect(_M2['default'].solve('sigma(0, 2, 5*2)')).to.equal(30);
});
it('should work with negative start / end points', function () {
_expect.expect(_M2['default'].solve('sigma(-5, -2, @)')).to.equal(-14);
});
});

76
equation.js
View File

@ -284,6 +284,13 @@ var Equation = {
};
},
// 2x + 5x * x => 7x^2
simplify: function simplify(expression) {
var stack = parseExpression(expression);
console.log(stack);
},
registerOperator: function registerOperator(key, options) {
_operators2['default'][key] = options;
},
@ -304,7 +311,13 @@ var solveStack = (function (_solveStack) {
return solveStack;
})(function (stack) {
if (stack.some(Array.isArray)) {
// if an operator takes an expression argument, we should not dive into it
// and solve the expression inside
var hasExpressionArgument = stack.some(function (a) {
return _operators2['default'][a] && _operators2['default'][a].hasExpression;
});
if (!hasExpressionArgument && stack.some(Array.isArray)) {
stack = stack.map(function (group) {
if (!Array.isArray(group)) {
return group;
@ -336,6 +349,12 @@ var MIN_PRECEDENCE = Math.min.apply(Math, _toConsumableArray(PRECEDENCES));
* The parsed array
*/
var parseExpression = function parseExpression(expression) {
// function arguments can be separated using comma,
// but we parse as groups, so this is the solution to getting comma to work
// sigma(0, 4, 2@) becomes sigma(0)(4)(2@) so every argument is parsed
// separately
expression = expression.replace(/,/g, ')(');
var stream = new _ReadStream2['default'](expression),
stack = [],
record = '',
@ -415,19 +434,19 @@ var parseExpression = function parseExpression(expression) {
*/
var parseGroups = function parseGroups(stack) {
// Parantheses become inner arrays which will then be processed first
var sub = 0;
var depth = 0;
return stack.reduce(function (a, b) {
if (b.indexOf('(') > -1) {
if (b.length > 1) {
_.dive(a, sub).push(b.replace('(', ''), []);
_.dive(a, depth).push(b.replace('(', ''), []);
} else {
_.dive(a, sub).push([]);
_.dive(a, depth).push([]);
}
sub++;
depth++;
} else if (b === ')') {
sub--;
depth--;
} else {
_.dive(a, sub).push(b);
_.dive(a, depth).push(b);
}
return a;
}, []);
@ -650,9 +669,16 @@ exports['default'] = Equation;
},{"./constants":1,"./helpers":2,"./operators":4,"./readstream":5}],4:[function(require,module,exports){
'use strict';
var _interopRequireWildcard = function (obj) { return obj && obj.__esModule ? obj : { 'default': obj }; };
Object.defineProperty(exports, '__esModule', {
value: true
});
var _Equation = require('equation');
var _Equation2 = _interopRequireWildcard(_Equation);
/*
* Operators and Functions
* fn: function used to evaluate value
@ -661,6 +687,11 @@ Object.defineProperty(exports, '__esModule', {
* e.g: factorial is 01, add is 010, like 2!, 2+2
* precedence: determines which operators should be evaluated first
* the lower the value, the higher the precedence
* hasExpression: determines if any of the operator arguments are an expression
* This way, arguments will not be solved by equation and instead
* you have to call solve on each argument yourself.
* You get the arguments as parsed arrays sigma(0, 5, 2@) becomes
* sigma(0, 5, [2, '*', '@']). See sigma operator for reference
*/
exports['default'] = {
'^': {
@ -769,10 +800,27 @@ exports['default'] = {
fn: Math.floor,
format: '10',
precedence: -1
},
sigma: {
fn: function fn(from, to, expression) {
var expr = expression.join('').replace(/,/g, '');
var regex = new RegExp(ITERATOR_SIGN, 'g');
var sum = 0;
for (var i = from; i <= to; i++) {
sum += _Equation2['default'].solve(expr.replace(regex, i));
}
return sum;
},
format: '1000',
hasExpression: true,
precedence: -1
}
};
var ITERATOR_SIGN = '@';
module.exports = exports['default'];
},{}],5:[function(require,module,exports){
},{"equation":8}],5:[function(require,module,exports){
'use strict';
Object.defineProperty(exports, '__esModule', {
@ -835,5 +883,15 @@ exports['default'] = function (string) {
};
module.exports = exports['default'];
},{}]},{},[3])(3)
},{}],6:[function(require,module,exports){
arguments[4][1][0].apply(exports,arguments)
},{"dup":1}],7:[function(require,module,exports){
arguments[4][2][0].apply(exports,arguments)
},{"dup":2}],8:[function(require,module,exports){
arguments[4][3][0].apply(exports,arguments)
},{"./constants":6,"./helpers":7,"./operators":9,"./readstream":10,"dup":3}],9:[function(require,module,exports){
arguments[4][4][0].apply(exports,arguments)
},{"dup":4,"equation":8}],10:[function(require,module,exports){
arguments[4][5][0].apply(exports,arguments)
},{"dup":5}]},{},[3])(3)
});

2
equation.min.js vendored
View File

File diff suppressed because one or more lines are too long

26
lib/index.js
View File

@ -90,7 +90,13 @@ let Equation = {
};
const solveStack = stack => {
if (stack.some(Array.isArray)) {
// if an operator takes an expression argument, we should not dive into it
// and solve the expression inside
const hasExpressionArgument = stack.some(a => {
return operators[a] && operators[a].hasExpression;
});
if (!hasExpressionArgument && stack.some(Array.isArray)) {
stack = stack.map(group => {
if (!Array.isArray(group)) {
return group;
@ -122,6 +128,12 @@ const MIN_PRECEDENCE = Math.min(...PRECEDENCES);
* The parsed array
*/
const parseExpression = expression => {
// function arguments can be separated using comma,
// but we parse as groups, so this is the solution to getting comma to work
// sigma(0, 4, 2@) becomes sigma(0)(4)(2@) so every argument is parsed
// separately
expression = expression.replace(/,/g, ')(');
let stream = new ReadStream(expression),
stack = [],
record = '',
@ -202,19 +214,19 @@ const parseExpression = expression => {
*/
const parseGroups = stack => {
// Parantheses become inner arrays which will then be processed first
let sub = 0;
let depth = 0;
return stack.reduce((a, b) => {
if (b.indexOf('(') > -1) {
if (b.length > 1) {
_.dive(a, sub).push(b.replace('(', ''), []);
_.dive(a, depth).push(b.replace('(', ''), []);
} else {
_.dive(a, sub).push([]);
_.dive(a, depth).push([]);
}
sub++;
depth++;
} else if (b === ')') {
sub--;
depth--;
} else {
_.dive(a, sub).push(b);
_.dive(a, depth).push(b);
}
return a;
}, []);

24
lib/operators.js
View File

@ -1,3 +1,5 @@
import Equation from './index';
/*
* Operators and Functions
* fn: function used to evaluate value
@ -6,6 +8,11 @@
* e.g: factorial is 01, add is 010, like 2!, 2+2
* precedence: determines which operators should be evaluated first
* the lower the value, the higher the precedence
* hasExpression: determines if any of the operator arguments are an expression
* This way, arguments will not be solved by equation and instead
* you have to call solve on each argument yourself.
* You get the arguments as parsed arrays sigma(0, 5, 2@) becomes
* sigma(0, 5, [2, '*', '@']). See sigma operator for reference
*/
export default {
'^': {
@ -98,5 +105,22 @@ export default {
fn: Math.floor,
format: '10',
precedence: -1
},
'sigma': {
fn(from, to, expression) {
const expr = expression.join('').replace(/,/g, '');
const regex = new RegExp(ITERATOR_SIGN, 'g');
let sum = 0;
for (let i = from; i <= to; i++) {
sum += Equation.solve(expr.replace(regex, i));
}
return sum;
},
format: '1000',
hasExpression: true,
precedence: -1
}
};
const ITERATOR_SIGN = '@';

2
package.json
View File

@ -1,6 +1,6 @@
{
"name": "equations",
"version": "1.2.1",
"version": "1.3.0",
"description": "",
"main": "dist/index.js",
"directories": {

20
tests/solve.js
View File

@ -85,7 +85,25 @@ describe('Constats', () => {
expect(M.solve('sin(PI/2)')).to.equal(1);
});
it('should work for functions as constants', () => {
it('should work for functions as constants - retry on fail', () => {
expect(M.solve('RAND')).to.not.equal(M.solve('RAND'));
});
});
describe('Sigma', () => {
it('should work with simple expressions', () => {
expect(M.solve('sigma(0, 5, @)')).to.equal(15);
});
it('should work with more complex expressions', () => {
expect(M.solve('sigma(0, 2, 2@+5)')).to.equal(21);
});
it('should work without an iterator sign', () => {
expect(M.solve('sigma(0, 2, 5*2)')).to.equal(30);
});
it('should work with negative start / end points', () => {
expect(M.solve('sigma(-5, -2, @)')).to.equal(-14);
});
});