feat: add plot/table/unicode

lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js

@@ -0,0 +1,140 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/base/randu' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var Float64Array = require( '@stdlib/array/float64' );
+var array = require( '@stdlib/ndarray/array' );
+var pkg = require( './../package.json' ).name;
+var UnicodeTable = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} rows - number of rows
+* @param {PositiveInteger} columns - number of columns
+* @param {UnicodeTable} table - table instance
+* @returns {Function} benchmark function
+*/
+function createBenchmark( rows, columns, table ) {
+	var headers;
+	var data;
+	var i;
+
+	data = new Float64Array( rows * columns );
+	for ( i = 0; i < data.length; i++ ) {
+		data[ i ] = randu();
+	}
+	data = array( data, {
+		'shape': [ rows, columns ]
+	});
+	headers = [];
+	for ( i = 0; i < columns; i++ ) {
+		headers.push( randu() );
+	}
+	table.data = data;
+	table.headers = headers;
+	return benchmark;
+
+	/**
+	* Generates a row of table data.
+	*
+	* @private
+	* @returns {Array<number>} table data
+	*/
+	function row() {
+		var data;
+		var i;
+
+		data = [];
+		for ( i = 0; i < columns; i++ ) {
+			data.push( randu() );
+		}
+		return data;
+	}
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var str;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			str = table.push( row() ).render();
+			if ( typeof str !== 'string' ) {
+				b.fail( 'should return a string' );
+			}
+		}
+		b.toc();
+		if ( typeof str !== 'string' ) {
+			b.fail( 'should return a string' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var columns;
+	var table;
+	var rows;
+	var min;
+	var max;
+	var f;
+	var i;
+	var j;
+
+	min = 1; // 5^min
+	max = 3; // 5^max
+
+	for ( i = min; i <= max; i++ ) {
+		for ( j = min; j <= max; j++ ) {
+			rows = pow( 5, i );
+			columns = pow( 5, j );
+
+			table = new UnicodeTable();
+			table.bufferSize = rows;
+			f = createBenchmark( rows, columns, table );
+			bench( pkg+':render:rows='+rows+',columns='+columns, f );
+		}
+	}
+}
+
+main();

lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt

@@ -0,0 +1,160 @@
+
+{{alias}}( [data,] [headers,] [options] )
+    Returns a Unicode table instance.
+
+    Parameters
+    ----------
+    data: Object|Array<Object>|Array<Array>|MatrixLike (optional)
+        Table data.
+
+    headers: Collection (optional)
+        Table headers.
+
+    options: Object (optional)
+        Table options.
+
+    options.alignment: Array<string>|string (optional)
+        Datum's cell alignment(s). Default: 'right'.
+
+    options.autoRender: boolean (optional)
+        Boolean indicating whether to re-render on a 'change' event. Default:
+        false.
+
+    options.borders: Array<string> (optional)
+        Border characters. Default: [ '─', '│', '─', '│' ].
+
+    options.bufferSize: integer|null (optional)
+        Data buffer size. If provided, data is kept in a first-in first-out
+        (FIFO) buffer which cannot exceed the buffer size. Default: +infinity.
+
+    options.cellPaddingLeft: Array<NonNegativeInteger>|NonNegativeInteger
+    (optional)
+        Cell's left padding(s). Default: 1.
+
+    options.cellPaddingRight: Array<NonNegativeInteger>|NonNegativeInteger
+    (optional)
+        Cell's right padding(s). Default: 1.
+
+    options.columnSeparator: string (optional)
+        Column separator character(s). Default: '│'.
+
+    options.corners: Array<string> (optional)
+        Corner characters. Default: [ '┌', '┐', '┘', '└' ].
+
+    options.headerSeparator: string (optional)
+        Header separator character(s). Default: '─'.
+
+    options.horizontalSeparatorMode: string (optional)
+        Horizontal line separator mode. The following modes are supported:
+
+        - resume: resume line sequence after a joint.
+        - interpolate: skip line character at a joint.
+        - repeat: repeat line sequence after a joint.
+
+        Default: `resume`.
+
+    options.joints: Array<string> (optional)
+        Joint characters. Default: [ '┼', '┬', '┤', '┴', '├' ].
+
+    options.marginX: NonNegativeInteger (optional)
+        Horizontal output margin. Default: 0.
+
+    options.marginY: NonNegativeInteger (optional)
+        Vertical output margin. Default: 0.
+
+    options.maxCellWidth: Array<NonNegativeInteger>|NonNegativeInteger|null
+    (optional)
+        Maximum cell width(s). Default: +infinity.
+
+    options.maxOutputWidth: NonNegativeInteger|null (optional)
+        Maximum output width. Default: +infinity.
+
+    options.rowSeparator: string (optional)
+        Row separator character(s). Default: ''.
+
+    options.verticalSeparatorMode: string (optional)
+        Vertical line separator mode. The following modes are supported:
+
+        - resume: resume line sequence after a joint.
+        - interpolate: skip line character at a joint.
+        - repeat: repeat line sequence after a joint.
+
+        Default: `resume`.
+
+    Returns
+    -------
+    table.alignment
+        Datum's cell alignment(s).
+
+    table.autoRender
+        Rendering mode. If `true`, an instance renders on each 'change' event;
+        otherwise, rendering must be triggered manually.
+
+    table.borders
+        Border characters.
+
+    table.bufferSize
+        Data buffer size.
+
+    table.cellPaddingLeft
+        Cell's left Padding.
+
+    table.cellPaddingRight
+        Cell's right Padding.
+
+    table.columnSeparator
+        Column separator character(s).
+
+    table.corners
+        Corner characters.
+
+    table.data
+        Table data.
+
+    table.headers
+        Table headers.
+
+    table.headerSeparator
+        Header separator character(s).
+
+    table.horizontalSeparatorMode
+        Horizontal line separator mode.
+
+    table.joints
+        Joint characters.
+
+    table.marginX
+        Horizontal output margin.
+
+    table.marginY
+        Vertical output margin.
+
+    table.maxCellWidth
+        Maximum cell width.
+
+    table.maxOutputWidth
+        Maximum output width.
+
+    table.push( row )
+        Appends a row to table data.
+
+    table.render()
+        Renders a table.
+
+    table.rowSeparator
+        Row separator character(s).
+
+    table.verticalSeparatorMode
+        Vertical line separator mode.
+
+    Examples
+    --------
+    > var data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ];
+    > var headers = [ 'col1', 'col2', 'col3' ];
+    > var table = new {{alias}}( data, headers );
+    > table.render()
+    '...'
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/plot/table/unicode/examples/index.js

@@ -0,0 +1,45 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var uniform = require( '@stdlib/random/array/uniform' );
+var array = require( '@stdlib/ndarray/array' );
+var ctor = require( './../lib' );
+
+var headers;
+var table;
+var data;
+var str;
+
+// Generate some random data...
+data = uniform( 50, 1, 100 );
+data = array( data, {
+	'shape': [ 10, 5 ]
+});
+
+// Generate headers...
+headers = [ 'A', 'B', 'C', 'D', 'E' ];
+
+// Create a table:
+table = ctor( data, headers );
+
+// Render the table:
+str = table.render();
+console.log( str );
+// => '...'