Skip to content

Commit 70eb789

Browse files
stdlib-botPlaneshifter
stdlib-bot
and
Planeshifter
authored
docs: update REPL namespace documentation
PR-URL: stdlib-js#2682 Reviewed-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 1655420 commit 70eb789

11 files changed

Lines changed: 11 additions & 11 deletions

File tree

‎lib/node_modules/@stdlib/repl/code-blocks/data/data.csv‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2536,7 +2536,7 @@ base.truncateMiddle,"var str = 'beep boop';\nvar out = base.truncateMiddle( str,
25362536
base.truncb,"var y = base.truncb( 3.14159, -4, 10 )\ny = base.truncb( 3.14159, 0, 2 )\ny = base.truncb( 5.0, 1, 2 )\n"
25372537
base.truncf,"var y = base.truncf( 3.14 )\ny = base.truncf( -4.2 )\ny = base.truncf( -4.6 )\ny = base.truncf( 9.5 )\ny = base.truncf( -0.0 )\n"
25382538
base.truncn,"var y = base.truncn( 3.14159, -4 )\ny = base.truncn( 3.14159, 0 )\ny = base.truncn( 12368.0, 3 )\n"
2539-
base.truncsd,"var y = base.truncsd( 3.14159, 5 )\ny = base.truncsd( 3.14159, 1 )\ny = base.truncsd( 12368.0, 2 )\ny = base.truncsd( 0.0313, 2, 2 )\n"
2539+
base.truncsd,"var y = base.truncsd( 3.14159, 5, 10 )\ny = base.truncsd( 3.14159, 1, 10 )\ny = base.truncsd( 12368.0, 2, 10 )\ny = base.truncsd( 0.0313, 2, 2 )\n"
25402540
base.uint32ToInt32,"var y = base.uint32ToInt32( base.float64ToUint32( 4294967295 ) )\ny = base.uint32ToInt32( base.float64ToUint32( 3 ) )\n"
25412541
base.umul,"var v = base.umul( 10>>>0, 4>>>0 )\n"
25422542
base.umuldw,"var v = base.umuldw( 1, 10 )\n"

‎lib/node_modules/@stdlib/repl/code-blocks/data/data.json‎

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

