Skip to content

Commit cf3e438

Browse files
committed
docs: update REPL docs
1 parent 0dd0377 commit cf3e438

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

lib/node_modules/@stdlib/repl/help/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,7 @@ base.ldexp,"\nbase.ldexp( frac, exp )\n Multiplies a double-precision floatin
10901090
base.leftPad,"\nbase.leftPad( str, len, pad )\n Left pads a string such that the padded string has a length of at least\n `len`.\n\n An output string is not guaranteed to have a length of exactly `len`, but to\n have a length of at least `len`. To generate a padded string having a length\n equal to `len`, post-process a padded string by trimming off excess\n characters.\n\n Parameters\n ----------\n str: string\n Input string.\n\n len: integer\n Minimum string length.\n\n pad: string\n String used to pad.\n\n Returns\n -------\n out: string\n Padded string.\n\n Examples\n --------\n > var out = base.leftPad( 'a', 5, ' ' )\n ' a'\n > out = base.leftPad( 'beep', 10, 'b' )\n 'bbbbbbbeep'\n > out = base.leftPad( 'boop', 12, 'beep' )\n 'beepbeepboop'\n\n See Also\n --------\n base.rightPad\n"
10911091
base.leftTrim,"\nbase.leftTrim( str )\n Trims whitespace from the beginning of a string.\n\n \"Whitespace\" is defined as the following characters:\n\n - \f\n - \n\n - \r\n - \t\n - \v\n - \u0020\n - \u00a0\n - \u1680\n - \u2000-\u200a\n - \u2028\n - \u2029\n - \u202f\n - \u205f\n - \u3000\n - \ufeff\n\n Parameters\n ----------\n str: string\n Input string.\n\n Returns\n -------\n out: string\n Trimmed string.\n\n Examples\n --------\n > var out = base.leftTrim( ' \r\n\t Beep \t\t\n ' )\n 'Beep \t\t\n '\n\n See Also\n --------\n base.rightTrim, base.trim\n"
10921092
base.ln,"\nbase.ln( x )\n Evaluates the natural logarithm of a double-precision floating-point number.\n\n For negative numbers, the natural logarithm is not defined.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.ln( 4.0 )\n ~1.386\n > y = base.ln( 0.0 )\n -Infinity\n > y = base.ln( PINF )\n Infinity\n > y = base.ln( NaN )\n NaN\n > y = base.ln( -4.0 )\n NaN\n\n See Also\n --------\n base.exp, base.log10, base.log1p, base.log2\n"
1093-
base.log,"\nbase.log( x, b )\n Computes the base `b` logarithm of `x`.\n\n For negative `b` or `x`, the function returns `NaN`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n b: number\n Base.\n\n Returns\n -------\n y: number\n Logarithm (base `b`).\n\n Examples\n --------\n > var y = base.log( 100.0, 10.0 )\n 2.0\n > y = base.log( 16.0, 2.0 )\n 4.0\n > y = base.log( 5.0, 1.0 )\n Infinity\n > y = base.log( NaN, 2.0 )\n NaN\n > y = base.log( 1.0, NaN )\n NaN\n > y = base.log( -4.0, 2.0 )\n NaN\n > y = base.log( 4.0, -2.0 )\n NaN\n\n See Also\n --------\n base.exp, base.ln, base.log10, base.log1p, base.log2\n"
1093+
base.log,"\nbase.log( x, b )\n Computes the base `b` logarithm of a double-precision floating-point number.\n\n For negative `b` or `x`, the function returns `NaN`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n b: number\n Base.\n\n Returns\n -------\n y: number\n Logarithm (base `b`).\n\n Examples\n --------\n > var y = base.log( 100.0, 10.0 )\n 2.0\n > y = base.log( 16.0, 2.0 )\n 4.0\n > y = base.log( 5.0, 1.0 )\n Infinity\n > y = base.log( NaN, 2.0 )\n NaN\n > y = base.log( 1.0, NaN )\n NaN\n > y = base.log( -4.0, 2.0 )\n NaN\n > y = base.log( 4.0, -2.0 )\n NaN\n\n See Also\n --------\n base.exp, base.ln, base.log10, base.log1p, base.log2\n"
10941094
base.log1mexp,"\nbase.log1mexp( x )\n Evaluates the natural logarithm of `1-exp(-|x|)`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.log1mexp( -10.0 )\n ~-0.00005\n > y = base.log1mexp( 0.0 )\n -Infinity\n > y = base.log1mexp( 5.0 )\n ~-0.00676\n > y = base.log1mexp( 10.0 )\n ~-0.00005\n > y = base.log1mexp( NaN )\n NaN\n\n See Also\n --------\n base.exp, base.ln, base.log1p, base.log1pexp"
10951095
base.log1p,"\nbase.log1p( x )\n Evaluates the natural logarithm of `1+x`.\n\n For `x < -1`, the function returns `NaN`, as the natural logarithm is not\n defined for negative numbers.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.log1p( 4.0 )\n ~1.609\n > y = base.log1p( -1.0 )\n -Infinity\n > y = base.log1p( 0.0 )\n 0.0\n > y = base.log1p( -0.0 )\n -0.0\n > y = base.log1p( -2.0 )\n NaN\n > y = base.log1p( NaN )\n NaN\n\n See Also\n --------\n base.ln, base.log\n"
10961096
base.log1pexp,"\nbase.log1pexp( x )\n Evaluates the natural logarithm of `1+exp(x)`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.log1pexp( -10.0 )\n ~0.000045\n > y = base.log1pexp( 0.0 )\n ~0.693147\n > y = base.log1pexp( 5.0 )\n ~5.006715\n > y = base.log1pexp( 34.0 )\n 34.0\n > y = base.log1pexp( NaN )\n NaN\n\n See Also\n --------\n base.exp, base.ln, base.log1mexp, base.log1p"

lib/node_modules/@stdlib/repl/help/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/info/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,7 @@ base.ldexp,"\nbase.ldexp( frac:number, exp:number )\n Multiplies a double-pre
10901090
base.leftPad,"\nbase.leftPad( str:string, len:integer, pad:string )\n Left pads a string such that the padded string has a length of at least\n `len`.\n"
10911091
base.leftTrim,"\nbase.leftTrim( str:string )\n Trims whitespace from the beginning of a string.\n"
10921092
base.ln,"\nbase.ln( x:number )\n Evaluates the natural logarithm of a double-precision floating-point number.\n"
1093-
base.log,"\nbase.log( x:number, b:number )\n Computes the base `b` logarithm of `x`.\n"
1093+
base.log,"\nbase.log( x:number, b:number )\n Computes the base `b` logarithm of a double-precision floating-point number.\n"
10941094
base.log1mexp,"\nbase.log1mexp( x:number )\n Evaluates the natural logarithm of `1-exp(-|x|)`.\n"
10951095
base.log1p,"\nbase.log1p( x:number )\n Evaluates the natural logarithm of `1+x`.\n"
10961096
base.log1pexp,"\nbase.log1pexp( x:number )\n Evaluates the natural logarithm of `1+exp(x)`.\n"

lib/node_modules/@stdlib/repl/info/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)