Skip to content

Commit 176026a

Browse files
Planeshifterstdlib-bot
authored andcommitted
docs: update REPL namespace documentation
Signed-off-by: stdlib-bot <[email protected]>
1 parent 83f88d9 commit 176026a

File tree

11 files changed

+14
-11
lines changed

11 files changed

+14
-11
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1639,7 +1639,8 @@ base.signum,"var sign = base.signum( -5.0 )\nsign = base.signum( 5.0 )\nsign = b
16391639
base.signumf,"var sign = base.signumf( -5.0 )\nsign = base.signumf( 5.0 )\nsign = base.signumf( -0.0 )\nsign = base.signumf( 0.0 )\nsign = base.signumf( NaN )\n"
16401640
base.sin,"var y = base.sin( 0.0 )\ny = base.sin( PI/2.0 )\ny = base.sin( -PI/6.0 )\ny = base.sin( NaN )\n"
16411641
base.sinc,"var y = base.sinc( 0.5 )\ny = base.sinc( -1.2 )\ny = base.sinc( 0.0 )\ny = base.sinc( NaN )\n"
1642-
base.sincos,"var y = base.sincos( 0.0 )\ny = base.sincos( PI/2.0 )\ny = base.sincos( -PI/6.0 )\ny = base.sincos( NaN )\nvar out = new Float64Array( 2 );\nvar v = base.sincos.assign( 0.0, out, 1, 0 )\nvar bool = ( v === out )\n"
1642+
base.sincos,"var y = base.sincos( 0.0 )\ny = base.sincos( PI/2.0 )\ny = base.sincos( -PI/6.0 )\ny = base.sincos( NaN )\n"
1643+
base.sincos.assign,"var out = new Float64Array( 2 );\nvar v = base.sincos.assign( 0.0, out, 1, 0 )\nvar bool = ( v === out )\n"
16431644
base.sincospi,"var y = base.sincospi( 0.0 )\ny = base.sincospi( 0.5 )\ny = base.sincospi( 0.1 )\ny = base.sincospi( NaN )\n"
16441645
base.sincospi.assign,"var out = new Float64Array( 2 );\nvar v = base.sincospi.assign( 0.0, out, 1, 0 )\nvar bool = ( v === out )\n"
16451646
base.sinh,"var y = base.sinh( 0.0 )\ny = base.sinh( 2.0 )\ny = base.sinh( -2.0 )\ny = base.sinh( NaN )\n"

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

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["Aadish Jain","Aayush Khanna","Abdelrahman Samir","Abhay Punia","Abhijit Raut","Abhishek Jain","Adarsh Palaskar","Aditya Sapra","Ahmed Atwa","Ahmed Kashkoush","Ahmed Khaled","Aksshay Balasubramanian","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","Debashis Maharana","Desh Deepak Kant","Dev Goel","Dhruv Arvind Singh","Dhruvil Mehta","Divyansh Seth","Dominic Lim","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","GK Bishnoi","Gaurav","Gautam sharma","Golden Kumar","Gunj Joshi","Gururaj Gurram","Harsh","HarshaNP","Harshita Kalani","Hridyanshu","Jaimin Godhani","Jalaj Kumar","James Gelok","Jaysukh Makvana","Jenish Thapa","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Justyn Shelby","Karan Anand","Karthik Prakash","Kohantika Nath","Krishnam Agarwal","Krishnendu Das","Kshitij-Dale","Lovelin Dhoni J B","Manik Sharma","Manvith M","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Mohammad Bin Aftab","Mohammad Kaif","Momtchil Momtchev","Muhammad Haris","Naresh Jagadeesan","Naveen Kumar","Neeraj Pathak","Nishant Shinde","Nishchay Rajput","Nithin Katta","Nourhan Hasan","Ognjen Jevremović","Oneday12323","Ori Miles","Philipp Burckhardt","Prajwal Kulkarni","Pranav Goswami","Pranjal Jha","Prashant Kumar Yadav","Pratik Singh","Pratyush Kumar Chouhan","Priyansh Prajapati","Priyanshu Agarwal","Pushpendra Chandravanshi","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Rishav","Rishav Tarway","Robert Gislason","Roman Stetsyk","Rutam Kathale","Ruthwik Chikoti","Ryan Seal","Rylan Yang","Sai Srikar Dumpeti","Sarthak Paandey","Saurabh Singh","Seyyed Parsa Neshaei","Shabareesh Shetty","Shashank Shekhar Singh","Shivam Ahir","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suhaib Ilahi","Suraj Kumar","Tanishq Ahuja","Tirtadwipa Manunggal","Tudor Pagu","Tufailahmed Bargir","Utkarsh","Utkarsh Raj","UtkershBasnet","Vaibhav Patel","Varad Gupta","Vinit Pandit","Vivek Maurya","Xiaochuan Ye","Yaswanth Kosuru","Yernar Yergaziyev","Yugal Kaushik","Yuvi Mittal","ditsu","ekambains","fadiothman22","olenkabilonizhka","pranav-1720","rahulrangers","rainn","rei2hu"]
1+
["Aadish Jain","Aayush Khanna","Abdelrahman Samir","Abhay Punia","Abhijit Raut","Abhishek Jain","Adarsh Palaskar","Aditya Sapra","Ahmed Atwa","Ahmed Kashkoush","Ahmed Khaled","Aksshay Balasubramanian","Aleksandr","Ali Salesi","Aman Bhansali","Amit Jimiwal","Anshu Kumar","Anudeep Sanapala","Athan Reines","Ayaka","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Debashis Maharana","Desh Deepak Kant","Dev Goel","Dhruv Arvind Singh","Dhruvil Mehta","Divyansh Seth","Dominic Lim","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","GK Bishnoi","Gaurav","Gautam sharma","Golden Kumar","Gunj Joshi","Gururaj Gurram","Harsh","HarshaNP","Harshita Kalani","Hemant M Mehta","Hridyanshu","Jaimin Godhani","Jalaj Kumar","James Gelok","Jaysukh Makvana","Jenish Thapa","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Justyn Shelby","Karan Anand","Karthik Prakash","Kohantika Nath","Krishnam Agarwal","Krishnendu Das","Kshitij-Dale","Lovelin Dhoni J B","Manik Sharma","Manvith M","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Mohammad Bin Aftab","Mohammad Kaif","Momtchil Momtchev","Muhammad Haris","Naresh Jagadeesan","Naveen Kumar","Neeraj Pathak","Nishant Shinde","Nishchay Rajput","Nithin Katta","Nourhan Hasan","Ognjen Jevremović","Oneday12323","Ori Miles","Philipp Burckhardt","Prajwal Kulkarni","Pranav Goswami","Pranjal Jha","Prashant Kumar Yadav","Pratik Singh","Pratyush Kumar Chouhan","Priyansh Prajapati","Priyanshu Agarwal","Pushpendra Chandravanshi","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Rishav","Rishav Tarway","Robert Gislason","Roman Stetsyk","Rutam Kathale","Ruthwik Chikoti","Ryan Seal","Rylan Yang","Sai Srikar Dumpeti","Sarthak Paandey","Saurabh Singh","Seyyed Parsa Neshaei","Shabareesh Shetty","Shashank Shekhar Singh","Shivam Ahir","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suhaib Ilahi","Suraj Kumar","Tanishq Ahuja","Tirtadwipa Manunggal","Tudor Pagu","Tufailahmed Bargir","Utkarsh","Utkarsh Raj","UtkershBasnet","Vaibhav Patel","Varad Gupta","Vinit Pandit","Vivek Maurya","Xiaochuan Ye","Yaswanth Kosuru","Yernar Yergaziyev","Yugal Kaushik","Yuvi Mittal","ditsu","ekambains","fadiothman22","olenkabilonizhka","pranav-1720","rahulrangers","rainn","rei2hu"]

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1639,7 +1639,8 @@ base.signum,"\nbase.signum( x )\n Evaluates the signum function for a double-
16391639
base.signumf,"\nbase.signumf( x )\n Evaluates the signum function for a single-precision floating-point number.\n\n Value | Sign\n ----- | -----\n x > 0 | +1\n x < 0 | -1\n 0 | 0\n -0 | -0\n NaN | NaN\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n sign: number\n Function value.\n\n Examples\n --------\n > var sign = base.signumf( -5.0 )\n -1.0\n > sign = base.signumf( 5.0 )\n 1.0\n > sign = base.signumf( -0.0 )\n -0.0\n > sign = base.signumf( 0.0 )\n 0.0\n > sign = base.signumf( NaN )\n NaN\n\n See Also\n --------\n base.signum\n"
16401640
base.sin,"\nbase.sin( x )\n Computes the sine of a number.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n Returns\n -------\n y: number\n Sine.\n\n Examples\n --------\n > var y = base.sin( 0.0 )\n ~0.0\n > y = base.sin( PI/2.0 )\n ~1.0\n > y = base.sin( -PI/6.0 )\n ~-0.5\n > y = base.sin( NaN )\n NaN\n\n See Also\n --------\n base.cos, base.sinpi, base.tan\n"
16411641
base.sinc,"\nbase.sinc( x )\n Computes the normalized cardinal sine of a number.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Cardinal sine.\n\n Examples\n --------\n > var y = base.sinc( 0.5 )\n ~0.637\n > y = base.sinc( -1.2 )\n ~-0.156\n > y = base.sinc( 0.0 )\n 1.0\n > y = base.sinc( NaN )\n NaN\n\n See Also\n --------\n base.sin\n"
1642-
base.sincos,"\nbase.sincos( x )\n Simultaneously computes the sine and cosine of a number.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n Returns\n -------\n y: Array<number>\n Sine and cosine.\n\n Examples\n --------\n > var y = base.sincos( 0.0 )\n [ ~0.0, ~1.0 ]\n > y = base.sincos( PI/2.0 )\n [ ~1.0, ~0.0 ]\n > y = base.sincos( -PI/6.0 )\n [ ~-0.5, ~0.866 ]\n > y = base.sincos( NaN )\n [ NaN, NaN ]\n\n\nbase.sincos( x, out, stride, offset )\n Simultaneously computes the sine and cosine of a number and assigns\n results to a provided output array.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\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 y: Array|TypedArray|Object\n Sine and cosine.\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > var v = base.sincos.assign( 0.0, out, 1, 0 )\n <Float64Array>[ ~0.0, ~1.0 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.cos, base.sin, base.sincospi"
1642+
base.sincos,"\nbase.sincos( x )\n Simultaneously computes the sine and cosine of an angle measured in radians.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n Returns\n -------\n y: Array<number>\n Sine and cosine.\n\n Examples\n --------\n > var y = base.sincos( 0.0 )\n [ ~0.0, ~1.0 ]\n > y = base.sincos( PI/2.0 )\n [ ~1.0, ~0.0 ]\n > y = base.sincos( -PI/6.0 )\n [ ~-0.5, ~0.866 ]\n > y = base.sincos( NaN )\n [ NaN, NaN ]\n\n\nbase.sincos.assign( x, out, stride, offset )\n Simultaneously computes the sine and cosine of an angle measured in radians\n and assigns the results to a provided output array.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\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 y: Array|TypedArray|Object\n Sine and cosine.\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > var v = base.sincos.assign( 0.0, out, 1, 0 )\n <Float64Array>[ ~0.0, ~1.0 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.cos, base.sin, base.sincospi"
1643+
base.sincos.assign,"\nbase.sincos.assign( x, out, stride, offset )\n Simultaneously computes the sine and cosine of an angle measured in radians\n and assigns the results to a provided output array.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\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 y: Array|TypedArray|Object\n Sine and cosine.\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > var v = base.sincos.assign( 0.0, out, 1, 0 )\n <Float64Array>[ ~0.0, ~1.0 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.cos, base.sin, base.sincospi"
16431644
base.sincospi,"\nbase.sincospi( x )\n Simultaneously computes the sine and cosine of a number times π.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: Array<number>\n Two-element array containing sin(πx) and cos(πx).\n\n Examples\n --------\n > var y = base.sincospi( 0.0 )\n [ 0.0, 1.0 ]\n > y = base.sincospi( 0.5 )\n [ 1.0, 0.0 ]\n > y = base.sincospi( 0.1 )\n [ ~0.309, ~0.951 ]\n > y = base.sincospi( NaN )\n [ NaN, NaN ]\n\n\nbase.sincospi.assign( x, out, stride, offset )\n Simultaneously computes the sine and cosine of a number times π and\n assigns results to a provided output array.\n\n Parameters\n ----------\n x: number\n Input value.\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 y: Array|TypedArray|Object\n Two-element array containing sin(πx) and cos(πx).\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > var v = base.sincospi.assign( 0.0, out, 1, 0 )\n <Float64Array>[ 0.0, 1.0 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.cospi, base.sincos, base.sinpi"
16441645
base.sincospi.assign,"\nbase.sincospi.assign( x, out, stride, offset )\n Simultaneously computes the sine and cosine of a number times π and\n assigns results to a provided output array.\n\n Parameters\n ----------\n x: number\n Input value.\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 y: Array|TypedArray|Object\n Two-element array containing sin(πx) and cos(πx).\n\n Examples\n --------\n > var out = new Float64Array( 2 );\n > var v = base.sincospi.assign( 0.0, out, 1, 0 )\n <Float64Array>[ 0.0, 1.0 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.cospi, base.sincos, base.sinpi"
16451646
base.sinh,"\nbase.sinh( x )\n Computes the hyperbolic sine of a double-precision floating-point number.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Hyperbolic sine.\n\n Examples\n --------\n > var y = base.sinh( 0.0 )\n 0.0\n > y = base.sinh( 2.0 )\n ~3.627\n > y = base.sinh( -2.0 )\n ~-3.627\n > y = base.sinh( NaN )\n NaN\n\n See Also\n --------\n base.cosh, base.sin, base.tanh\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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1639,7 +1639,8 @@ base.signum,"\nbase.signum( x:number )\n Evaluates the signum function for a
16391639
base.signumf,"\nbase.signumf( x:number )\n Evaluates the signum function for a single-precision floating-point number.\n"
16401640
base.sin,"\nbase.sin( x:number )\n Computes the sine of a number.\n"
16411641
base.sinc,"\nbase.sinc( x:number )\n Computes the normalized cardinal sine of a number.\n"
1642-
base.sincos,"\nbase.sincos( x:number )\n Simultaneously computes the sine and cosine of a number.\n\nbase.sincos( x:number, out:Array|TypedArray|Object, stride:integer, \n offset:integer )\n Simultaneously computes the sine and cosine of a number and assigns\n results to a provided output array.\n"
1642+
base.sincos,"\nbase.sincos( x:number )\n Simultaneously computes the sine and cosine of an angle measured in radians.\n"
1643+
base.sincos.assign,"\nbase.sincos.assign( x:number, out:Array|TypedArray|Object, stride:integer, \n offset:integer )\n Simultaneously computes the sine and cosine of an angle measured in radians\n and assigns the results to a provided output array.\n"
16431644
base.sincospi,"\nbase.sincospi( x:number )\n Simultaneously computes the sine and cosine of a number times π.\n"
16441645
base.sincospi.assign,"\nbase.sincospi.assign( x:number, out:Array|TypedArray|Object, stride:integer, \n offset:integer )\n Simultaneously computes the sine and cosine of a number times π and\n assigns results to a provided output array.\n"
16451646
base.sinh,"\nbase.sinh( x:number )\n Computes the hyperbolic sine of a double-precision floating-point number.\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
@@ -1640,7 +1640,7 @@ base.signumf,"base.signumf( x )"
16401640
base.sin,"base.sin( x )"
16411641
base.sinc,"base.sinc( x )"
16421642
base.sincos,"base.sincos( x )"
1643-
base.sincos,"base.sincos( x, out, stride, offset )"
1643+
base.sincos.assign,"base.sincos.assign( x, out, stride, offset )"
16441644
base.sincospi,"base.sincospi( x )"
16451645
base.sincospi.assign,"base.sincospi.assign( x, out, stride, offset )"
16461646
base.sinh,"base.sinh( x )"

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
@@ -1640,7 +1640,7 @@ base.signumf,"base.signumf( x:number )"
16401640
base.sin,"base.sin( x:number )"
16411641
base.sinc,"base.sinc( x:number )"
16421642
base.sincos,"base.sincos( x:number )"
1643-
base.sincos,"base.sincos( x:number, out:Array|TypedArray|Object, stride:integer, offset:integer )"
1643+
base.sincos.assign,"base.sincos.assign( x:number, out:Array|TypedArray|Object, stride:integer, offset:integer )"
16441644
base.sincospi,"base.sincospi( x:number )"
16451645
base.sincospi.assign,"base.sincospi.assign( x:number, out:Array|TypedArray|Object, stride:integer, offset:integer )"
16461646
base.sinh,"base.sinh( x:number )"

0 commit comments

Comments
 (0)