kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-06-04 19:42:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

[@types/mathjs] enable linting (#24725)

Browse Source 
* [@types/mathjs] enable linting

* [@types/mathjs] add username to definitions

* [@types/mathjs] remove redundant jsdoc annotations and export statements
This commit is contained in:
Andy Patterson
2018-04-09 19:31:31 -04:00
committed by Mohamed Hegazy
parent 951c4f05dc
commit 21e5370ae9
3 changed files with 594 additions and 792 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1000
types/mathjs/index.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

311
types/mathjs/mathjs-tests.ts
View File

@@ -1,17 +1,14 @@
/*
Basic usage examples
*/
(function(){
{
// functions and constants
math.round(math.e, 3); // 2.718
math.atan2(3, -3) / math.pi; // 0.75
math.log(10000, 10); // 4
math.sqrt(-4); // 2i
math.pow([[-1, 2], [3, 1]], 2); // [[7, 0], [0, 7]]
var angle = 0.2;
const angle = 0.2;
math.add(math.pow(math.sin(angle), 2), math.pow(math.cos(angle), 2)); // returns number ~1
// expressions
@@ -22,7 +19,7 @@ Basic usage examples
math.eval('det([-1, 2; 3, 1])'); // -7
// chained operations
var a = math.chain(3)
const a = math.chain(3)
.add(4)
.multiply(2)
.done(); // 14
@@ -33,18 +30,17 @@ Basic usage examples
math.multiply(math.unit('5 mm'), 3); // Unit * number, 15 mm
math.subtract([2, 3, 4], 5); // Array - number, [-3, -2, -1]
math.add(math.matrix([2, 3]), [4, 5]); // Matrix + Array, [6, 8]
}());
}
/*
Bignumbers examples
*/
(function() {
{
// configure the default type of numbers as BigNumbers
math.config({
number: 'bignumber', // Default type of number:
// 'number' (default), 'bignumber', or 'fraction'
precision: 20 // Number of significant digits for BigNumbers
number: 'bignumber', // Default type of number:
// 'number' (default), 'bignumber', or 'fraction'
precision: 20 // Number of significant digits for BigNumbers
});
console.log('round-off errors with numbers');
@@ -68,23 +64,21 @@ Bignumbers examples
math.eval('0.1 + 0.2'); // BigNumber, 0.3
math.eval('0.3 / 0.2'); // BigNumber, 1.5
console.log();
}());
}
/*
Chaining examples
*/
(function() {
{
// create a chained operation using the function `chain(value)`
// end a chain using done(). Let's calculate (3 + 4) * 2
var a = math.chain(3)
const a = math.chain(3)
.add(4)
.multiply(2)
.done(); // 14
// Another example, calculate square(sin(pi / 4))
var b = math.chain(math.pi)
const b = math.chain(math.pi)
.divide(4)
.sin()
.square()
@@ -94,46 +88,44 @@ Chaining examples
// these are demonstrated in the following examples
// toString will return a string representation of the chain's value
var chain = math.chain(2).divide(3);
var str = chain.toString(); // "0.6666666666666666"
const chain = math.chain(2).divide(3);
const str = chain.toString(); // "0.6666666666666666"
// a chain has a function .valueOf(), which returns the value hold by the chain.
// This allows using it in regular operations. The function valueOf() acts the
// same as function done().
chain.valueOf(); // 0.66666666666667
// the function subset can be used to get or replace sub matrices
var array = [[1, 2], [3, 4]];
var v = math.chain(array)
const array = [[1, 2], [3, 4]];
const v = math.chain(array)
.subset(math.index(1, 0))
.done(); // 3
var m = math.chain(array)
const m = math.chain(array)
.subset(math.index(0, 0), 8)
.multiply(3)
.done(); // [[24, 6], [9, 12]]
}());
}
/*
Complex numbers examples
*/
(function(){
var a = math.complex(2, 3); // 2 + 3i
{
const a = math.complex(2, 3); // 2 + 3i
// read the real and complex parts of the complex number
a.re; // 2
a.im; // 3
// clone a complex value
var clone = a.clone(); // 2 + 3i
const clone = a.clone(); // 2 + 3i
// adjust the complex value
a.re = 5; // 5 + 3i
// create a complex number by providing a string with real and complex parts
var b = math.complex('3 - 7i'); // 3 - 7i
const b = math.complex('3 - 7i'); // 3 - 7i
console.log();
// perform operations with complex numbers
@@ -148,18 +140,17 @@ Complex numbers examples
// create a complex number from polar coordinates
console.log('create complex numbers with polar coordinates');
var c = math.complex({r: math.sqrt(2), phi: math.pi / 4}); // 1 + i
const c = math.complex({r: math.sqrt(2), phi: math.pi / 4}); // 1 + i
// get polar coordinates of a complex number
var d = math.complex(3, 4);
const d = math.complex(3, 4);
d.toPolar(); // { r: 5, phi: 0.9272952180016122 }
}());
}
/*
Expressions examples
*/
(function() {
{
// 1. using the function math.eval
//
// Function `eval` accepts a single expression or an array with
@@ -179,16 +170,16 @@ Expressions examples
// evaluate multiple expressions at once
console.log('\nevaluate multiple expressions at once');
math.eval([
'f = 3',
'g = 4',
'f * g'
]); // [3, 4, 12]
'f = 3',
'g = 4',
'f * g'
]); // [3, 4, 12]
// provide a scope (just a regular JavaScript Object)
console.log('\nevaluate expressions providing a scope with variables and functions');
var scope: any = {
a: 3,
b: 4
let scope: any = {
a: 3,
b: 4,
};
// variables can be read from the scope
@@ -199,18 +190,16 @@ Expressions examples
scope.c; // 6.8
// scope can contain both variables and functions
scope["hello"] = function (name: string) {
return 'hello, ' + name + '!';
scope["hello"] = function(name: string) {
return `hello, ${name}!`;
};
math.eval('hello("hero")', scope); // "hello, hero!"
// define a function as an expression
var f = math.eval('f(x) = x ^ a', scope);
let f = math.eval('f(x) = x ^ a', scope);
f(2); // 8
scope.f(2); // 8
// 2. using function math.parse
//
// Function `math.parse` parses expressions into a node tree. The syntax is
@@ -224,7 +213,7 @@ Expressions examples
// parse an expression
console.log('\nparse an expression into a node tree');
var node1 = math.parse('sqrt(3^2 + 4^2)');
const node1 = math.parse('sqrt(3^2 + 4^2)');
node1.toString(); // "sqrt((3 ^ 2) + (4 ^ 2))"
// compile and evaluate the compiled code
@@ -233,12 +222,12 @@ Expressions examples
// provide a scope
console.log('\nprovide a scope');
var node2 = math.parse('x^a');
var code2 = node2.compile();
const node2 = math.parse('x^a');
let code2 = node2.compile();
node2.toString(); // "x ^ a"
var scope: any = {
x: 3,
a: 2
scope = {
x: 3,
a: 2,
};
code2.eval(scope); // 9
@@ -246,7 +235,6 @@ Expressions examples
scope.a = 3;
code2.eval(scope); // 27
// 3. using function math.compile
//
// Function `math.compile` compiles expressions into a node tree. The syntax is
@@ -260,21 +248,18 @@ Expressions examples
// parse an expression
console.log('\ncompile an expression');
var code3 = math.compile('sqrt(3^2 + 4^2)');
const code3 = math.compile('sqrt(3^2 + 4^2)');
// evaluate the compiled code
code3.eval(); // 5
// provide a scope for the variable assignment
console.log('\nprovide a scope');
var code2 = math.compile('a = a + 3');
var scope: any = {
a: 7
};
code2 = math.compile('a = a + 3');
scope = { a: 7 };
code2.eval(scope);
scope.a; // 10
// 4. using a parser
//
// In addition to the static functions `math.eval` and `math.parse`, math.js
@@ -282,7 +267,7 @@ Expressions examples
// keeps a scope with assigned variables in memory. The parser also contains
// some convenience methods to get, set, and remove variables from memory.
console.log('\n4. USING A PARSER');
var parser = math.parser();
const parser = math.parser();
// evaluate with parser
console.log('\nevaluate expressions');
@@ -313,29 +298,28 @@ Expressions examples
// get and set variables and functions
console.log('\nget and set variables and function in the scope of the parser');
var x = parser.get('x');
const x = parser.get('x');
console.log('x =', x); // x = 7
var f = parser.get('f');
f = parser.get('f');
console.log('f =', math.format(f)); // f = f(x, y)
var g = f(3, 3);
const g = f(3, 3);
console.log('g =', g); // g = 27
parser.set('h', 500);
parser.eval('h / 2'); // 250
parser.set('hello', function (name: string) {
return 'hello, ' + name + '!';
parser.set('hello', function(name: string) {
return `hello, ${name}!`;
});
parser.eval('hello("hero")'); // "hello, hero!"
// clear defined functions and variables
parser.clear();
}());
}
/*
Fractions examples
*/
(function(){
{
// configure the default type of numbers as Fractions
math.config({
number: 'fraction' // Default type of number:
@@ -377,65 +361,64 @@ Fractions examples
// output formatting
console.log('output formatting of fractions');
var a = math.fraction('2/3');
const a = math.fraction('2/3');
console.log(math.format(a)); // Fraction, 2/3
console.log(math.format(a, {fraction: 'ratio'})); // Fraction, 2/3
console.log(math.format(a, {fraction: 'decimal'})); // Fraction, 0.(6)
console.log(a.toString()); // Fraction, 0.(6)
console.log();
}());
}
/*
Matrices examples
*/
(function() {
{
// create matrices and arrays. a matrix is just a wrapper around an Array,
// providing some handy utilities.
console.log('create a matrix');
var a = math.matrix([1, 4, 9, 16, 25]); // [1, 4, 9, 16, 25]
var b = math.matrix(math.ones([2, 3])); // [[1, 1, 1], [1, 1, 1]]
const a = math.matrix([1, 4, 9, 16, 25]); // [1, 4, 9, 16, 25]
const b = math.matrix(math.ones([2, 3])); // [[1, 1, 1], [1, 1, 1]]
b.size(); // [2, 3]
// the Array data of a Matrix can be retrieved using valueOf()
var array = a.valueOf(); // [1, 4, 9, 16, 25]
const array = a.valueOf(); // [1, 4, 9, 16, 25]
// Matrices can be cloned
var clone = a.clone(); // [1, 4, 9, 16, 25]
const clone = a.clone(); // [1, 4, 9, 16, 25]
console.log();
// perform operations with matrices
console.log('perform operations');
math.sqrt(a); // [1, 2, 3, 4, 5]
var c = [1, 2, 3, 4, 5];
const c = [1, 2, 3, 4, 5];
math.factorial(c); // [1, 2, 6, 24, 120]
console.log();
// create and manipulate matrices. Arrays and Matrices can be used mixed.
console.log('manipulate matrices');
var d = [[1, 2], [3, 4]]; // [[1, 2], [3, 4]]
var e = math.matrix([[5, 6], [1, 1]]); // [[5, 6], [1, 1]]
const d = [[1, 2], [3, 4]]; // [[1, 2], [3, 4]]
const e = math.matrix([[5, 6], [1, 1]]); // [[5, 6], [1, 1]]
// set a submatrix.
// Matrix indexes are zero-based.
e.subset(math.index(1, [0, 1]), [[7, 8]]); // [[5, 6], [7, 8]]
var f = math.multiply(d, e); // [[19, 22], [43, 50]]
var g = f.subset(math.index(1, 0)); // 43
const f = math.multiply(d, e); // [[19, 22], [43, 50]]
const g = f.subset(math.index(1, 0)); // 43
console.log();
// get a sub matrix
// Matrix indexes are zero-based.
console.log('get a sub matrix');
var h = math.diag(math.range(1,4)); // [[1, 0, 0], [0, 2, 0], [0, 0, 3]]
h.subset( math.index([1, 2], [1, 2])); // [[2, 0], [0, 3]]
var i = math.range(1,6); // [1, 2, 3, 4, 5]
i.subset(math.index(math.range(1,4))); // [2, 3, 4]
const h = math.diag(math.range(1, 4)); // [[1, 0, 0], [0, 2, 0], [0, 0, 3]]
h.subset(math.index([1, 2], [1, 2])); // [[2, 0], [0, 3]]
const i = math.range(1, 6); // [1, 2, 3, 4, 5]
i.subset(math.index(math.range(1, 4))); // [2, 3, 4]
console.log();
// resize a multi dimensional matrix
console.log('resizing a matrix');
var j = math.matrix();
var defaultValue = 0;
const j = math.matrix();
let defaultValue = 0;
j.resize([2, 2, 2], defaultValue); // [[[0, 0], [0, 0]], [[0, 0], [0, 0]]]
j.size(); // [2, 2, 2]
j.resize([2, 2]); // [[0, 0], [0, 0]]
@@ -445,12 +428,12 @@ Matrices examples
// setting a value outside the matrices range will resize the matrix.
// new elements will be initialized with zero.
console.log('set a value outside a matrices range');
var k = math.matrix();
const k = math.matrix();
k.subset(math.index(2), 6); // [0, 0, 6]
console.log();
console.log('set a value outside a matrices range, leaving new entries uninitialized');
var m = math.matrix();
const m = math.matrix();
defaultValue = math.uninitialized;
m.subset(math.index(2), 6, defaultValue); // [undefined, undefined, 6]
console.log();
@@ -462,38 +445,38 @@ Matrices examples
math.range('2:-1:-3'); // [2, 1, 0, -1, -2]
math.factorial(math.range('1:6')); // [1, 2, 6, 24, 120]
console.log();
}());
}
/*
Sparse matrices examples
*/
(function() {
{
// create a sparse matrix
console.log('creating a 1000x1000 sparse matrix...');
var a = math.eye(1000, 1000, 'sparse');
const a = math.eye(1000, 1000, 'sparse');
// do operations with a sparse matrix
console.log('doing some operations on the sparse matrix...');
var b = math.multiply(a, a);
var c = math.multiply(b, math.complex(2, 2));
var d = math.transpose(c);
var e = math.multiply(d, a);
const b = math.multiply(a, a);
const c = math.multiply(b, math.complex(2, 2));
const d = math.transpose(c);
const e = math.multiply(d, a);
// we will not print the output, but doing the same operations
// with a dense matrix are very slow, try it for yourself.
console.log('already done');
console.log('now try this with a dense matrix :)');
}());
}
/*
Units examples
*/
(function() {
{
// units can be created by providing a value and unit name, or by providing
// a string with a valued unit.
console.log('create units');
var a = math.unit(45, 'cm'); // 450 mm
var b = math.unit('0.1m'); // 100 mm
const a = math.unit(45, 'cm'); // 450 mm
const b = math.unit('0.1m'); // 100 mm
console.log();
// creating units
@@ -509,7 +492,7 @@ Units examples
aliases: ['knots', 'kt', 'kts'],
prefixes: 'long'
}, {override: true});
math.createUnit( {
math.createUnit({
foo: {
prefixes: 'long'
},
@@ -561,10 +544,10 @@ Units examples
// example engineering calculations
console.log('compute molar volume of ideal gas at 65 Fahrenheit, 14.7 psi in L/mol');
var Rg = math.unit('8.314 N m / (mol K)');
var T = math.unit('65 degF');
var P = math.unit('14.7 psi');
var v = math.divide(math.multiply(Rg, T), P);
const Rg = math.unit('8.314 N m / (mol K)');
const T = math.unit('65 degF');
const P = math.unit('14.7 psi');
const v = math.divide(math.multiply(Rg, T), P);
console.log('gas constant (Rg) = ', format(Rg));
console.log('P = ' + format(P));
console.log('T = ' + format(T));
@@ -572,100 +555,74 @@ Units examples
console.log();
console.log('compute speed of fluid flowing out of hole in a container');
var g = math.unit('9.81 m / s^2');
var h = math.unit('1 m');
var v2 = math.pow(math.multiply(2, math.multiply(g, h)), 0.5); // Can also use math.sqrt
const g = math.unit('9.81 m / s^2');
const h = math.unit('1 m');
const v2 = math.pow(math.multiply(2, math.multiply(g, h)), 0.5); // Can also use math.sqrt
console.log('g = ' + format(g));
console.log('h = ' + format(h));
console.log('v = (2 g h) ^ 0.5 = ' + format(v2)); // 4.429... m / s
console.log();
console.log('electrical power consumption:');
var expr = '460 V * 20 A * 30 days to kWh';
console.log(expr + ' = ' + math.eval(expr)); // 6624 kWh
let expr = '460 V * 20 A * 30 days to kWh';
console.log(`${expr} = ${math.eval(expr)}`); // 6624 kWh
console.log();
console.log('circuit design:');
var expr = '24 V / (6 mA)';
console.log(expr + ' = ' + math.eval(expr)); // 4 kohm
expr = '24 V / (6 mA)';
console.log(`${expr} = ${math.eval(expr)}`); // 4 kohm
console.log();
console.log('operations on arrays:');
var B = math.eval('[1, 0, 0] T');
var v3 = math.eval('[0, 1, 0] m/s');
var q = math.eval('1 C');
var F = math.multiply(q, math.cross(v3, B));
const B = math.eval('[1, 0, 0] T');
const v3 = math.eval('[0, 1, 0] m/s');
const q = math.eval('1 C');
const F = math.multiply(q, math.cross(v3, B));
console.log('B (magnetic field strength) = ' + format(B)); // [1 T, 0 T, 0 T]
console.log('v (particle velocity) = ' + format(v3)); // [0 m / s, 1 m / s, 0 m / s]
console.log('q (particle charge) = ' + format(q)); // 1 C
console.log('F (force) = q (v cross B) = ' + format(F)); // [0 N, 0 N, -1 N]
/**
* Helper function to format an output a value.
* @param {*} value
* @return {string} Returns the formatted value
*/
function format (value: any): string {
var precision = 14;
* Helper function to format an output a value.
* @return Returns the formatted value
*/
function format(value: any): string {
const precision = 14;
return math.format(value, precision);
}
}());
}
/*
Expression tree examples
*/
(function(){
{
// Filter an expression tree
console.log('Filter all symbol nodes "x" in the expression "x^2 + x/4 + 3*y"');
const node = math.parse('x^2 + x/4 + 3*y');
const filtered = node.filter(function(node) {
return node.isSymbolNode && node.name === 'x';
});
// returns an array with two entries: two SymbolNodes 'x'
// Filter an expression tree
console.log('Filter all symbol nodes "x" in the expression "x^2 + x/4 + 3*y"');
var node = math.parse('x^2 + x/4 + 3*y');
var filtered = node.filter(function (node) {
return node.isSymbolNode && node.name == 'x';
});
// returns an array with two entries: two SymbolNodes 'x'
filtered.forEach(function(node) {
console.log(node.type, node.toString());
});
// outputs:
// SymbolNode x
// SymbolNode x
filtered.forEach(function (node) {
console.log(node.type, node.toString())
});
// outputs:
// SymbolNode x
// SymbolNode x
// Traverse an expression tree
console.log();
console.log('Traverse the expression tree of expression "3 * x + 2"');
var node1 = math.parse('3 * x + 2');
node1.traverse(function (node, path, parent) {
switch (node.type) {
// case 'OperatorNode': console.log(node.type, node.op); break;
case 'OperatorNode': console.log(node.type); break;//for now removing .op
case 'ConstantNode': console.log(node.type, node.value); break;
case 'SymbolNode': console.log(node.type, node.name); break;
default: console.log(node.type);
}
});
// outputs:
// OperatorNode +
// OperatorNode *
// ConstantNode 3
// SymbolNode x
// ConstantNode 2
// transform an expression tree
// console.log();
// console.log('Replace all symbol nodes "x" in expression "x^2 + 5*x" with a constant 3');
// var node2 = math.parse('x^2 + 5*x');
// var transformed = node2.transform(function (node, path, parent) {
// if (node.isSymbolNode && node.name == 'x') {
// return new math.expression.node.ConstantNode(3);
// }
// else {
// return node;
// }
// });
// console.log(transformed.toString());
// outputs: '(3 ^ 2) + (5 * 3)'
}());
// Traverse an expression tree
console.log();
console.log('Traverse the expression tree of expression "3 * x + 2"');
const node1 = math.parse('3 * x + 2');
node1.traverse(function(node, path, parent) {
switch (node.type) {
// case 'OperatorNode': console.log(node.type, node.op); break;
case 'OperatorNode': console.log(node.type); break; // for now removing .op
case 'ConstantNode': console.log(node.type, node.value); break;
case 'SymbolNode': console.log(node.type, node.name); break;
default: console.log(node.type);
}
});
}

75
types/mathjs/tslint.json
View File

@@ -1,79 +1,6 @@
{
"extends": "dtslint/dt.json",
"rules": {
"adjacent-overload-signatures": false,
"array-type": false,
"arrow-return-shorthand": false,
"ban-types": false,
"callable-types": false,
"comment-format": false,
"dt-header": false,
"eofline": false,
"export-just-namespace": false,
"import-spacing": false,
"interface-name": false,
"interface-over-type-literal": false,
"jsdoc-format": false,
"max-line-length": false,
"member-access": false,
"new-parens": false,
"no-any-union": false,
"no-boolean-literal-compare": false,
"no-conditional-assignment": false,
"no-consecutive-blank-lines": false,
"no-construct": false,
"no-declare-current-package": false,
"no-duplicate-imports": false,
"no-duplicate-variable": false,
"no-empty-interface": false,
"no-for-in-array": false,
"no-inferrable-types": false,
"no-internal-module": false,
"no-irregular-whitespace": false,
"no-mergeable-namespace": false,
"no-misused-new": false,
"no-namespace": false,
"no-object-literal-type-assertion": false,
"no-padding": false,
"no-redundant-jsdoc": false,
"no-redundant-jsdoc-2": false,
"no-redundant-undefined": false,
"no-reference-import": false,
"no-relative-import-in-test": false,
"no-self-import": false,
"no-single-declare-module": false,
"no-string-throw": false,
"no-unnecessary-callback-wrapper": false,
"no-unnecessary-class": false,
"no-unnecessary-generics": false,
"no-unnecessary-qualifier": false,
"no-unnecessary-type-assertion": false,
"no-useless-files": false,
"no-var-keyword": false,
"no-var-requires": false,
"no-void-expression": false,
"no-trailing-whitespace": false,
"object-literal-key-quotes": false,
"object-literal-shorthand": false,
"one-line": false,
"one-variable-per-declaration": false,
"only-arrow-functions": false,
"prefer-conditional-expression": false,
"prefer-const": false,
"prefer-declare-function": false,
"prefer-for-of": false,
"prefer-method-signature": false,
"prefer-template": false,
"radix": false,
"semicolon": false,
"space-before-function-paren": false,
"space-within-parens": false,
"strict-export-declare-modifiers": false,
"trim-file": false,
"triple-equals": false,
"typedef-whitespace": false,
"unified-signatures": false,
"void-return": false,
"whitespace": false
"only-arrow-functions": false
}
}