embeddedDocs.js 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706
  1. import { eDocs } from './constants/e.js';
  2. import { falseDocs } from './constants/false.js';
  3. import { iDocs } from './constants/i.js';
  4. import { InfinityDocs } from './constants/Infinity.js';
  5. import { LN10Docs } from './constants/LN10.js';
  6. import { LN2Docs } from './constants/LN2.js';
  7. import { LOG10EDocs } from './constants/LOG10E.js';
  8. import { LOG2EDocs } from './constants/LOG2E.js';
  9. import { NaNDocs } from './constants/NaN.js';
  10. import { nullDocs } from './constants/null.js';
  11. import { phiDocs } from './constants/phi.js';
  12. import { piDocs } from './constants/pi.js';
  13. import { SQRT12Docs } from './constants/SQRT1_2.js';
  14. import { SQRT2Docs } from './constants/SQRT2.js';
  15. import { tauDocs } from './constants/tau.js';
  16. import { trueDocs } from './constants/true.js';
  17. import { versionDocs } from './constants/version.js';
  18. import { bignumberDocs } from './construction/bignumber.js';
  19. import { booleanDocs } from './construction/boolean.js';
  20. import { complexDocs } from './construction/complex.js';
  21. import { createUnitDocs } from './construction/createUnit.js';
  22. import { fractionDocs } from './construction/fraction.js';
  23. import { indexDocs } from './construction/index.js';
  24. import { matrixDocs } from './construction/matrix.js';
  25. import { numberDocs } from './construction/number.js';
  26. import { sparseDocs } from './construction/sparse.js';
  27. import { splitUnitDocs } from './construction/splitUnit.js';
  28. import { stringDocs } from './construction/string.js';
  29. import { unitDocs } from './construction/unit.js';
  30. import { configDocs } from './core/config.js';
  31. import { importDocs } from './core/import.js';
  32. import { typedDocs } from './core/typed.js';
  33. import { derivativeDocs } from './function/algebra/derivative.js';
  34. import { leafCountDocs } from './function/algebra/leafCount.js';
  35. import { lsolveDocs } from './function/algebra/lsolve.js';
  36. import { lsolveAllDocs } from './function/algebra/lsolveAll.js';
  37. import { lupDocs } from './function/algebra/lup.js';
  38. import { lusolveDocs } from './function/algebra/lusolve.js';
  39. import { polynomialRootDocs } from './function/algebra/polynomialRoot.js';
  40. import { qrDocs } from './function/algebra/qr.js';
  41. import { rationalizeDocs } from './function/algebra/rationalize.js';
  42. import { resolveDocs } from './function/algebra/resolve.js';
  43. import { simplifyDocs } from './function/algebra/simplify.js';
  44. import { simplifyConstantDocs } from './function/algebra/simplifyConstant.js';
  45. import { simplifyCoreDocs } from './function/algebra/simplifyCore.js';
  46. import { sluDocs } from './function/algebra/slu.js';
  47. import { symbolicEqualDocs } from './function/algebra/symbolicEqual.js';
  48. import { usolveDocs } from './function/algebra/usolve.js';
  49. import { usolveAllDocs } from './function/algebra/usolveAll.js';
  50. import { absDocs } from './function/arithmetic/abs.js';
  51. import { addDocs } from './function/arithmetic/add.js';
  52. import { cbrtDocs } from './function/arithmetic/cbrt.js';
  53. import { ceilDocs } from './function/arithmetic/ceil.js';
  54. import { cubeDocs } from './function/arithmetic/cube.js';
  55. import { divideDocs } from './function/arithmetic/divide.js';
  56. import { dotDivideDocs } from './function/arithmetic/dotDivide.js';
  57. import { dotMultiplyDocs } from './function/arithmetic/dotMultiply.js';
  58. import { dotPowDocs } from './function/arithmetic/dotPow.js';
  59. import { expDocs } from './function/arithmetic/exp.js';
  60. import { expmDocs } from './function/arithmetic/expm.js';
  61. import { expm1Docs } from './function/arithmetic/expm1.js';
  62. import { fixDocs } from './function/arithmetic/fix.js';
  63. import { floorDocs } from './function/arithmetic/floor.js';
  64. import { gcdDocs } from './function/arithmetic/gcd.js';
  65. import { hypotDocs } from './function/arithmetic/hypot.js';
  66. import { invmodDocs } from './function/arithmetic/invmod.js';
  67. import { lcmDocs } from './function/arithmetic/lcm.js';
  68. import { logDocs } from './function/arithmetic/log.js';
  69. import { log10Docs } from './function/arithmetic/log10.js';
  70. import { log1pDocs } from './function/arithmetic/log1p.js';
  71. import { log2Docs } from './function/arithmetic/log2.js';
  72. import { modDocs } from './function/arithmetic/mod.js';
  73. import { multiplyDocs } from './function/arithmetic/multiply.js';
  74. import { normDocs } from './function/arithmetic/norm.js';
  75. import { nthRootDocs } from './function/arithmetic/nthRoot.js';
  76. import { nthRootsDocs } from './function/arithmetic/nthRoots.js';
  77. import { powDocs } from './function/arithmetic/pow.js';
  78. import { roundDocs } from './function/arithmetic/round.js';
  79. import { signDocs } from './function/arithmetic/sign.js';
  80. import { sqrtDocs } from './function/arithmetic/sqrt.js';
  81. import { sqrtmDocs } from './function/arithmetic/sqrtm.js';
  82. import { sylvesterDocs } from './function/matrix/sylvester.js';
  83. import { schurDocs } from './function/matrix/schur.js';
  84. import { lyapDocs } from './function/matrix/lyap.js';
  85. import { squareDocs } from './function/arithmetic/square.js';
  86. import { subtractDocs } from './function/arithmetic/subtract.js';
  87. import { unaryMinusDocs } from './function/arithmetic/unaryMinus.js';
  88. import { unaryPlusDocs } from './function/arithmetic/unaryPlus.js';
  89. import { xgcdDocs } from './function/arithmetic/xgcd.js';
  90. import { bitAndDocs } from './function/bitwise/bitAnd.js';
  91. import { bitNotDocs } from './function/bitwise/bitNot.js';
  92. import { bitOrDocs } from './function/bitwise/bitOr.js';
  93. import { bitXorDocs } from './function/bitwise/bitXor.js';
  94. import { leftShiftDocs } from './function/bitwise/leftShift.js';
  95. import { rightArithShiftDocs } from './function/bitwise/rightArithShift.js';
  96. import { rightLogShiftDocs } from './function/bitwise/rightLogShift.js';
  97. import { bellNumbersDocs } from './function/combinatorics/bellNumbers.js';
  98. import { catalanDocs } from './function/combinatorics/catalan.js';
  99. import { compositionDocs } from './function/combinatorics/composition.js';
  100. import { stirlingS2Docs } from './function/combinatorics/stirlingS2.js';
  101. import { argDocs } from './function/complex/arg.js';
  102. import { conjDocs } from './function/complex/conj.js';
  103. import { imDocs } from './function/complex/im.js';
  104. import { reDocs } from './function/complex/re.js';
  105. import { evaluateDocs } from './function/expression/evaluate.js';
  106. import { helpDocs } from './function/expression/help.js';
  107. import { distanceDocs } from './function/geometry/distance.js';
  108. import { intersectDocs } from './function/geometry/intersect.js';
  109. import { andDocs } from './function/logical/and.js';
  110. import { notDocs } from './function/logical/not.js';
  111. import { orDocs } from './function/logical/or.js';
  112. import { xorDocs } from './function/logical/xor.js';
  113. import { columnDocs } from './function/matrix/column.js';
  114. import { concatDocs } from './function/matrix/concat.js';
  115. import { countDocs } from './function/matrix/count.js';
  116. import { crossDocs } from './function/matrix/cross.js';
  117. import { ctransposeDocs } from './function/matrix/ctranspose.js';
  118. import { detDocs } from './function/matrix/det.js';
  119. import { diagDocs } from './function/matrix/diag.js';
  120. import { diffDocs } from './function/matrix/diff.js';
  121. import { dotDocs } from './function/matrix/dot.js';
  122. import { eigsDocs } from './function/matrix/eigs.js';
  123. import { filterDocs } from './function/matrix/filter.js';
  124. import { flattenDocs } from './function/matrix/flatten.js';
  125. import { forEachDocs } from './function/matrix/forEach.js';
  126. import { getMatrixDataTypeDocs } from './function/matrix/getMatrixDataType.js';
  127. import { identityDocs } from './function/matrix/identity.js';
  128. import { invDocs } from './function/matrix/inv.js';
  129. import { pinvDocs } from './function/matrix/pinv.js';
  130. import { kronDocs } from './function/matrix/kron.js';
  131. import { mapDocs } from './function/matrix/map.js';
  132. import { matrixFromColumnsDocs } from './function/matrix/matrixFromColumns.js';
  133. import { matrixFromFunctionDocs } from './function/matrix/matrixFromFunction.js';
  134. import { matrixFromRowsDocs } from './function/matrix/matrixFromRows.js';
  135. import { onesDocs } from './function/matrix/ones.js';
  136. import { partitionSelectDocs } from './function/matrix/partitionSelect.js';
  137. import { rangeDocs } from './function/matrix/range.js';
  138. import { reshapeDocs } from './function/matrix/reshape.js';
  139. import { resizeDocs } from './function/matrix/resize.js';
  140. import { rotateDocs } from './function/matrix/rotate.js';
  141. import { rotationMatrixDocs } from './function/matrix/rotationMatrix.js';
  142. import { rowDocs } from './function/matrix/row.js';
  143. import { sizeDocs } from './function/matrix/size.js';
  144. import { sortDocs } from './function/matrix/sort.js';
  145. import { squeezeDocs } from './function/matrix/squeeze.js';
  146. import { subsetDocs } from './function/matrix/subset.js';
  147. import { traceDocs } from './function/matrix/trace.js';
  148. import { transposeDocs } from './function/matrix/transpose.js';
  149. import { zerosDocs } from './function/matrix/zeros.js';
  150. import { fftDocs } from './function/matrix/fft.js';
  151. import { ifftDocs } from './function/matrix/ifft.js';
  152. import { combinationsDocs } from './function/probability/combinations.js';
  153. import { combinationsWithRepDocs } from './function/probability/combinationsWithRep.js';
  154. import { factorialDocs } from './function/probability/factorial.js';
  155. import { gammaDocs } from './function/probability/gamma.js';
  156. import { lgammaDocs } from './function/probability/lgamma.js';
  157. import { kldivergenceDocs } from './function/probability/kldivergence.js';
  158. import { multinomialDocs } from './function/probability/multinomial.js';
  159. import { permutationsDocs } from './function/probability/permutations.js';
  160. import { pickRandomDocs } from './function/probability/pickRandom.js';
  161. import { randomDocs } from './function/probability/random.js';
  162. import { randomIntDocs } from './function/probability/randomInt.js';
  163. import { compareDocs } from './function/relational/compare.js';
  164. import { compareNaturalDocs } from './function/relational/compareNatural.js';
  165. import { compareTextDocs } from './function/relational/compareText.js';
  166. import { deepEqualDocs } from './function/relational/deepEqual.js';
  167. import { equalDocs } from './function/relational/equal.js';
  168. import { equalTextDocs } from './function/relational/equalText.js';
  169. import { largerDocs } from './function/relational/larger.js';
  170. import { largerEqDocs } from './function/relational/largerEq.js';
  171. import { smallerDocs } from './function/relational/smaller.js';
  172. import { smallerEqDocs } from './function/relational/smallerEq.js';
  173. import { unequalDocs } from './function/relational/unequal.js';
  174. import { setCartesianDocs } from './function/set/setCartesian.js';
  175. import { setDifferenceDocs } from './function/set/setDifference.js';
  176. import { setDistinctDocs } from './function/set/setDistinct.js';
  177. import { setIntersectDocs } from './function/set/setIntersect.js';
  178. import { setIsSubsetDocs } from './function/set/setIsSubset.js';
  179. import { setMultiplicityDocs } from './function/set/setMultiplicity.js';
  180. import { setPowersetDocs } from './function/set/setPowerset.js';
  181. import { setSizeDocs } from './function/set/setSize.js';
  182. import { setSymDifferenceDocs } from './function/set/setSymDifference.js';
  183. import { setUnionDocs } from './function/set/setUnion.js';
  184. import { erfDocs } from './function/special/erf.js';
  185. import { madDocs } from './function/statistics/mad.js';
  186. import { maxDocs } from './function/statistics/max.js';
  187. import { meanDocs } from './function/statistics/mean.js';
  188. import { medianDocs } from './function/statistics/median.js';
  189. import { minDocs } from './function/statistics/min.js';
  190. import { modeDocs } from './function/statistics/mode.js';
  191. import { prodDocs } from './function/statistics/prod.js';
  192. import { quantileSeqDocs } from './function/statistics/quantileSeq.js';
  193. import { stdDocs } from './function/statistics/std.js';
  194. import { cumSumDocs } from './function/statistics/cumsum.js';
  195. import { sumDocs } from './function/statistics/sum.js';
  196. import { varianceDocs } from './function/statistics/variance.js';
  197. import { acosDocs } from './function/trigonometry/acos.js';
  198. import { acoshDocs } from './function/trigonometry/acosh.js';
  199. import { acotDocs } from './function/trigonometry/acot.js';
  200. import { acothDocs } from './function/trigonometry/acoth.js';
  201. import { acscDocs } from './function/trigonometry/acsc.js';
  202. import { acschDocs } from './function/trigonometry/acsch.js';
  203. import { asecDocs } from './function/trigonometry/asec.js';
  204. import { asechDocs } from './function/trigonometry/asech.js';
  205. import { asinDocs } from './function/trigonometry/asin.js';
  206. import { asinhDocs } from './function/trigonometry/asinh.js';
  207. import { atanDocs } from './function/trigonometry/atan.js';
  208. import { atan2Docs } from './function/trigonometry/atan2.js';
  209. import { atanhDocs } from './function/trigonometry/atanh.js';
  210. import { cosDocs } from './function/trigonometry/cos.js';
  211. import { coshDocs } from './function/trigonometry/cosh.js';
  212. import { cotDocs } from './function/trigonometry/cot.js';
  213. import { cothDocs } from './function/trigonometry/coth.js';
  214. import { cscDocs } from './function/trigonometry/csc.js';
  215. import { cschDocs } from './function/trigonometry/csch.js';
  216. import { secDocs } from './function/trigonometry/sec.js';
  217. import { sechDocs } from './function/trigonometry/sech.js';
  218. import { sinDocs } from './function/trigonometry/sin.js';
  219. import { sinhDocs } from './function/trigonometry/sinh.js';
  220. import { tanDocs } from './function/trigonometry/tan.js';
  221. import { tanhDocs } from './function/trigonometry/tanh.js';
  222. import { toDocs } from './function/units/to.js';
  223. import { binDocs } from './function/utils/bin.js';
  224. import { cloneDocs } from './function/utils/clone.js';
  225. import { formatDocs } from './function/utils/format.js';
  226. import { hasNumericValueDocs } from './function/utils/hasNumericValue.js';
  227. import { hexDocs } from './function/utils/hex.js';
  228. import { isIntegerDocs } from './function/utils/isInteger.js';
  229. import { isNaNDocs } from './function/utils/isNaN.js';
  230. import { isNegativeDocs } from './function/utils/isNegative.js';
  231. import { isNumericDocs } from './function/utils/isNumeric.js';
  232. import { isPositiveDocs } from './function/utils/isPositive.js';
  233. import { isPrimeDocs } from './function/utils/isPrime.js';
  234. import { isZeroDocs } from './function/utils/isZero.js';
  235. import { numericDocs } from './function/utils/numeric.js';
  236. import { octDocs } from './function/utils/oct.js';
  237. import { printDocs } from './function/utils/print.js';
  238. import { typeOfDocs } from './function/utils/typeOf.js';
  239. export var embeddedDocs = {
  240. // construction functions
  241. bignumber: bignumberDocs,
  242. boolean: booleanDocs,
  243. complex: complexDocs,
  244. createUnit: createUnitDocs,
  245. fraction: fractionDocs,
  246. index: indexDocs,
  247. matrix: matrixDocs,
  248. number: numberDocs,
  249. sparse: sparseDocs,
  250. splitUnit: splitUnitDocs,
  251. string: stringDocs,
  252. unit: unitDocs,
  253. // constants
  254. e: eDocs,
  255. E: eDocs,
  256. false: falseDocs,
  257. i: iDocs,
  258. Infinity: InfinityDocs,
  259. LN2: LN2Docs,
  260. LN10: LN10Docs,
  261. LOG2E: LOG2EDocs,
  262. LOG10E: LOG10EDocs,
  263. NaN: NaNDocs,
  264. null: nullDocs,
  265. pi: piDocs,
  266. PI: piDocs,
  267. phi: phiDocs,
  268. SQRT1_2: SQRT12Docs,
  269. SQRT2: SQRT2Docs,
  270. tau: tauDocs,
  271. true: trueDocs,
  272. version: versionDocs,
  273. // physical constants
  274. // TODO: more detailed docs for physical constants
  275. speedOfLight: {
  276. description: 'Speed of light in vacuum',
  277. examples: ['speedOfLight']
  278. },
  279. gravitationConstant: {
  280. description: 'Newtonian constant of gravitation',
  281. examples: ['gravitationConstant']
  282. },
  283. planckConstant: {
  284. description: 'Planck constant',
  285. examples: ['planckConstant']
  286. },
  287. reducedPlanckConstant: {
  288. description: 'Reduced Planck constant',
  289. examples: ['reducedPlanckConstant']
  290. },
  291. magneticConstant: {
  292. description: 'Magnetic constant (vacuum permeability)',
  293. examples: ['magneticConstant']
  294. },
  295. electricConstant: {
  296. description: 'Electric constant (vacuum permeability)',
  297. examples: ['electricConstant']
  298. },
  299. vacuumImpedance: {
  300. description: 'Characteristic impedance of vacuum',
  301. examples: ['vacuumImpedance']
  302. },
  303. coulomb: {
  304. description: 'Coulomb\'s constant',
  305. examples: ['coulomb']
  306. },
  307. elementaryCharge: {
  308. description: 'Elementary charge',
  309. examples: ['elementaryCharge']
  310. },
  311. bohrMagneton: {
  312. description: 'Borh magneton',
  313. examples: ['bohrMagneton']
  314. },
  315. conductanceQuantum: {
  316. description: 'Conductance quantum',
  317. examples: ['conductanceQuantum']
  318. },
  319. inverseConductanceQuantum: {
  320. description: 'Inverse conductance quantum',
  321. examples: ['inverseConductanceQuantum']
  322. },
  323. // josephson: {description: 'Josephson constant', examples: ['josephson']},
  324. magneticFluxQuantum: {
  325. description: 'Magnetic flux quantum',
  326. examples: ['magneticFluxQuantum']
  327. },
  328. nuclearMagneton: {
  329. description: 'Nuclear magneton',
  330. examples: ['nuclearMagneton']
  331. },
  332. klitzing: {
  333. description: 'Von Klitzing constant',
  334. examples: ['klitzing']
  335. },
  336. bohrRadius: {
  337. description: 'Borh radius',
  338. examples: ['bohrRadius']
  339. },
  340. classicalElectronRadius: {
  341. description: 'Classical electron radius',
  342. examples: ['classicalElectronRadius']
  343. },
  344. electronMass: {
  345. description: 'Electron mass',
  346. examples: ['electronMass']
  347. },
  348. fermiCoupling: {
  349. description: 'Fermi coupling constant',
  350. examples: ['fermiCoupling']
  351. },
  352. fineStructure: {
  353. description: 'Fine-structure constant',
  354. examples: ['fineStructure']
  355. },
  356. hartreeEnergy: {
  357. description: 'Hartree energy',
  358. examples: ['hartreeEnergy']
  359. },
  360. protonMass: {
  361. description: 'Proton mass',
  362. examples: ['protonMass']
  363. },
  364. deuteronMass: {
  365. description: 'Deuteron Mass',
  366. examples: ['deuteronMass']
  367. },
  368. neutronMass: {
  369. description: 'Neutron mass',
  370. examples: ['neutronMass']
  371. },
  372. quantumOfCirculation: {
  373. description: 'Quantum of circulation',
  374. examples: ['quantumOfCirculation']
  375. },
  376. rydberg: {
  377. description: 'Rydberg constant',
  378. examples: ['rydberg']
  379. },
  380. thomsonCrossSection: {
  381. description: 'Thomson cross section',
  382. examples: ['thomsonCrossSection']
  383. },
  384. weakMixingAngle: {
  385. description: 'Weak mixing angle',
  386. examples: ['weakMixingAngle']
  387. },
  388. efimovFactor: {
  389. description: 'Efimov factor',
  390. examples: ['efimovFactor']
  391. },
  392. atomicMass: {
  393. description: 'Atomic mass constant',
  394. examples: ['atomicMass']
  395. },
  396. avogadro: {
  397. description: 'Avogadro\'s number',
  398. examples: ['avogadro']
  399. },
  400. boltzmann: {
  401. description: 'Boltzmann constant',
  402. examples: ['boltzmann']
  403. },
  404. faraday: {
  405. description: 'Faraday constant',
  406. examples: ['faraday']
  407. },
  408. firstRadiation: {
  409. description: 'First radiation constant',
  410. examples: ['firstRadiation']
  411. },
  412. loschmidt: {
  413. description: 'Loschmidt constant at T=273.15 K and p=101.325 kPa',
  414. examples: ['loschmidt']
  415. },
  416. gasConstant: {
  417. description: 'Gas constant',
  418. examples: ['gasConstant']
  419. },
  420. molarPlanckConstant: {
  421. description: 'Molar Planck constant',
  422. examples: ['molarPlanckConstant']
  423. },
  424. molarVolume: {
  425. description: 'Molar volume of an ideal gas at T=273.15 K and p=101.325 kPa',
  426. examples: ['molarVolume']
  427. },
  428. sackurTetrode: {
  429. description: 'Sackur-Tetrode constant at T=1 K and p=101.325 kPa',
  430. examples: ['sackurTetrode']
  431. },
  432. secondRadiation: {
  433. description: 'Second radiation constant',
  434. examples: ['secondRadiation']
  435. },
  436. stefanBoltzmann: {
  437. description: 'Stefan-Boltzmann constant',
  438. examples: ['stefanBoltzmann']
  439. },
  440. wienDisplacement: {
  441. description: 'Wien displacement law constant',
  442. examples: ['wienDisplacement']
  443. },
  444. // spectralRadiance: {description: 'First radiation constant for spectral radiance', examples: ['spectralRadiance']},
  445. molarMass: {
  446. description: 'Molar mass constant',
  447. examples: ['molarMass']
  448. },
  449. molarMassC12: {
  450. description: 'Molar mass constant of carbon-12',
  451. examples: ['molarMassC12']
  452. },
  453. gravity: {
  454. description: 'Standard acceleration of gravity (standard acceleration of free-fall on Earth)',
  455. examples: ['gravity']
  456. },
  457. planckLength: {
  458. description: 'Planck length',
  459. examples: ['planckLength']
  460. },
  461. planckMass: {
  462. description: 'Planck mass',
  463. examples: ['planckMass']
  464. },
  465. planckTime: {
  466. description: 'Planck time',
  467. examples: ['planckTime']
  468. },
  469. planckCharge: {
  470. description: 'Planck charge',
  471. examples: ['planckCharge']
  472. },
  473. planckTemperature: {
  474. description: 'Planck temperature',
  475. examples: ['planckTemperature']
  476. },
  477. // functions - algebra
  478. derivative: derivativeDocs,
  479. lsolve: lsolveDocs,
  480. lsolveAll: lsolveAllDocs,
  481. lup: lupDocs,
  482. lusolve: lusolveDocs,
  483. leafCount: leafCountDocs,
  484. polynomialRoot: polynomialRootDocs,
  485. resolve: resolveDocs,
  486. simplify: simplifyDocs,
  487. simplifyConstant: simplifyConstantDocs,
  488. simplifyCore: simplifyCoreDocs,
  489. symbolicEqual: symbolicEqualDocs,
  490. rationalize: rationalizeDocs,
  491. slu: sluDocs,
  492. usolve: usolveDocs,
  493. usolveAll: usolveAllDocs,
  494. qr: qrDocs,
  495. // functions - arithmetic
  496. abs: absDocs,
  497. add: addDocs,
  498. cbrt: cbrtDocs,
  499. ceil: ceilDocs,
  500. cube: cubeDocs,
  501. divide: divideDocs,
  502. dotDivide: dotDivideDocs,
  503. dotMultiply: dotMultiplyDocs,
  504. dotPow: dotPowDocs,
  505. exp: expDocs,
  506. expm: expmDocs,
  507. expm1: expm1Docs,
  508. fix: fixDocs,
  509. floor: floorDocs,
  510. gcd: gcdDocs,
  511. hypot: hypotDocs,
  512. lcm: lcmDocs,
  513. log: logDocs,
  514. log2: log2Docs,
  515. log1p: log1pDocs,
  516. log10: log10Docs,
  517. mod: modDocs,
  518. multiply: multiplyDocs,
  519. norm: normDocs,
  520. nthRoot: nthRootDocs,
  521. nthRoots: nthRootsDocs,
  522. pow: powDocs,
  523. round: roundDocs,
  524. sign: signDocs,
  525. sqrt: sqrtDocs,
  526. sqrtm: sqrtmDocs,
  527. square: squareDocs,
  528. subtract: subtractDocs,
  529. unaryMinus: unaryMinusDocs,
  530. unaryPlus: unaryPlusDocs,
  531. xgcd: xgcdDocs,
  532. invmod: invmodDocs,
  533. // functions - bitwise
  534. bitAnd: bitAndDocs,
  535. bitNot: bitNotDocs,
  536. bitOr: bitOrDocs,
  537. bitXor: bitXorDocs,
  538. leftShift: leftShiftDocs,
  539. rightArithShift: rightArithShiftDocs,
  540. rightLogShift: rightLogShiftDocs,
  541. // functions - combinatorics
  542. bellNumbers: bellNumbersDocs,
  543. catalan: catalanDocs,
  544. composition: compositionDocs,
  545. stirlingS2: stirlingS2Docs,
  546. // functions - core
  547. config: configDocs,
  548. import: importDocs,
  549. typed: typedDocs,
  550. // functions - complex
  551. arg: argDocs,
  552. conj: conjDocs,
  553. re: reDocs,
  554. im: imDocs,
  555. // functions - expression
  556. evaluate: evaluateDocs,
  557. help: helpDocs,
  558. // functions - geometry
  559. distance: distanceDocs,
  560. intersect: intersectDocs,
  561. // functions - logical
  562. and: andDocs,
  563. not: notDocs,
  564. or: orDocs,
  565. xor: xorDocs,
  566. // functions - matrix
  567. concat: concatDocs,
  568. count: countDocs,
  569. cross: crossDocs,
  570. column: columnDocs,
  571. ctranspose: ctransposeDocs,
  572. det: detDocs,
  573. diag: diagDocs,
  574. diff: diffDocs,
  575. dot: dotDocs,
  576. getMatrixDataType: getMatrixDataTypeDocs,
  577. identity: identityDocs,
  578. filter: filterDocs,
  579. flatten: flattenDocs,
  580. forEach: forEachDocs,
  581. inv: invDocs,
  582. pinv: pinvDocs,
  583. eigs: eigsDocs,
  584. kron: kronDocs,
  585. matrixFromFunction: matrixFromFunctionDocs,
  586. matrixFromRows: matrixFromRowsDocs,
  587. matrixFromColumns: matrixFromColumnsDocs,
  588. map: mapDocs,
  589. ones: onesDocs,
  590. partitionSelect: partitionSelectDocs,
  591. range: rangeDocs,
  592. resize: resizeDocs,
  593. reshape: reshapeDocs,
  594. rotate: rotateDocs,
  595. rotationMatrix: rotationMatrixDocs,
  596. row: rowDocs,
  597. size: sizeDocs,
  598. sort: sortDocs,
  599. squeeze: squeezeDocs,
  600. subset: subsetDocs,
  601. trace: traceDocs,
  602. transpose: transposeDocs,
  603. zeros: zerosDocs,
  604. fft: fftDocs,
  605. ifft: ifftDocs,
  606. sylvester: sylvesterDocs,
  607. schur: schurDocs,
  608. lyap: lyapDocs,
  609. // functions - probability
  610. combinations: combinationsDocs,
  611. combinationsWithRep: combinationsWithRepDocs,
  612. // distribution: distributionDocs,
  613. factorial: factorialDocs,
  614. gamma: gammaDocs,
  615. kldivergence: kldivergenceDocs,
  616. lgamma: lgammaDocs,
  617. multinomial: multinomialDocs,
  618. permutations: permutationsDocs,
  619. pickRandom: pickRandomDocs,
  620. random: randomDocs,
  621. randomInt: randomIntDocs,
  622. // functions - relational
  623. compare: compareDocs,
  624. compareNatural: compareNaturalDocs,
  625. compareText: compareTextDocs,
  626. deepEqual: deepEqualDocs,
  627. equal: equalDocs,
  628. equalText: equalTextDocs,
  629. larger: largerDocs,
  630. largerEq: largerEqDocs,
  631. smaller: smallerDocs,
  632. smallerEq: smallerEqDocs,
  633. unequal: unequalDocs,
  634. // functions - set
  635. setCartesian: setCartesianDocs,
  636. setDifference: setDifferenceDocs,
  637. setDistinct: setDistinctDocs,
  638. setIntersect: setIntersectDocs,
  639. setIsSubset: setIsSubsetDocs,
  640. setMultiplicity: setMultiplicityDocs,
  641. setPowerset: setPowersetDocs,
  642. setSize: setSizeDocs,
  643. setSymDifference: setSymDifferenceDocs,
  644. setUnion: setUnionDocs,
  645. // functions - special
  646. erf: erfDocs,
  647. // functions - statistics
  648. cumsum: cumSumDocs,
  649. mad: madDocs,
  650. max: maxDocs,
  651. mean: meanDocs,
  652. median: medianDocs,
  653. min: minDocs,
  654. mode: modeDocs,
  655. prod: prodDocs,
  656. quantileSeq: quantileSeqDocs,
  657. std: stdDocs,
  658. sum: sumDocs,
  659. variance: varianceDocs,
  660. // functions - trigonometry
  661. acos: acosDocs,
  662. acosh: acoshDocs,
  663. acot: acotDocs,
  664. acoth: acothDocs,
  665. acsc: acscDocs,
  666. acsch: acschDocs,
  667. asec: asecDocs,
  668. asech: asechDocs,
  669. asin: asinDocs,
  670. asinh: asinhDocs,
  671. atan: atanDocs,
  672. atanh: atanhDocs,
  673. atan2: atan2Docs,
  674. cos: cosDocs,
  675. cosh: coshDocs,
  676. cot: cotDocs,
  677. coth: cothDocs,
  678. csc: cscDocs,
  679. csch: cschDocs,
  680. sec: secDocs,
  681. sech: sechDocs,
  682. sin: sinDocs,
  683. sinh: sinhDocs,
  684. tan: tanDocs,
  685. tanh: tanhDocs,
  686. // functions - units
  687. to: toDocs,
  688. // functions - utils
  689. clone: cloneDocs,
  690. format: formatDocs,
  691. bin: binDocs,
  692. oct: octDocs,
  693. hex: hexDocs,
  694. isNaN: isNaNDocs,
  695. isInteger: isIntegerDocs,
  696. isNegative: isNegativeDocs,
  697. isNumeric: isNumericDocs,
  698. hasNumericValue: hasNumericValueDocs,
  699. isPositive: isPositiveDocs,
  700. isPrime: isPrimeDocs,
  701. isZero: isZeroDocs,
  702. print: printDocs,
  703. typeOf: typeOfDocs,
  704. numeric: numericDocs
  705. };