‎lib/node_modules/@stdlib/repl/data/contributor.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["Adarsh Palaskar","Aditya Sapra","AgPriyanshu18","Aleksandr","Ali Salesi","Aman Bhansali","Amit Jimiwal","Anudeep Sanapala","Athan Reines","Ayaka","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","Golden Kumar","Gunj Joshi","Harshita Kalani","Hridyanshu","Jaimin Godhani","James Gelok","Jaysukh Makvana","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Karthik Prakash","Khaldon","Krishnendu Das","Lovelin","Manik Sharma","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Momtchil Momtchev","Muhammad Haris","Naresh Jagadeesan","NightKnight","Nithin Katta","Ognjen Jevremović","Oneday12323","Philipp Burckhardt","Prajwal Kulkarni","Pranav Goswami","Praneki","Pratik","Priyansh","Pushpendra Chandravanshi","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Robert Gislason","Roman Stetsyk","Rutam","Ryan Seal","Sai Srikar Dumpeti","Seyyed Parsa Neshaei","Shashank Shekhar Singh","Shivam","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suraj kumar","Tirtadwipa Manunggal","Tudor Pagu","Utkarsh","Utkarsh Raj","Varad Gupta","Xiaochuan Ye","Yernar Yergaziyev","naveen","nishant-s7","orimiles5","rainn","rei2hu"]
1+
["Adarsh Palaskar","Aditya Sapra","AgPriyanshu18","Aleksandr","Ali Salesi","Aman Bhansali","Amit Jimiwal","Anudeep Sanapala","Athan Reines","Ayaka","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","Golden Kumar","Gunj Joshi","Harshita Kalani","Hridyanshu","Jaimin Godhani","James Gelok","Jaysukh Makvana","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Karthik Prakash","Khaldon","Krishnendu Das","Lovelin","Manik Sharma","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Momtchil Momtchev","Muhammad Haris","Naresh Jagadeesan","NightKnight","Nithin Katta","Nourhan Hasan","Ognjen Jevremović","Oneday12323","Philipp Burckhardt","Prajwal Kulkarni","Pranav Goswami","Praneki","Pratik","Priyansh","Pushpendra Chandravanshi","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Robert Gislason","Roman Stetsyk","Rutam","Ryan Seal","Sai Srikar Dumpeti","Seyyed Parsa Neshaei","Shashank Shekhar Singh","Shivam","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suraj kumar","Tirtadwipa Manunggal","Tudor Pagu","Utkarsh","Utkarsh Raj","Varad Gupta","Xiaochuan Ye","Yernar Yergaziyev","naveen","nishant-s7","orimiles5","rainn","rei2hu"]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2536,7 +2536,7 @@ base.truncateMiddle,"\nbase.truncateMiddle( str, len, seq )\n Truncates the m
25362536
base.truncb,"\nbase.truncb( x, n, b )\n Rounds a numeric value to the nearest multiple of `b^n` toward zero.\n\n Due to floating-point rounding error, rounding may not be exact.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Integer power.\n\n b: integer\n Base.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n // Round to 4 decimal places:\n > var y = base.truncb( 3.14159, -4, 10 )\n 3.1415\n\n // If `n = 0` or `b = 1`, standard round behavior:\n > y = base.truncb( 3.14159, 0, 2 )\n 3.0\n\n // Round to nearest multiple of two toward zero:\n > y = base.truncb( 5.0, 1, 2 )\n 4.0\n\n See Also\n --------\n base.ceilb, base.floorb, base.roundb, base.trunc, base.truncn\n"
25372537
base.truncf,"\nbase.truncf( x )\n Rounds a single-precision floating-point number toward zero.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.truncf( 3.14 )\n 3.0\n > y = base.truncf( -4.2 )\n -4.0\n > y = base.truncf( -4.6 )\n -4.0\n > y = base.truncf( 9.5 )\n 9.0\n > y = base.truncf( -0.0 )\n -0.0\n\n See Also\n --------\n base.ceilf, base.floorf, base.trunc\n"
25382538
base.truncn,"\nbase.truncn( x, n )\n Rounds a numeric value to the nearest multiple of `10^n` toward zero.\n\n When operating on floating-point numbers in bases other than `2`, rounding\n to specified digits can be inexact.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Integer power of 10.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n // Round to 4 decimal places:\n > var y = base.truncn( 3.14159, -4 )\n 3.1415\n\n // If `n = 0`, standard round behavior:\n > y = base.truncn( 3.14159, 0 )\n 3.0\n\n // Round to nearest thousand:\n > y = base.truncn( 12368.0, 3 )\n 12000.0\n\n\n See Also\n --------\n base.ceiln, base.floorn, base.roundn, base.trunc, base.truncb\n"
2539-
base.truncsd,"\nbase.truncsd( x, n[, b] )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Number of significant figures. Must be greater than 0.\n\n b: integer (optional)\n Base. Must be greater than 0. Default: 10.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.truncsd( 3.14159, 5 )\n 3.1415\n > y = base.truncsd( 3.14159, 1 )\n 3.0\n > y = base.truncsd( 12368.0, 2 )\n 12000.0\n > y = base.truncsd( 0.0313, 2, 2 )\n 0.03125\n\n See Also\n --------\n base.ceilsd, base.floorsd, base.roundsd, base.trunc\n"
2539+
base.truncsd,"\nbase.truncsd( x, n, b )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Number of significant figures. Must be greater than 0.\n\n b: integer\n Base. Must be greater than 0.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.truncsd( 3.14159, 5, 10 )\n 3.1415\n > y = base.truncsd( 3.14159, 1, 10 )\n 3.0\n > y = base.truncsd( 12368.0, 2, 10 )\n 12000.0\n > y = base.truncsd( 0.0313, 2, 2 )\n 0.03125\n\n See Also\n --------\n base.ceilsd, base.floorsd, base.roundsd, base.trunc\n"
25402540
base.uint32ToInt32,"\nbase.uint32ToInt32( x )\n Converts an unsigned 32-bit integer to a signed 32-bit integer.\n\n Parameters\n ----------\n x: integer\n Unsigned 32-bit integer.\n\n Returns\n -------\n out: integer\n Signed 32-bit integer.\n\n Examples\n --------\n > var y = base.uint32ToInt32( base.float64ToUint32( 4294967295 ) )\n -1\n > y = base.uint32ToInt32( base.float64ToUint32( 3 ) )\n 3\n\n"
25412541
base.umul,"\nbase.umul( a, b )\n Performs C-like multiplication of two unsigned 32-bit integers.\n\n Parameters\n ----------\n a: integer\n Unsigned 32-bit integer.\n\n b: integer\n Unsigned 32-bit integer.\n\n Returns\n -------\n out: integer\n Product.\n\n Examples\n --------\n > var v = base.umul( 10>>>0, 4>>>0 )\n 40\n\n See Also\n --------\n base.imul\n"
25422542
base.umuldw,"\nbase.umuldw( a, b )\n Multiplies two unsigned 32-bit integers and returns an array of two unsigned\n 32-bit integers which represents the unsigned 64-bit integer product.\n\n When computing the product of 32-bit integer values in double-precision\n floating-point format (the default JavaScript numeric data type), computing\n the double word product is necessary in order to avoid exceeding the maximum\n safe double-precision floating-point integer value.\n\n Parameters\n ----------\n a: integer\n Unsigned 32-bit integer.\n\n b: integer\n Unsigned 32-bit integer.\n\n Returns\n -------\n out: Array<number>\n Double word product (in big endian order; i.e., the first element\n corresponds to the most significant bits and the second element to the\n least significant bits).\n\n Examples\n --------\n > var v = base.umuldw( 1, 10 )\n [ 0, 10 ]\n\n\nbase.umuldw.assign( a, b, out, stride, offset )\n Multiplies two unsigned 32-bit integers and assigns results representing\n the unsigned 64-bit integer product to a provided output array.\n\n When computing the product of 32-bit integer values in double-precision\n floating-point format (the default JavaScript numeric data type), computing\n the double word product is necessary in order to avoid exceeding the maximum\n safe double-precision floating-point integer value.\n\n Parameters\n ----------\n a: integer\n Unsigned 32-bit integer.\n\n b: integer\n Unsigned 32-bit integer.\n\n out: Array|TypedArray|Object\n Output array.\n\n stride: integer\n Output array stride.\n\n offset: integer\n Output array index offset.\n\n Returns\n -------\n out: Array|TypedArray|Object\n Double word product (in big endian order; i.e., the first element\n corresponds to the most significant bits and the second element to the\n least significant bits).\n\n Examples\n --------\n > var out = [ 0, 0 ];\n > var v = base.umuldw.assign( 1, 10, out, 1, 0 )\n [ 0, 10 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.imuldw, base.umul\n"

