Docs rewritten to modules

This commit is contained in:
josdejong 2013-08-06 02:14:10 +02:00
parent 8cc9ceb980
commit ecdb8524ce
91 changed files with 214 additions and 102 deletions

View File

@ -1,4 +1,4 @@
math.docs['Infinity'] = {
module.exports = {
'name': 'Infinity',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.LN10 = {
module.exports = {
'name': 'LN10',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.LN2 = {
module.exports = {
'name': 'LN2',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.LOG10E = {
module.exports = {
'name': 'LOG10E',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.LOG2E = {
module.exports = {
'name': 'LOG2E',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['NaN'] = {
module.exports = {
'name': 'NaN',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.SQRT1_2 = {
module.exports = {
'name': 'SQRT1_2',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.SQRT2 = {
module.exports = {
'name': 'SQRT2',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.e = math.docs.E = {
module.exports = {
'name': 'e',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['false'] = {
module.exports = {
'name': 'false',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.i = {
module.exports = {
'name': 'i',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.pi = math.docs.PI = {
module.exports = {
'name': 'pi',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.tau = {
module.exports = {
'name': 'tau',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['true'] = {
module.exports = {
'name': 'true',
'category': 'Constants',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.abs = {
module.exports = {
'name': 'abs',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.add = {
module.exports = {
'name': 'add',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.ceil = {
module.exports = {
'name': 'ceil',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.cube = {
module.exports = {
'name': 'cube',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.divide = {
module.exports = {
'name': 'divide',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.edivide = {
module.exports = {
'name': 'edivide',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.emultiply = {
module.exports = {
'name': 'emultiply',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.epow = {
module.exports = {
'name': 'epow',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.equal = {
module.exports = {
'name': 'equal',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.exp = {
module.exports = {
'name': 'exp',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.fix = {
module.exports = {
'name': 'fix',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.floor = {
module.exports = {
'name': 'floor',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.gcd = {
module.exports = {
'name': 'gcd',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.larger = {
module.exports = {
'name': 'larger',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.largereq = {
module.exports = {
'name': 'largereq',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.lcm = {
module.exports = {
'name': 'lcm',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.log = {
module.exports = {
'name': 'log',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.log10 = {
module.exports = {
'name': 'log10',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.mod = {
module.exports = {
'name': 'mod',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.multiply = {
module.exports = {
'name': 'multiply',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.pow = {
module.exports = {
'name': 'pow',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.round = {
module.exports = {
'name': 'round',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.sign = {
module.exports = {
'name': 'sign',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.smaller = {
module.exports = {
'name': 'smaller',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.smallereq = {
module.exports = {
'name': 'smallereq',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.sqrt = {
module.exports = {
'name': 'sqrt',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.square = {
module.exports = {
'name': 'square',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.subtract = {
module.exports = {
'name': 'subtract',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.unary = {
module.exports = {
'name': 'unary',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.unequal = {
module.exports = {
'name': 'unequal',
'category': 'Operators',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.xgcd = {
module.exports = {
'name': 'xgcd',
'category': 'Arithmetic',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.arg = {
module.exports = {
'name': 'arg',
'category': 'Complex',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.conj = {
module.exports = {
'name': 'conj',
'category': 'Complex',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.im = {
module.exports = {
'name': 'im',
'category': 'Complex',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.re = {
module.exports = {
'name': 're',
'category': 'Complex',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['boolean'] = {
module.exports = {
'name': 'boolean',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.complex = {
module.exports = {
'name': 'complex',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.matrix = {
module.exports = {
'name': 'matrix',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.number = {
module.exports = {
'name': 'number',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.range = {
module.exports = {
'name': 'range',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.string = {
module.exports = {
'name': 'string',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.unit = {
module.exports = {
'name': 'unit',
'category': 'Type',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.concat = {
module.exports = {
'name': 'concat',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.det = {
module.exports = {
'name': 'det',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.diag = {
module.exports = {
'name': 'diag',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.eye = {
module.exports = {
'name': 'eye',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.inv = {
module.exports = {
'name': 'inv',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.ones = {
module.exports = {
'name': 'ones',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.size = {
module.exports = {
'name': 'size',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.squeeze = {
module.exports = {
'name': 'squeeze',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.subset = {
module.exports = {
'name': 'subset',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.transpose = {
module.exports = {
'name': 'transpose',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.zeros = {
module.exports = {
'name': 'zeros',
'category': 'Matrix',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.factorial = {
module.exports = {
'name': 'factorial',
'category': 'Probability',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.random = {
module.exports = {
'name': 'random',
'category': 'Probability',
'syntax': [
@ -11,17 +11,3 @@ math.docs.random = {
],
'seealso': []
};
math.docs.randInt = {
'name': 'randInt',
'category': 'Probability',
'syntax': [
'randInt()'
],
'description':
'Return a random number between 0 and 1.',
'examples': [
'randInt()'
],
'seealso': []
};

View File

@ -0,0 +1,13 @@
module.exports = {
'name': 'randInt',
'category': 'Probability',
'syntax': [
'randInt()'
],
'description':
'Return a random number between 0 and 1.',
'examples': [
'randInt()'
],
'seealso': []
};

View File

@ -1,4 +1,4 @@
math.docs.max = {
module.exports = {
'name': 'max',
'category': 'Statistics',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.min = {
module.exports = {
'name': 'min',
'category': 'Statistics',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.acos = {
module.exports = {
'name': 'acos',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.asin = {
module.exports = {
'name': 'asin',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.atan = {
module.exports = {
'name': 'atan',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.atan2 = {
module.exports = {
'name': 'atan2',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.cos = {
module.exports = {
'name': 'cos',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.cot = {
module.exports = {
'name': 'cot',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.csc = {
module.exports = {
'name': 'csc',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.sec = {
module.exports = {
'name': 'sec',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.sin = {
module.exports = {
'name': 'sin',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.tan = {
module.exports = {
'name': 'tan',
'category': 'Trigonometry',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['in'] = {
module.exports = {
'name': 'in',
'category': 'Units',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.clone = {
module.exports = {
'name': 'clone',
'category': 'Utils',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['eval'] = {
module.exports = {
'name': 'eval',
'category': 'Utils',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.format = {
module.exports = {
'name': 'format',
'category': 'Utils',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs.help = {
module.exports = {
'name': 'help',
'category': 'Utils',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['import'] = {
module.exports = {
'name': 'import',
'category': 'Utils',
'syntax': [

View File

@ -1,4 +1,4 @@
math.docs['typeof'] = {
module.exports = {
'name': 'typeof',
'category': 'Utils',
'syntax': [

110
src/docs/index.js Normal file
View File

@ -0,0 +1,110 @@
// constants
exports.e = require('./constants/e.js');
exports.E = require('./constants/e.js');
exports['false'] = require('./constants/false.js');
exports.i = require('./constants/i.js');
exports['Infinity'] = require('./constants/Infinity.js');
exports.LN2 = require('./constants/LN2.js');
exports.LN10 = require('./constants/LN10.js');
exports.LOG2E = require('./constants/LOG2E.js');
exports.LOG10E = require('./constants/LOG10E.js');
exports.NaN = require('./constants/NaN.js');
exports.pi = require('./constants/pi.js');
exports.PI = require('./constants/pi.js');
exports.SQRT1_2 = require('./constants/SQRT1_2.js');
exports.SQRT2 = require('./constants/SQRT2.js');
exports.tau = require('./constants/tau.js');
exports['true'] = require('./constants/true.js');
// functions - arithmetic
exports.abs = require('./function/arithmetic/abs.js');
exports.add = require('./function/arithmetic/add.js');
exports.ceil = require('./function/arithmetic/ceil.js');
exports.cube = require('./function/arithmetic/cube.js');
exports.divide = require('./function/arithmetic/divide.js');
exports.edivide = require('./function/arithmetic/edivide.js');
exports.emultiply = require('./function/arithmetic/emultiply.js');
exports.epow = require('./function/arithmetic/epow.js');
exports.equal = require('./function/arithmetic/equal.js');
exports.exp = require('./function/arithmetic/exp.js');
exports.fix = require('./function/arithmetic/fix.js');
exports.floor = require('./function/arithmetic/floor.js');
exports.gcd = require('./function/arithmetic/gcd.js');
exports.larger = require('./function/arithmetic/larger.js');
exports.largereq = require('./function/arithmetic/largereq.js');
exports.lcm = require('./function/arithmetic/lcm.js');
exports.log = require('./function/arithmetic/log.js');
exports.log10 = require('./function/arithmetic/log10.js');
exports.mod = require('./function/arithmetic/mod.js');
exports.multiply = require('./function/arithmetic/multiply.js');
exports.pow = require('./function/arithmetic/pow.js');
exports.round = require('./function/arithmetic/round.js');
exports.sign = require('./function/arithmetic/sign.js');
exports.smaller = require('./function/arithmetic/smaller.js');
exports.smallereq = require('./function/arithmetic/smallereq.js');
exports.sqrt = require('./function/arithmetic/sqrt.js');
exports.square = require('./function/arithmetic/square.js');
exports.subtract = require('./function/arithmetic/subtract.js');
exports.unary = require('./function/arithmetic/unary.js');
exports.unequal = require('./function/arithmetic/unequal.js');
exports.xgcd = require('./function/arithmetic/xgcd.js');
// functions - complex
exports.arg = require('./function/complex/arg.js');
exports.conj = require('./function/complex/conj.js');
exports.re = require('./function/complex/re.js');
exports.im = require('./function/complex/im.js');
// functions - construction
exports.boolean = require('./function/construction/boolean.js');
exports.complex = require('./function/construction/complex.js');
exports.matrix = require('./function/construction/matrix.js');
exports.number = require('./function/construction/number.js');
exports.range = require('./function/construction/range.js');
exports.string = require('./function/construction/string.js');
exports.unit = require('./function/construction/unit.js');
// functions - matrix
exports.concat = require('./function/matrix/concat.js');
exports.det = require('./function/matrix/det.js');
exports.diag = require('./function/matrix/diag.js');
exports.eye = require('./function/matrix/eye.js');
exports.inv = require('./function/matrix/inv.js');
exports.ones = require('./function/matrix/ones.js');
exports.size = require('./function/matrix/size.js');
exports.squeeze = require('./function/matrix/squeeze.js');
exports.subset = require('./function/matrix/subset.js');
exports.transpose = require('./function/matrix/transpose.js');
exports.zeros = require('./function/matrix/zeros.js');
// functions - probability
exports.factorial = require('./function/probability/factorial.js');
exports.random = require('./function/probability/random.js');
exports.randomInt = require('./function/probability/randomInt.js');
// functions - statistics
exports.min = require('./function/statistics/min.js');
exports.max = require('./function/statistics/max.js');
// functions - trigonometry
exports.acos = require('./function/trigonometry/acos.js');
exports.asin = require('./function/trigonometry/asin.js');
exports.atan = require('./function/trigonometry/atan.js');
exports.atan2 = require('./function/trigonometry/atan2.js');
exports.cos = require('./function/trigonometry/cos.js');
exports.cot = require('./function/trigonometry/cot.js');
exports.csc = require('./function/trigonometry/csc.js');
exports.sec = require('./function/trigonometry/sec.js');
exports.sin = require('./function/trigonometry/sin.js');
exports.tan = require('./function/trigonometry/tan.js');
// functions - units
exports['in'] = require('./function/units/in.js');
// functions - utils
exports.clone = require('./function/utils/clone.js');
exports['eval'] = require('./function/utils/eval.js');
exports.format = require('./function/utils/format.js');
exports.help = require('./function/utils/help.js');
exports['import'] = require('./function/utils/import.js');
exports['typeof'] = require('./function/utils/typeof.js');

View File

@ -108,3 +108,6 @@ exports['typeof'] = require('./function/utils/typeof.js');
var object = require('./util/object.js');
var constants = require('./constants.js');
object.extend(exports, constants);
// docs
exports.docs = require('./docs/index.js');