doc: clean up definition wordings

Author: arnog

src/compute-engine/library/arithmetic.ts

@@ -185,6 +185,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     // Functions
     //
     Abs: {
+      description: 'Absolute value (magnitude) of a number.',
       wikidata: 'Q3317982', // magnitude 'Q120812 (for reals)
       broadcastable: true,
       idempotent: true,
@@ -201,6 +202,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Add: {
+      description: 'Sum of two or more values.',
       wikidata: 'Q32043',
       associative: true,
       commutative: true,
@@ -266,6 +268,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Chop: {
+      description: 'Replace tiny numeric values with zero.',
       associative: true,
       broadcastable: true,
       idempotent: true,
@@ -292,6 +295,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     // },
 
     Divide: {
+      description: 'Quotient of a numerator and one or more denominators.',
       wikidata: 'Q1226939',
       complexity: 2500,
       broadcastable: true,
@@ -350,6 +354,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Exp: {
+      description: 'Natural exponential function: e^x.',
       wikidata: 'Q168698',
       broadcastable: true,
       complexity: 3500,
@@ -504,6 +509,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Floor: {
+      description: 'Rounds a number down to the nearest integer.',
       wikidata: 'Q56860783',
       complexity: 1250,
       broadcastable: true,
@@ -548,6 +554,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Gamma: {
+      description: 'Gamma function, extending factorial to complex numbers.',
       wikidata: 'Q190573',
       complexity: 8000,
       broadcastable: true,
@@ -568,6 +575,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     GammaLn: {
+      description: 'Natural logarithm of the gamma function.',
       complexity: 8000,
       broadcastable: true,
       signature: '(number) -> number',
@@ -918,6 +926,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Multiply: {
+      description: 'Product of two or more values.',
       wikidata: 'Q40276',
       associative: true,
       commutative: true,
@@ -1033,6 +1042,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Power: {
+      description: 'Exponentiation: raise a base to a power.',
       wikidata: 'Q33456',
       broadcastable: true,
       complexity: 3500,
@@ -1116,6 +1126,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Rational: {
+      description: 'Construct a rational number from a numerator and denominator.',
       complexity: 2400,
 
       signature: '(number, integer?) -> rational',
@@ -1164,6 +1175,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Root: {
+      description: 'n-th root of a value.',
       complexity: 3200,
       broadcastable: true,
 
@@ -1231,6 +1243,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Round: {
+      description: 'Rounds a number to the nearest integer.',
       complexity: 1250,
       broadcastable: true,
       signature: '(number) -> integer',
@@ -1264,6 +1277,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
 
     /** Heaviside step function: H(x) = 0 for x < 0, 1/2 for x = 0, 1 for x > 0 */
     Heaviside: {
+      description: 'Heaviside step function.',
       complexity: 1200,
       broadcastable: true,
       signature: '(number) -> real',
@@ -1278,6 +1292,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Sign: {
+      description: 'Sign of a number: -1, 0, or 1.',
       complexity: 1200,
       broadcastable: true,
       signature: '(number) -> integer',
@@ -1362,6 +1377,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Square: {
+      description: 'Square of a number: x^2.',
       wikidata: 'Q3075175',
       complexity: 3100,
       broadcastable: true,
@@ -1387,6 +1403,7 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
     },
 
     Subtract: {
+      description: 'Difference between two or more values.',
       wikidata: 'Q40754',
       complexity: 1350,
       broadcastable: true,
@@ -1575,9 +1592,11 @@ export const ARITHMETIC_LIBRARY: SymbolDefinitions[] = [
 
   {
     PreIncrement: {
+      description: 'Increment a number by one.',
       signature: '(number) -> number',
     },
     PreDecrement: {
+      description: 'Decrement a number by one.',
       signature: '(number) -> number',
     },
   },

src/compute-engine/library/calculus.ts

@@ -103,6 +103,7 @@ volumes
     // with values of the order that can be either fractional or negative
     //
     Derivative: {
+      description: 'Derivative operator that returns a derivative function.',
       broadcastable: false,
 
       lazy: true,
@@ -133,6 +134,8 @@ volumes
     // This is equivalent to `["Apply", ["Derivative", "Sin"], "x"]`
 
     D: {
+      description:
+        'Symbolic partial derivative with respect to one or more variables.',
       broadcastable: false,
 
       scoped: true,
@@ -204,6 +207,7 @@ volumes
 
     // Evaluate a numerical approximation of a derivative at point x
     ND: {
+      description: 'Numerical derivative evaluated at a point.',
       broadcastable: false,
       lazy: true,
       signature: '(function, at:number) -> number',
@@ -225,6 +229,7 @@ volumes
     },
 
     Integrate: {
+      description: 'Symbolic integral with optional bounds.',
       wikidata: 'Q80091',
       broadcastable: false,
 
@@ -336,6 +341,7 @@ volumes
     },
 
     NIntegrate: {
+      description: 'Numerical approximation of a definite integral.',
       broadcastable: false,
       lazy: true,
       signature: '(function, limits:(tuple|symbol)?) -> number',

src/compute-engine/library/combinatorics.ts

@@ -6,6 +6,8 @@ import { isFunction } from '../boxed-expression/type-guards';
 export const COMBINATORICS_LIBRARY: SymbolDefinitions[] = [
   {
     Choose: {
+      description:
+        'Binomial coefficient: number of ways to choose k items from n.',
       complexity: 1200,
       signature: '(n:number, m:number) -> number',
       type: () => 'finite_integer',

src/compute-engine/library/complex.ts

@@ -7,6 +7,7 @@ import { isNumber } from '../boxed-expression/type-guards';
 export const COMPLEX_LIBRARY: SymbolDefinitions[] = [
   {
     Real: {
+      description: 'Real part of a complex number.',
       // @todo: could be extended to return an expression, i.e. ["Real", ["Add", "x", ["Complex", 0, 5]]] -> "x". Not for any operator, but at least for Add, Multiply, Negate, etc.
       broadcastable: true,
       complexity: 1200,
@@ -26,6 +27,7 @@ export const COMPLEX_LIBRARY: SymbolDefinitions[] = [
       },
     },
     Imaginary: {
+      description: 'Imaginary part of a complex number.',
       broadcastable: true,
       complexity: 1200,
       signature: '(number) -> real',
@@ -44,6 +46,7 @@ export const COMPLEX_LIBRARY: SymbolDefinitions[] = [
       },
     },
     Argument: {
+      description: 'Complex argument (phase angle) of a number.',
       broadcastable: true,
       complexity: 1200,
       signature: '(number) -> real',
@@ -60,6 +63,7 @@ export const COMPLEX_LIBRARY: SymbolDefinitions[] = [
     // For Abs (magnitude) see src/compute-engine/library/processAbs
 
     AbsArg: {
+      description: 'Tuple of magnitude and argument of a complex number.',
       broadcastable: true,
       complexity: 1200,
       signature: '(number) -> tuple<real, real>',
@@ -73,6 +77,7 @@ export const COMPLEX_LIBRARY: SymbolDefinitions[] = [
     },
 
     Conjugate: {
+      description: 'Complex conjugate of a number.',
       broadcastable: true,
       complexity: 1200,
       signature: '(number) -> number',
@@ -87,6 +92,7 @@ export const COMPLEX_LIBRARY: SymbolDefinitions[] = [
     },
 
     ComplexRoots: {
+      description: 'All n-th complex roots of a number.',
       broadcastable: true,
       complexity: 1200,
       signature: '(number, number) -> list<number>',

src/compute-engine/library/control-structures.ts

@@ -15,6 +15,7 @@ import { isFunction, isSymbol, sym } from '../boxed-expression/type-guards';
 export const CONTROL_STRUCTURES_LIBRARY: SymbolDefinitions[] = [
   {
     Block: {
+      description: 'Evaluate a sequence of expressions in a local scope.',
       lazy: true,
       scoped: true,
       signature: '(unknown*) -> unknown',
@@ -29,6 +30,7 @@ export const CONTROL_STRUCTURES_LIBRARY: SymbolDefinitions[] = [
     // A condition expression tests for one or more conditions of an expression
     // ['Condition', value, "positive"]
     Condition: {
+      description: 'Test whether a value satisfies one or more conditions.',
       lazy: true,
       signature: '(value, symbol) -> boolean',
       evaluate: ([value, conds], { engine }) => {
@@ -44,6 +46,7 @@ export const CONTROL_STRUCTURES_LIBRARY: SymbolDefinitions[] = [
     },
 
     If: {
+      description: 'Conditional branch: evaluate one of two expressions.',
       lazy: true,
       signature: '(expression, expression, expression) -> any',
       type: ([_cond, ifTrue, ifFalse]) =>
@@ -63,6 +66,7 @@ export const CONTROL_STRUCTURES_LIBRARY: SymbolDefinitions[] = [
     },
 
     Loop: {
+      description: 'Evaluate a body expression over elements of a collection.',
       lazy: true,
       signature: '(body:expression, collection:expression) -> any',
       type: ([body]) => body.type,
@@ -73,6 +77,7 @@ export const CONTROL_STRUCTURES_LIBRARY: SymbolDefinitions[] = [
     },
 
     Which: {
+      description: 'Return the value for the first condition that is true.',
       lazy: true,
       signature: '(expression+) -> unknown',
       type: (args) => {
@@ -91,7 +96,11 @@ export const CONTROL_STRUCTURES_LIBRARY: SymbolDefinitions[] = [
       evaluate: (ops, options) => evaluateWhich(ops, options),
     },
 
-    FixedPoint: { lazy: true, signature: '(any) -> unknown' },
+    FixedPoint: {
+      description: 'Iterate a function until a fixed point is reached.',
+      lazy: true,
+      signature: '(any) -> unknown',
+    },
   },
 ];