‎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
@@ -2536,7 +2536,7 @@ base.truncateMiddle,"\nbase.truncateMiddle( str:string, len:integer, seq:string
25362536
base.truncb,"\nbase.truncb( x:number, n:integer, b:integer )\n Rounds a numeric value to the nearest multiple of `b^n` toward zero.\n"
25372537
base.truncf,"\nbase.truncf( x:number )\n Rounds a single-precision floating-point number toward zero.\n"
25382538
base.truncn,"\nbase.truncn( x:number, n:integer )\n Rounds a numeric value to the nearest multiple of `10^n` toward zero.\n"
2539-
base.truncsd,"\nbase.truncsd( x:number, n:integer[, b:integer] )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n"
2539+
base.truncsd,"\nbase.truncsd( x:number, n:integer, b:integer )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n"
25402540
base.uint32ToInt32,"\nbase.uint32ToInt32( x:integer )\n Converts an unsigned 32-bit integer to a signed 32-bit integer.\n"
25412541
base.umul,"\nbase.umul( a:integer, b:integer )\n Performs C-like multiplication of two unsigned 32-bit integers.\n"
25422542
base.umuldw,"\nbase.umuldw( a:integer, b:integer )\n Multiplies two unsigned 32-bit integers and returns an array of two unsigned\n 32-bit integers which represents the unsigned 64-bit integer product.\n"

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

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

‎lib/node_modules/@stdlib/repl/signature/data/data.csv‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2537,7 +2537,7 @@ base.truncateMiddle,"base.truncateMiddle( str, len, seq )"
25372537
base.truncb,"base.truncb( x, n, b )"
25382538
base.truncf,"base.truncf( x )"
25392539
base.truncn,"base.truncn( x, n )"
2540-
base.truncsd,"base.truncsd( x, n[, b] )"
2540+
base.truncsd,"base.truncsd( x, n, b )"
25412541
base.uint32ToInt32,"base.uint32ToInt32( x )"
25422542
base.umul,"base.umul( a, b )"
25432543
base.umuldw,"base.umuldw( a, b )"

‎lib/node_modules/@stdlib/repl/signature/data/data.json‎

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

‎lib/node_modules/@stdlib/repl/typed-signature/data/data.csv‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2537,7 +2537,7 @@ base.truncateMiddle,"base.truncateMiddle( str:string, len:integer, seq:string )"
25372537
base.truncb,"base.truncb( x:number, n:integer, b:integer )"
25382538
base.truncf,"base.truncf( x:number )"
25392539
base.truncn,"base.truncn( x:number, n:integer )"
2540-
base.truncsd,"base.truncsd( x:number, n:integer[, b:integer] )"
2540+
base.truncsd,"base.truncsd( x:number, n:integer, b:integer )"
25412541
base.uint32ToInt32,"base.uint32ToInt32( x:integer )"
25422542
base.umul,"base.umul( a:integer, b:integer )"
25432543
base.umuldw,"base.umuldw( a:integer, b:integer )"

0 commit comments

Comments
 (0)