From ec04cbdc97be7bc0d5a3dd1e930fd6340b20bad6 Mon Sep 17 00:00:00 2001 From: Snehil Shah Date: Wed, 19 Jun 2024 23:51:07 +0000 Subject: [PATCH 01/34] feat: add `@stdlib/plot/table/unicode` Signed-off-by: Snehil Shah --- .../@stdlib/plot/table/unicode/README.md | 407 ++++++++++++++ .../plot/table/unicode/benchmark/benchmark.js | 495 ++++++++++++++++ .../unicode/benchmark/benchmark.render.js | 142 +++++ .../@stdlib/plot/table/unicode/docs/repl.txt | 112 ++++ .../plot/table/unicode/examples/index.js | 53 ++ .../@stdlib/plot/table/unicode/lib/addrow.js | 63 +++ .../plot/table/unicode/lib/defaults.js | 77 +++ .../@stdlib/plot/table/unicode/lib/getdata.js | 38 ++ .../@stdlib/plot/table/unicode/lib/index.js | 34 ++ .../@stdlib/plot/table/unicode/lib/main.js | 527 ++++++++++++++++++ .../unicode/lib/parser/parse_2d_array.js | 74 +++ .../table/unicode/lib/parser/parse_object.js | 105 ++++ .../unicode/lib/parser/parse_objects_list.js | 78 +++ .../table/unicode/lib/props/alignment/get.js | 35 ++ .../table/unicode/lib/props/alignment/set.js | 56 ++ .../table/unicode/lib/props/borders/get.js | 38 ++ .../table/unicode/lib/props/borders/set.js | 66 +++ .../unicode/lib/props/cell-padding/get.js | 35 ++ .../unicode/lib/props/cell-padding/set.js | 47 ++ .../unicode/lib/props/column-separator/get.js | 35 ++ .../unicode/lib/props/column-separator/set.js | 59 ++ .../table/unicode/lib/props/corners/get.js | 39 ++ .../table/unicode/lib/props/corners/set.js | 67 +++ .../unicode/lib/props/header-separator/get.js | 35 ++ .../unicode/lib/props/header-separator/set.js | 59 ++ .../table/unicode/lib/props/joints/get.js | 39 ++ .../table/unicode/lib/props/joints/set.js | 67 +++ .../table/unicode/lib/props/margin-x/get.js | 35 ++ .../table/unicode/lib/props/margin-x/set.js | 47 ++ .../table/unicode/lib/props/margin-y/get.js | 35 ++ .../table/unicode/lib/props/margin-y/set.js | 47 ++ .../unicode/lib/props/max-cell-width/get.js | 35 ++ .../unicode/lib/props/max-cell-width/set.js | 47 ++ .../unicode/lib/props/max-output-width/get.js | 35 ++ .../unicode/lib/props/max-output-width/set.js | 47 ++ .../unicode/lib/props/row-separator/get.js | 35 ++ .../unicode/lib/props/row-separator/set.js | 59 ++ .../@stdlib/plot/table/unicode/lib/render.js | 289 ++++++++++ .../@stdlib/plot/table/unicode/lib/setdata.js | 88 +++ .../@stdlib/plot/table/unicode/package.json | 65 +++ .../plot/table/unicode/test/test.add_row.js | 79 +++ .../plot/table/unicode/test/test.alignment.js | 81 +++ .../plot/table/unicode/test/test.borders.js | 81 +++ .../table/unicode/test/test.cell_padding.js | 80 +++ .../unicode/test/test.column_separator.js | 80 +++ .../plot/table/unicode/test/test.corners.js | 81 +++ .../unicode/test/test.header_separator.js | 80 +++ .../plot/table/unicode/test/test.joints.js | 81 +++ .../@stdlib/plot/table/unicode/test/test.js | 39 ++ .../plot/table/unicode/test/test.main.js | 229 ++++++++ .../plot/table/unicode/test/test.margin_x.js | 80 +++ .../plot/table/unicode/test/test.margin_y.js | 80 +++ .../table/unicode/test/test.max_cell_width.js | 80 +++ .../unicode/test/test.max_output_width.js | 80 +++ .../plot/table/unicode/test/test.parser.js | 240 ++++++++ .../plot/table/unicode/test/test.render.js | 417 ++++++++++++++ .../table/unicode/test/test.row_separator.js | 80 +++ 57 files changed, 5714 insertions(+) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/README.md create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/index.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/index.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/main.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/render.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/package.json create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md new file mode 100644 index 000000000000..ccbb89363aa4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -0,0 +1,407 @@ + + +# Unicode Table + +> Create a Unicode table. + +
+ +## Usage + +```javascript +var UnicodeTable = require( '@stdlib/plot/table/unicode' ); +``` + +#### UnicodeTable( \[data,] \[headers,] \[options] ) + +Returns a table instance. + +```javascript +var table = new UnicodeTable(); +``` + +The constructor accepts the following `options`: + +- **alignment**: datum's cell alignment. Default: `'right'`. +- **borders**: border characters. Default: `'─ │ ─ │'`. +- **cellPadding**: cell padding. Default: `1`. +- **columnSeparator**: column separator character. Default: `'│'`. +- **corners**: corner characters. Default: `'┌ ┐ ┘ └'`. +- **headerSeparator**: header separator character. Default: `'─'`. +- **joints**: joint characters. Default: `'┼ ┬ ┤ ┴ ├'`. +- **marginX**: horizontal output margin. Default: `0`. +- **marginY**: vertical output margin. Default: `0`. +- **maxCellWidth**: maximum cell width (excluding padding). Default: `FLOAT64_MAX`. +- **maxOutputWidth**: maximum output width (including margin). Default: `FLOAT64_MAX`. +- **rowSeparator**: row separator character. Default: `'None'`. + +* * * + +### Writable Properties + + + +#### UnicodeTable.prototype.alignment + +Alignment of datum in cell. The value must be either `'right'`, `'left'` or `'center'`. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.alignment = 'center'; + +// Get: +var alignment = table.alignment; +// returns 'center' +``` + + + +#### UnicodeTable.prototype.borders + +Border characters. String must be four space separated characters in the order 'top right bottom left'. A value of `'None'` indicates no border would be rendered. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.borders = '= ! = !'; + +// Get: +var borders = table.borders; +// returns '= ! = !' +``` + + + +#### UnicodeTable.prototype.cellPadding + +Cell padding. Pads each side of the cell with whitespace characters. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.cellPadding = 3; + +// Get: +var padding = table.cellPadding; +// returns 3 +``` + + + +#### UnicodeTable.prototype.corners + +Corner characters. String must be four space separated characters in the order 'top-left top-right bottom-right bottom-left'. A value of `'None'` indicates no corners would be rendered. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.corners = '* * * *'; + +// Get: +var corners = table.corners; +// returns '* * * *' +``` + + + +#### UnicodeTable.prototype.columnSeparator + +Column Separator character. Must be a character string or `'None'`. A value of `'None'` indicates that columns won't be separated. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.columnSeparator = '|'; + +// Get: +var separator = table.columnSeparator; +// returns '|' +``` + + + +#### UnicodeTable.prototype.headerSeparator + +Header Separator character. Must be a character string or `'None'`. A value of `'None'` indicates that headers won't be separated from the data. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.headerSeparator = '-'; + +// Get: +var separator = table.headerSeparator; +// returns '-' +``` + + + +#### UnicodeTable.prototype.joints + +Joint characters. String must be five space separated characters in the order 'middle top right bottom left'. A value of `'None'` indicates no joints would be rendered. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.joints = '* * * * *'; + +// Get: +var joints = table.joints; +// returns '* * * * *' +``` + + + +#### UnicodeTable.prototype.marginX + +Horizontal output margin. This will add margin to both left and right of the output. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.marginX = 2; + +// Get: +var margin = table.marginX; +// returns 2 +``` + + + +#### UnicodeTable.prototype.marginY + +Vertical output margin. This will add margin to both top and bottom of the output. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.marginY = 2; + +// Get: +var margin = table.marginY; +// returns 2 +``` + + + +#### UnicodeTable.prototype.maxCellWidth + +Maximum cell width. If a datum is longer than the maximum cell width, it is truncated. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.maxCellWidth = 10; + +// Get: +var width = table.maxCellWidth; +// returns 10 +``` + + + +#### UnicodeTable.prototype.maxOutputWidth + +Maximum output width. If the output is longer than the maximum output width, it is wrapped into multiple tables. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.maxOutputWidth = 200; + +// Get: +var width = table.maxOutputWidth; +// returns 200 +``` + + + +#### UnicodeTable.prototype.rowSeparator + +Row Separator character. Must be a character string or `'None'`. A value of `'None'` indicates that rows won't be separated. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.rowSeparator = '-'; + +// Get: +var separator = table.rowSeparator; +// returns '-' +``` + +* * * + +### Methods + + + +#### UnicodeTable.prototype.addRow( row ) + +Adds a row to table data. The row must have the same number of columns as existing data. + +```javascript +var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); + +var data = table.getData().data; +// returns [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] + +table.addRow( [ 7, 8, 9 ] ); + +data = table.getData().data; +// returns [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ] +``` + + + +#### UnicodeTable.prototype.getData() + +Gets table data and headers. + +```javascript +var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); + +var data = table.getData(); +// returns { 'data': [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], 'headers': [ 'col1', 'col2', 'col3' ] } +``` + + + +#### UnicodeTable.prototype.render() + +Renders a Unicode table. + +```javascript +var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); + +var str = table.render(); +// returns '...' +``` + + + +#### UnicodeTable.prototype.setData() + +Sets table data and headers. + +```javascript +var table = new UnicodeTable(); + +table.setData( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); + +var data = table.getData(); +// returns { 'data': [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], 'headers': [ 'col1', 'col2', 'col3' ] } +``` + +* * * + +
+ + + +
+ +
+ + + +
+ +* * * + +## Examples + + + + + +```javascript +var randu = require( '@stdlib/random/base/randu' ); +var Float64Array = require( '@stdlib/array/float64' ); +var array = require( '@stdlib/ndarray/array' ); +var ctor = require( '@stdlib/plot/table/unicode' ); + +var headers; +var table; +var data; +var str; +var i; + +// Generate some random data... +data = new Float64Array( 50 ); +for ( i = 0; i < data.length; i++ ) { + data[ i ] = randu() * 100.0; +} +data = array( data, { + 'shape': [ 10, 5 ] +}); + +// Generate headers... +headers = new Float64Array( 5 ); +for ( i = 0; i < headers.length; i++ ) { + headers[ i ] = randu() * 100.0; +} + +// Create a table: +table = ctor( data, headers ); + +// Render the table: +str = table.render(); +console.log( str ); +// => '...' +``` + +
+ + + +* * * + +## See Also + + + + + + + +
+ + + + + +
+ + diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js new file mode 100644 index 000000000000..0e81b8561fac --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -0,0 +1,495 @@ +/** +* @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 pkg = require( './../package.json' ).name; +var UnicodeTable = require( './../lib' ); + + +// MAIN // + +bench( pkg+'::instantiation', function benchmark( b ) { + var v; + var i; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = new UnicodeTable(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + } + b.toc(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::instantiation,no_new', function benchmark( b ) { + var ctor; + var v; + var i; + + ctor = UnicodeTable; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = ctor(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + } + b.toc(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::instantiation,data', function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + } + b.toc(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::instantiation,data,headers', function benchmark( b ) { + var v; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + } + b.toc(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::instantiation,data,options', function benchmark( b ) { + var opts; + var v; + var i; + + opts = { + 'alignment': 'left', + 'borders': '1 2 3 4', + 'cellPadding': 2, + 'columnSeparator': 'None', + 'corners': '* * * *', + 'headerSeparator': '-', + 'joints': '* * * * *', + 'marginX': 2, + 'marginY': 4, + 'maxCellWidth': 10, + 'maxOutputWidth': 60, + 'rowSeparator': '_' + }; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], opts ); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + } + b.toc(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::instantiation,data,headers,options', function benchmark( b ) { + var opts; + var v; + var i; + + opts = { + 'alignment': 'left', + 'borders': '1 2 3 4', + 'cellPadding': 2, + 'columnSeparator': 'None', + 'corners': '* * * *', + 'headerSeparator': '-', + 'joints': '* * * * *', + 'marginX': 2, + 'marginY': 4, + 'maxCellWidth': 10, + 'maxOutputWidth': 60, + 'rowSeparator': '_' + }; + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ], opts ); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + } + b.toc(); + if ( !( v instanceof UnicodeTable ) ) { + b.fail( 'should return an instance' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:alignment', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 'left', + 'center', + 'right' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.alignment = values[ i % values.length ]; + if ( typeof v.alignment !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.borders !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:borders', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1 2 3 4', + '- | - |', + 'None' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.borders = values[ i % values.length ]; + if ( typeof v.borders !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.borders !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:cellPadding', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 1, + 2, + 3 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.cellPadding = values[ i % values.length ]; + if ( typeof v.cellPadding !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.cellPadding !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '|', + 'None' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.columnSeparator = values[ i % values.length ]; + if ( typeof v.columnSeparator !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.columnSeparator !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:corners', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1 2 3 4', + '* * * *', + 'None' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.corners = values[ i % values.length ]; + if ( typeof v.corners !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.corners !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:headerSeparator', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + 'None' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.headerSeparator = values[ i % values.length ]; + if ( typeof v.headerSeparator !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.headerSeparator !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:joints', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1 2 3 4 5', + '* * * * *', + 'None' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.joints = values[ i % values.length ]; + if ( typeof v.joints !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.joints !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:marginX', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 0, + 1, + 2 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.marginX = values[ i % values.length ]; + if ( typeof v.marginX !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.marginX !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:marginY', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 0, + 1, + 2 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.marginY = values[ i % values.length ]; + if ( typeof v.marginY !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.marginY !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:maxCellWidth', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 10, + 20, + 30 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.maxCellWidth = values[ i % values.length ]; + if ( typeof v.maxCellWidth !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.maxCellWidth !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:maxOutputWidth', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 100, + 200, + 300 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.maxOutputWidth = values[ i % values.length ]; + if ( typeof v.maxOutputWidth !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.maxOutputWidth !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:rowSeparator', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + 'None' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.rowSeparator = values[ i % values.length ]; + if ( typeof v.rowSeparator !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.rowSeparator !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js new file mode 100644 index 000000000000..79f812e10670 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js @@ -0,0 +1,142 @@ +/** +* @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 {UnicodeSparkline} table - table instance +* @returns {Function} benchmark function +*/ +function createBenchmark( rows, columns, table ) { + return benchmark; + + /** + * Generates table data. + * + * @private + * @returns {ndarray} table data + */ + function data() { + 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 ] + }); + return data; + } + + /** + * Generates table headers. + * + * @private + * @returns {Float64Array} table data + */ + function headers() { + var data; + var i; + + data = new Float64Array( columns ); + for ( i = 0; i < data.length; i++ ) { + data[ i ] = 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.setData( data(), headers() ).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(); + f = createBenchmark( rows, columns, table ); + bench( pkg+':render:rows='+rows+',columns='+columns, f ); + } + } +} + +main(); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt new file mode 100644 index 000000000000..7200f71b2983 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -0,0 +1,112 @@ + +{{alias}}( [data,] [headers,] [options] ) + Returns a Unicode table instance. + + Parameters + ---------- + data: Object|Array|Array|MatrixLike (optional) + Table data. + + headers: Collection (optional) + Table headers. + + options: Object (optional) + Table options. + + options.alignment: string (optional) + Datum's cell alignment. Default: 'right'. + + options.borders: string (optional) + Border characters. Default: '─ │ ─ │'. + + options.cellPadding: NonNegativeInteger (optional) + Cell padding. Default: 1. + + options.columnSeparator: string (optional) + Column separator character. Default: '│'. + + options.corners: string (optional) + Corner characters. Default: '┌ ┐ ┘ └'. + + options.headerSeparator: string (optional) + Header separator character. Default: '─'. + + options.joints: 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: NonNegativeInteger (optional) + Maximum cell width (excluding padding). Default: FLOAT64_MAX. + + options.maxOutputWidth: NonNegativeInteger (optional) + Maximum output width (including margin). Default: FLOAT64_MAX. + + options.rowSeparator: string (optional) + Row separator character. Default: 'None'. + + Returns + ------- + table.addRow( row ) + Adds a row to table data. + + table.alignment + Datum's cell alignment. + + table.borders + Border characters. + + table.cellPadding + Cell Padding. + + table.columnSeparator + Column separator character. + + table.corners + Corner characters. + + table.getData() + Gets table data and headers. + + table.headerSeparator + Header separator character. + + 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.render() + Renders a table. + + table.rowSeparator + Row separator character. + + table.setData( data, [headers] ) + Sets table data and headers + + 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 + -------- + diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js new file mode 100644 index 000000000000..6903a124be79 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -0,0 +1,53 @@ +/** +* @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 randu = require( '@stdlib/random/base/randu' ); +var Float64Array = require( '@stdlib/array/float64' ); +var array = require( '@stdlib/ndarray/array' ); +var ctor = require( './../lib' ); + +var headers; +var table; +var data; +var str; +var i; + +// Generate some random data... +data = new Float64Array( 50 ); +for ( i = 0; i < data.length; i++ ) { + data[ i ] = randu() * 100.0; +} +data = array( data, { + 'shape': [ 10, 5 ] +}); + +// Generate headers... +headers = new Float64Array( 5 ); +for ( i = 0; i < headers.length; i++ ) { + headers[ i ] = randu() * 100.0; +} + +// Create a table: +table = ctor( data, headers ); + +// Render the table: +str = table.render(); +console.log( str ); +// => '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js new file mode 100644 index 000000000000..caeeb454ca15 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js @@ -0,0 +1,63 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var parse2dArray = require( './parser/parse_2d_array.js' ); + + +// MAIN // + +/** +* Adds a row to table data. +* +* @private +* @param {Collection} row - row to add +* @throws {TypeError} must provide a collection with equal number of columns to existing data +* @returns {UnicodeTable} class instance +*/ +function addRow( row ) { + /* eslint-disable no-invalid-this */ + var parsed; + + if ( !isCollection ) { + throw new TypeError( format( 'invalid argument. Must provide a collection. Value: `%s`.', row ) ); + } + // If data doesn't already exist, parse row as new data... + if ( !this._data || !this._data.length ) { + parsed = parse2dArray( [ row ], this._headers ); + this._data = parsed.data; + this._headers = parsed.headers; + this._columnWidths = parsed.columnWidths; + return this; + } + if ( this._data[ 0 ].length !== row.length ) { + throw new TypeError( format( 'invalid argument. Must provide a collection with equal number of columns to existing data. Value: `%s`.', row ) ); + } + this._data.push( row ); + return this; +} + + +// EXPORTS // + +module.exports = addRow; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js new file mode 100644 index 000000000000..d7a7883a39f1 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -0,0 +1,77 @@ +/** +* @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 FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); + + +// MAIN // + +/** +* Returns default options. +* +* @private +* @returns {Object} default options +*/ +function defaults() { + var out = {}; + + // Cell alignment: + out.alignment = 'right'; + + // Border characters: + out.borders = '─ │ ─ │'; + + // Cell padding: + out.cellPadding = 1; + + // Corner characters: + out.corners = '┌ ┐ ┘ └'; + + // Column separator character: + out.columnSeparator = '│'; + + // Header separator character: + out.headerSeparator = '─'; + + // Row separator character: + out.rowSeparator = 'None'; + + // Joint characters: + out.joints = '┼ ┬ ┤ ┴ ├'; + + // Output margins: + out.marginX = 0; + out.marginY = 0; + + // Maximum cell width: + out.maxCellWidth = FLOAT64_MAX; + + // Maximum output width: + out.maxOutputWidth = FLOAT64_MAX; + + return out; +} + + +// EXPORTS // + +module.exports = defaults; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js new file mode 100644 index 000000000000..5b8ab1bda4b0 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js @@ -0,0 +1,38 @@ +/** +* @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'; + +/** +* Returns table data and headers. +* +* @private +* @returns {Object} table data and headers +*/ +function getData() { + /* eslint-disable no-invalid-this */ + return { + 'headers': this._headers, + 'data': this._data + }; +} + + +// EXPORTS // + +module.exports = getData; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js new file mode 100644 index 000000000000..f0b575b93d5f --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js @@ -0,0 +1,34 @@ +/** +* @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'; + +/** +* Create a Unicode table. +* +* @module @stdlib/plot/table/unicode +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js new file mode 100644 index 000000000000..830cec9f5796 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -0,0 +1,527 @@ +/** +* @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 logger = require( 'debug' ); +var format = require( '@stdlib/string/format' ); +var defineProperty = require( '@stdlib/utils/define-property' ); +var objectKeys = require( '@stdlib/utils/keys' ); +var isPlainObject = require( '@stdlib/assert/is-plain-object' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var mergeFcn = require( '@stdlib/utils/merge' ).factory; +var pick = require( '@stdlib/utils/pick' ); +var setAlignment = require( './props/alignment/set.js' ); +var getAlignment = require( './props/alignment/get.js' ); +var setBorders = require( './props/borders/set.js' ); +var getBorders = require( './props/borders/get.js' ); +var setCellPadding = require( './props/cell-padding/set.js' ); +var getCellPadding = require( './props/cell-padding/get.js' ); +var setCorners = require( './props/corners/set.js' ); +var getCorners = require( './props/corners/get.js' ); +var setColumnSeparator = require( './props/column-separator/set.js' ); +var getColumnSeparator = require( './props/column-separator/get.js' ); +var setHeaderSeparator = require( './props/header-separator/set.js' ); +var getHeaderSeparator = require( './props/header-separator/get.js' ); +var setJoints = require( './props/joints/set.js' ); +var getJoints = require( './props/joints/get.js' ); +var setMarginX = require( './props/margin-x/set.js' ); +var getMarginX = require( './props/margin-x/get.js' ); +var setMarginY = require( './props/margin-y/set.js' ); +var getMarginY = require( './props/margin-y/get.js' ); +var setMaxCellWidth = require( './props/max-cell-width/set.js' ); +var getMaxCellWidth = require( './props/max-cell-width/get.js' ); +var setMaxOutputWidth = require( './props/max-output-width/set.js' ); +var getMaxOutputWidth = require( './props/max-output-width/get.js' ); +var setRowSeparator = require( './props/row-separator/set.js' ); +var getRowSeparator = require( './props/row-separator/get.js' ); +var defaults = require( './defaults.js' ); +var render = require( './render.js' ); +var setData = require('./setdata.js'); +var getData = require( './getdata.js' ); +var addRow = require( './addrow.js' ); + + +// VARIABLES // + +var debug = logger( 'table:unicode:main' ); + +var merge = mergeFcn({ + 'extend': false +}); + +// List of private properties (note: keep in alphabetical order): +var PRIVATE_PROPS = [ + '_alignment', + '_borders', + '_cellPadding', + '_corners', + '_columnSeparator', + '_columnWidths', + '_data', + '_headers', + '_headerSeparator', + '_joints', + '_marginX', + '_marginY', + '_maxCellWidth', + '_maxOutputWidth', + '_rowSeparator' +]; + +// List of options properties (note: keep in alphabetical order): +var OPTIONS_PROPS = [ + 'alignment', + 'borders', + 'cellPadding', + 'columnSeparator', + 'corners', + 'headerSeparator', + 'joints', + 'marginX', + 'marginY', + 'maxCellWidth', + 'maxOutputWidth', + 'rowSeparator' +]; + + +// MAIN // + +/** +* Unicode table constructor. +* +* @constructor +* @param {(Object|Array|Array|MatrixLike)} [data] - table data +* @param {Collection} [headers] - table headers +* @param {Options} [options] - table options +* @param {string} [options.alignment='right'] - datum's cell alignment +* @param {(string)} [options.borders='─ │ ─ │'] - border characters +* @param {NonNegativeInteger} [options.cellPadding=1] - cell padding +* @param {string} [options.columnSeparator='│'] - column separator character +* @param {string} [options.corners='┌ ┐ ┘ └'] - corner characters +* @param {string} [options.headerSeparator='─'] - header separator character +* @param {string} [options.joints='┼ ┬ ┤ ┴ ├'] - joint characters +* @param {NonNegativeInteger} [options.marginX=0] - horizontal output margin +* @param {NonNegativeInteger} [options.marginY=0] - vertical output margin +* @param {NonNegativeInteger} [options.maxCellWidth=FLOAT64_MAX] - maximum cell width (excluding padding) +* @param {NonNegativeInteger} [options.maxOutputWidth=FLOAT64_MAX] - maximum output width (including margin) +* @param {string} [options.rowSeparator='None'] - row separator character +* @throws {TypeError} must provide valid options +* @returns {UnicodeTable} table instance +*/ +function UnicodeTable() { + var headers; + var options; + var nargs; + var data; + var opts; + var keys; + var key; + var i; + + nargs = arguments.length; + if ( !( this instanceof UnicodeTable ) ) { + if ( nargs === 0 ) { + return new UnicodeTable(); + } + if ( nargs === 1 ) { + return new UnicodeTable( arguments[ 0 ] ); + } + if ( nargs === 2 ) { + return new UnicodeTable( arguments[ 0 ], arguments[ 1 ] ); + } + return new UnicodeTable( arguments[ 0 ], arguments[ 1 ], arguments[ 2 ] ); // eslint-disable-line max-len + } + + // Extract table-specific options... + opts = defaults(); + if ( nargs === 0 ) { + data = null; + headers = null; + options = {}; + } else if ( nargs === 1 ) { + data = arguments[ 0 ]; + headers = null; + options = {}; + } else if ( nargs === 2 ) { + if ( isCollection( arguments[ 1 ] ) ) { + data = arguments[ 0 ]; + headers = arguments[ 1 ]; + options = {}; + } else { + data = arguments[ 0 ]; + headers = null; + options = arguments[ 1 ]; + if ( !isPlainObject( options ) ) { + throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + } + } + } else { + data = arguments[ 0 ]; + headers = arguments[ 1 ]; + options = arguments[ 2 ]; + if ( !isPlainObject( options ) ) { + throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + } + } + opts = merge( opts, pick( options, OPTIONS_PROPS ) ); + + debug( 'Creating an instance with the following configuration: %s.', JSON.stringify( opts ) ); + + // Initialize private table-specific properties... + for ( i = 0; i < PRIVATE_PROPS.length; i++ ) { + defineProperty( this, PRIVATE_PROPS[i], { + 'configurable': false, + 'enumerable': false, + 'writable': true, + 'value': null + }); + } + // Set table data and headers... + if ( headers ) { + this.setData( data, headers ); + } else if ( data ) { + this.setData( data ); + } + // Set table-specific properties... + keys = objectKeys( opts ); + for ( i = 0; i < keys.length; i++ ) { + key = keys[ i ]; + this[ key ] = opts[ key ]; + } + return this; +} + +/** +* Alignment of datum in cell. +* +* @name alignment +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a supported alignment string +* @default 'right' +* +* @example +* var table = new UnicodeTable(); +* table.alignment = 'left'; +* var alignment = table.alignment; +* // returns 'left' +*/ +defineProperty( UnicodeTable.prototype, 'alignment', { + 'configurable': false, + 'enumerable': true, + 'set': setAlignment, + 'get': getAlignment +}); + +/** +* Border characters. +* +* @name borders +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a four space separated characters or 'None' +* @default '─ │ ─ │' +* +* @example +* var table = new UnicodeTable(); +* table.borders = '= ! = !'; +* var borders = table.borders; +* // returns '= ! = !' +*/ +defineProperty( UnicodeTable.prototype, 'borders', { + 'configurable': false, + 'enumerable': true, + 'set': setBorders, + 'get': getBorders +}); + +/** +* Cell padding. +* +* @name cellPadding +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a non-negative integer +* @default '1' +* +* @example +* var table = new UnicodeTable(); +* table.cellPadding = 3; +* var padding = table.cellPadding; +* // returns 3 +*/ +defineProperty( UnicodeTable.prototype, 'cellPadding', { + 'configurable': false, + 'enumerable': true, + 'set': setCellPadding, + 'get': getCellPadding +}); + +/** +* Corner characters. +* +* @name corners +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string with four space separated characters or 'None' +* @default '┌ ┐ ┘ └' +* +* @example +* var table = new UnicodeTable(); +* table.corners = '* * * *'; +* var corners = table.corners; +* // returns '* * * *' +*/ +defineProperty( UnicodeTable.prototype, 'corners', { + 'configurable': false, + 'enumerable': true, + 'set': setCorners, + 'get': getCorners +}); + +/** +* Column separator character. +* +* @name columnSeparator +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a character string or 'None' +* @default '│' +* +* @example +* var table = new UnicodeTable(); +* table.columnSeparator = '$'; +* var separator = table.columnSeparator; +* // returns '$' +*/ +defineProperty( UnicodeTable.prototype, 'columnSeparator', { + 'configurable': false, + 'enumerable': true, + 'set': setColumnSeparator, + 'get': getColumnSeparator +}); + +/** +* Header separator character. +* +* @name headerSeparator +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a character string or 'None' +* @default '─' +* +* @example +* var table = new UnicodeTable(); +* table.headerSeparator = '$'; +* var separator = table.headerSeparator; +* // returns '$' +*/ +defineProperty( UnicodeTable.prototype, 'headerSeparator', { + 'configurable': false, + 'enumerable': true, + 'set': setHeaderSeparator, + 'get': getHeaderSeparator +}); + +/** +* Joint characters. +* +* @name joints +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string with five space separated characters or 'None' +* @default '┼ ┬ ┤ ┴ ├' +* +* @example +* var table = new UnicodeTable(); +* table.joints = '* * * * *'; +* var joints = table.joints; +* // returns '* * * * *' +*/ +defineProperty( UnicodeTable.prototype, 'joints', { + 'configurable': false, + 'enumerable': true, + 'set': setJoints, + 'get': getJoints +}); + +/** +* Horizontal output margin. +* +* @name marginX +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a non-negative integer +* @default '0' +* +* @example +* var table = new UnicodeTable(); +* table.marginX = 2; +* var margin = table.marginX; +* // returns 2 +*/ +defineProperty( UnicodeTable.prototype, 'marginX', { + 'configurable': false, + 'enumerable': true, + 'set': setMarginX, + 'get': getMarginX +}); + +/** +* Vertical output margin. +* +* @name marginY +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a non-negative integer +* @default '0' +* +* @example +* var table = new UnicodeTable(); +* table.marginY = 2; +* var margin = table.marginY; +* // returns 2 +*/ +defineProperty( UnicodeTable.prototype, 'marginY', { + 'configurable': false, + 'enumerable': true, + 'set': setMarginY, + 'get': getMarginY +}); + +/** +* Maximum cell width (excluding padding). +* +* @name maxCellWidth +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a non-negative integer +* @default 'FLOAT64_MAX' +* +* @example +* var table = new UnicodeTable(); +* table.maxCellWidth = 10; +* var width = table.maxCellWidth; +* // returns 10 +*/ +defineProperty( UnicodeTable.prototype, 'maxCellWidth', { + 'configurable': false, + 'enumerable': true, + 'set': setMaxCellWidth, + 'get': getMaxCellWidth +}); + +/** +* Maximum output width (including margin). +* +* @name maxOutputWidth +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a non-negative integer +* @default 'FLOAT64_MAX' +* +* @example +* var table = new UnicodeTable(); +* table.maxOutputWidth = 50; +* var width = table.maxOutputWidth; +* // returns 50 +*/ +defineProperty( UnicodeTable.prototype, 'maxOutputWidth', { + 'configurable': false, + 'enumerable': true, + 'set': setMaxOutputWidth, + 'get': getMaxOutputWidth +}); + +/** +* Row separator character. +* +* @name rowSeparator +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a character string or 'None' +* @default 'None' +* +* @example +* var table = new UnicodeTable(); +* table.rowSeparator = '$'; +* var separator = table.rowSeparator; +* // returns '$' +*/ +defineProperty( UnicodeTable.prototype, 'rowSeparator', { + 'configurable': false, + 'enumerable': true, + 'set': setRowSeparator, + 'get': getRowSeparator +}); + +/** +* Adds a row to table data. +* +* @name addRow +* @memberof UnicodeTable.prototype +* @type {Function} +* @param {Collection} row - row to add +* @throws {TypeError} must provide a collection with equal number of columns to existing data +* @returns {UnicodeTable} class instance +*/ +UnicodeTable.prototype.addRow = addRow; + +/** +* Gets table data and headers. +* +* @name getData +* @memberof UnicodeTable.prototype +* @type {Function} +* @returns {Object} table data and headers +*/ +UnicodeTable.prototype.getData = getData; + +/** +* Renders a table. +* +* @name render +* @memberof UnicodeTable.prototype +* @type {Function} +* @throws {Error} output must be able to accommodate every column individually +* @returns {string} rendered table +*/ +UnicodeTable.prototype.render = render; + +/** +* Sets table data and headers. +* +* @name setData +* @memberof UnicodeTable.prototype +* @type {Function} +* @param {(Object|Array|Array|MatrixLike)} data - table data +* @param {Collection} [headers] - table headers +* @throws {TypeError} first argument must be an object, array of objects, or a 2 dimensional array/ndarray +* @throws {TypeError} second argument must be a collection +* @returns {UnicodeTable} class instance +*/ +UnicodeTable.prototype.setData = setData; + + +// EXPORTS // + +module.exports = UnicodeTable; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js new file mode 100644 index 000000000000..411157f88db3 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js @@ -0,0 +1,74 @@ +/** +* @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'; + +// MAIN // + +/** +* Parses 2D array into tabular data. +* +* @private +* @param {Array} data - tabular data +* @param {Collection} [headers] - column names +* @throws {Error} must provide correct number of columns +* @returns {Object} table metadata +*/ +function parse2dArray( data, headers ) { + var widths = []; + var cols; + var len; + var i; + var j; + + // If headers exist, initialize the widths array... + if ( headers ) { + cols = headers.length; + for ( i = 0; i < cols; i++ ) { + widths.push( String( headers[ i ] ).length ); + } + } else { + headers = null; + cols = data[ 0 ].length; + for ( i = 0; i < cols; i++ ) { + widths.push( 0 ); + } + } + // Calculating max widths of all columns: + for ( i = 0; i < data.length; i++ ) { + if ( cols !== data[ i ].length ) { + throw new Error( 'invalid data. All rows must have equal number of columns' ); + } + for ( j = 0; j < cols; j++ ) { + len = String( data[ i ][ j ] ).length; + if ( len > widths[ j ] ) { + widths[ j ] = len; + } + } + } + return { + 'headers': headers, + 'data': data, + 'columnWidths': widths + }; +} + + +// EXPORTS // + +module.exports = parse2dArray; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js new file mode 100644 index 000000000000..69b5edf2a71d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js @@ -0,0 +1,105 @@ +/** +* @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 objectKeys = require( '@stdlib/utils/keys' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var format = require( '@stdlib/string/format' ); +var hasOwnProp = require( '@stdlib/assert/has-own-property' ); + + +// MAIN // + +/** +* Parses an object into tabular data. +* +* @private +* @param {Object} data - tabular data +* @param {Collection} [headers] - column names +* @throws {Error} must provide correct number of rows +* @throws {Error} headers must exist in the object +* @throws {Error} each key must correspond to a collection +* @returns {Object} table metadata +*/ +function parseObject( data, headers ) { + var columns; + var header; + var widths; + var cols; + var rows; + var len; + var i; + var j; + + // If headers don't exist, extract headers from data: + if ( !headers ) { + headers = objectKeys( data ); + } + + // Parsing data into a 2D array: + rows = []; // final data after parsing + columns = []; // final headers list after parsing + widths = []; // max widths of each column + for ( i = 0; i < headers.length; i++ ) { + header = String( headers[ i ] ); + + // Skip header if it doesn't exist in the data... + if ( hasOwnProp( data, header ) ) { + if ( !isCollection( data[ header ] ) ) { + throw new Error( format( 'invalid data. Each key must correspond to an array. Value: `%s`.', data ) ); + } + columns.push( header ); + widths.push( header.length ); + for ( j = 0; j < data[ header ].length; j++ ) { + len = String( data[ header ][ j ] ).length; + + // Updating max width of column: + if ( len > widths[ i ] ) { + widths[ i ] = len; + } + if ( !rows[ j ] ) { + rows[ j ] = []; + } + rows[ j ][ i ] = data[ header ][ j ]; + } + } + } + if ( columns.length === 0 ) { + throw new Error( format( 'invalid data. No headers found in data. Value: `%s`.', data ) ); + } + // Checking if all columns have the same number of rows... + cols = data[ columns[ 0 ] ].length; + for ( i = 1; i < columns.length; i++ ) { + if ( cols !== data[ columns[ i ] ].length ) { + throw new Error( 'invalid data. All columns must have the same number of rows' ); + } + } + return { + 'headers': columns, + 'data': rows, + 'columnWidths': widths + }; +} + + +// EXPORTS // + +module.exports = parseObject; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js new file mode 100644 index 000000000000..671854f9d2e6 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js @@ -0,0 +1,78 @@ +/** +* @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 objectKeys = require( '@stdlib/utils/keys' ); + + +// MAIN // + +/** +* Parses array of objects into tabular data. +* +* @private +* @param {Array} data - tabular data +* @param {Collection} [headers] - column names +* @returns {Object} table metadata +*/ +function parseObjectsList( data, headers ) { + var header; + var widths; + var rows; + var len; + var i; + var j; + + // If headers don't exist, extract headers from data: + if ( !headers ) { + headers = objectKeys( data[ 0 ] ); + } + + // Parsing data into a 2D array... + rows = []; // final data after parsing + widths = []; // max widths of each column + for ( i = 0; i < headers.length; i++ ) { // initialize widths + widths.push( String( headers[ i ] ).length ); + } + for ( i = 0; i < data.length; i++ ) { + rows[ i ] = []; + for ( j = 0; j < headers.length; j++ ) { + header = headers[ j ]; + len = String( data[ i ][ header ] ).length; + + // Updating max width of column: + if ( len > widths[ j ] ) { + widths[ j ] = len; + } + rows[ i ][ j ] = data[ i ][ header ]; + } + } + return { + 'headers': headers, + 'data': rows, + 'columnWidths': widths + }; +} + + +// EXPORTS // + +module.exports = parseObjectsList; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js new file mode 100644 index 000000000000..7ab5a7b8d181 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table cell alignment. +* +* @private +* @returns {string} cell alignment +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._alignment; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js new file mode 100644 index 000000000000..e9b5f100e5db --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js @@ -0,0 +1,56 @@ +/** +* @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 contains = require( '@stdlib/assert/contains' ); +var isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var ALIGNMENTS = [ 'right', 'center', 'left' ]; + + +// MAIN // + +/** +* Sets the table cell alignment. +* +* @private +* @param {string} alignment - cell alignment +* @throws {TypeError} must be a supported alignment string +*/ +function set( alignment ) { + /* eslint-disable no-invalid-this */ + if ( !isString( alignment ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'alignment', alignment ) ); + } + if ( !contains( ALIGNMENTS, alignment ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be one of the following: "%s". Value: `%s`.', 'alignment', ALIGNMENTS.join( '", "' ), alignment ) ); + } + this._alignment = alignment; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js new file mode 100644 index 000000000000..f19ba3763f86 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js @@ -0,0 +1,38 @@ +/** +* @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'; + +/** +* Returns the table's border characters. +* +* @private +* @returns {string} borders string +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( this._borders === 'None' ) { + return 'None'; + } + return this._borders.join( ' ' ); +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js new file mode 100644 index 000000000000..b500f70ce062 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -0,0 +1,66 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var BORDER_STRING_LEN = 7; +var BORDER_CHARACTERS = 4; + + +// MAIN // + +/** +* Sets the table's border characters. +* +* @private +* @param {string} borders - borders string +* @throws {TypeError} must be a four space separated characters or 'None' +*/ +function set( borders ) { + var arr; + + /* eslint-disable no-invalid-this */ + if ( !isString( borders ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borders', borders ) ); + } + if ( borders === 'None' ) { + this._borders = borders; + return; + } + arr = borders.split( ' ' ); + if ( borders.length !== BORDER_STRING_LEN ) { + throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'borders', borders ) ); + } + if ( arr.length !== BORDER_CHARACTERS ) { + throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'borders', borders ) ); + } + this._borders = arr; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js new file mode 100644 index 000000000000..c33cfcc67aa4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's cell padding. +* +* @private +* @returns {NonNegativeInteger} cell padding +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._cellPadding; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js new file mode 100644 index 000000000000..ff5365675c3b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js @@ -0,0 +1,47 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's cell padding. +* +* @private +* @param {NonNegativeInteger} padding - cell padding +* @throws {TypeError} must provide a non-negative integer +*/ +function set( padding ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( padding ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'cellPadding', padding ) ); + } + this._cellPadding = padding; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js new file mode 100644 index 000000000000..60fd29996d58 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the column separator character. +* +* @private +* @returns {string} column separator +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._columnSeparator; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js new file mode 100644 index 000000000000..e43341a4c047 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -0,0 +1,59 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var CHARACTER_LENGTH = 1; + + +// MAIN // + +/** +* Sets the column separator character. +* +* @private +* @param {string} separator - column separator +* @throws {TypeError} must be a character string or 'None' +*/ +function set( separator ) { + /* eslint-disable no-invalid-this */ + if ( !isString( separator ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', separator ) ); + } + if ( separator === 'None' ) { + this._columnSeparator = separator; + return; + } + if ( separator.length !== CHARACTER_LENGTH ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a single character or \'None\'. Value: `%s`.', 'columnSeparator', separator ) ); + } + this._columnSeparator = separator; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js new file mode 100644 index 000000000000..13500c3b0160 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js @@ -0,0 +1,39 @@ +/** +* @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'; + +/** +* Returns the table's corner characters. +* +* @private +* @returns {string} corners string +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( this._corners[ 0 ] === ' ' ) { + // Empty corner: + return 'None'; + } + return this._corners.join( ' ' ); +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js new file mode 100644 index 000000000000..6f3c5e03759f --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -0,0 +1,67 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var CORNER_STRING_LEN = 7; +var CORNER_CHARACTERS = 4; +var EMPTY_CORNERS = [ ' ', ' ', ' ', ' ' ]; + + +// MAIN // + +/** +* Sets the table's corner characters. +* +* @private +* @param {string} corners - corners string +* @throws {TypeError} must be a string with four space separated characters or 'None' +*/ +function set( corners ) { + /* eslint-disable no-invalid-this */ + var arr; + + if ( !isString( corners ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'corners', corners ) ); + } + if ( corners === 'None' ) { + this._corners = EMPTY_CORNERS; + return; + } + arr = corners.split( ' ' ); + if ( corners.length !== CORNER_STRING_LEN ) { + throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'corners', corners ) ); + } + if ( arr.length !== CORNER_CHARACTERS ) { + throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'corners', corners ) ); + } + this._corners = arr; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js new file mode 100644 index 000000000000..8f87e32abca4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the header separator character. +* +* @private +* @returns {string} header separator +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._headerSeparator; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js new file mode 100644 index 000000000000..584db81ebea1 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -0,0 +1,59 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var CHARACTER_LENGTH = 1; + + +// MAIN // + +/** +* Sets the header separator character. +* +* @private +* @param {string} separator - header separator +* @throws {TypeError} must be a character string or 'None' +*/ +function set( separator ) { + /* eslint-disable no-invalid-this */ + if ( !isString( separator ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', separator ) ); + } + if ( separator === 'None' ) { + this._headerSeparator = separator; + return; + } + if ( separator.length !== CHARACTER_LENGTH ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a character or \'None\'. Value: `%s`.', 'headerSeparator', separator ) ); + } + this._headerSeparator = separator; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js new file mode 100644 index 000000000000..1a8a6811697c --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js @@ -0,0 +1,39 @@ +/** +* @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'; + +/** +* Returns the joint characters. +* +* @private +* @returns {string} joint character +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( this._joints[ 0 ] === ' ' ) { + // Empty joint: + return 'None'; + } + return this._joints.join( ' ' ); +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js new file mode 100644 index 000000000000..1ba1a89ce48b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -0,0 +1,67 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var JOINT_STRING_LEN = 9; +var JOINT_CHARACTERS = 5; +var EMPTY_JOINTS = [ ' ', ' ', ' ', ' ', ' ' ]; + + +// MAIN // + +/** +* Sets the joint characters. +* +* @private +* @param {string} joints - joint character +* @throws {TypeError} must be a string with five space separated characters or 'None' +*/ +function set( joints ) { + /* eslint-disable no-invalid-this */ + var arr; + + if ( !isString( joints ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'joints', joints ) ); + } + if ( joints === 'None' ) { + this._joints = EMPTY_JOINTS; + return; + } + arr = joints.split( ' ' ); + if ( joints.length !== JOINT_STRING_LEN ) { + throw new TypeError( format( 'invalid assignment. `%s` must be five space separated characters or \'None\'. Value: `%s`.', 'joints', joints ) ); + } + if ( arr.length !== JOINT_CHARACTERS ) { + throw new TypeError( format( 'invalid assignment. `%s` must be five space separated characters or \'None\'. Value: `%s`.', 'joints', joints ) ); + } + this._joints = arr; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js new file mode 100644 index 000000000000..395cb89f03d9 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's horizontal margin. +* +* @private +* @returns {NonNegativeInteger} X margin +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._marginX; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js new file mode 100644 index 000000000000..66407ad7200d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js @@ -0,0 +1,47 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's horizontal margin. +* +* @private +* @param {NonNegativeInteger} x - X margin +* @throws {TypeError} must provide a non-negative integer +*/ +function set( x ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( x ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'marginX', x ) ); + } + this._marginX = x; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js new file mode 100644 index 000000000000..b8672fbdf6f2 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's vertical margin. +* +* @private +* @returns {NonNegativeInteger} Y margin +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._marginY; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js new file mode 100644 index 000000000000..f1c5652c7c53 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js @@ -0,0 +1,47 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's vertical margin. +* +* @private +* @param {NonNegativeInteger} y - Y margin +* @throws {TypeError} must provide a non-negative integer +*/ +function set( y ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( y ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'marginY', y ) ); + } + this._marginY = y; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js new file mode 100644 index 000000000000..10513c017df6 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's max cell width. +* +* @private +* @returns {NonNegativeInteger} max cell width +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._maxCellWidth; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js new file mode 100644 index 000000000000..a5762c2e6f63 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js @@ -0,0 +1,47 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's max cell width. +* +* @private +* @param {NonNegativeInteger} width - max cell width +* @throws {TypeError} must provide a non-negative integer +*/ +function set( width ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( width ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'maxCellWidth', width ) ); + } + this._maxCellWidth = width; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js new file mode 100644 index 000000000000..606e4d09337a --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's max output width. +* +* @private +* @returns {NonNegativeInteger} max output width +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._maxOutputWidth; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js new file mode 100644 index 000000000000..59d2ab40e686 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js @@ -0,0 +1,47 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's max output width. +* +* @private +* @param {NonNegativeInteger} width - max output width +* @throws {TypeError} must provide a non-negative integer +*/ +function set( width ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( width ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'maxOutputWidth', width ) ); + } + this._maxOutputWidth = width; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js new file mode 100644 index 000000000000..d404104acc21 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the row separator character. +* +* @private +* @returns {string} row separator +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._rowSeparator; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js new file mode 100644 index 000000000000..0c824793df1d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -0,0 +1,59 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var CHARACTER_LENGTH = 1; + + +// MAIN // + +/** +* Sets the row separator character. +* +* @private +* @param {string} separator - row separator +* @throws {TypeError} must be a character string or 'None' +*/ +function set( separator ) { + /* eslint-disable no-invalid-this */ + if ( !isString( separator ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', separator ) ); + } + if ( separator === 'None' ) { + this._rowSeparator = separator; + return; + } + if ( separator.length !== CHARACTER_LENGTH ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a character or \'None\'. Value: `%s`.', 'rowSeparator', separator ) ); + } + this._rowSeparator = separator; +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js new file mode 100644 index 000000000000..b6829c758a98 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -0,0 +1,289 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var repeat = require( '@stdlib/string/repeat' ); +var floor = require( '@stdlib/math/base/special/floor' ); +var ceil = require( '@stdlib/math/base/special/ceil' ); +var min = require( '@stdlib/math/base/special/min' ); +var slice = require( '@stdlib/array/slice' ); +var truncate = require( '@stdlib/string/truncate' ); + + +// MAIN // + +/** +* Renders a table. +* +* @private +* @throws {Error} output must be able to accommodate every column individually +* @returns {string} rendered table +*/ +function render() { + /* eslint-disable no-invalid-this, no-underscore-dangle */ + var wrapIndices; + var widths; + var start; + var table; + var wraps; + var self; + var row; + var end; + var out; + var i; + var j; + + self = this; + out = ''; + + if ( !this._columnWidths ) { + // Empty table: + return out; + } + + // Resolve indices to wrap the table at: + wrapIndices = resolveWrapping(); + + // Render top margin: + out += repeat( '\n', this._marginY ); + + // Render table: + wraps = []; + for ( j = 0; j < wrapIndices.length - 1; j++ ) { + table = ''; + start = wrapIndices[ j ]; + end = wrapIndices[ j + 1 ]; + + // Render top border: + if ( this._borders !== 'None' ) { + widths = slice( this._columnWidths, start, end ); + table += renderLine( this._borders[ 0 ], widths, this._corners[ 0 ], this._joints[ 1 ], this._corners[ 1 ] ); // eslint-disable-line max-len + table += '\n'; + } + + // Render headers: + if ( this._headers ) { + row = slice( this._headers, start, end ); + widths = slice( this._columnWidths, start, end ); + table += renderRow( row, widths ); + table += '\n'; + } + + // Render header separator: + if ( this._headers && this._headerSeparator !== 'None' ) { + widths = slice( this._columnWidths, start, end ); + table += renderLine( this._headerSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len + table += '\n'; + } + + // Render data: + if ( this._data ) { + for ( i = 0; i < this._data.length; i++ ) { + // Render row: + row = slice( this._data[ i ], start, end ); + widths = slice( this._columnWidths, start, end ); + table += renderRow( row, widths ); + if ( i !== this._data.length - 1 || this._borders !== 'None' ) { + table += '\n'; + } + // Render row separator: + if ( this._rowSeparator !== 'None' && i !== this._data.length - 1 ) { + widths = slice( this._columnWidths, start, end ); + table += renderLine( this._rowSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len + table += '\n'; + } + } + } + + // Render bottom border: + if ( this._borders !== 'None' ) { + widths = slice( this._columnWidths, start, end ); + table += renderLine( this._borders[ 2 ], widths, this._corners[ 3 ], this._joints[ 3 ], this._corners[ 2 ] ); // eslint-disable-line max-len + } + wraps.push( table ); + } + out += wraps.join( '\n' ); + + // Render bottom margin: + out += repeat( '\n', this._marginY ); + return out; + + /** + * Resolves columns to wrap the table at (includes bounding indices). + * + * @private + * @throws {Error} output must be able to accommodate every column individually + * @returns {Array} list of column indices + */ + function resolveWrapping() { + var outputWidth; + var fixedLength; + var colWidth; + var indices; + + // Initialize with zeroth index: + indices = [ 0 ]; + + // Calculate fixed horizontal length: + fixedLength = 2 * self._marginX; + if ( self._borders !== 'None' ) { + fixedLength += 2; + } + outputWidth = 0; + for ( i = 0; i < self._columnWidths.length; i++ ) { + colWidth = min( self._columnWidths[ i ], self._maxCellWidth ); // width of current column + outputWidth += colWidth + ( 2 * self._cellPadding ); + + // If output crosses the maximum, time to wrap: + if ( outputWidth + fixedLength > self._maxOutputWidth ) { + if ( i === indices[ indices.length - 1 ] ) { + // The output width cannot accommodate current column: + throw new Error( format( 'invalid operation. `maxOutputWidth` must be able to accommodate every column individually. Value: `%s`', self._maxOutputWidth ) ); + } + indices.push( i ); + outputWidth = 0; + continue; + } + // Include column separator. Exclude for last column as we included them as borders: + if ( i !== self._columnWidths.length - 1 && self._columnSeparator !== 'None' ) { + outputWidth += 1; + } + } + // Include last bounding index: + indices.push( self._columnWidths.length ); + return indices; + } + + /** + * Renders a line. + * + * @private + * @param {string} lineChar - line character + * @param {Array} columnWidths - column widths + * @param {string} jointL - left joint + * @param {string} jointM - middle joint + * @param {jointR} jointR - right joint + * @returns {string} rendered line + */ + function renderLine( lineChar, columnWidths, jointL, jointM, jointR ) { + var colWidth; + var out; + var i; + + out = ''; + + // Render left margin: + out += repeat( ' ', self._marginX ); + + // Render left joint: + if ( self._borders !== 'None' ) { + out += jointL; + } + // Render line: + for ( i = 0; i < columnWidths.length; i++ ) { + // If columns are separated, render the middle joint... + if ( self._columnSeparator !== 'None' && i !== 0 ) { + out += jointM; + } + colWidth = min( columnWidths[ i ], self._maxCellWidth ); + out += repeat( lineChar, colWidth + ( 2 * self._cellPadding ) ); + } + // Render right joint: + if ( self._borders !== 'None' ) { + out += jointR; + } + // Render right margin: + out += repeat( ' ', self._marginX ); + return out; + } + + /** + * Renders a data row. + * + * @private + * @param {Array} data - row data + * @param {Array} columnWidths - column widths + * @returns {string} rendered line + */ + function renderRow( data, columnWidths ) { + var width; + var datum; + var out; + var i; + + out = ''; + + // Render left margin: + out += repeat( ' ', self._marginX ); + + // Render left border: + if ( self._borders !== 'None' ) { + out += self._borders[ 3 ]; + } + for ( i = 0; i < columnWidths.length; i++ ) { + // Render column separator... + if ( self._columnSeparator !== 'None' && i !== 0 ) { + out += self._columnSeparator; + } + // Render left cell padding: + out += repeat( ' ', self._cellPadding ); + datum = String( data[ i ] ); + width = min( columnWidths[ i ], self._maxCellWidth ); + if ( datum.length > self._maxCellWidth ) { + // Truncate long datum: + datum = truncate( datum, self._maxCellWidth ); + } + // Render datum: + switch ( self._alignment ) { + case 'left': + out += datum; + out += repeat( ' ', width - datum.length ); + break; + case 'center': + out += repeat( ' ', ceil( ( width - datum.length ) / 2 ) ); + out += datum; + out += repeat( ' ', floor( ( width - datum.length ) / 2 ) ); + break; + case 'right': + out += repeat( ' ', width - datum.length ); + out += datum; + break; + default: + break; + } + // Render right cell padding: + out += repeat( ' ', self._cellPadding ); + } + // Render right border: + if ( self._borders !== 'None' ) { + out += self._borders[ 1 ]; + } + // Render right margin: + out += repeat( ' ', self._marginX ); + return out; + } +} + + +// EXPORTS // + +module.exports = render; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js new file mode 100644 index 000000000000..1e2b2f882497 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js @@ -0,0 +1,88 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var isMatrixLike = require( '@stdlib/assert/is-matrix-like' ); +var isPlainObject = require( '@stdlib/assert/is-plain-object' ); +var isObjectArray = require( '@stdlib/assert/is-object-array' ); +var isArrayArray = require( '@stdlib/assert/is-array-array' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var parseObject = require( './parser/parse_object.js' ); +var parseObjectsList = require( './parser/parse_objects_list.js' ); +var parse2dArray = require( './parser/parse_2d_array.js' ); + + +// MAIN // + +/** +* Sets the table data. +* +* @private +* @param {(Object|Array|Array|MatrixLike)} data - table data +* @param {Collection} [headers] - table headers +* @throws {TypeError} first argument must be an object, array of objects, or a 2 dimensional array/ndarray +* @throws {TypeError} second argument must be a collection +* @returns {UnicodeTable} class instance +*/ +function setData() { + /* eslint-disable no-invalid-this */ + var headers; + var parsed; + var nargs; + var data; + + nargs = arguments.length; + if ( nargs === 0 ) { + throw new TypeError( format( 'invalid argument. First argument must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', data ) ); + } else if ( nargs === 1 ) { + data = arguments[ 0 ]; + headers = this._headers; + } else { + data = arguments[ 0 ]; + headers = arguments[ 1 ]; + if ( !isCollection( headers ) ) { + throw new TypeError( format( 'invalid argument. Second argument must be a collection. Value: `%s`.', headers ) ); + } + } + // Parse according to data-type... + if ( isMatrixLike( data ) ) { + parsed = parse2dArray( ndarray2array( data ), headers ); + } else if ( isArrayArray( data ) ) { + parsed = parse2dArray( data, headers ); + } else if ( isObjectArray( data ) ) { + parsed = parseObjectsList( data, headers ); + } else if ( isPlainObject( data ) ) { + parsed = parseObject( data, headers ); + } else { + throw new TypeError( format( 'invalid argument. First argument must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', data ) ); + } + this._data = parsed.data; + this._headers = parsed.headers; + this._columnWidths = parsed.columnWidths; + return this; +} + + +// EXPORTS // + +module.exports = setData; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/package.json b/lib/node_modules/@stdlib/plot/table/unicode/package.json new file mode 100644 index 000000000000..aac9d0f1a47a --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/package.json @@ -0,0 +1,65 @@ +{ + "name": "@stdlib/plot/table/unicode", + "version": "0.0.0", + "description": "Create a Unicode table.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "bin": {}, + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "plot", + "table", + "tabular", + "chart", + "graph", + "graphic", + "data", + "visualize", + "viz", + "vis", + "unicode" + ] +} diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js new file mode 100644 index 000000000000..12d2ba6cf4f5 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js @@ -0,0 +1,79 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function adds a row to existing data', function test( t ) { + var expected; + var headers; + var table; + var data; + var row; + var v; + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor( data, headers ); + + row = [ 1, true, 'hello' ]; + table.addRow( row ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ], [ 1, true, 'hello' ] ]; + expected.headers = [ 'col1', 'col2', 'col3' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function creates table data if no existing data found', function test( t ) { + var expected; + var table; + var row; + var v; + + table = ctor(); + + row = [ 1, true, 'hello' ]; + table.addRow( row ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 1, true, 'hello' ] ]; + expected.headers = null; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js new file mode 100644 index 000000000000..5bd1dff4e153 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js @@ -0,0 +1,81 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `alignment` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + '1234', + 'middle' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.alignment = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'alignment': 'right' + }); + t.strictEqual( table.alignment, 'right', 'returns expected value' ); + + table.alignment = 'left'; + t.strictEqual( table.alignment, 'left', 'returns expected value' ); + + table.alignment = 'center'; + t.strictEqual( table.alignment, 'center', 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js new file mode 100644 index 000000000000..f1bc1538cf28 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js @@ -0,0 +1,81 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `borders` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + 'hello', + '1234567' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.borders = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'borders': '1 2 3 4' + }); + t.strictEqual( table.borders, '1 2 3 4', 'returns expected value' ); + + table.borders = '- | _ |'; + t.strictEqual( table.borders, '- | _ |', 'returns expected value' ); + + table.borders = 'None'; + t.strictEqual( table.borders, 'None', 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js new file mode 100644 index 000000000000..230d613f0e7b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `cellPadding` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.cellPadding = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'cellPadding': 2 + }); + t.strictEqual( table.cellPadding, 2, 'returns expected value' ); + + table.cellPadding = 3; + t.strictEqual( table.cellPadding, 3, 'returns expected value' ); + + table.cellPadding = 0; + t.strictEqual( table.cellPadding, 0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js new file mode 100644 index 000000000000..9517244e5f3d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `columnSeparator` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + '5437' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.columnSeparator = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'columnSeparator': '1' + }); + t.strictEqual( table.columnSeparator, '1', 'returns expected value' ); + + table.columnSeparator = '!'; + t.strictEqual( table.columnSeparator, '!', 'returns expected value' ); + + table.columnSeparator = 'None'; + t.strictEqual( table.columnSeparator, 'None', 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js new file mode 100644 index 000000000000..690514acf20b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js @@ -0,0 +1,81 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `corners` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + 'hello', + '1234567' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.corners = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'corners': '1 2 3 4' + }); + t.strictEqual( table.corners, '1 2 3 4', 'returns expected value' ); + + table.corners = '* * * *'; + t.strictEqual( table.corners, '* * * *', 'returns expected value' ); + + table.corners = 'None'; + t.strictEqual( table.corners, 'None', 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js new file mode 100644 index 000000000000..d5d3c68c555a --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `headerSeparator` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + '5437' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.headerSeparator = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'headerSeparator': '1' + }); + t.strictEqual( table.headerSeparator, '1', 'returns expected value' ); + + table.headerSeparator = '!'; + t.strictEqual( table.headerSeparator, '!', 'returns expected value' ); + + table.headerSeparator = 'None'; + t.strictEqual( table.headerSeparator, 'None', 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js new file mode 100644 index 000000000000..efc987353387 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js @@ -0,0 +1,81 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `joints` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + 'hello', + '1234567' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.joints = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'joints': '1 2 3 4 5' + }); + t.strictEqual( table.joints, '1 2 3 4 5', 'returns expected value' ); + + table.joints = '& # * ^ @'; + t.strictEqual( table.joints, '& # * ^ @', 'returns expected value' ); + + table.joints = 'None'; + t.strictEqual( table.joints, 'None', 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.js new file mode 100644 index 000000000000..9858a4d627f6 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.js @@ -0,0 +1,39 @@ +/** +* @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 tape = require( 'tape' ); +var Table = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof Table, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the export is a class constructor', function test( t ) { + var table = new Table(); + t.strictEqual( table instanceof Table, true, 'returns class instance' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js new file mode 100644 index 000000000000..f0ec1f362309 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js @@ -0,0 +1,229 @@ +/** +* @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 tape = require( 'tape' ); +var UnicodeTable = require( './../lib/main.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof UnicodeTable, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the export is a class constructor', function test( t ) { + var table = new UnicodeTable(); + t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); + t.end(); +}); + +tape( 'the constructor does not require the `new` keyword (no data, no options)', function test( t ) { + var table; + var ctor; + + ctor = UnicodeTable; + table = ctor(); + + t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); + t.end(); +}); + +tape( 'the constructor does not require the `new` keyword (data)', function test( t ) { + var table; + var ctor; + + ctor = UnicodeTable; + table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); + + t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); + t.end(); +}); + +tape( 'the constructor does not require the `new` keyword (data and headers)', function test( t ) { + var table; + var ctor; + + ctor = UnicodeTable; + table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); + + t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); + t.end(); +}); + +tape( 'the constructor does not require the `new` keyword (data and options)', function test( t ) { + var table; + var ctor; + var data; + + ctor = UnicodeTable; + data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; + table = ctor( data, { + 'alignment': 'left', + 'borders': '1 2 3 4', + 'cellPadding': 2, + 'columnSeparator': 'None', + 'corners': '* * * *', + 'headerSeparator': '-', + 'joints': '* * * * *', + 'marginX': 2, + 'marginY': 4, + 'maxCellWidth': 10, + 'maxOutputWidth': 60, + 'rowSeparator': '_' + }); + + t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); + t.end(); +}); + +tape( 'the constructor does not require the `new` keyword (data, headers and options)', function test( t ) { + var headers; + var table; + var ctor; + var data; + + ctor = UnicodeTable; + data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor( data, headers, { + 'alignment': 'left', + 'borders': '1 2 3 4', + 'cellPadding': 2, + 'columnSeparator': 'None', + 'corners': '* * * *', + 'headerSeparator': '-', + 'joints': '* * * * *', + 'marginX': 2, + 'marginY': 4, + 'maxCellWidth': 10, + 'maxOutputWidth': 60, + 'rowSeparator': '_' + }); + + t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); + t.end(); +}); + +tape( 'the constructor will throw an error if provided an invalid options argument (no headers argument)', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + null, + void 0, + true, + false, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], value ); // eslint-disable-line no-unused-vars + }; + } +}); + +tape( 'the constructor will throw an error if provided an invalid options argument (headers argument)', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + null, + void 0, + true, + false, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = new UnicodeTable( [ [ 1, 3 ], [ 4, 6 ] ], [ 'col1', 'col2' ], value ); // eslint-disable-line no-unused-vars + }; + } +}); + +tape( 'the constructor throws an error if provided an invalid option (no headers argument)', function test( t ) { + t.throws( foo, TypeError, 'throws an error' ); + t.end(); + + function foo() { + // eslint-disable-next-line no-unused-vars + var table = new UnicodeTable( [ [ 1, 3 ], [ 4, 6 ] ], { + 'alignment': [] + }); + } +}); + +tape( 'the constructor throws an error if provided an invalid option (headers argument)', function test( t ) { + t.throws( foo, TypeError, 'throws an error' ); + t.end(); + + function foo() { + // eslint-disable-next-line no-unused-vars + var table = new UnicodeTable( [ [ 1, 3 ], [ 4, 6 ] ], [ 'col1', 'col2' ], { + 'alignment': [] + }); + } +}); + +tape( 'an instance has a `addRow` method for adding a row', function test( t ) { + var table = new UnicodeTable(); + t.strictEqual( typeof table.addRow, 'function', 'has addRow method' ); + t.end(); +}); + +tape( 'an instance has a `setData` method for setting data', function test( t ) { + var table = new UnicodeTable(); + t.strictEqual( typeof table.setData, 'function', 'has setData method' ); + t.end(); +}); + +tape( 'an instance has a `getData` method for getting data', function test( t ) { + var table = new UnicodeTable(); + t.strictEqual( typeof table.getData, 'function', 'has getData method' ); + t.end(); +}); + +tape( 'an instance has a `render` method for rendering the table', function test( t ) { + var table = new UnicodeTable(); + t.strictEqual( typeof table.render, 'function', 'has render method' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js new file mode 100644 index 000000000000..09a773b014e4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `marginX` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.marginX = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'marginX': 2 + }); + t.strictEqual( table.marginX, 2, 'returns expected value' ); + + table.marginX = 3; + t.strictEqual( table.marginX, 3, 'returns expected value' ); + + table.marginX = 0; + t.strictEqual( table.marginX, 0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js new file mode 100644 index 000000000000..da4835b2aecd --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `marginY` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.marginY = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'marginY': 2 + }); + t.strictEqual( table.marginY, 2, 'returns expected value' ); + + table.marginY = 3; + t.strictEqual( table.marginY, 3, 'returns expected value' ); + + table.marginY = 0; + t.strictEqual( table.marginY, 0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js new file mode 100644 index 000000000000..068a06340878 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `maxCellWidth` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.maxCellWidth = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'maxCellWidth': 2 + }); + t.strictEqual( table.maxCellWidth, 2, 'returns expected value' ); + + table.maxCellWidth = 3; + t.strictEqual( table.maxCellWidth, 3, 'returns expected value' ); + + table.maxCellWidth = 0; + t.strictEqual( table.maxCellWidth, 0, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js new file mode 100644 index 000000000000..b14fd3c80873 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `maxOutputWidth` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.maxOutputWidth = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'maxOutputWidth': 20 + }); + t.strictEqual( table.maxOutputWidth, 20, 'returns expected value' ); + + table.maxOutputWidth = 30; + t.strictEqual( table.maxOutputWidth, 30, 'returns expected value' ); + + table.maxOutputWidth = 10; + t.strictEqual( table.maxOutputWidth, 10, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js new file mode 100644 index 000000000000..d12666c551ba --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js @@ -0,0 +1,240 @@ +/** +* @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 tape = require( 'tape' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function sets the table data for an array of objects (with headers)', function test( t ) { + var expected; + var headers; + var table; + var data; + var v; + + data = [ + { + 'col1': 'hello', + 'col2': 45, + 'col3': true + }, + { + 'col1': null, + 'col3': 45.3 + } + ]; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor(); + + table.setData( data, headers ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 'hello', 45, true ], [ null, undefined, 45.3 ] ]; + expected.headers = [ 'col1', 'col2', 'col3' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for an array of objects (without headers)', function test( t ) { + var expected; + var table; + var data; + var v; + + data = [ + { + 'col1': 'hello', + 'col2': 45, + 'col3': true + }, + { + 'col1': null, + 'col3': 45.3 + } + ]; + table = ctor(); + + table.setData( data ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 'hello', 45, true ], [ null, undefined, 45.3 ] ]; + expected.headers = [ 'col1', 'col2', 'col3' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for an object of columns (with headers)', function test( t ) { + var expected; + var headers; + var table; + var data; + var v; + + data = { + 'col1': [ 'hello', true ], + 'col2': [ null, 45 ] + }; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor(); + + table.setData( data, headers ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 'hello', null ], [ true, 45 ] ]; + expected.headers = [ 'col1', 'col2' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for an object of columns (without headers)', function test( t ) { + var expected; + var table; + var data; + var v; + + data = { + 'col1': [ 'hello', true ], + 'col2': [ null, 45 ] + }; + table = ctor(); + + table.setData( data ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 'hello', null ], [ true, 45 ] ]; + expected.headers = [ 'col1', 'col2' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for an array of arrays (with headers)', function test( t ) { + var expected; + var headers; + var table; + var data; + var v; + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor(); + + table.setData( data, headers ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + expected.headers = [ 'col1', 'col2', 'col3' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for an array of arrays (without headers)', function test( t ) { + var expected; + var table; + var data; + var v; + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table = ctor(); + + table.setData( data ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + expected.headers = null; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for a matrix-like ndarray (with headers)', function test( t ) { + var expected; + var headers; + var buffer; + var table; + var data; + var v; + + buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; + data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); + headers = [ 'col1', 'col2', 'col3', 'col4' ]; + table = ctor(); + + table.setData( data, headers ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 14, 2, 'hello', false ], [ 32.54, true, null, 'bye' ], [ 9, 10, 11, 12 ] ]; + expected.headers = [ 'col1', 'col2', 'col3', 'col4' ]; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function sets the table data for a matrix-like ndarray (without headers)', function test( t ) { + var expected; + var buffer; + var table; + var data; + var v; + + buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; + data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); + table = ctor(); + + table.setData( data ); + v = table.getData(); + + expected = {}; + expected.data = [ [ 14, 2, 'hello', false ], [ 32.54, true, null, 'bye' ], [ 9, 10, 11, 12 ] ]; + expected.headers = null; + + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js new file mode 100644 index 000000000000..c3870e155e4c --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js @@ -0,0 +1,417 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns an empty string if no table data provided ', function test( t ) { + var table; + var str; + + table = ctor(); + + str = table.render(); + t.strictEqual( str, '', 'returns empty string' ); + + t.end(); +}); + +tape( 'the function supports rendering a table', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (without headers)', function test( t ) { + var expected; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.setData( data ); + + expected = [ + '┌───────┬──────┬───────┐', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (with row separators)', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.rowSeparator = '─'; + + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '├───────┼──────┼───────┤', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (without borders)', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.borders = 'None'; + + expected = [ + ' col1 │ col2 │ col3 ', + '───────┼──────┼───────', + ' 45 │ 33 │ hello ', + ' 32.54 │ true │ null ' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (without column separators)', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.columnSeparator = 'None'; + + expected = [ + '┌────────────────────┐', + '│ col1 col2 col3 │', + '├────────────────────┤', + '│ 45 33 hello │', + '│ 32.54 true null │', + '└────────────────────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (without header separator)', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.headerSeparator = 'None'; + + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (without corners)', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.corners = 'None'; + + expected = [ + ' ───────┬──────┬─────── ', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + ' ───────┴──────┴─────── ' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table (without joints)', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.joints = 'None'; + + expected = [ + '┌─────── ────── ───────┐', + '│ col1 │ col2 │ col3 │', + ' ─────── ────── ─────── ', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└─────── ────── ───────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table with a margin', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.marginX = 1; + table.marginY = 1; + + expected = [ + '', + ' ┌───────┬──────┬───────┐ ', + ' │ col1 │ col2 │ col3 │ ', + ' ├───────┼──────┼───────┤ ', + ' │ 45 │ 33 │ hello │ ', + ' │ 32.54 │ true │ null │ ', + ' └───────┴──────┴───────┘ ', + '' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table with truncated data', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.maxCellWidth = 4; + + expected = [ + '┌──────┬──────┬──────┐', + '│ col1 │ col2 │ col3 │', + '├──────┼──────┼──────┤', + '│ 45 │ 33 │ h... │', + '│ 3... │ true │ null │', + '└──────┴──────┴──────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table with different alignments', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + + table.alignment = 'right'; + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns right-aligned rendered table' ); + + table.alignment = 'left'; + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns left-aligned rendered table' ); + + table.alignment = 'center'; + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns center-aligned rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a wrapped table for long outputs', function test( t ) { + var expected; + var headers; + var table; + var data; + var str; + + table = ctor(); + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table.setData( data, headers ); + table.maxOutputWidth = 16; + + expected = [ + '┌───────┬──────┐', + '│ col1 │ col2 │', + '├───────┼──────┤', + '│ 45 │ 33 │', + '│ 32.54 │ true │', + '└───────┴──────┘', + '┌───────┐', + '│ col3 │', + '├───────┤', + '│ hello │', + '│ null │', + '└───────┘' + ].join( '\n' ); + + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js new file mode 100644 index 000000000000..2e34d82bed3e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js @@ -0,0 +1,80 @@ +/** +* @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 tape = require( 'tape' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `rowSeparator` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + '5437' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.rowSeparator = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var data = null; + + table = ctor( data, { + 'rowSeparator': '1' + }); + t.strictEqual( table.rowSeparator, '1', 'returns expected value' ); + + table.rowSeparator = '!'; + t.strictEqual( table.rowSeparator, '!', 'returns expected value' ); + + table.rowSeparator = 'None'; + t.strictEqual( table.rowSeparator, 'None', 'returns expected value' ); + + t.end(); +}); From 8ab53e7c5f130cc3c2e41932765fce9a8c89a7af Mon Sep 17 00:00:00 2001 From: Snehil Shah Date: Sat, 20 Jul 2024 19:52:27 +0000 Subject: [PATCH 02/34] refactor: update table from code review Signed-off-by: Snehil Shah --- .../@stdlib/plot/table/unicode/README.md | 326 ++++++++++--- .../plot/table/unicode/benchmark/benchmark.js | 408 ++++++++++++++-- .../unicode/benchmark/benchmark.render.js | 52 +- .../@stdlib/plot/table/unicode/docs/repl.txt | 108 +++-- .../plot/table/unicode/examples/index.js | 14 +- .../plot/table/unicode/lib/defaults.js | 25 +- .../@stdlib/plot/table/unicode/lib/index.js | 10 + .../@stdlib/plot/table/unicode/lib/main.js | 450 ++++++++++++++---- .../unicode/lib/{setdata.js => parse.js} | 41 +- .../unicode/lib/parser/parse_2d_array.js | 4 +- .../table/unicode/lib/parser/parse_headers.js | 58 +++ .../table/unicode/lib/parser/parse_object.js | 46 +- .../unicode/lib/parser/parse_objects_list.js | 6 + .../table/unicode/lib/props/alignment/get.js | 14 +- .../table/unicode/lib/props/alignment/set.js | 41 +- .../{cell-padding => auto-render}/get.js | 6 +- .../{cell-padding => auto-render}/set.js | 19 +- .../table/unicode/lib/props/borders/get.js | 7 +- .../table/unicode/lib/props/borders/set.js | 26 +- .../{getdata.js => props/buffer-size/get.js} | 13 +- .../unicode/lib/props/buffer-size/set.js | 60 +++ .../lib/props/cell-padding-left/get.js | 45 ++ .../lib/props/cell-padding-left/set.js | 62 +++ .../lib/props/cell-padding-right/get.js | 45 ++ .../lib/props/cell-padding-right/set.js | 62 +++ .../unicode/lib/props/column-separator/get.js | 2 +- .../unicode/lib/props/column-separator/set.js | 17 +- .../table/unicode/lib/props/corners/get.js | 8 +- .../table/unicode/lib/props/corners/set.js | 35 +- .../plot/table/unicode/lib/props/data/get.js | 45 ++ .../plot/table/unicode/lib/props/data/set.js | 72 +++ .../unicode/lib/props/header-separator/get.js | 2 +- .../unicode/lib/props/header-separator/set.js | 17 +- .../table/unicode/lib/props/headers/get.js | 45 ++ .../table/unicode/lib/props/headers/set.js | 63 +++ .../props/horizontal-separator-mode/get.js | 35 ++ .../props/horizontal-separator-mode/set.js | 56 +++ .../table/unicode/lib/props/joints/get.js | 8 +- .../table/unicode/lib/props/joints/set.js | 35 +- .../table/unicode/lib/props/margin-x/set.js | 5 +- .../table/unicode/lib/props/margin-y/set.js | 5 +- .../unicode/lib/props/max-cell-width/get.js | 14 +- .../unicode/lib/props/max-cell-width/set.js | 49 +- .../unicode/lib/props/max-output-width/set.js | 19 +- .../unicode/lib/props/row-separator/get.js | 2 +- .../unicode/lib/props/row-separator/set.js | 17 +- .../lib/props/vertical-separator-mode/get.js | 35 ++ .../lib/props/vertical-separator-mode/set.js | 56 +++ .../table/unicode/lib/{addrow.js => push.js} | 27 +- .../@stdlib/plot/table/unicode/lib/render.js | 170 +++++-- .../plot/table/unicode/test/test.add_row.js | 79 --- .../plot/table/unicode/test/test.alignment.js | 74 ++- .../table/unicode/test/test.auto_render.js | 152 ++++++ .../plot/table/unicode/test/test.borders.js | 64 ++- .../table/unicode/test/test.buffer_size.js | 146 ++++++ .../table/unicode/test/test.cell_padding.js | 80 ---- .../unicode/test/test.cell_padding_left.js | 143 ++++++ .../unicode/test/test.cell_padding_right.js | 143 ++++++ .../unicode/test/test.column_separator.js | 48 +- .../plot/table/unicode/test/test.corners.js | 64 ++- .../plot/table/unicode/test/test.data.js | 177 +++++++ .../unicode/test/test.header_separator.js | 48 +- .../plot/table/unicode/test/test.headers.js | 138 ++++++ .../test/test.horizontal_separator_mode.js | 119 +++++ .../plot/table/unicode/test/test.joints.js | 64 ++- .../plot/table/unicode/test/test.main.js | 50 +- .../plot/table/unicode/test/test.margin_x.js | 42 +- .../plot/table/unicode/test/test.margin_y.js | 42 +- .../table/unicode/test/test.max_cell_width.js | 84 +++- .../unicode/test/test.max_output_width.js | 38 +- .../plot/table/unicode/test/test.parse.js | 337 +++++++++++++ .../plot/table/unicode/test/test.parser.js | 240 ---------- .../plot/table/unicode/test/test.push.js | 133 ++++++ .../plot/table/unicode/test/test.render.js | 275 +++++++---- .../table/unicode/test/test.row_separator.js | 48 +- .../test/test.vertical_separator_mode.js | 119 +++++ 76 files changed, 4587 insertions(+), 1147 deletions(-) rename lib/node_modules/@stdlib/plot/table/unicode/lib/{setdata.js => parse.js} (67%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{cell-padding => auto-render}/get.js (87%) rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{cell-padding => auto-render}/set.js (67%) rename lib/node_modules/@stdlib/plot/table/unicode/lib/{getdata.js => props/buffer-size/get.js} (79%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/{addrow.js => push.js} (61%) delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index ccbb89363aa4..98d9eeb72097 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -41,17 +41,50 @@ var table = new UnicodeTable(); The constructor accepts the following `options`: - **alignment**: datum's cell alignment. Default: `'right'`. -- **borders**: border characters. Default: `'─ │ ─ │'`. -- **cellPadding**: cell padding. Default: `1`. -- **columnSeparator**: column separator character. Default: `'│'`. -- **corners**: corner characters. Default: `'┌ ┐ ┘ └'`. -- **headerSeparator**: header separator character. Default: `'─'`. -- **joints**: joint characters. Default: `'┼ ┬ ┤ ┴ ├'`. + +- **autoRender**: `boolean` indicating whether to re-render on a `change` event. Default: `false`. + +- **borders**: border characters. Default: `[ '─', '│', '─', '│' ]`. + +- **bufferSize**: data buffer size. If provided, data is kept in a first-in first-out (FIFO) buffer which cannot exceed the buffer size. Default: `+infinity`. + +- **cellPaddingLeft**: cell's left padding. Default: `1`. + +- **cellPaddingRight**: cell's right padding. Default: `1`. + +- **columnSeparator**: column separator character(s). Default: `'│'`. + +- **corners**: corner characters. Default: `[ '┌', '┐', '┘', '└' ]`. + +- **headerSeparator**: header separator character(s). Default: `'─'`. + +- **horizontalSeparatorMode**: 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`. + +- **joints**: joint characters. Default: `[ '┼', '┬', '┤', '┴', '├' ]`. + - **marginX**: horizontal output margin. Default: `0`. + - **marginY**: vertical output margin. Default: `0`. -- **maxCellWidth**: maximum cell width (excluding padding). Default: `FLOAT64_MAX`. -- **maxOutputWidth**: maximum output width (including margin). Default: `FLOAT64_MAX`. -- **rowSeparator**: row separator character. Default: `'None'`. + +- **maxCellWidth**: maximum cell width(s). Default: `+infinity`. + +- **maxOutputWidth**: maximum output width. Default: `+infinity`. + +- **rowSeparator**: row separator character(s). Default: `''`. + +- **verticalSeparatorMode**: 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`. * * * @@ -61,7 +94,7 @@ The constructor accepts the following `options`: #### UnicodeTable.prototype.alignment -Alignment of datum in cell. The value must be either `'right'`, `'left'` or `'center'`. +Alignment(s) of datum in cell. The value must be either `'right'`, `'left'`, or `'center'` or an array of them. ```javascript var table = new UnicodeTable(); @@ -72,64 +105,131 @@ table.alignment = 'center'; // Get: var alignment = table.alignment; // returns 'center' + +// Set: +table.alignment = [ 'left', 'right', 'center' ]; + +// Get: +alignment = table.alignment; +// returns [ 'left', 'right', 'center' ] +``` + + + +#### UnicodeTable.prototype.autoRender + +Rendering mode. If `true`, an instance renders on each `'change'` event; otherwise, rendering must be triggered manually. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.autoRender = false; + +// Get: +var mode = table.autoRender; +// returns false ``` #### UnicodeTable.prototype.borders -Border characters. String must be four space separated characters in the order 'top right bottom left'. A value of `'None'` indicates no border would be rendered. +Border characters. Must be an array of `four` strings in the order `[ 'top', 'right', 'bottom', 'left' ]`. ```javascript var table = new UnicodeTable(); // Set: -table.borders = '= ! = !'; +table.borders = [ '=', '!', '=', '!' ]; // Get: var borders = table.borders; -// returns '= ! = !' +// returns [ '=', '!', '=', '!' ] +``` + + + +#### UnicodeTable.prototype.bufferSize + +Data buffer size. If set, this specifies the maximum number of rows which can be rendered. Once the data buffer is full, each new row results in the oldest row being removed. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.bufferSize = 3; + +// Get: +var size = table.bufferSize; +// returns 3 + +table.data = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]; + +var data = table.data; +// returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] + +table.push( [ 7, 8 ] ); + +data = table.data; +// returns [ [ 3, 4 ], [ 5, 6 ], [ 7, 8 ] ] ``` - +Setting a data buffer size is useful when rendering data streams. + + -#### UnicodeTable.prototype.cellPadding +#### UnicodeTable.prototype.cellPaddingLeft -Cell padding. Pads each side of the cell with whitespace characters. +Cell's left padding(s). Pads the left side of the cell with whitespace characters. Pad each cell individually by providing an array of paddings. ```javascript var table = new UnicodeTable(); // Set: -table.cellPadding = 3; +table.cellPaddingLeft = 3; // Get: -var padding = table.cellPadding; +var padding = table.cellPaddingLeft; // returns 3 + +// Set: +table.cellPaddingLeft = [ 3, 4 ]; + +// Get: +padding = table.cellPaddingLeft; +// returns [ 3, 4 ] ``` - + -#### UnicodeTable.prototype.corners +#### UnicodeTable.prototype.cellPaddingRight -Corner characters. String must be four space separated characters in the order 'top-left top-right bottom-right bottom-left'. A value of `'None'` indicates no corners would be rendered. +Cell's right padding(s). Pads the right side of the cell with whitespace characters. Pad each cell individually by providing an array of paddings. ```javascript var table = new UnicodeTable(); // Set: -table.corners = '* * * *'; +table.cellPaddingRight = 3; // Get: -var corners = table.corners; -// returns '* * * *' +var padding = table.cellPaddingRight; +// returns 3 + +// Set: +table.cellPaddingRight = [ 3, 4 ]; + +// Get: +padding = table.cellPaddingRight; +// returns [ 3, 4 ] ``` #### UnicodeTable.prototype.columnSeparator -Column Separator character. Must be a character string or `'None'`. A value of `'None'` indicates that columns won't be separated. +Column separator character(s). If provided a string with multiple graphmeme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. ```javascript var table = new UnicodeTable(); @@ -142,11 +242,62 @@ var separator = table.columnSeparator; // returns '|' ``` + + +#### UnicodeTable.prototype.corners + +Corner characters. Must be an array of `four` grapheme clusters in the order `[ 'top-left', 'top-right', 'bottom-right', 'bottom-left' ]`. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.corners = [ '*', '*', '*', '*' ]; + +// Get: +var corners = table.corners; +// returns [ '*', '*', '*', '*' ] +``` + + + +#### UnicodeTable.prototype.data + +Table data. Must be an array of arrays or a MatrixLike ndarray and should not exceed the `bufferSize`. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.data = [ [ 1, 2 ], [ 3, 4 ] ]; + +// Get: +var data = table.data; +// returns [ [ 1, 2 ], [ 3, 4 ] ] +``` + + + +#### UnicodeTable.prototype.headers + +Table headers. Must be an array. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.headers = [ 'A', 'B' ]; + +// Get: +var headers = table.headers; +// returns [ 'A', 'B' ] +``` + #### UnicodeTable.prototype.headerSeparator -Header Separator character. Must be a character string or `'None'`. A value of `'None'` indicates that headers won't be separated from the data. +Header separator character(s). If provided a string with multiple graphmeme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. ```javascript var table = new UnicodeTable(); @@ -159,21 +310,42 @@ var separator = table.headerSeparator; // returns '-' ``` + + +#### UnicodeTable.prototype.horizontalSeparatorMode + +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. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.horizontalSeparatorMode = 'interpolate'; + +// Get: +var mode = table.horizontalSeparatorMode; +// returns 'interpolate' +``` + #### UnicodeTable.prototype.joints -Joint characters. String must be five space separated characters in the order 'middle top right bottom left'. A value of `'None'` indicates no joints would be rendered. +Joint characters. Must be an array of `five` grapheme clusters in the order `[ 'middle', 'top', 'right', 'bottom', 'left' ]`. ```javascript var table = new UnicodeTable(); // Set: -table.joints = '* * * * *'; +table.joints = [ '*', '*', '*', '*', '*' ]; // Get: var joints = table.joints; -// returns '* * * * *' +// returns [ '*', '*', '*', '*', '*' ] ``` @@ -214,7 +386,7 @@ var margin = table.marginY; #### UnicodeTable.prototype.maxCellWidth -Maximum cell width. If a datum is longer than the maximum cell width, it is truncated. +Maximum cell width. If a datum is longer than the maximum cell width, it is truncated. Truncate each cell individually by providing an array of widhts. ```javascript var table = new UnicodeTable(); @@ -225,6 +397,12 @@ table.maxCellWidth = 10; // Get: var width = table.maxCellWidth; // returns 10 + +// Set: +table.maxCellWidth = [ 10, 15 ]; + +// Get: +width = table.maxCellWidth; ``` @@ -248,7 +426,7 @@ var width = table.maxOutputWidth; #### UnicodeTable.prototype.rowSeparator -Row Separator character. Must be a character string or `'None'`. A value of `'None'` indicates that rows won't be separated. +Row separator character(s). If provided a string with multiple graphmeme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. ```javascript var table = new UnicodeTable(); @@ -261,39 +439,50 @@ var separator = table.rowSeparator; // returns '-' ``` -* * * - -### Methods + - +#### UnicodeTable.prototype.verticalSeparatorMode -#### UnicodeTable.prototype.addRow( row ) +Vertical line separator mode. The following modes are supported: -Adds a row to table data. The row must have the same number of columns as existing data. +- `resume`: resume line sequence after a joint. +- `interpolate`: skip line character at a joint. +- `repeat`: repeat line sequence after a joint. ```javascript -var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); - -var data = table.getData().data; -// returns [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] +var table = new UnicodeTable(); -table.addRow( [ 7, 8, 9 ] ); +// Set: +table.verticalSeparatorMode = 'interpolate'; -data = table.getData().data; -// returns [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ] +// Get: +var mode = table.verticalSeparatorMode; +// returns 'interpolate' ``` - +* * * -#### UnicodeTable.prototype.getData() +### Methods -Gets table data and headers. + + +#### UnicodeTable.prototype.push( row ) + +Appends a row to table data. The row must have the same number of columns as existing data. ```javascript -var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); +var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); -var data = table.getData(); -// returns { 'data': [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], 'headers': [ 'col1', 'col2', 'col3' ] } +// Get: +var data = table.data; +// returns [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] + +// Push: +table.push( [ 7, 8, 9 ] ); + +// Get: +data = table.data; +// returns [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ] ``` @@ -303,27 +492,18 @@ var data = table.getData(); Renders a Unicode table. ```javascript -var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); +var headers; +var table; +var data; + +headers = [ 'col1', 'col2', 'col3' ]; +data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; +table = new UnicodeTable( data, headers ); var str = table.render(); // returns '...' ``` - - -#### UnicodeTable.prototype.setData() - -Sets table data and headers. - -```javascript -var table = new UnicodeTable(); - -table.setData( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); - -var data = table.getData(); -// returns { 'data': [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], 'headers': [ 'col1', 'col2', 'col3' ] } -``` - * * * @@ -347,8 +527,7 @@ var data = table.getData(); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var array = require( '@stdlib/ndarray/array' ); var ctor = require( '@stdlib/plot/table/unicode' ); @@ -356,22 +535,15 @@ var headers; var table; var data; var str; -var i; // Generate some random data... -data = new Float64Array( 50 ); -for ( i = 0; i < data.length; i++ ) { - data[ i ] = randu() * 100.0; -} +data = uniform( 50, 1, 100 ); data = array( data, { 'shape': [ 10, 5 ] }); // Generate headers... -headers = new Float64Array( 5 ); -for ( i = 0; i < headers.length; i++ ) { - headers[ i ] = randu() * 100.0; -} +headers = [ 'A', 'B', 'C', 'D', 'E' ]; // Create a table: table = ctor( data, headers ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index 0e81b8561fac..14b46d529cc6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -21,6 +21,7 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); var pkg = require( './../package.json' ).name; var UnicodeTable = require( './../lib' ); @@ -112,17 +113,22 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { opts = { 'alignment': 'left', - 'borders': '1 2 3 4', - 'cellPadding': 2, + 'autoRender': false, + 'borders': [ '1', '23', '456', '7890' ], + 'bufferSize': 10, + 'cellPaddingLeft': 2, + 'cellPaddingRight': [ 2, 3, 4 ], 'columnSeparator': 'None', - 'corners': '* * * *', - 'headerSeparator': '-', - 'joints': '* * * * *', + 'corners': [ '*', '*', '*', '*' ], + 'headerSeparator': '-=', + 'horizontalSeparatorMode': 'repeat', + 'joints': [ '*', '*', '*', '*', '*' ], 'marginX': 2, 'marginY': 4, 'maxCellWidth': 10, 'maxOutputWidth': 60, - 'rowSeparator': '_' + 'rowSeparator': '_-', + 'verticalSeparatorMode': 'resume' }; b.tic(); for ( i = 0; i < b.iterations; i++ ) { @@ -146,17 +152,22 @@ bench( pkg+'::instantiation,data,headers,options', function benchmark( b ) { opts = { 'alignment': 'left', - 'borders': '1 2 3 4', - 'cellPadding': 2, + 'autoRender': false, + 'borders': [ '1', '23', '456', '7890' ], + 'bufferSize': 10, + 'cellPaddingLeft': 2, + 'cellPaddingRight': [ 2, 3, 4 ], 'columnSeparator': 'None', - 'corners': '* * * *', - 'headerSeparator': '-', - 'joints': '* * * * *', + 'corners': [ '*', '*', '*', '*' ], + 'headerSeparator': '-=', + 'horizontalSeparatorMode': 'repeat', + 'joints': [ '*', '*', '*', '*', '*' ], 'marginX': 2, 'marginY': 4, 'maxCellWidth': 10, 'maxOutputWidth': 60, - 'rowSeparator': '_' + 'rowSeparator': '_-', + 'verticalSeparatorMode': 'resume' }; b.tic(); for ( i = 0; i < b.iterations; i++ ) { @@ -173,7 +184,7 @@ bench( pkg+'::instantiation,data,headers,options', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:alignment', function benchmark( b ) { +bench( pkg+'::set,get:alignment:string', function benchmark( b ) { var values; var v; var i; @@ -193,41 +204,123 @@ bench( pkg+'::set,get:alignment', function benchmark( b ) { } } b.toc(); - if ( typeof v.borders !== 'string' ) { + if ( typeof v.alignment !== 'string' ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); +bench( pkg+'::set,get:alignment:array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 'left', 'right' ], + [ 'center', 'right' ], + [ 'left', 'center' ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.alignment = values[ i % values.length ]; + if ( typeof v.alignment !== 'object' || !v.alignment.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.alignment !== 'object' || !v.alignment.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:autoRender', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + false, + true + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.autoRender = values[ i % values.length ]; + if ( typeof v.autoRender !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( typeof v.autoRender !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:borders', function benchmark( b ) { var values; var v; var i; values = [ - '1 2 3 4', - '- | - |', - 'None' + [ '-', '|', '-', '|' ], + [ '1', '23', '456', '7890' ], + [ '', '', '', '' ], + [ '🌹', '🥀', '🔥', '👍' ] ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.borders = values[ i % values.length ]; - if ( typeof v.borders !== 'string' ) { - b.fail( 'should return a string' ); + if ( typeof v.borders !== 'object' || !v.borders.length ) { + b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.borders !== 'string' ) { - b.fail( 'should return a string' ); + if ( typeof v.borders !== 'object' || !v.borders.length ) { + b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:cellPadding', function benchmark( b ) { +bench( pkg+'::set,get:bufferSize', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 1, + 2, + 3, + null + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.bufferSize = values[ i % values.length ]; + if ( typeof v.bufferSize !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.bufferSize !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:cellPaddingLeft:number', function benchmark( b ) { var values; var v; var i; @@ -241,19 +334,100 @@ bench( pkg+'::set,get:cellPadding', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.cellPadding = values[ i % values.length ]; - if ( typeof v.cellPadding !== 'number' ) { + v.cellPaddingLeft = values[ i % values.length ]; + if ( typeof v.cellPaddingLeft !== 'number' ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.cellPadding !== 'number' ) { + if ( typeof v.cellPaddingLeft !== 'number' ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); b.end(); }); +bench( pkg+'::set,get:cellPaddingLeft:array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 1, 2 ], + [ 3, 4 ], + [ 5, 6 ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.cellPaddingLeft = values[ i % values.length ]; + if ( typeof v.cellPaddingLeft !== 'object' || !v.cellPaddingLeft.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.cellPaddingLeft !== 'object' || !v.cellPaddingLeft.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:cellPaddingRight:number', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 1, + 2, + 3 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.cellPaddingRight = values[ i % values.length ]; + if ( typeof v.cellPaddingRight !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.cellPaddingRight !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:cellPaddingRight:array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 1, 2 ], + [ 3, 4 ], + [ 5, 6 ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.cellPaddingRight = values[ i % values.length ]; + if ( typeof v.cellPaddingRight !== 'object' || !v.cellPaddingRight.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.cellPaddingRight !== 'object' || !v.cellPaddingRight.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { var values; var v; @@ -261,7 +435,9 @@ bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { values = [ '|', - 'None' + '123', + '🥀', + '' ]; v = new UnicodeTable(); @@ -286,22 +462,73 @@ bench( pkg+'::set,get:corners', function benchmark( b ) { var i; values = [ - '1 2 3 4', - '* * * *', - 'None' + [ '-', '|', '-', '|' ], + [ '🌹', '🥀', '🔥', '👍' ] ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.corners = values[ i % values.length ]; - if ( typeof v.corners !== 'string' ) { - b.fail( 'should return a string' ); + if ( typeof v.corners !== 'object' || !v.corners.length ) { + b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.corners !== 'string' ) { - b.fail( 'should return a string' ); + if ( typeof v.corners !== 'object' || !v.corners.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:data', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], + ndarray( 'generic', [ 1, 2, 3, 4, 5, 6 ], [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ) + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.data = values[ i % values.length ]; + if ( typeof v.data !== 'object' || !v.data.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.data !== 'object' || !v.data.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:headers', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 'col1', 'col2', 'col3' ], + [ 1, 2, 3] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.headers = values[ i % values.length ]; + if ( typeof v.headers !== 'object' || !v.headers.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.headers !== 'object' || !v.headers.length ) { + b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); b.end(); @@ -313,8 +540,10 @@ bench( pkg+'::set,get:headerSeparator', function benchmark( b ) { var i; values = [ - '-', - 'None' + '|', + '123', + '🥀', + '' ]; v = new UnicodeTable(); @@ -333,33 +562,59 @@ bench( pkg+'::set,get:headerSeparator', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:joints', function benchmark( b ) { +bench( pkg+'::set,get:horizontalSeparatorMode', function benchmark( b ) { var values; var v; var i; values = [ - '1 2 3 4 5', - '* * * * *', - 'None' + 'repeat', + 'resume', + 'interpolate' ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.joints = values[ i % values.length ]; - if ( typeof v.joints !== 'string' ) { + v.horizontalSeparatorMode = values[ i % values.length ]; + if ( typeof v.horizontalSeparatorMode !== 'string' ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.joints !== 'string' ) { + if ( typeof v.horizontalSeparatorMode !== 'string' ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); +bench( pkg+'::set,get:joints', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ '-', '|', '-', '|', '=' ], + [ '🌹', '🥀', '🔥', '👍', '📸' ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.joints = values[ i % values.length ]; + if ( typeof v.joints !== 'object' || !v.joints.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.joints !== 'object' || !v.joints.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:marginX', function benchmark( b ) { var values; var v; @@ -414,7 +669,7 @@ bench( pkg+'::set,get:marginY', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:maxCellWidth', function benchmark( b ) { +bench( pkg+'::set,get:maxCellWidth:number', function benchmark( b ) { var values; var v; var i; @@ -422,7 +677,8 @@ bench( pkg+'::set,get:maxCellWidth', function benchmark( b ) { values = [ 10, 20, - 30 + 30, + null ]; v = new UnicodeTable(); @@ -441,6 +697,34 @@ bench( pkg+'::set,get:maxCellWidth', function benchmark( b ) { b.end(); }); +bench( pkg+'::set,get:maxCellWidth:array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 1, 2, 3 ], + [ 4, 5, 6 ], + [ 7, null, 9 ], + [ null, null, null ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.maxCellWidth = values[ i % values.length ]; + if ( typeof v.maxCellWidth !== 'object' || !v.maxCellWidth.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.maxCellWidth !== 'object' || !v.maxCellWidth.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:maxOutputWidth', function benchmark( b ) { var values; var v; @@ -449,7 +733,8 @@ bench( pkg+'::set,get:maxOutputWidth', function benchmark( b ) { values = [ 100, 200, - 300 + 300, + null ]; v = new UnicodeTable(); @@ -474,8 +759,10 @@ bench( pkg+'::set,get:rowSeparator', function benchmark( b ) { var i; values = [ - '-', - 'None' + '|', + '123', + '🥀', + '' ]; v = new UnicodeTable(); @@ -493,3 +780,30 @@ bench( pkg+'::set,get:rowSeparator', function benchmark( b ) { b.pass( 'benchmark finished' ); b.end(); }); + +bench( pkg+'::set,get:verticalSeparatorMode', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 'repeat', + 'resume', + 'interpolate' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.verticalSeparatorMode = values[ i % values.length ]; + if ( typeof v.verticalSeparatorMode !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.verticalSeparatorMode !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js index 79f812e10670..11c989b4bbd1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js @@ -37,45 +37,42 @@ var UnicodeTable = require( './../lib' ); * @private * @param {PositiveInteger} rows - number of rows * @param {PositiveInteger} columns - number of columns -* @param {UnicodeSparkline} table - table instance +* @param {UnicodeTable} table - table instance * @returns {Function} benchmark function */ function createBenchmark( rows, columns, table ) { - return benchmark; - - /** - * Generates table data. - * - * @private - * @returns {ndarray} table data - */ - function data() { - var data; - var i; + 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 ] - }); - return data; + 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 table headers. + * Generates a row of table data. * * @private - * @returns {Float64Array} table data + * @returns {Array} table data */ - function headers() { + function row() { var data; var i; - data = new Float64Array( columns ); - for ( i = 0; i < data.length; i++ ) { - data[ i ] = randu(); + data = []; + for ( i = 0; i < columns; i++ ) { + data.push( randu() ); } return data; } @@ -92,7 +89,7 @@ function createBenchmark( rows, columns, table ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - str = table.setData( data(), headers() ).render(); + str = table.push( row() ).render(); if ( typeof str !== 'string' ) { b.fail( 'should return a string' ); } @@ -133,6 +130,7 @@ function main() { columns = pow( 5, j ); table = new UnicodeTable(); + table.bufferSize = rows; f = createBenchmark( rows, columns, table ); bench( pkg+':render:rows='+rows+',columns='+columns, f ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index 7200f71b2983..0947404ced32 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -13,26 +13,48 @@ options: Object (optional) Table options. - options.alignment: string (optional) - Datum's cell alignment. Default: 'right'. + options.alignment: Array|string (optional) + Datum's cell alignment(s). Default: 'right'. - options.borders: string (optional) - Border characters. Default: '─ │ ─ │'. + options.autoRender: boolean (optional) + Boolean indicating whether to re-render on a 'change' event. Default: + false. - options.cellPadding: NonNegativeInteger (optional) - Cell padding. Default: 1. + options.borders: Array (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 + (optional) + Cell's left padding(s). Default: 1. + + options.cellPaddingRight: Array|NonNegativeInteger + (optional) + Cell's right padding(s). Default: 1. options.columnSeparator: string (optional) - Column separator character. Default: '│'. + Column separator character(s). Default: '│'. - options.corners: string (optional) - Corner characters. Default: '┌ ┐ ┘ └'. + options.corners: Array (optional) + Corner characters. Default: [ '┌', '┐', '┘', '└' ]. options.headerSeparator: string (optional) - Header separator character. Default: '─'. + 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. - options.joints: string (optional) - Joint characters. Default: '┼ ┬ ┤ ┴ ├'. + Default: `resume`. + + options.joints: Array (optional) + Joint characters. Default: [ '┼', '┬', '┤', '┴', '├' ]. options.marginX: NonNegativeInteger (optional) Horizontal output margin. Default: 0. @@ -40,40 +62,63 @@ options.marginY: NonNegativeInteger (optional) Vertical output margin. Default: 0. - options.maxCellWidth: NonNegativeInteger (optional) - Maximum cell width (excluding padding). Default: FLOAT64_MAX. + options.maxCellWidth: Array|NonNegativeInteger|null + (optional) + Maximum cell width(s). Default: +infinity. - options.maxOutputWidth: NonNegativeInteger (optional) - Maximum output width (including margin). Default: FLOAT64_MAX. + options.maxOutputWidth: NonNegativeInteger|null (optional) + Maximum output width. Default: +infinity. options.rowSeparator: string (optional) - Row separator character. Default: 'None'. + 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.addRow( row ) - Adds a row to table data. - table.alignment - Datum's cell 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.cellPadding - Cell Padding. + table.bufferSize + Data buffer size. + + table.cellPaddingLeft + Cell's left Padding. + + table.cellPaddingRight + Cell's right Padding. table.columnSeparator - Column separator character. + Column separator character(s). table.corners Corner characters. - table.getData() - Gets table data and headers. + table.data + Table data. + + table.headers + Table headers. table.headerSeparator - Header separator character. + Header separator character(s). + + table.horizontalSeparatorMode + Horizontal line separator mode. table.joints Joint characters. @@ -90,14 +135,17 @@ table.maxOutputWidth Maximum output width. + table.push( row ) + Appends a row to table data. + table.render() Renders a table. table.rowSeparator - Row separator character. + Row separator character(s). - table.setData( data, [headers] ) - Sets table data and headers + table.verticalSeparatorMode + Vertical line separator mode. Examples -------- diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 6903a124be79..722cd52735c1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -18,8 +18,7 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var Float64Array = require( '@stdlib/array/float64' ); +var uniform = require( '@stdlib/random/array/uniform' ); var array = require( '@stdlib/ndarray/array' ); var ctor = require( './../lib' ); @@ -27,22 +26,15 @@ var headers; var table; var data; var str; -var i; // Generate some random data... -data = new Float64Array( 50 ); -for ( i = 0; i < data.length; i++ ) { - data[ i ] = randu() * 100.0; -} +data = uniform( 50, 1, 100 ); data = array( data, { 'shape': [ 10, 5 ] }); // Generate headers... -headers = new Float64Array( 5 ); -for ( i = 0; i < headers.length; i++ ) { - headers[ i ] = randu() * 100.0; -} +headers = [ 'A', 'B', 'C', 'D', 'E' ]; // Create a table: table = ctor( data, headers ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index d7a7883a39f1..ad2e9a670cab 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -37,14 +37,21 @@ function defaults() { // Cell alignment: out.alignment = 'right'; + // Boolean indicating whether to re-render on a `change` event: + out.autoRender = false; + // Border characters: - out.borders = '─ │ ─ │'; + out.borders = [ '─', '│', '─', '│' ]; + + // Buffer size: + out.bufferSize = FLOAT64_MAX; // Cell padding: - out.cellPadding = 1; + out.cellPaddingLeft = 1; + out.cellPaddingRight = 1; // Corner characters: - out.corners = '┌ ┐ ┘ └'; + out.corners = [ '┌', '┐', '┘', '└' ]; // Column separator character: out.columnSeparator = '│'; @@ -52,11 +59,12 @@ function defaults() { // Header separator character: out.headerSeparator = '─'; - // Row separator character: - out.rowSeparator = 'None'; - // Joint characters: - out.joints = '┼ ┬ ┤ ┴ ├'; + out.joints = [ '┼', '┬', '┤', '┴', '├' ]; + + // Line separator mode: + out.horizontalSeparatorMode = 'resume'; + out.verticalSeparatorMode = 'resume'; // Output margins: out.marginX = 0; @@ -68,6 +76,9 @@ function defaults() { // Maximum output width: out.maxOutputWidth = FLOAT64_MAX; + // Row separator character: + out.rowSeparator = ''; + return out; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js index f0b575b93d5f..ec280ed94dab 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js @@ -22,6 +22,16 @@ * Create a Unicode table. * * @module @stdlib/plot/table/unicode +* +* @example +* var UnicodeTable = require( '@stdlib/plot/table/unicode' ); +* +* var data = [ [ 1, 2 ], [ 3, 4 ] ]; +* var headers = [ 'A', 'B' ] +* var table = UnicodeTable( data, headers ); +* +* var str = table.render(); +* // returns '...' */ // MODULES // diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 830cec9f5796..e10232b7f300 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -16,30 +16,46 @@ * limitations under the License. */ +/* eslint-disable max-lines */ + 'use strict'; // MODULES // +var EventEmitter = require( 'events' ).EventEmitter; var logger = require( 'debug' ); var format = require( '@stdlib/string/format' ); var defineProperty = require( '@stdlib/utils/define-property' ); var objectKeys = require( '@stdlib/utils/keys' ); -var isPlainObject = require( '@stdlib/assert/is-plain-object' ); +var inherit = require( '@stdlib/utils/inherit' ); +var isObject = require( '@stdlib/assert/is-plain-object' ); var isCollection = require( '@stdlib/assert/is-collection' ); var mergeFcn = require( '@stdlib/utils/merge' ).factory; var pick = require( '@stdlib/utils/pick' ); var setAlignment = require( './props/alignment/set.js' ); var getAlignment = require( './props/alignment/get.js' ); +var setAutoRender = require( './props/auto-render/set.js' ); +var getAutoRender = require( './props/auto-render/get.js' ); var setBorders = require( './props/borders/set.js' ); var getBorders = require( './props/borders/get.js' ); -var setCellPadding = require( './props/cell-padding/set.js' ); -var getCellPadding = require( './props/cell-padding/get.js' ); +var setBufferSize = require( './props/buffer-size/set.js' ); +var getBufferSize = require( './props/buffer-size/get.js' ); +var setCellPaddingLeft = require( './props/cell-padding-left/set.js' ); +var getCellPaddingLeft = require( './props/cell-padding-left/get.js' ); +var setCellPaddingRight = require( './props/cell-padding-right/set.js' ); +var getCellPaddingRight = require( './props/cell-padding-right/get.js' ); var setCorners = require( './props/corners/set.js' ); var getCorners = require( './props/corners/get.js' ); var setColumnSeparator = require( './props/column-separator/set.js' ); var getColumnSeparator = require( './props/column-separator/get.js' ); +var setData = require( './props/data/set.js' ); +var getData = require( './props/data/get.js' ); +var setHeaders = require( './props/headers/set.js' ); +var getHeaders = require( './props/headers/get.js' ); var setHeaderSeparator = require( './props/header-separator/set.js' ); var getHeaderSeparator = require( './props/header-separator/get.js' ); +var setHorizontalSeparatorMode = require( './props/horizontal-separator-mode/set.js' ); // eslint-disable-line id-length +var getHorizontalSeparatorMode = require( './props/horizontal-separator-mode/get.js' ); // eslint-disable-line id-length var setJoints = require( './props/joints/set.js' ); var getJoints = require( './props/joints/get.js' ); var setMarginX = require( './props/margin-x/set.js' ); @@ -52,11 +68,12 @@ var setMaxOutputWidth = require( './props/max-output-width/set.js' ); var getMaxOutputWidth = require( './props/max-output-width/get.js' ); var setRowSeparator = require( './props/row-separator/set.js' ); var getRowSeparator = require( './props/row-separator/get.js' ); +var setVerticalSeparatorMode = require( './props/vertical-separator-mode/set.js' ); +var getVerticalSeparatorMode = require( './props/vertical-separator-mode/get.js' ); var defaults = require( './defaults.js' ); var render = require( './render.js' ); -var setData = require('./setdata.js'); -var getData = require( './getdata.js' ); -var addRow = require( './addrow.js' ); +var push = require( './push.js' ); +var parse = require( './parse.js' ); // VARIABLES // @@ -70,36 +87,47 @@ var merge = mergeFcn({ // List of private properties (note: keep in alphabetical order): var PRIVATE_PROPS = [ '_alignment', + '_autoRender', '_borders', - '_cellPadding', + '_bufferSize', + '_cellPaddingLeft', + '_cellPaddingRight', '_corners', '_columnSeparator', '_columnWidths', '_data', '_headers', '_headerSeparator', + '_horizontalSeparatorMode', '_joints', '_marginX', '_marginY', '_maxCellWidth', '_maxOutputWidth', - '_rowSeparator' + '_numColumns', + '_rowSeparator', + '_verticalSeparatorMode' ]; // List of options properties (note: keep in alphabetical order): var OPTIONS_PROPS = [ 'alignment', + 'autoRender', 'borders', - 'cellPadding', + 'bufferSize', + 'cellPaddingLeft', + 'cellPaddingRight', 'columnSeparator', 'corners', 'headerSeparator', + 'horizontalSeparatorMode', 'joints', 'marginX', 'marginY', 'maxCellWidth', 'maxOutputWidth', - 'rowSeparator' + 'rowSeparator', + 'verticalSeparatorMode' ]; @@ -112,28 +140,45 @@ var OPTIONS_PROPS = [ * @param {(Object|Array|Array|MatrixLike)} [data] - table data * @param {Collection} [headers] - table headers * @param {Options} [options] - table options -* @param {string} [options.alignment='right'] - datum's cell alignment -* @param {(string)} [options.borders='─ │ ─ │'] - border characters -* @param {NonNegativeInteger} [options.cellPadding=1] - cell padding -* @param {string} [options.columnSeparator='│'] - column separator character -* @param {string} [options.corners='┌ ┐ ┘ └'] - corner characters -* @param {string} [options.headerSeparator='─'] - header separator character -* @param {string} [options.joints='┼ ┬ ┤ ┴ ├'] - joint characters +* @param {(Array|string)} [options.alignment='right'] - datum's cell alignment(s) +* @param {boolean} [options.autoRender=false] - boolean indicating whether to re-render on each `change` event +* @param {Array} [options.borders=[ '─', '│', '─', '│' ]] - border characters +* @param {(PositiveInteger|null)} [options.bufferSize] - size of data buffer +* @param {(Array|NonNegativeInteger)} [options.cellPaddingLeft=1] - cell's left padding +* @param {(Array|NonNegativeInteger)} [options.cellPaddingRight=1] - cell's right padding +* @param {string} [options.columnSeparator='│'] - column separator character(s) +* @param {Array} [options.corners=[ '┌', '┐', '┘', '└' ]] - corner characters +* @param {string} [options.headerSeparator='─'] - header separator character(s) +* @param {string} [options.horizontalSeparatorMode='resume'] - horizontal line separator mode +* @param {Array} [options.joints=[ '┼', '┬', '┤', '┴', '├' ]] - joint characters * @param {NonNegativeInteger} [options.marginX=0] - horizontal output margin * @param {NonNegativeInteger} [options.marginY=0] - vertical output margin -* @param {NonNegativeInteger} [options.maxCellWidth=FLOAT64_MAX] - maximum cell width (excluding padding) -* @param {NonNegativeInteger} [options.maxOutputWidth=FLOAT64_MAX] - maximum output width (including margin) -* @param {string} [options.rowSeparator='None'] - row separator character +* @param {(Array|NonNegativeInteger)} [options.maxCellWidth] - maximum cell width(s) +* @param {NonNegativeInteger} [options.maxOutputWidth] - maximum output width +* @param {string} [options.rowSeparator=''] - row separator character(s) +* @param {string} [options.verticalSeparatorMode='resume'] - vertical line separator mode * @throws {TypeError} must provide valid options * @returns {UnicodeTable} table instance +* +* @example +* var UnicodeTable = require( '@stdlib/plot/table/unicode' ); +* +* var data = [ [ 1, 2 ], [ 3, 4 ] ]; +* var headers = [ 'A', 'B' ] +* var table = UnicodeTable( data, headers ); +* +* var str = table.render(); +* // returns '...' */ function UnicodeTable() { var headers; var options; + var parsed; var nargs; var data; var opts; var keys; + var self; var key; var i; @@ -150,6 +195,7 @@ function UnicodeTable() { } return new UnicodeTable( arguments[ 0 ], arguments[ 1 ], arguments[ 2 ] ); // eslint-disable-line max-len } + self = this; // Extract table-specific options... opts = defaults(); @@ -170,7 +216,7 @@ function UnicodeTable() { data = arguments[ 0 ]; headers = null; options = arguments[ 1 ]; - if ( !isPlainObject( options ) ) { + if ( !isObject( options ) ) { throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); } } @@ -178,7 +224,7 @@ function UnicodeTable() { data = arguments[ 0 ]; headers = arguments[ 1 ]; options = arguments[ 2 ]; - if ( !isPlainObject( options ) ) { + if ( !isObject( options ) ) { throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); } } @@ -196,27 +242,62 @@ function UnicodeTable() { }); } // Set table data and headers... - if ( headers ) { - this.setData( data, headers ); - } else if ( data ) { - this.setData( data ); + if ( data || headers ) { + parsed = parse( data, headers ); + this._data = parsed.data; + this._headers = parsed.headers; + this._columnWidths = parsed.columnWidths; + this._numColumns = parsed.columnWidths.length; } + // Set table-specific properties... keys = objectKeys( opts ); for ( i = 0; i < keys.length; i++ ) { key = keys[ i ]; this[ key ] = opts[ key ]; } + // Add event listeners: + this.on( 'change', onChange ); + this.on( 'render', onRender ); + return this; + + /** + * Callback invoked upon receiving a `change` event. + * + * @private + */ + function onChange() { + /* eslint-disable no-underscore-dangle */ + debug( 'Received a change event.' ); + if ( self._autoRender ) { + self.render(); + } + } + + /** + * Callback invoked upon receiving a `render` event. + * + * @private + * @param {string} table - rendered table + */ + function onRender() { + debug( 'Received a render event.' ); + } } +/* +* Inherit from the `EventEmitter` prototype. +*/ +inherit( UnicodeTable, EventEmitter ); + /** -* Alignment of datum in cell. +* Alignment(s) of datum in cell. * * @name alignment * @memberof UnicodeTable.prototype -* @type {string} -* @throws {TypeError} must be a supported alignment string +* @type {(Array|string)} +* @throws {TypeError} must be a supported alignment string or an array of alignment strings * @default 'right' * * @example @@ -224,6 +305,12 @@ function UnicodeTable() { * table.alignment = 'left'; * var alignment = table.alignment; * // returns 'left' +* +* @example +* var table = new UnicodeTable(); +* table.alignment = [ 'left', 'right', 'center' ]; +* var alignment = table.alignment; +* // returns [ 'left', 'right', 'center' ] */ defineProperty( UnicodeTable.prototype, 'alignment', { 'configurable': false, @@ -232,20 +319,46 @@ defineProperty( UnicodeTable.prototype, 'alignment', { 'get': getAlignment }); +/** +* Rendering mode. +* +* ## Notes +* +* - If `true`, an instance re-renders on each `change` event. +* +* @name autoRender +* @memberof UnicodeTable.prototype +* @type {boolean} +* @throws {TypeError} must be a boolean +* @default false +* +* @example +* var table = new UnicodeTable(); +* table.autoRender = true; +* var mode = table.autoRender; +* // returns true +*/ +defineProperty( UnicodeTable.prototype, 'autoRender', { + 'configurable': false, + 'enumerable': true, + 'set': setAutoRender, + 'get': getAutoRender +}); + /** * Border characters. * * @name borders * @memberof UnicodeTable.prototype -* @type {string} -* @throws {TypeError} must be a four space separated characters or 'None' -* @default '─ │ ─ │' +* @type {Array} +* @throws {TypeError} must be an array of four strings +* @default '[ "─", "│", "─", "│" ]' * * @example * var table = new UnicodeTable(); -* table.borders = '= ! = !'; +* table.borders = [ '=', '!', '=', '!' ]; * var borders = table.borders; -* // returns '= ! = !' +* // returns [ '=', '!', '=', '!' ] */ defineProperty( UnicodeTable.prototype, 'borders', { 'configurable': false, @@ -255,25 +368,79 @@ defineProperty( UnicodeTable.prototype, 'borders', { }); /** -* Cell padding. +* Size of data buffer. * -* @name cellPadding +* @name bufferSize * @memberof UnicodeTable.prototype -* @type {NonNegativeInteger} -* @throws {TypeError} must be a non-negative integer +* @type {(PositiveInteger|null)} +* @throws {TypeError} must be a positive integer or null +* @throws {RangeError} must be greater than or equal to the number of rows +* +* @example +* var table = new UnicodeTable(); +* table.bufferSize = 20; +*/ +defineProperty( UnicodeTable.prototype, 'bufferSize', { + 'configurable': false, + 'enumerable': true, + 'set': setBufferSize, + 'get': getBufferSize +}); + +/** +* Cell's left padding. +* +* @name cellPaddingLeft +* @memberof UnicodeTable.prototype +* @type {(Array|NonNegativeInteger)} +* @throws {TypeError} must be a non-negative integer or an array of non-negative integers +* @default '1' +* +* @example +* var table = new UnicodeTable(); +* table.cellPaddingLeft = 3; +* var padding = table.cellPaddingLeft; +* // returns 3 +* +* @example +* var table = new UnicodeTable(); +* table.cellPaddingLeft = [ 3, 2 ]; +* var paddings = table.cellPaddingLeft; +* // returns [ 3, 2 ] +*/ +defineProperty( UnicodeTable.prototype, 'cellPaddingLeft', { + 'configurable': false, + 'enumerable': true, + 'set': setCellPaddingLeft, + 'get': getCellPaddingLeft +}); + +/** +* Cell's right padding. +* +* @name cellPaddingRight +* @memberof UnicodeTable.prototype +* @type {(Array|NonNegativeInteger)} +* @throws {TypeError} must be a non-negative integer or an array of non-negative integers * @default '1' * * @example * var table = new UnicodeTable(); -* table.cellPadding = 3; -* var padding = table.cellPadding; +* table.cellPaddingRight = 3; +* var padding = table.cellPaddingRight; * // returns 3 +* +* @example +* var table = new UnicodeTable(); +* table.cellPaddingRight = [ 3, 2 ]; +* var paddings = table.cellPaddingRight; +* // returns [ 3, 2 ] */ -defineProperty( UnicodeTable.prototype, 'cellPadding', { +defineProperty( UnicodeTable.prototype, 'cellPaddingRight', { 'configurable': false, 'enumerable': true, - 'set': setCellPadding, - 'get': getCellPadding + 'set': setCellPaddingRight, + 'get': getCellPaddingRight }); /** @@ -281,15 +448,15 @@ defineProperty( UnicodeTable.prototype, 'cellPadding', { * * @name corners * @memberof UnicodeTable.prototype -* @type {string} -* @throws {TypeError} must be a string with four space separated characters or 'None' -* @default '┌ ┐ ┘ └' +* @type {Array} +* @throws {TypeError} must be an array of four grapheme clusters +* @default '[ "┌", "┐", "┘", "└" ]' * * @example * var table = new UnicodeTable(); -* table.corners = '* * * *'; +* table.corners = [ '*', '*', '*', '*' ]; * var corners = table.corners; -* // returns '* * * *' +* // returns [ '*', '*', '*', '*' ] */ defineProperty( UnicodeTable.prototype, 'corners', { 'configurable': false, @@ -299,19 +466,19 @@ defineProperty( UnicodeTable.prototype, 'corners', { }); /** -* Column separator character. +* Column separator character(s). * * @name columnSeparator * @memberof UnicodeTable.prototype * @type {string} -* @throws {TypeError} must be a character string or 'None' +* @throws {TypeError} must be a string * @default '│' * * @example * var table = new UnicodeTable(); -* table.columnSeparator = '$'; +* table.columnSeparator = '$='; * var separator = table.columnSeparator; -* // returns '$' +* // returns '$=' */ defineProperty( UnicodeTable.prototype, 'columnSeparator', { 'configurable': false, @@ -321,19 +488,64 @@ defineProperty( UnicodeTable.prototype, 'columnSeparator', { }); /** -* Header separator character. +* Table data. +* +* @name data +* @memberof UnicodeTable.prototype +* @type {Array|MatrixLike} +* @throws {TypeError} must be a 2 dimensional array/ndarray +* @throws {RangeError} must provide correct number of columns +* @throws {RangeError} rows must not exceed maximum data buffer size +* +* @example +* var table = new UnicodeTable(); +* table.data = [ [ 'a', 'b' ], [ 1, 2 ] ]; +* var data = table.data; +* // returns [ [ 'a', 'b' ], [ 1, 2 ] ] +*/ +defineProperty( UnicodeTable.prototype, 'data', { + 'configurable': false, + 'enumerable': true, + 'set': setData, + 'get': getData +}); + +/** +* Table headers. +* +* @name headers +* @memberof UnicodeTable.prototype +* @type {Collection} +* @throws {TypeError} must be a collection +* @throws {RangeError} must provide correct number of columns +* +* @example +* var table = new UnicodeTable(); +* table.headers = [ 'name', 'age' ]; +* var headers = table.headers; +* // returns [ 'name', 'age' ] +*/ +defineProperty( UnicodeTable.prototype, 'headers', { + 'configurable': false, + 'enumerable': true, + 'set': setHeaders, + 'get': getHeaders +}); + +/** +* Header separator character(s). * * @name headerSeparator * @memberof UnicodeTable.prototype * @type {string} -* @throws {TypeError} must be a character string or 'None' +* @throws {TypeError} must be a string * @default '─' * * @example * var table = new UnicodeTable(); -* table.headerSeparator = '$'; +* table.headerSeparator = '$='; * var separator = table.headerSeparator; -* // returns '$' +* // returns '$=' */ defineProperty( UnicodeTable.prototype, 'headerSeparator', { 'configurable': false, @@ -342,20 +554,42 @@ defineProperty( UnicodeTable.prototype, 'headerSeparator', { 'get': getHeaderSeparator }); +/** +* Horizontal line separator mode. +* +* @name horizontalSeparatorMode +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a supported line separator mode string +* @default 'resume' +* +* @example +* var table = new UnicodeTable(); +* table.horizontalSeparatorMode = 'repeat'; +* var mode = table.horizontalSeparatorMode; +* // returns 'repeat' +*/ +defineProperty( UnicodeTable.prototype, 'horizontalSeparatorMode', { + 'configurable': false, + 'enumerable': true, + 'set': setHorizontalSeparatorMode, + 'get': getHorizontalSeparatorMode +}); + /** * Joint characters. * * @name joints * @memberof UnicodeTable.prototype -* @type {string} -* @throws {TypeError} must be a string with five space separated characters or 'None' -* @default '┼ ┬ ┤ ┴ ├' +* @type {Array} +* @throws {TypeError} must be an array of five grapheme clusters +* @default '[ "┼", "┬", "┤", "┴", "├" ]' * * @example * var table = new UnicodeTable(); -* table.joints = '* * * * *'; +* table.joints = [ '*', '*', '*', '*', '*' ]; * var joints = table.joints; -* // returns '* * * * *' +* // returns [ '*', '*', '*', '*', '*' ] */ defineProperty( UnicodeTable.prototype, 'joints', { 'configurable': false, @@ -409,19 +643,25 @@ defineProperty( UnicodeTable.prototype, 'marginY', { }); /** -* Maximum cell width (excluding padding). +* Maximum cell width. * * @name maxCellWidth * @memberof UnicodeTable.prototype -* @type {NonNegativeInteger} -* @throws {TypeError} must be a non-negative integer -* @default 'FLOAT64_MAX' +* @type {(Array|NonNegativeInteger|null)} +* @throws {TypeError} must be a non-negative integer, an array of non-negative integers or null +* @default '+infinity' * * @example * var table = new UnicodeTable(); * table.maxCellWidth = 10; * var width = table.maxCellWidth; * // returns 10 +* +* @example +* var table = new UnicodeTable(); +* table.maxCellWidth = [ 10, 8 ]; +* var widhts = table.maxCellWidth; +* // returns [ 10, 8 ] */ defineProperty( UnicodeTable.prototype, 'maxCellWidth', { 'configurable': false, @@ -431,13 +671,13 @@ defineProperty( UnicodeTable.prototype, 'maxCellWidth', { }); /** -* Maximum output width (including margin). +* Maximum output width. * * @name maxOutputWidth * @memberof UnicodeTable.prototype -* @type {NonNegativeInteger} -* @throws {TypeError} must be a non-negative integer -* @default 'FLOAT64_MAX' +* @type {(NonNegativeInteger|null)} +* @throws {TypeError} must be a non-negative integer or null +* @default '+infinity' * * @example * var table = new UnicodeTable(); @@ -453,19 +693,19 @@ defineProperty( UnicodeTable.prototype, 'maxOutputWidth', { }); /** -* Row separator character. +* Row separator character(s). * * @name rowSeparator * @memberof UnicodeTable.prototype * @type {string} -* @throws {TypeError} must be a character string or 'None' -* @default 'None' +* @throws {TypeError} must be a string +* @default '' * * @example * var table = new UnicodeTable(); -* table.rowSeparator = '$'; +* table.rowSeparator = '$='; * var separator = table.rowSeparator; -* // returns '$' +* // returns '$=' */ defineProperty( UnicodeTable.prototype, 'rowSeparator', { 'configurable': false, @@ -475,26 +715,47 @@ defineProperty( UnicodeTable.prototype, 'rowSeparator', { }); /** -* Adds a row to table data. +* Vertical line separator mode. * -* @name addRow +* @name verticalSeparatorMode * @memberof UnicodeTable.prototype -* @type {Function} -* @param {Collection} row - row to add -* @throws {TypeError} must provide a collection with equal number of columns to existing data -* @returns {UnicodeTable} class instance +* @type {string} +* @throws {TypeError} must be a supported line separator mode string +* @default 'resume' +* +* @example +* var table = new UnicodeTable(); +* table.verticalSeparatorMode = 'repeat'; +* var mode = table.verticalSeparatorMode; +* // returns 'repeat' */ -UnicodeTable.prototype.addRow = addRow; +defineProperty( UnicodeTable.prototype, 'verticalSeparatorMode', { + 'configurable': false, + 'enumerable': true, + 'set': setVerticalSeparatorMode, + 'get': getVerticalSeparatorMode +}); /** -* Gets table data and headers. +* Appends row to table data. * -* @name getData +* @name push * @memberof UnicodeTable.prototype * @type {Function} -* @returns {Object} table data and headers +* @param {Collection} row - row to add +* @throws {TypeError} must provide a collection with equal number of columns to existing data +* @returns {UnicodeTable} class instance +* +* @example +* var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ] ); +* var data = table.data; +* // returns [ [ 1, 2 ], [ 3, 4 ] ] +* +* table.push( [ 5, 6 ] ); +* data = table.data; +* // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] */ -UnicodeTable.prototype.getData = getData; +UnicodeTable.prototype.push = push; /** * Renders a table. @@ -504,22 +765,13 @@ UnicodeTable.prototype.getData = getData; * @type {Function} * @throws {Error} output must be able to accommodate every column individually * @returns {string} rendered table -*/ -UnicodeTable.prototype.render = render; - -/** -* Sets table data and headers. * -* @name setData -* @memberof UnicodeTable.prototype -* @type {Function} -* @param {(Object|Array|Array|MatrixLike)} data - table data -* @param {Collection} [headers] - table headers -* @throws {TypeError} first argument must be an object, array of objects, or a 2 dimensional array/ndarray -* @throws {TypeError} second argument must be a collection -* @returns {UnicodeTable} class instance +* @example +* var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ], [ 'A', 'B' ] ); +* var str = table.render(); +* // returns '...' */ -UnicodeTable.prototype.setData = setData; +UnicodeTable.prototype.render = render; // EXPORTS // diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js similarity index 67% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js index 1e2b2f882497..42c00ebc3e32 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/setdata.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js @@ -30,6 +30,7 @@ var ndarray2array = require( '@stdlib/ndarray/to-array' ); var parseObject = require( './parser/parse_object.js' ); var parseObjectsList = require( './parser/parse_objects_list.js' ); var parse2dArray = require( './parser/parse_2d_array.js' ); +var parseHeaders = require( './parser/parse_headers.js' ); // MAIN // @@ -39,30 +40,27 @@ var parse2dArray = require( './parser/parse_2d_array.js' ); * * @private * @param {(Object|Array|Array|MatrixLike)} data - table data -* @param {Collection} [headers] - table headers +* @param {Collection} headers - table headers * @throws {TypeError} first argument must be an object, array of objects, or a 2 dimensional array/ndarray * @throws {TypeError} second argument must be a collection -* @returns {UnicodeTable} class instance +* @returns {Object} table metadata */ -function setData() { - /* eslint-disable no-invalid-this */ - var headers; +function setData( data, headers ) { var parsed; - var nargs; - var data; - nargs = arguments.length; - if ( nargs === 0 ) { - throw new TypeError( format( 'invalid argument. First argument must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', data ) ); - } else if ( nargs === 1 ) { - data = arguments[ 0 ]; - headers = this._headers; - } else { - data = arguments[ 0 ]; - headers = arguments[ 1 ]; - if ( !isCollection( headers ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be a collection. Value: `%s`.', headers ) ); + if ( headers && !isCollection( headers ) ) { + throw new TypeError( format( 'invalid argument. `%s` argument must be a collection. Value: `%s`.', 'headers', headers ) ); + } + if ( !data ) { + if ( !headers ) { + return { + 'data': null, + 'headers': null, + 'columnWidths': null + }; } + parsed = parseHeaders( headers ); + return parsed; } // Parse according to data-type... if ( isMatrixLike( data ) ) { @@ -74,12 +72,9 @@ function setData() { } else if ( isPlainObject( data ) ) { parsed = parseObject( data, headers ); } else { - throw new TypeError( format( 'invalid argument. First argument must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', data ) ); + throw new TypeError( format( 'invalid argument. `%s` argument must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', 'data', data ) ); } - this._data = parsed.data; - this._headers = parsed.headers; - this._columnWidths = parsed.columnWidths; - return this; + return parsed; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js index 411157f88db3..999afcf7b2a5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js @@ -26,7 +26,7 @@ * @private * @param {Array} data - tabular data * @param {Collection} [headers] - column names -* @throws {Error} must provide correct number of columns +* @throws {RangeError} must provide correct number of columns * @returns {Object} table metadata */ function parse2dArray( data, headers ) { @@ -52,7 +52,7 @@ function parse2dArray( data, headers ) { // Calculating max widths of all columns: for ( i = 0; i < data.length; i++ ) { if ( cols !== data[ i ].length ) { - throw new Error( 'invalid data. All rows must have equal number of columns' ); + throw new RangeError( 'invalid data. All rows must have equal number of columns' ); } for ( j = 0; j < cols; j++ ) { len = String( data[ i ][ j ] ).length; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js new file mode 100644 index 000000000000..53fa83ce1a7a --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js @@ -0,0 +1,58 @@ +/** +* @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'; + +// MAIN // + +/** +* Parses an array into table headers. +* +* @private +* @param {Collection} headers - column names +* @param {Array} [columnWidths] - column widths +* @returns {Object} table metadata +*/ +function parseHeaders( headers, columnWidths ) { + var header; + var i; + + if ( columnWidths ) { + for ( i = 0; i < headers.length; i++ ) { + header = String( headers[ i ] ); + if ( header.length > columnWidths[ i ] ) { + columnWidths[ i ] = header.length; + } + } + } else { + columnWidths = []; + for ( i = 0; i < headers.length; i++ ) { + columnWidths.push( String( headers[ i ] ).length ); + } + } + return { + 'headers': headers, + 'columnWidths': columnWidths, + 'data': null + }; +} + + +// EXPORTS // + +module.exports = parseHeaders; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js index 69b5edf2a71d..1f6582f550fc 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js @@ -40,7 +40,6 @@ var hasOwnProp = require( '@stdlib/assert/has-own-property' ); * @returns {Object} table metadata */ function parseObject( data, headers ) { - var columns; var header; var widths; var cols; @@ -56,44 +55,39 @@ function parseObject( data, headers ) { // Parsing data into a 2D array: rows = []; // final data after parsing - columns = []; // final headers list after parsing widths = []; // max widths of each column for ( i = 0; i < headers.length; i++ ) { header = String( headers[ i ] ); - // Skip header if it doesn't exist in the data... - if ( hasOwnProp( data, header ) ) { - if ( !isCollection( data[ header ] ) ) { - throw new Error( format( 'invalid data. Each key must correspond to an array. Value: `%s`.', data ) ); - } - columns.push( header ); - widths.push( header.length ); - for ( j = 0; j < data[ header ].length; j++ ) { - len = String( data[ header ][ j ] ).length; + if ( !hasOwnProp( data, header ) ) { + throw new Error( format( 'invalid data. Column `%s` not found in data. Value: `%s`.', header, data ) ); + } + if ( !isCollection( data[ header ] ) ) { + throw new Error( format( 'invalid data. Each key must correspond to an array. Value: `%s`.', data ) ); + } + widths.push( header.length ); + for ( j = 0; j < data[ header ].length; j++ ) { + len = String( data[ header ][ j ] ).length; - // Updating max width of column: - if ( len > widths[ i ] ) { - widths[ i ] = len; - } - if ( !rows[ j ] ) { - rows[ j ] = []; - } - rows[ j ][ i ] = data[ header ][ j ]; + // Updating max width of column: + if ( len > widths[ i ] ) { + widths[ i ] = len; } + if ( !rows[ j ] ) { + rows[ j ] = []; + } + rows[ j ][ i ] = data[ header ][ j ]; } } - if ( columns.length === 0 ) { - throw new Error( format( 'invalid data. No headers found in data. Value: `%s`.', data ) ); - } // Checking if all columns have the same number of rows... - cols = data[ columns[ 0 ] ].length; - for ( i = 1; i < columns.length; i++ ) { - if ( cols !== data[ columns[ i ] ].length ) { + cols = data[ headers[ 0 ] ].length; + for ( i = 1; i < headers.length; i++ ) { + if ( cols !== data[ headers[ i ] ].length ) { throw new Error( 'invalid data. All columns must have the same number of rows' ); } } return { - 'headers': columns, + 'headers': headers, 'data': rows, 'columnWidths': widths }; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js index 671854f9d2e6..79894ea57a8d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js @@ -20,7 +20,9 @@ // MODULES // +var format = require( '@stdlib/string/format' ); var objectKeys = require( '@stdlib/utils/keys' ); +var hasOwnProp = require( '@stdlib/assert/has-own-property' ); // MAIN // @@ -31,6 +33,7 @@ var objectKeys = require( '@stdlib/utils/keys' ); * @private * @param {Array} data - tabular data * @param {Collection} [headers] - column names +* @throws {Error} must provide valid data * @returns {Object} table metadata */ function parseObjectsList( data, headers ) { @@ -56,6 +59,9 @@ function parseObjectsList( data, headers ) { rows[ i ] = []; for ( j = 0; j < headers.length; j++ ) { header = headers[ j ]; + if ( !hasOwnProp( data[ i ], header ) ) { + throw new Error( format( 'invalid data. Column `%s` not found in data. Value: `%s`.', header, data ) ); + } len = String( data[ i ][ header ] ).length; // Updating max width of column: diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js index 7ab5a7b8d181..09175302ff9e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js @@ -18,14 +18,24 @@ 'use strict'; +// MODULES // + +var isArray = require( '@stdlib/assert/is-array' ); + + +// MAIN // + /** -* Returns the table cell alignment. +* Returns the table's cell alignment(s). * * @private -* @returns {string} cell alignment +* @returns {(Array|string)} cell alignment(s) */ function get() { /* eslint-disable no-invalid-this */ + if ( isArray( this._alignment ) ) { + return this._alignment.slice(); + } return this._alignment; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js index e9b5f100e5db..f17065fdb39b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js @@ -20,34 +20,55 @@ // MODULES // -var contains = require( '@stdlib/assert/contains' ); +var contains = require( '@stdlib/array/base/assert/contains' ).factory; var isString = require( '@stdlib/assert/is-string' ); +var isStringArray = require( '@stdlib/assert/is-string-array' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); var format = require( '@stdlib/string/format' ); // VARIABLES // -var ALIGNMENTS = [ 'right', 'center', 'left' ]; +var isValidAlignment = contains( [ 'right', 'center', 'left' ] ); // MAIN // /** -* Sets the table cell alignment. +* Sets the table's cell alignment(s). * * @private -* @param {string} alignment - cell alignment -* @throws {TypeError} must be a supported alignment string +* @param {(Array|string)} alignment - cell alignment(s) +* @throws {TypeError} must be a supported alignment string or an array of alignment strings +* @throws {RangeError} must provide correct number of columns if providing an array */ function set( alignment ) { /* eslint-disable no-invalid-this */ - if ( !isString( alignment ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'alignment', alignment ) ); + var i; + if ( isString( alignment ) ) { + if ( !isValidAlignment( alignment ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a supported alignment string. Value: `%s`.', 'alignment', alignment ) ); + } + } else if ( isStringArray( alignment ) ) { + for ( i = 0; i < alignment.length; i++ ) { + if ( !isValidAlignment( alignment[ i ] ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of supported alignment strings. Value: `%s`.', 'alignment', alignment ) ); + } + } + if ( this._numColumns ) { + if ( alignment.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'alignment', this._numColumns, alignment.length ) ); + } + } else { + this._numColumns = alignment.length; + } + } else { + throw new TypeError( format( 'invalid assignment. `%s` must be a string or an array of strings. Value: `%s`.', 'alignment', alignment ) ); } - if ( !contains( ALIGNMENTS, alignment ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be one of the following: "%s". Value: `%s`.', 'alignment', ALIGNMENTS.join( '", "' ), alignment ) ); + if ( !isEqual( alignment, this._alignment ) ) { + this._alignment = alignment; + this.emit( 'change' ); } - this._alignment = alignment; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js similarity index 87% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js index c33cfcc67aa4..19f5a8e9b3df 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js @@ -19,14 +19,14 @@ 'use strict'; /** -* Returns the table's cell padding. +* Returns the rendering mode. * * @private -* @returns {NonNegativeInteger} cell padding +* @returns {boolean} rendering mode */ function get() { /* eslint-disable no-invalid-this */ - return this._cellPadding; + return this._autoRender; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js similarity index 67% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js index ff5365675c3b..343a2305a3ae 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js @@ -20,25 +20,28 @@ // MODULES // -var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table's cell padding. +* Sets the rendering mode. * * @private -* @param {NonNegativeInteger} padding - cell padding -* @throws {TypeError} must provide a non-negative integer +* @param {boolean} bool - boolean indicating whether to re-render on a change event +* @throws {TypeError} must be a boolean */ -function set( padding ) { +function set( bool ) { /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( padding ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'cellPadding', padding ) ); + if ( !isBoolean( bool ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a boolean. Value: `%s`.', 'autoRender', bool ) ); + } + if ( bool !== this._autoRender ) { + this._autoRender = bool; + this.emit( 'change' ); } - this._cellPadding = padding; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js index f19ba3763f86..ab66d4f30ab2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js @@ -22,14 +22,11 @@ * Returns the table's border characters. * * @private -* @returns {string} borders string +* @returns {Array} borders */ function get() { /* eslint-disable no-invalid-this */ - if ( this._borders === 'None' ) { - return 'None'; - } - return this._borders.join( ' ' ); + return this._borders.slice(); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index b500f70ce062..f66106e202be 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -20,14 +20,14 @@ // MODULES // -var isString = require( '@stdlib/assert/is-string' ); +var isStringArray = require( '@stdlib/assert/is-string-array' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); var format = require( '@stdlib/string/format' ); // VARIABLES // -var BORDER_STRING_LEN = 7; -var BORDER_CHARACTERS = 4; +var NUM_BORDERS = 4; // MAIN // @@ -37,27 +37,17 @@ var BORDER_CHARACTERS = 4; * * @private * @param {string} borders - borders string -* @throws {TypeError} must be a four space separated characters or 'None' +* @throws {TypeError} must be an array of four strings */ function set( borders ) { - var arr; - /* eslint-disable no-invalid-this */ - if ( !isString( borders ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borders', borders ) ); + if ( !isStringArray( borders ) || borders.length !== NUM_BORDERS ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of four strings. Value: `%s`.', 'borders', borders ) ); } - if ( borders === 'None' ) { + if ( !isEqual( borders, this._borders ) ) { this._borders = borders; - return; - } - arr = borders.split( ' ' ); - if ( borders.length !== BORDER_STRING_LEN ) { - throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'borders', borders ) ); - } - if ( arr.length !== BORDER_CHARACTERS ) { - throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'borders', borders ) ); + this.emit( 'change' ); } - this._borders = arr; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js similarity index 79% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js index 5b8ab1bda4b0..0e647aff2dee 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/getdata.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js @@ -19,20 +19,17 @@ 'use strict'; /** -* Returns table data and headers. +* Returns the data buffer size. * * @private -* @returns {Object} table data and headers +* @returns {PositiveInteger} data buffer size */ -function getData() { +function get() { /* eslint-disable no-invalid-this */ - return { - 'headers': this._headers, - 'data': this._data - }; + return this._bufferSize; } // EXPORTS // -module.exports = getData; +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js new file mode 100644 index 000000000000..d34fddaa3360 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js @@ -0,0 +1,60 @@ +/** +* @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 isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive; +var isNull = require( '@stdlib/assert/is-null' ); +var format = require( '@stdlib/string/format' ); +var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); + + +// MAIN // + +/** +* Sets the data buffer size. +* +* @private +* @param {(PositiveInteger|null)} size - data buffer size +* @throws {TypeError} must be a positive integer or null +* @throws {RangeError} must be greater than or equal to the number of rows +*/ +function set( size ) { + /* eslint-disable no-invalid-this */ + var FLG = isNull( size ); + if ( !isPositiveInteger( size ) && !FLG ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a positive integer or null. Value: `%s`.', 'bufferSize', size ) ); + } + if ( FLG ) { + size = FLOAT64_MAX; + } + if ( this._data && size < this._data.length ) { + throw new RangeError( format( 'invalid assignment. `%s` size is less than the number of data elements. Number of elements: `%u`. Value: `%u`.', 'bufferSize', this._data.length, size ) ); + } + if ( size !== this._bufferSize ) { + this._bufferSize = size; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js new file mode 100644 index 000000000000..ba983074f66c --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.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'; + +// MODULES // + +var isArray = require( '@stdlib/assert/is-array' ); + + +// MAIN // + +/** +* Returns the cell's left padding(s). +* +* @private +* @returns {(Array|NonNegativeInteger)} cell's left padding(s) +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( isArray( this._cellPaddingLeft ) ) { + return this._cellPaddingLeft.slice(); + } + return this._cellPaddingLeft; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js new file mode 100644 index 000000000000..5d5094ceebdb --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js @@ -0,0 +1,62 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the cell's left padding(s). +* +* @private +* @param {(Array|NonNegativeInteger)} padding - cell's left padding(s) +* @throws {TypeError} must provide a non-negative integer +* @throws {RangeError} must provide correct number of columns if providing an array +*/ +function set( padding ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( padding ) && !isNonNegativeIntegerArray( padding ) ) { // eslint-disable-line max-len + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'cellPadding', padding ) ); + } + if ( isNonNegativeIntegerArray( padding ) ) { + if ( this._numColumns ) { + if ( padding.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'padding', this._numColumns, padding.length ) ); + } + } else { + this._numColumns = padding.length; + } + } + if ( !isEqual( padding, this._cellPaddingLeft ) ) { + this._cellPaddingLeft = padding; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js new file mode 100644 index 000000000000..a16f7fafb3e1 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.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'; + +// MODULES // + +var isArray = require( '@stdlib/assert/is-array' ); + + +// MAIN // + +/** +* Returns the cell's right padding(s). +* +* @private +* @returns {(Array|NonNegativeInteger)} cell's right padding(s) +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( isArray( this._cellPaddingRight ) ) { + return this._cellPaddingRight.slice(); + } + return this._cellPaddingRight; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js new file mode 100644 index 000000000000..45329e67db29 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js @@ -0,0 +1,62 @@ +/** +* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the cell's right padding(s). +* +* @private +* @param {(Array|NonNegativeInteger)} padding - cell's right padding(s) +* @throws {TypeError} must provide a non-negative integer +* @throws {RangeError} must provide correct number of columns if providing an array +*/ +function set( padding ) { + /* eslint-disable no-invalid-this */ + if ( !isNonNegativeInteger( padding ) && !isNonNegativeIntegerArray( padding ) ) { // eslint-disable-line max-len + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'cellPadding', padding ) ); + } + if ( isNonNegativeIntegerArray( padding ) ) { + if ( this._numColumns ) { + if ( padding.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'padding', this._numColumns, padding.length ) ); + } + } else { + this._numColumns = padding.length; + } + } + if ( !isEqual( padding, this._cellPaddingRight ) ) { + this._cellPaddingRight = padding; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js index 60fd29996d58..69395f1df009 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Returns the column separator character. +* Returns the column separator character(s). * * @private * @returns {string} column separator diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index e43341a4c047..2e97c7cc4b91 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -24,33 +24,24 @@ var isString = require( '@stdlib/assert/is-string' ); var format = require( '@stdlib/string/format' ); -// VARIABLES // - -var CHARACTER_LENGTH = 1; - - // MAIN // /** -* Sets the column separator character. +* Sets the column separator character(s). * * @private * @param {string} separator - column separator -* @throws {TypeError} must be a character string or 'None' +* @throws {TypeError} must be a string */ function set( separator ) { /* eslint-disable no-invalid-this */ if ( !isString( separator ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', separator ) ); } - if ( separator === 'None' ) { + if ( separator !== this._columnSeparator ) { this._columnSeparator = separator; - return; - } - if ( separator.length !== CHARACTER_LENGTH ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a single character or \'None\'. Value: `%s`.', 'columnSeparator', separator ) ); + this.emit( 'change' ); } - this._columnSeparator = separator; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js index 13500c3b0160..bb498efeb240 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js @@ -22,15 +22,11 @@ * Returns the table's corner characters. * * @private -* @returns {string} corners string +* @returns {Array} corners */ function get() { /* eslint-disable no-invalid-this */ - if ( this._corners[ 0 ] === ' ' ) { - // Empty corner: - return 'None'; - } - return this._corners.join( ' ' ); + return this._corners.slice(); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index 6f3c5e03759f..74633d863669 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -20,15 +20,15 @@ // MODULES // -var isString = require( '@stdlib/assert/is-string' ); +var isStringArray = require( '@stdlib/assert/is-string-array' ); +var numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); var format = require( '@stdlib/string/format' ); // VARIABLES // -var CORNER_STRING_LEN = 7; -var CORNER_CHARACTERS = 4; -var EMPTY_CORNERS = [ ' ', ' ', ' ', ' ' ]; +var NUM_CORNERS = 4; // MAIN // @@ -37,28 +37,25 @@ var EMPTY_CORNERS = [ ' ', ' ', ' ', ' ' ]; * Sets the table's corner characters. * * @private -* @param {string} corners - corners string -* @throws {TypeError} must be a string with four space separated characters or 'None' +* @param {Array} corners - corners +* @throws {TypeError} must be an array of four grapheme clusters */ function set( corners ) { /* eslint-disable no-invalid-this */ - var arr; + var i; - if ( !isString( corners ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'corners', corners ) ); + if ( !isStringArray( corners ) || corners.length !== NUM_CORNERS ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of four grapheme clusters. Value: `%s`.', 'corners', corners ) ); } - if ( corners === 'None' ) { - this._corners = EMPTY_CORNERS; - return; + for ( i = 0; i < NUM_CORNERS; i++ ) { + if ( numGraphemeClusters( corners[ i ] ) !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of four grapheme clusters. Value: `%s`.', 'corners', corners ) ); + } } - arr = corners.split( ' ' ); - if ( corners.length !== CORNER_STRING_LEN ) { - throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'corners', corners ) ); + if ( !isEqual( corners, this._corners ) ) { + this._corners = corners; + this.emit( 'change' ); } - if ( arr.length !== CORNER_CHARACTERS ) { - throw new TypeError( format( 'invalid assignment. `%s` must be four space separated characters or \'None\'. Value: `%s`.', 'corners', corners ) ); - } - this._corners = arr; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js new file mode 100644 index 000000000000..26e6b99c9d67 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.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'; + +// MODULES // + +var isArray = require( '@stdlib/assert/is-array' ); + + +// MAIN // + +/** +* Returns table data. +* +* @private +* @returns {Array|null} table data +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( isArray( this._data ) ) { + return this._data.slice(); + } + return this._data; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js new file mode 100644 index 000000000000..3d6583c3da87 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -0,0 +1,72 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var isMatrixLike = require( '@stdlib/assert/is-matrix-like' ); +var isArrayArray = require( '@stdlib/assert/is-array-array' ); +var ndarray2array = require( '@stdlib/ndarray/to-array' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); +var parse2dArray = require( './../../parser/parse_2d_array.js' ); + + +// MAIN // + +/** +* Sets the table data. +* +* @private +* @param {Array|MatrixLike} data - table data +* @throws {TypeError} must be a 2 dimensional array/ndarray +* @throws {RangeError} must provide correct number of columns +* @throws {RangeError} rows must not exceed maximum data buffer size +*/ +function set( data ) { + /* eslint-disable no-invalid-this */ + var parsed; + if ( isMatrixLike( data ) ) { + data = ndarray2array( data ); + } + if ( !isArrayArray( data ) ) { + throw new TypeError( format( 'invalid argument. `%s` must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', 'data', data ) ); + } + parsed = parse2dArray( data, this._headers ); + if ( parsed.data.length > this._bufferSize ) { + throw new RangeError( format( 'invalid assignment. `%s` length exceeds maximum data buffer size. Buffer size: `%u`. Length: `%u`.', 'data', this._bufferSize, parsed.data.length ) ); + } + if ( this._numColumns ) { + if ( parsed.columnWidths.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'data', this._numColumns, parsed.columnWidths.length ) ); + } + } else { + this._numColumns = parsed.columnWidths.length; + } + if ( !isEqual( parsed.data, this._data ) ) { + this._data = parsed.data; + this._columnWidths = parsed.columnWidths; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js index 8f87e32abca4..251f39912e81 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Returns the header separator character. +* Returns the header separator character(s). * * @private * @returns {string} header separator diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index 584db81ebea1..592bb4bc9090 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -24,33 +24,24 @@ var isString = require( '@stdlib/assert/is-string' ); var format = require( '@stdlib/string/format' ); -// VARIABLES // - -var CHARACTER_LENGTH = 1; - - // MAIN // /** -* Sets the header separator character. +* Sets the header separator character(s). * * @private * @param {string} separator - header separator -* @throws {TypeError} must be a character string or 'None' +* @throws {TypeError} must be a string */ function set( separator ) { /* eslint-disable no-invalid-this */ if ( !isString( separator ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', separator ) ); } - if ( separator === 'None' ) { + if ( separator !== this._headerSeparator ) { this._headerSeparator = separator; - return; - } - if ( separator.length !== CHARACTER_LENGTH ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a character or \'None\'. Value: `%s`.', 'headerSeparator', separator ) ); + this.emit( 'change' ); } - this._headerSeparator = separator; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js new file mode 100644 index 000000000000..f92278d36f41 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.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'; + +// MODULES // + +var isArray = require( '@stdlib/assert/is-array' ); + + +// MAIN // + +/** +* Returns table headers. +* +* @private +* @returns {Array|null} table headers +*/ +function get() { + /* eslint-disable no-invalid-this */ + if ( isArray( this._headers ) ) { + return this._headers.slice(); + } + return this._headers; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js new file mode 100644 index 000000000000..a3d90bcc23ec --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -0,0 +1,63 @@ +/** +* @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 format = require( '@stdlib/string/format' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); +var parseHeaders = require( './../../parser/parse_headers.js' ); + + +// MAIN // + +/** +* Sets the table data. +* +* @private +* @param {Collection} headers - table headers +* @throws {TypeError} must be a collection +* @throws {RangeError} must provide correct number of columns +*/ +function set( headers ) { + /* eslint-disable no-invalid-this */ + var parsed; + if ( !isCollection( headers ) ) { + throw new TypeError( format( 'invalid argument. `%s` must be a collection. Value: `%s`.', 'headers', headers ) ); + } + parsed = parseHeaders( headers, this._columnWidths ); + if ( this._numColumns ) { + if ( parsed.headers.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'headers', this._numColumns, parsed.columnWidths.length ) ); + } + } else { + this._numColumns = parsed.columnWidths.length; + } + if ( !isEqual( parsed.headers, this._headers ) ) { + this._headers = parsed.headers; + this._columnWidths = parsed.columnWidths; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js new file mode 100644 index 000000000000..f23865de9cdf --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's horizontal line separator mode. +* +* @private +* @returns {string} line separator mode +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._horizontalSeparatorMode; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js new file mode 100644 index 000000000000..aa31f0ef2cfb --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js @@ -0,0 +1,56 @@ +/** +* @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 contains = require( '@stdlib/array/base/assert/contains' ).factory; +var isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var isValidMode = contains( [ 'resume', 'interpolate', 'repeat' ] ); + + +// MAIN // + +/** +* Sets the table's horizontal line separator mode. +* +* @private +* @param {string} mode - line separator mode +* @throws {TypeError} must be a supported line separator mode string +*/ +function set( mode ) { + /* eslint-disable no-invalid-this */ + if ( !isString( mode ) || !isValidMode( mode ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a valid line separator mode string. Value: `%s`.', 'lineSeparatorMode', mode ) ); + } + if ( mode !== this._horizontalSeparatorMode ) { + this._horizontalSeparatorMode = mode; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js index 1a8a6811697c..1d2ba1b9cb38 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js @@ -22,15 +22,11 @@ * Returns the joint characters. * * @private -* @returns {string} joint character +* @returns {Array} joint characters */ function get() { /* eslint-disable no-invalid-this */ - if ( this._joints[ 0 ] === ' ' ) { - // Empty joint: - return 'None'; - } - return this._joints.join( ' ' ); + return this._joints.slice(); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 1ba1a89ce48b..3307a16f32d4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -20,15 +20,15 @@ // MODULES // -var isString = require( '@stdlib/assert/is-string' ); +var isStringArray = require( '@stdlib/assert/is-string-array' ); +var numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); var format = require( '@stdlib/string/format' ); // VARIABLES // -var JOINT_STRING_LEN = 9; -var JOINT_CHARACTERS = 5; -var EMPTY_JOINTS = [ ' ', ' ', ' ', ' ', ' ' ]; +var NUM_JOINTS = 5; // MAIN // @@ -37,28 +37,25 @@ var EMPTY_JOINTS = [ ' ', ' ', ' ', ' ', ' ' ]; * Sets the joint characters. * * @private -* @param {string} joints - joint character -* @throws {TypeError} must be a string with five space separated characters or 'None' +* @param {Array} joints - joint characters +* @throws {TypeError} must be an array of five grapheme clusters */ function set( joints ) { /* eslint-disable no-invalid-this */ - var arr; + var i; - if ( !isString( joints ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'joints', joints ) ); + if ( !isStringArray( joints ) || joints.length !== NUM_JOINTS ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of five grapheme clusters. Value: `%s`.', 'joints', joints ) ); } - if ( joints === 'None' ) { - this._joints = EMPTY_JOINTS; - return; + for ( i = 0; i < NUM_JOINTS; i++ ) { + if ( numGraphemeClusters( joints[ i ] ) !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of five grapheme clusters. Value: `%s`.', 'joints', joints ) ); + } } - arr = joints.split( ' ' ); - if ( joints.length !== JOINT_STRING_LEN ) { - throw new TypeError( format( 'invalid assignment. `%s` must be five space separated characters or \'None\'. Value: `%s`.', 'joints', joints ) ); + if ( !isEqual( joints, this._joints ) ) { + this._joints = joints; + this.emit( 'change' ); } - if ( arr.length !== JOINT_CHARACTERS ) { - throw new TypeError( format( 'invalid assignment. `%s` must be five space separated characters or \'None\'. Value: `%s`.', 'joints', joints ) ); - } - this._joints = arr; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js index 66407ad7200d..c424112179be 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js @@ -38,7 +38,10 @@ function set( x ) { if ( !isNonNegativeInteger( x ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'marginX', x ) ); } - this._marginX = x; + if ( x !== this._marginX ) { + this._marginX = x; + this.emit( 'change' ); + } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js index f1c5652c7c53..2ba10b80f880 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js @@ -38,7 +38,10 @@ function set( y ) { if ( !isNonNegativeInteger( y ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'marginY', y ) ); } - this._marginY = y; + if ( y !== this._marginY ) { + this._marginY = y; + this.emit( 'change' ); + } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js index 10513c017df6..2936f0d15728 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js @@ -18,14 +18,24 @@ 'use strict'; +// MODULES // + +var isArray = require( '@stdlib/assert/is-array' ); + + +// MAIN // + /** -* Returns the table's max cell width. +* Returns the table's max cell width(s). * * @private -* @returns {NonNegativeInteger} max cell width +* @returns {(Array|NonNegativeInteger)} max cell width(s) */ function get() { /* eslint-disable no-invalid-this */ + if ( isArray( this._maxCellWidth ) ) { + return this._maxCellWidth.slice(); + } return this._maxCellWidth; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js index a5762c2e6f63..8f9f31341fd5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js @@ -21,24 +21,61 @@ // MODULES // var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isArray = require( '@stdlib/assert/is-array' ); +var isNull = require( '@stdlib/assert/is-null' ); +var isEqual = require( '@stdlib/assert/deep-equal' ); var format = require( '@stdlib/string/format' ); +var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); // MAIN // /** -* Sets the table's max cell width. +* Sets the table's max cell width(s). * * @private -* @param {NonNegativeInteger} width - max cell width -* @throws {TypeError} must provide a non-negative integer +* @param {(Array|NonNegativeInteger|null)} width - max cell width(s) +* @throws {TypeError} must provide a non-negative integer, an array of non-negative integers or null +* @throws {RangeError} must provide correct number of columns if providing an array */ function set( width ) { /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( width ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'maxCellWidth', width ) ); + var out; + var FLG; + var i; + + FLG = isNull( width ); + if ( !isNonNegativeInteger( width ) && !isArray( width ) && !FLG ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'width', width ) ); + } + if ( isArray( width ) ) { + out = []; + for ( i = 0; i < width.length; i++ ) { + if ( isNull( width[ i ] ) ) { + out.push( FLOAT64_MAX ); + continue; + } + if ( !isNonNegativeInteger( width[ i ] ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'width', width ) ); + } + out.push( width[ i ] ); + } + if ( this._numColumns ) { + if ( out.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'width', this._numColumns, width.length ) ); + } + } else { + this._numColumns = out.length; + } + } else if ( FLG ) { + out = FLOAT64_MAX; + } else { + out = width; + } + if ( !isEqual( out, this._maxCellWidth ) ) { + this._maxCellWidth = out; + this.emit( 'change' ); } - this._maxCellWidth = width; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js index 59d2ab40e686..b87da48ef6cc 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js @@ -21,7 +21,9 @@ // MODULES // var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isNull = require( '@stdlib/assert/is-null' ); var format = require( '@stdlib/string/format' ); +var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); // MAIN // @@ -30,15 +32,22 @@ var format = require( '@stdlib/string/format' ); * Sets the table's max output width. * * @private -* @param {NonNegativeInteger} width - max output width -* @throws {TypeError} must provide a non-negative integer +* @param {(NonNegativeInteger|null)} width - max output width +* @throws {TypeError} must provide a non-negative integer or null */ function set( width ) { /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( width ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'maxOutputWidth', width ) ); + var FLG = isNull( width ); + if ( !isNonNegativeInteger( width ) && !FLG ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or null. Value: `%s`.', 'maxOutputWidth', width ) ); + } + if ( FLG ) { + width = FLOAT64_MAX; + } + if ( width !== this._maxOutputWidth ) { + this._maxOutputWidth = width; + this.emit( 'change' ); } - this._maxOutputWidth = width; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js index d404104acc21..ba503a4e2ddb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Returns the row separator character. +* Returns the row separator character(s). * * @private * @returns {string} row separator diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index 0c824793df1d..3b2c96821a39 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -24,33 +24,24 @@ var isString = require( '@stdlib/assert/is-string' ); var format = require( '@stdlib/string/format' ); -// VARIABLES // - -var CHARACTER_LENGTH = 1; - - // MAIN // /** -* Sets the row separator character. +* Sets the row separator character(s). * * @private * @param {string} separator - row separator -* @throws {TypeError} must be a character string or 'None' +* @throws {TypeError} must be a string */ function set( separator ) { /* eslint-disable no-invalid-this */ if ( !isString( separator ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', separator ) ); } - if ( separator === 'None' ) { + if ( separator !== this._rowSeparator ) { this._rowSeparator = separator; - return; - } - if ( separator.length !== CHARACTER_LENGTH ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a character or \'None\'. Value: `%s`.', 'rowSeparator', separator ) ); + this.emit( 'change' ); } - this._rowSeparator = separator; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js new file mode 100644 index 000000000000..b8760b12e1c2 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js @@ -0,0 +1,35 @@ +/** +* @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'; + +/** +* Returns the table's vertical line separator mode. +* +* @private +* @returns {string} line separator mode +*/ +function get() { + /* eslint-disable no-invalid-this */ + return this._verticalSeparatorMode; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js new file mode 100644 index 000000000000..9c40fb45a651 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js @@ -0,0 +1,56 @@ +/** +* @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 contains = require( '@stdlib/array/base/assert/contains' ).factory; +var isString = require( '@stdlib/assert/is-string' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var isValidMode = contains( [ 'resume', 'interpolate', 'repeat' ] ); + + +// MAIN // + +/** +* Sets the table's vertical line separator mode. +* +* @private +* @param {string} mode - line separator mode +* @throws {TypeError} must be a supported line separator mode string +*/ +function set( mode ) { + /* eslint-disable no-invalid-this */ + if ( !isString( mode ) || !isValidMode( mode ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a valid line separator mode string. Value: `%s`.', 'lineSeparatorMode', mode ) ); + } + if ( mode !== this._verticalSeparatorMode ) { + this._verticalSeparatorMode = mode; + this.emit( 'change' ); + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js similarity index 61% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index caeeb454ca15..85b3393a3344 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/addrow.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -28,14 +28,15 @@ var parse2dArray = require( './parser/parse_2d_array.js' ); // MAIN // /** -* Adds a row to table data. +* Appends row. * * @private * @param {Collection} row - row to add -* @throws {TypeError} must provide a collection with equal number of columns to existing data +* @throws {TypeError} must provide a collection +* @throws {RangeError} must provide correct number of columns * @returns {UnicodeTable} class instance */ -function addRow( row ) { +function push( row ) { /* eslint-disable no-invalid-this */ var parsed; @@ -45,19 +46,33 @@ function addRow( row ) { // If data doesn't already exist, parse row as new data... if ( !this._data || !this._data.length ) { parsed = parse2dArray( [ row ], this._headers ); + if ( this._numColumns ) { + if ( parsed.columnWidths.length !== this._numColumns ) { + throw new RangeError( format( 'invalid argument. `%s` must have `%d` number of columns. Value: `%d`.', 'data', this._numColumns, parsed.columnWidths.length ) ); + } + } else { + this._numColumns = parsed.columnWidths.length; + } this._data = parsed.data; this._headers = parsed.headers; this._columnWidths = parsed.columnWidths; + this.emit( 'change' ); return this; } - if ( this._data[ 0 ].length !== row.length ) { - throw new TypeError( format( 'invalid argument. Must provide a collection with equal number of columns to existing data. Value: `%s`.', row ) ); + if ( this._numColumns !== row.length ) { + throw new RangeError( format( 'invalid argument. `%s` must have `%d` number of columns. Value: `%d`.', 'data', this._numColumns, row.length ) ); + } + if ( this._data.length >= this._bufferSize ) { + this._data.shift(); } this._data.push( row ); + parsed = parse2dArray( this._data, this._headers ); + this._columnWidths = parsed.columnWidths; + this.emit( 'change' ); return this; } // EXPORTS // -module.exports = addRow; +module.exports = push; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index b6829c758a98..601f3d6ad632 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -16,12 +16,18 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this, no-underscore-dangle, max-lines-per-function */ + 'use strict'; // MODULES // var format = require( '@stdlib/string/format' ); var repeat = require( '@stdlib/string/repeat' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var isString = require( '@stdlib/assert/is-string' ); +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var filled = require( '@stdlib/array/base/filled' ); var floor = require( '@stdlib/math/base/special/floor' ); var ceil = require( '@stdlib/math/base/special/ceil' ); var min = require( '@stdlib/math/base/special/min' ); @@ -39,8 +45,16 @@ var truncate = require( '@stdlib/string/truncate' ); * @returns {string} rendered table */ function render() { - /* eslint-disable no-invalid-this, no-underscore-dangle */ + var verticalLineIdx; + var columnSeparator; + var headerSeparator; + var maxCellWidths; + var paddingsRight; + var rowSeparator; + var paddingsLeft; var wrapIndices; + var alignments; + var borders; var widths; var start; var table; @@ -55,10 +69,8 @@ function render() { self = this; out = ''; - if ( !this._columnWidths ) { - // Empty table: - return out; - } + // Resolve table properties: + resolveProps(); // Resolve indices to wrap the table at: wrapIndices = resolveWrapping(); @@ -70,14 +82,18 @@ function render() { wraps = []; for ( j = 0; j < wrapIndices.length - 1; j++ ) { table = ''; + verticalLineIdx = 0; start = wrapIndices[ j ]; end = wrapIndices[ j + 1 ]; // Render top border: - if ( this._borders !== 'None' ) { + if ( borders[ 0 ].length !== 0 ) { widths = slice( this._columnWidths, start, end ); - table += renderLine( this._borders[ 0 ], widths, this._corners[ 0 ], this._joints[ 1 ], this._corners[ 1 ] ); // eslint-disable-line max-len + table += renderLine( borders[ 0 ], widths, this._corners[ 0 ], this._joints[ 1 ], this._corners[ 1 ] ); // eslint-disable-line max-len table += '\n'; + if ( this._verticalSeparatorMode === 'interpolate' ) { + verticalLineIdx += 1; + } } // Render headers: @@ -86,13 +102,19 @@ function render() { widths = slice( this._columnWidths, start, end ); table += renderRow( row, widths ); table += '\n'; + verticalLineIdx += 1; } // Render header separator: - if ( this._headers && this._headerSeparator !== 'None' ) { + if ( this._headers && headerSeparator.length !== 0 ) { widths = slice( this._columnWidths, start, end ); - table += renderLine( this._headerSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len + table += renderLine( headerSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len table += '\n'; + if ( this._verticalSeparatorMode === 'interpolate' ) { + verticalLineIdx += 1; + } else if ( this._verticalSeparatorMode === 'repeat' ) { + verticalLineIdx = 0; + } } // Render data: @@ -102,22 +124,30 @@ function render() { row = slice( this._data[ i ], start, end ); widths = slice( this._columnWidths, start, end ); table += renderRow( row, widths ); - if ( i !== this._data.length - 1 || this._borders !== 'None' ) { + if ( i !== this._data.length - 1 ) { table += '\n'; } + verticalLineIdx += 1; + // Render row separator: - if ( this._rowSeparator !== 'None' && i !== this._data.length - 1 ) { + if ( rowSeparator.length !== 0 && i !== this._data.length - 1 ) { // eslint-disable-line max-len widths = slice( this._columnWidths, start, end ); - table += renderLine( this._rowSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len + table += renderLine( rowSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len table += '\n'; + if ( this._verticalSeparatorMode === 'interpolate' ) { + verticalLineIdx += 1; + } else if ( this._verticalSeparatorMode === 'repeat' ) { + verticalLineIdx = 0; + } } } } // Render bottom border: - if ( this._borders !== 'None' ) { + if ( borders[ 2 ].length !== 0 ) { + table += '\n'; widths = slice( this._columnWidths, start, end ); - table += renderLine( this._borders[ 2 ], widths, this._corners[ 3 ], this._joints[ 3 ], this._corners[ 2 ] ); // eslint-disable-line max-len + table += renderLine( borders[ 2 ], widths, this._corners[ 3 ], this._joints[ 3 ], this._corners[ 2 ] ); // eslint-disable-line max-len } wraps.push( table ); } @@ -125,8 +155,46 @@ function render() { // Render bottom margin: out += repeat( '\n', this._marginY ); + + this.emit( 'render', out ); return out; + /** + * Resolves table properties for rendering. + * + * @private + */ + function resolveProps() { + var i; + if ( isString( self._alignment ) ) { + alignments = filled( self._alignment, self._numColumns ); + } else { + alignments = self._alignment; + } + if ( isNonNegativeInteger( self._cellPaddingLeft ) ) { + paddingsLeft = filled( self._cellPaddingLeft, self._numColumns ); + } else { + paddingsLeft = self._cellPaddingLeft; + } + if ( isNonNegativeInteger( self._cellPaddingRight ) ) { + paddingsRight = filled( self._cellPaddingRight, self._numColumns ); + } else { + paddingsRight = self._cellPaddingRight; + } + if ( isNonNegativeInteger( self._maxCellWidth ) ) { + maxCellWidths = filled( self._maxCellWidth, self._numColumns ); + } else { + maxCellWidths = self._maxCellWidth; + } + borders = []; + for ( i = 0; i < self._borders.length; i++ ) { + borders.push( splitGraphemeClusters( self._borders[ i ] ) ); + } + columnSeparator = splitGraphemeClusters( self._columnSeparator ); + headerSeparator = splitGraphemeClusters( self._headerSeparator ); + rowSeparator = splitGraphemeClusters( self._rowSeparator ); + } + /** * Resolves columns to wrap the table at (includes bounding indices). * @@ -137,7 +205,6 @@ function render() { function resolveWrapping() { var outputWidth; var fixedLength; - var colWidth; var indices; // Initialize with zeroth index: @@ -145,13 +212,18 @@ function render() { // Calculate fixed horizontal length: fixedLength = 2 * self._marginX; - if ( self._borders !== 'None' ) { - fixedLength += 2; + if ( borders[ 1 ] !== 0 ) { + fixedLength += 1; + } + if ( borders[ 3 ] !== 0 ) { + fixedLength += 1; + } + if ( !self._columnWidths ) { + return indices; } outputWidth = 0; for ( i = 0; i < self._columnWidths.length; i++ ) { - colWidth = min( self._columnWidths[ i ], self._maxCellWidth ); // width of current column - outputWidth += colWidth + ( 2 * self._cellPadding ); + outputWidth += min( self._columnWidths[ i ] + ( paddingsLeft[ i ] + paddingsRight[ i ] ), maxCellWidths[ i ] ); // eslint-disable-line max-len // If output crosses the maximum, time to wrap: if ( outputWidth + fixedLength > self._maxOutputWidth ) { @@ -164,7 +236,7 @@ function render() { continue; } // Include column separator. Exclude for last column as we included them as borders: - if ( i !== self._columnWidths.length - 1 && self._columnSeparator !== 'None' ) { + if ( i !== self._columnWidths.length - 1 && columnSeparator.length !== 0 ) { // eslint-disable-line max-len outputWidth += 1; } } @@ -177,38 +249,52 @@ function render() { * Renders a line. * * @private - * @param {string} lineChar - line character + * @param {string} lineChars - line character * @param {Array} columnWidths - column widths * @param {string} jointL - left joint * @param {string} jointM - middle joint * @param {jointR} jointR - right joint * @returns {string} rendered line */ - function renderLine( lineChar, columnWidths, jointL, jointM, jointR ) { + function renderLine( lineChars, columnWidths, jointL, jointM, jointR ) { + var horizontalLineIdx; var colWidth; var out; var i; + var j; out = ''; + horizontalLineIdx = 0; // Render left margin: out += repeat( ' ', self._marginX ); // Render left joint: - if ( self._borders !== 'None' ) { + if ( borders[ 3 ].length !== 0 ) { out += jointL; + if ( self._horizontalSeparatorMode === 'interpolate' ) { + horizontalLineIdx += 1; + } } // Render line: for ( i = 0; i < columnWidths.length; i++ ) { // If columns are separated, render the middle joint... - if ( self._columnSeparator !== 'None' && i !== 0 ) { + if ( columnSeparator.length !== 0 && i !== 0 ) { out += jointM; + if ( self._horizontalSeparatorMode === 'interpolate' ) { + horizontalLineIdx += 1; + } else if ( self._horizontalSeparatorMode === 'repeat' ) { + horizontalLineIdx = 0; + } + } + colWidth = min( columnWidths[ i ] + ( paddingsLeft[ i ] + paddingsRight[ i ] ), maxCellWidths[ i ] ); // eslint-disable-line max-len + for ( j = 0; j < colWidth; j++ ) { + out += lineChars[ horizontalLineIdx % lineChars.length ]; + horizontalLineIdx += 1; } - colWidth = min( columnWidths[ i ], self._maxCellWidth ); - out += repeat( lineChar, colWidth + ( 2 * self._cellPadding ) ); } // Render right joint: - if ( self._borders !== 'None' ) { + if ( borders[ 1 ].length !== 0 ) { out += jointR; } // Render right margin: @@ -225,6 +311,7 @@ function render() { * @returns {string} rendered line */ function renderRow( data, columnWidths ) { + var maxDatumWidth; var width; var datum; var out; @@ -236,24 +323,27 @@ function render() { out += repeat( ' ', self._marginX ); // Render left border: - if ( self._borders !== 'None' ) { - out += self._borders[ 3 ]; + if ( borders[ 3 ].length !== 0 ) { + out += borders[ 3 ][ verticalLineIdx % borders[ 3 ].length ]; } for ( i = 0; i < columnWidths.length; i++ ) { // Render column separator... - if ( self._columnSeparator !== 'None' && i !== 0 ) { - out += self._columnSeparator; + if ( columnSeparator.length !== 0 && i !== 0 ) { + out += columnSeparator[ verticalLineIdx % columnSeparator.length ]; // eslint-disable-line max-len } // Render left cell padding: - out += repeat( ' ', self._cellPadding ); + out += repeat( ' ', paddingsLeft[ i ] ); + + // If datum is longer than what is allowed by `maxCellWidth`, truncate it... datum = String( data[ i ] ); - width = min( columnWidths[ i ], self._maxCellWidth ); - if ( datum.length > self._maxCellWidth ) { - // Truncate long datum: - datum = truncate( datum, self._maxCellWidth ); + maxDatumWidth = maxCellWidths[ i ] - ( paddingsLeft[ i ] + paddingsRight[ i ] ); // eslint-disable-line max-len + width = columnWidths[ i ]; + if ( width > maxDatumWidth ) { + datum = truncate( datum, maxDatumWidth ); + width = maxDatumWidth; } // Render datum: - switch ( self._alignment ) { + switch ( alignments[ i ] ) { case 'left': out += datum; out += repeat( ' ', width - datum.length ); @@ -271,11 +361,11 @@ function render() { break; } // Render right cell padding: - out += repeat( ' ', self._cellPadding ); + out += repeat( ' ', paddingsRight[ i ] ); } // Render right border: - if ( self._borders !== 'None' ) { - out += self._borders[ 1 ]; + if ( borders[ 1 ].length !== 0 ) { + out += borders[ 1 ][ verticalLineIdx % borders[ 1 ].length ]; } // Render right margin: out += repeat( ' ', self._marginX ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js deleted file mode 100644 index 12d2ba6cf4f5..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.add_row.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var ctor = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ctor, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function adds a row to existing data', function test( t ) { - var expected; - var headers; - var table; - var data; - var row; - var v; - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table = ctor( data, headers ); - - row = [ 1, true, 'hello' ]; - table.addRow( row ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ], [ 1, true, 'hello' ] ]; - expected.headers = [ 'col1', 'col2', 'col3' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function creates table data if no existing data found', function test( t ) { - var expected; - var table; - var row; - var v; - - table = ctor(); - - row = [ 1, true, 'hello' ]; - table.addRow( row ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 1, true, 'hello' ] ]; - expected.headers = null; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js index 5bd1dff4e153..0fa4b33bbf2b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -46,7 +47,9 @@ tape( 'an instance throws an error if provided an invalid `alignment` value', fu {}, [], '1234', - 'middle' + 'middle', + [ 4, 'hello', null ], + [ 'beep', 'boop' ] ]; for ( i = 0; i < values.length; i++ ) { @@ -64,11 +67,13 @@ tape( 'an instance throws an error if provided an invalid `alignment` value', fu tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; + var arr; - table = ctor( data, { + table = ctor( null, { 'alignment': 'right' }); + table.render = noop; + t.strictEqual( table.alignment, 'right', 'returns expected value' ); table.alignment = 'left'; @@ -77,5 +82,68 @@ tape( 'an instance supports setting and getting the property value', function te table.alignment = 'center'; t.strictEqual( table.alignment, 'center', 'returns expected value' ); + arr = [ 'left', 'right', 'center' ]; + table.alignment = arr; + t.notEqual( table.alignment, arr, 'returns a new reference' ); + t.deepEqual( table.alignment, arr, 'returns expected value' ); + + t.end(); +}); + +tape( 'an instance throws an error if provided an `alignment` array with incorrect number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns + table.alignment = [ 'left', 'right' ]; // 2 columns + } +}); + +tape( 'settings the `alignment` property to an array sets number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); t.end(); + + function badValue() { + var table = ctor( null, { + 'alignment': [ 'left', 'center', 'right' ] // 3 columns + }); + table.data = [ [ 1, 2 ], [ 4, 5 ] ]; // 2 columns + } +}); + +tape( 'setting the `alignment` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'alignment': 'right' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.alignment = [ 'left', 'right' ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `alignment` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'alignment': [ 'left', 'right' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.alignment = [ 'left', 'right' ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } }); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js new file mode 100644 index 000000000000..05bbdbe6c379 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js @@ -0,0 +1,152 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `autoRender` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + null, + void 0, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.autoRender = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + + table = ctor( null, { + 'autoRender': false + }); + table.render = noop; + t.strictEqual( table.autoRender, false, 'returns expected value' ); + + table.autoRender = true; + t.strictEqual( table.autoRender, true, 'returns expected value' ); + + table.autoRender = false; + t.strictEqual( table.autoRender, false, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `autoRender` is `true`, when a returned instance receives a `change` event, it re-renders and emits a `render` event', function test( t ) { + var table; + + table = ctor( null, { + 'autoRender': true + }); + + table.on( 'render', onRender ); + table.emit( 'change' ); + + function onRender( str ) { + t.ok( true, 'emits a render event' ); + t.strictEqual( str, '', 'provides expected value' ); + t.end(); + } +}); + +tape( 'if `autoRender` is `false`, when a returned instance receives a `change` event, it does not re-render or emit a `render` event', function test( t ) { + var table; + + table = ctor( null, { + 'autoRender': false + }); + table.render = noop; + + table.on( 'render', onRender ); + table.emit( 'change' ); + + t.pass( 'is ok' ); + t.end(); + + function onRender() { + t.fail( 'should never be invoked' ); + } +}); + +tape( 'setting the `autoRender` property triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'autoRender': false + }); + table.render = noop; + + table.on( 'change', onChange ); + table.autoRender = true; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `autoRender` property to an existing value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'autoRender': true + }); + table.render = noop; + + table.on( 'change', onChange ); + table.autoRender = true; + + t.pass( 'is ok' ); + t.end(); + + function onChange() { + t.fail( 'should never be called' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js index f1bc1538cf28..086c9d6d8885 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -45,8 +46,9 @@ tape( 'an instance throws an error if provided an invalid `borders` value', func void 0, {}, [], - 'hello', - '1234567' + 'beep', + [ 4, 'hello', null, 'world' ], + [ 'beep', 'boop', 'foo' ] ]; for ( i = 0; i < values.length; i++ ) { @@ -64,18 +66,60 @@ tape( 'an instance throws an error if provided an invalid `borders` value', func tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; + var arr; - table = ctor( data, { - 'borders': '1 2 3 4' + arr = [ '-', '|', '=', '!' ]; + table = ctor( null, { + 'borders': arr }); - t.strictEqual( table.borders, '1 2 3 4', 'returns expected value' ); + t.notEqual( table.borders, arr, 'returns a new reference' ); + t.deepEqual( table.borders, arr, 'returns expected value' ); - table.borders = '- | _ |'; - t.strictEqual( table.borders, '- | _ |', 'returns expected value' ); + arr = [ '1', '23', '456', '7890' ]; + table.borders = arr; + t.notEqual( table.borders, arr, 'returns a new reference' ); + t.deepEqual( table.borders, arr, 'returns expected value' ); - table.borders = 'None'; - t.strictEqual( table.borders, 'None', 'returns expected value' ); + arr = [ '', '🌹', '', '@🥀' ]; + table.borders = arr; + t.notEqual( table.borders, arr, 'returns a new reference' ); + t.deepEqual( table.borders, arr, 'returns expected value' ); t.end(); }); + +tape( 'setting the `borders` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'borders': [ '-', '|', '=', '!' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.borders = [ '1', '23', '456', '7890' ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `borders` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'borders': [ '-', '|', '=', '!' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.borders = [ '-', '|', '=', '!' ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js new file mode 100644 index 000000000000..b44594ac2e68 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js @@ -0,0 +1,146 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `bufferSize` value', function test( t ) { + var values; + var i; + + values = [ + '5', + -5, + 0, + 3.14, + NaN, + void 0, + true, + false, + {}, + [], + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.bufferSize = value; + }; + } +}); + +tape( 'an instance throws an error if provided a `bufferSize` which is less than the number of data elements', function test( t ) { + var values; + var i; + + values = [ + 1, + 2, + 3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor( [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ], [ 7, 8 ] ] ); + table.bufferSize = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + + table = ctor( null, { + 'bufferSize': 10 + }); + table.render = noop; + t.strictEqual( table.bufferSize, 10, 'returns expected value' ); + + table.bufferSize = 20; + t.strictEqual( table.bufferSize, 20, 'returns expected value' ); + + table.bufferSize = 30; + t.strictEqual( table.bufferSize, 30, 'returns expected value' ); + + table.bufferSize = null; + t.strictEqual( table.bufferSize, FLOAT64_MAX, 'returns expected value' ); + + t.end(); +}); + +tape( 'setting the `bufferSize` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'bufferSize': 10 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.bufferSize = 30; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `bufferSize` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'bufferSize': 10 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.bufferSize = 10; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js deleted file mode 100644 index 230d613f0e7b..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding.js +++ /dev/null @@ -1,80 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var ctor = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ctor, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'an instance throws an error if provided an invalid `cellPadding` value', function test( t ) { - var values; - var i; - - values = [ - '5', - 2.4, - -3, - true, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - var table = ctor(); - table.cellPadding = value; - }; - } -}); - -tape( 'an instance supports setting and getting the property value', function test( t ) { - var table; - var data = null; - - table = ctor( data, { - 'cellPadding': 2 - }); - t.strictEqual( table.cellPadding, 2, 'returns expected value' ); - - table.cellPadding = 3; - t.strictEqual( table.cellPadding, 3, 'returns expected value' ); - - table.cellPadding = 0; - t.strictEqual( table.cellPadding, 0, 'returns expected value' ); - - t.end(); -}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js new file mode 100644 index 000000000000..51486f34c220 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js @@ -0,0 +1,143 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `cellPaddingLeft` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {}, + [ 4, 'hello', null ], + [ 2, -5, 3.4 ] + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.cellPaddingLeft = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var arr; + + table = ctor( null, { + 'cellPaddingLeft': 2 + }); + t.strictEqual( table.cellPaddingLeft, 2, 'returns expected value' ); + + table.cellPaddingLeft = 3; + t.strictEqual( table.cellPaddingLeft, 3, 'returns expected value' ); + + arr = [ 0, 5 ]; + table.cellPaddingLeft = arr; + t.notEqual( table.cellPaddingLeft, arr, 'returns a new reference' ); + t.deepEqual( table.cellPaddingLeft, arr, 'returns expected value' ); + + t.end(); +}); + +tape( 'an instance throws an error if provided a `cellPaddingLeft` array with incorrect number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns + table.cellPaddingLeft = [ 1, 2 ]; // 2 columns + } +}); + +tape( 'settings the `cellPaddingLeft` property to an array sets number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( null, { + 'cellPaddingLeft': [ 1, 2, 3 ] // 3 columns + }); + table.data = [ [ 1, 2 ], [ 4, 5 ] ]; // 2 columns + } +}); + +tape( 'setting the `cellPaddingLeft` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'cellPaddingLeft': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.cellPaddingLeft = [ 1, 2 ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `cellPaddingLeft` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'cellPaddingLeft': [ 2, 3 ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.cellPaddingLeft = [ 2, 3 ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js new file mode 100644 index 000000000000..15655cb96d46 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js @@ -0,0 +1,143 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `cellPaddingRight` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 2.4, + -3, + true, + null, + void 0, + {}, + [], + function noop() {}, + [ 4, 'hello', null ], + [ 2, -5, 3.4 ] + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.cellPaddingRight = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var arr; + + table = ctor( null, { + 'cellPaddingRight': 2 + }); + t.strictEqual( table.cellPaddingRight, 2, 'returns expected value' ); + + table.cellPaddingRight = 3; + t.strictEqual( table.cellPaddingRight, 3, 'returns expected value' ); + + arr = [ 0, 5 ]; + table.cellPaddingRight = arr; + t.notEqual( table.cellPaddingRight, arr, 'returns a new reference' ); + t.deepEqual( table.cellPaddingRight, arr, 'returns expected value' ); + + t.end(); +}); + +tape( 'an instance throws an error if provided a `cellPaddingRight` array with incorrect number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns + table.cellPaddingRight = [ 1, 2 ]; // 2 columns + } +}); + +tape( 'settings the `cellPaddingRight` property to an array sets number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( null, { + 'cellPaddingRight': [ 1, 2, 3 ] // 3 columns + }); + table.data = [ [ 1, 2 ], [ 4, 5 ] ]; // 2 columns + } +}); + +tape( 'setting the `cellPaddingRight` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'cellPaddingRight': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.cellPaddingRight = [ 1, 2 ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `cellPaddingRight` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'cellPaddingRight': [ 2, 3 ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.cellPaddingRight = [ 2, 3 ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js index 9517244e5f3d..9cc52ba6ca42 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -44,8 +45,7 @@ tape( 'an instance throws an error if provided an invalid `columnSeparator` valu null, void 0, {}, - [], - '5437' + [] ]; for ( i = 0; i < values.length; i++ ) { @@ -70,11 +70,47 @@ tape( 'an instance supports setting and getting the property value', function te }); t.strictEqual( table.columnSeparator, '1', 'returns expected value' ); - table.columnSeparator = '!'; - t.strictEqual( table.columnSeparator, '!', 'returns expected value' ); + table.columnSeparator = '!/1'; + t.strictEqual( table.columnSeparator, '!/1', 'returns expected value' ); - table.columnSeparator = 'None'; - t.strictEqual( table.columnSeparator, 'None', 'returns expected value' ); + table.columnSeparator = ''; + t.strictEqual( table.columnSeparator, '', 'returns expected value' ); t.end(); }); + +tape( 'setting the `columnSeparator` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'columnSeparator': '1' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.columnSeparator = '23'; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `columnSeparator` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'columnSeparator': '1' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.columnSeparator = '1'; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js index 690514acf20b..18d774c1abc1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -45,8 +46,9 @@ tape( 'an instance throws an error if provided an invalid `corners` value', func void 0, {}, [], - 'hello', - '1234567' + 'beep', + [ 4, 'hello', null, 'world' ], + [ 'beep', 'boop', 'foo', '' ] ]; for ( i = 0; i < values.length; i++ ) { @@ -64,18 +66,60 @@ tape( 'an instance throws an error if provided an invalid `corners` value', func tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; + var arr; - table = ctor( data, { - 'corners': '1 2 3 4' + arr = [ '1', '2', '3', '4' ]; + table = ctor( null, { + 'corners': [ '1', '2', '3', '4' ] }); - t.strictEqual( table.corners, '1 2 3 4', 'returns expected value' ); + t.notEqual( table.corners, arr, 'returns a new reference' ); + t.deepEqual( table.corners, arr, 'returns expected value' ); - table.corners = '* * * *'; - t.strictEqual( table.corners, '* * * *', 'returns expected value' ); + arr = [ '*', '&', '-', '=' ]; + table.corners = arr; + t.notEqual( table.corners, arr, 'returns a new reference' ); + t.deepEqual( table.corners, arr, 'returns expected value' ); - table.corners = 'None'; - t.strictEqual( table.corners, 'None', 'returns expected value' ); + arr = [ '🥀', '🌹', ' ', '🔥' ]; + table.corners = arr; + t.notEqual( table.corners, arr, 'returns a new reference' ); + t.deepEqual( table.corners, arr, 'returns expected value' ); t.end(); }); + +tape( 'setting the `corners` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'corners': [ '-', '|', '=', '!' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.corners = [ '1', '2', '3', '4' ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `corners` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'corners': [ '-', '|', '=', '!' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.corners = [ '-', '|', '=', '!' ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js new file mode 100644 index 000000000000..fee3f5527cc3 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js @@ -0,0 +1,177 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `data` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + null, + void 0, + true, + false, + [], + {}, + function noop() {}, + [ 1, 'hello', null ] + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.data = value; + }; + } +}); + +tape( 'an instance throws an error if provided a `data` value which more rows than the data buffer size', function test( t ) { + var values; + var i; + + values = [ + [ [ 1, 2 ], [ 3, 4 ] ], + [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ], + [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ], [ 7, 8 ] ] + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor( null, { + 'bufferSize': 1 + }); + table.data = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var arr; + + arr = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]; + table = ctor( arr ); + table.render = noop; + t.notEqual( table.data, arr, 'returns a new reference' ); + t.deepEqual( table.data, arr, 'returns expected value' ); + + arr = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ], [ 7, 8 ] ]; + table.data = arr; + t.notEqual( table.data, arr, 'returns a new reference' ); + t.deepEqual( table.data, arr, 'returns expected value' ); + + arr = ndarray( 'generic', [ 1, 2, 3, 4 ], [ 2, 2 ], [ 2, 1 ], 0, 'row-major' ); + table.data = arr; + t.notEqual( table.data, arr, 'returns a new reference' ); + t.deepEqual( table.data, [ [ 1, 2 ], [ 3, 4 ] ], 'returns expected value' ); + + t.end(); +}); + +tape( 'an instance throws an error if provided `data` with incorrect number of columns', function test( t ) { + var values; + var i; + + values = [ + [ [ 1, 2 ], [ 3, 4 ] ], + [ [ 1, 2, 3 ], [ 4, 5 ] ] + ]; + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), RangeError, 'throws an error' ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor( null, [ 'col1', 'col2', 'col3' ] ); // 3 columns + table.data = value; + }; + } +}); + +tape( 'settings the `data` property sets number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns + table.headers = [ 'col1', 'col2' ]; // 2 columns + } +}); + +tape( 'setting the `data` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( [ [ 1, 2 ], [ 3, 4 ] ] ); + table.render = noop; + + table.on( 'change', onChange ); + table.data = [ [ 5, 6 ], [ 7, 8 ] ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `data` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( [ [ 1, 2 ], [ 3, 4 ] ] ); + table.render = noop; + + table.on( 'change', onChange ); + table.data = [ [ 1, 2 ], [ 3, 4 ] ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js index d5d3c68c555a..fc5ecaac3057 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -44,8 +45,7 @@ tape( 'an instance throws an error if provided an invalid `headerSeparator` valu null, void 0, {}, - [], - '5437' + [] ]; for ( i = 0; i < values.length; i++ ) { @@ -70,11 +70,47 @@ tape( 'an instance supports setting and getting the property value', function te }); t.strictEqual( table.headerSeparator, '1', 'returns expected value' ); - table.headerSeparator = '!'; - t.strictEqual( table.headerSeparator, '!', 'returns expected value' ); + table.headerSeparator = '!/1'; + t.strictEqual( table.headerSeparator, '!/1', 'returns expected value' ); - table.headerSeparator = 'None'; - t.strictEqual( table.headerSeparator, 'None', 'returns expected value' ); + table.headerSeparator = ''; + t.strictEqual( table.headerSeparator, '', 'returns expected value' ); t.end(); }); + +tape( 'setting the `headerSeparator` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'headerSeparator': '1' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.headerSeparator = '23'; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `headerSeparator` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'headerSeparator': '1' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.headerSeparator = '1'; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js new file mode 100644 index 000000000000..fdffdba4976d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js @@ -0,0 +1,138 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `headers` value', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + NaN, + null, + void 0, + true, + false, + {}, + function noop() {} + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.data = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + var arr; + + arr = [ 'col1', 'col2' ]; + table = ctor( null, arr ); + table.render = noop; + t.notEqual( table.headers, arr, 'returns a new reference' ); + t.deepEqual( table.headers, arr, 'returns expected value' ); + + arr = [ 1, 2 ]; + table.headers = arr; + t.notEqual( table.headers, arr, 'returns a new reference' ); + t.deepEqual( table.headers, arr, 'returns expected value' ); + + arr = [ null, undefined ]; + table.headers = arr; + t.notEqual( table.headers, arr, 'returns a new reference' ); + t.deepEqual( table.headers, arr, 'returns expected value' ); + + t.end(); +}); + +tape( 'an instance throws an error if provided `headers` with incorrect number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns + table.headers = [ 'col1', 'col2' ]; // 2 columns + } +}); + +tape( 'settings the `headers` property sets number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( null, [ 'col1', 'col2', 'col3' ] ); // 3 columns + table.data = [ [ 1, 2 ], [ 3, 4 ] ]; // 2 columns + } +}); + +tape( 'setting the `headers` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, [ 'col1', 'col2' ] ); + table.render = noop; + + table.on( 'change', onChange ); + table.headers = [ 1, 2 ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `headers` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, [ 'col1', 'col2' ] ); + table.render = noop; + + table.on( 'change', onChange ); + table.headers = [ 'col1', 'col2' ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js new file mode 100644 index 000000000000..eee3b275a76e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js @@ -0,0 +1,119 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `horizontalSeparatorMode` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + '1234', + 'beep' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.horizontalSeparatorMode = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + + table = ctor( null, { + 'horizontalSeparatorMode': 'interpolate' + }); + table.render = noop; + + t.strictEqual( table.horizontalSeparatorMode, 'interpolate', 'returns expected value' ); + + table.horizontalSeparatorMode = 'repeat'; + t.strictEqual( table.horizontalSeparatorMode, 'repeat', 'returns expected value' ); + + table.horizontalSeparatorMode = 'resume'; + t.strictEqual( table.horizontalSeparatorMode, 'resume', 'returns expected value' ); + + t.end(); +}); + +tape( 'setting the `horizontalSeparatorMode` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'horizontalSeparatorMode': 'interpolate' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.horizontalSeparatorMode = 'resume'; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `horizontalSeparatorMode` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'horizontalSeparatorMode': 'repeat' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.horizontalSeparatorMode = 'repeat'; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js index efc987353387..f414ae198739 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -45,8 +46,9 @@ tape( 'an instance throws an error if provided an invalid `joints` value', funct void 0, {}, [], - 'hello', - '1234567' + 'beep', + [ 4, 'hello', null, 'world' ], + [ 'beep', 'boop', 'foo', '', 'bar' ] ]; for ( i = 0; i < values.length; i++ ) { @@ -64,18 +66,60 @@ tape( 'an instance throws an error if provided an invalid `joints` value', funct tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; + var arr; - table = ctor( data, { - 'joints': '1 2 3 4 5' + arr = [ '1', '2', '3', '4', '5' ]; + table = ctor( null, { + 'joints': arr }); - t.strictEqual( table.joints, '1 2 3 4 5', 'returns expected value' ); + t.notEqual( table.joints, arr, 'returns a new reference' ); + t.deepEqual( table.joints, arr, 'returns expected value' ); - table.joints = '& # * ^ @'; - t.strictEqual( table.joints, '& # * ^ @', 'returns expected value' ); + arr = [ '&', '#', '*', '^', '@' ]; + table.joints = arr; + t.notEqual( table.corners, arr, 'returns a new reference' ); + t.deepEqual( table.joints, arr, 'returns expected value' ); - table.joints = 'None'; - t.strictEqual( table.joints, 'None', 'returns expected value' ); + arr = [ '🥀', '🌹', ' ', '🔥', '*' ]; + table.joints = arr; + t.notEqual( table.corners, arr, 'returns a new reference' ); + t.deepEqual( table.joints, arr, 'returns expected value' ); t.end(); }); + +tape( 'setting the `joints` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'joints': [ '-', '|', '=', '!', '1' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.joints = [ '1', '2', '3', '4', '5' ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `joints` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'joints': [ '-', '|', '=', '!', '1' ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.joints = [ '-', '|', '=', '!', '1' ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js index f0ec1f362309..9ed2bf13acc9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js @@ -80,17 +80,22 @@ tape( 'the constructor does not require the `new` keyword (data and options)', f data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; table = ctor( data, { 'alignment': 'left', - 'borders': '1 2 3 4', - 'cellPadding': 2, + 'autoRender': false, + 'borders': [ '1', '23', '456', '7890' ], + 'bufferSize': 10, + 'cellPaddingLeft': 2, + 'cellPaddingRight': [ 2, 3, 4 ], 'columnSeparator': 'None', - 'corners': '* * * *', - 'headerSeparator': '-', - 'joints': '* * * * *', + 'corners': [ '*', '*', '*', '*' ], + 'headerSeparator': '-=', + 'horizontalSeparatorMode': 'repeat', + 'joints': [ '*', '*', '*', '*', '*' ], 'marginX': 2, 'marginY': 4, 'maxCellWidth': 10, 'maxOutputWidth': 60, - 'rowSeparator': '_' + 'rowSeparator': '_-', + 'verticalSeparatorMode': 'resume' }); t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); @@ -108,17 +113,22 @@ tape( 'the constructor does not require the `new` keyword (data, headers and opt headers = [ 'col1', 'col2', 'col3' ]; table = ctor( data, headers, { 'alignment': 'left', - 'borders': '1 2 3 4', - 'cellPadding': 2, + 'autoRender': false, + 'borders': [ '1', '23', '456', '7890' ], + 'bufferSize': 10, + 'cellPaddingLeft': 2, + 'cellPaddingRight': [ 2, 3, 4 ], 'columnSeparator': 'None', - 'corners': '* * * *', - 'headerSeparator': '-', - 'joints': '* * * * *', + 'corners': [ '*', '*', '*', '*' ], + 'headerSeparator': '-=', + 'horizontalSeparatorMode': 'repeat', + 'joints': [ '*', '*', '*', '*', '*' ], 'marginX': 2, 'marginY': 4, 'maxCellWidth': 10, 'maxOutputWidth': 60, - 'rowSeparator': '_' + 'rowSeparator': '_-', + 'verticalSeparatorMode': 'resume' }); t.strictEqual( table instanceof UnicodeTable, true, 'returns class instance' ); @@ -204,21 +214,9 @@ tape( 'the constructor throws an error if provided an invalid option (headers ar } }); -tape( 'an instance has a `addRow` method for adding a row', function test( t ) { +tape( 'an instance has a `push` method for adding a row', function test( t ) { var table = new UnicodeTable(); - t.strictEqual( typeof table.addRow, 'function', 'has addRow method' ); - t.end(); -}); - -tape( 'an instance has a `setData` method for setting data', function test( t ) { - var table = new UnicodeTable(); - t.strictEqual( typeof table.setData, 'function', 'has setData method' ); - t.end(); -}); - -tape( 'an instance has a `getData` method for getting data', function test( t ) { - var table = new UnicodeTable(); - t.strictEqual( typeof table.getData, 'function', 'has getData method' ); + t.strictEqual( typeof table.push, 'function', 'has addRow method' ); t.end(); }); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js index 09a773b014e4..e119935f5776 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -63,11 +64,12 @@ tape( 'an instance throws an error if provided an invalid `marginX` value', func tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; - table = ctor( data, { + table = ctor( null, { 'marginX': 2 }); + table.render = noop; + t.strictEqual( table.marginX, 2, 'returns expected value' ); table.marginX = 3; @@ -78,3 +80,39 @@ tape( 'an instance supports setting and getting the property value', function te t.end(); }); + +tape( 'setting the `marginX` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'marginX': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.marginX = 3; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `marginX` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'marginX': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.marginX = 2; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js index da4835b2aecd..aceff08bed43 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -63,11 +64,12 @@ tape( 'an instance throws an error if provided an invalid `marginY` value', func tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; - table = ctor( data, { + table = ctor( null, { 'marginY': 2 }); + table.render = noop; + t.strictEqual( table.marginY, 2, 'returns expected value' ); table.marginY = 3; @@ -78,3 +80,39 @@ tape( 'an instance supports setting and getting the property value', function te t.end(); }); + +tape( 'setting the `marginY` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'marginY': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.marginY = 3; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `marginY` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'marginY': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.marginY = 2; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js index 068a06340878..c44982a0f1c7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js @@ -21,6 +21,8 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); var ctor = require( './../lib' ); @@ -41,11 +43,11 @@ tape( 'an instance throws an error if provided an invalid `maxCellWidth` value', 2.4, -3, true, - null, void 0, {}, - [], - function noop() {} + function noop() {}, + [ 4, 'hello', null ], + [ 2, -5, 3.4 ] ]; for ( i = 0; i < values.length; i++ ) { @@ -63,9 +65,9 @@ tape( 'an instance throws an error if provided an invalid `maxCellWidth` value', tape( 'an instance supports setting and getting the property value', function test( t ) { var table; - var data = null; + var arr; - table = ctor( data, { + table = ctor( null, { 'maxCellWidth': 2 }); t.strictEqual( table.maxCellWidth, 2, 'returns expected value' ); @@ -73,8 +75,76 @@ tape( 'an instance supports setting and getting the property value', function te table.maxCellWidth = 3; t.strictEqual( table.maxCellWidth, 3, 'returns expected value' ); - table.maxCellWidth = 0; - t.strictEqual( table.maxCellWidth, 0, 'returns expected value' ); + table.maxCellWidth = null; + t.strictEqual( table.maxCellWidth, FLOAT64_MAX, 'returns expected value' ); + arr = [ 0, 5 ]; + table.maxCellWidth = arr; + t.notEqual( table.maxCellWidth, arr, 'returns a new reference' ); + t.deepEqual( table.maxCellWidth, arr, 'returns expected value' ); + + arr = [ null, 5 ]; + table.maxCellWidth = arr; + t.notEqual( table.maxCellWidth, arr, 'returns a new reference' ); + t.deepEqual( table.maxCellWidth, [ FLOAT64_MAX, 5 ], 'returns expected value' ); + + t.end(); +}); + +tape( 'an instance throws an error if provided a `maxCellWidth` array with incorrect number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns + table.maxCellWidth = [ 1, 2 ]; // 2 columns + } +}); + +tape( 'settings the `maxCellWidth` property to an array sets number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); t.end(); + + function badValue() { + var table = ctor( null, { + 'maxCellWidth': [ 1, 2, 3 ] // 3 columns + }); + table.data = [ [ 1, 2 ], [ 4, 5 ] ]; // 2 columns + } +}); + +tape( 'setting the `maxCellWidth` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'maxCellWidth': 2 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.maxCellWidth = [ 1, 2 ]; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `maxCellWidth` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'maxCellWidth': [ 2, 3 ] + }); + table.render = noop; + + table.on( 'change', onChange ); + table.maxCellWidth = [ 2, 3 ]; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } }); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js index b14fd3c80873..41560f3d54e2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -41,7 +42,6 @@ tape( 'an instance throws an error if provided an invalid `maxOutputWidth` value 2.4, -3, true, - null, void 0, {}, [], @@ -78,3 +78,39 @@ tape( 'an instance supports setting and getting the property value', function te t.end(); }); + +tape( 'setting the `maxOutputWidth` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'maxOutputWidth': 10 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.maxOutputWidth = 30; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `maxOutputWidth` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'maxOutputWidth': 10 + }); + table.render = noop; + + table.on( 'change', onChange ); + table.maxOutputWidth = 10; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js new file mode 100644 index 000000000000..47180d39e893 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js @@ -0,0 +1,337 @@ +/** +* @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 tape = require( 'tape' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid array of objects', function test( t ) { + t.throws( badValue, Error, 'throws an error' ); + t.end(); + + function badValue() { + var headers; + var table; + var data; + + data = [ + { + 'col1': 'hello', + 'col2': 45, + 'col3': true + }, + { + 'col1': null, + 'col3': 45.3 + } + ]; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor( data, headers ); // eslint-disable-line no-unused-vars + } +}); + +tape( 'the function sets the table data for an array of objects (with headers)', function test( t ) { + var expected; + var headers; + var table; + var data; + var v; + + data = [ + { + 'col1': 'hello', + 'col2': 45, + 'col3': true + }, + { + 'col1': null, + 'col3': 45.3 + } + ]; + headers = [ 'col1', 'col3' ]; + table = ctor( data, headers ); + + v = table.data; + expected = [ [ 'hello', true ], [ null, 45.3 ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = [ 'col1', 'col3' ]; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function sets the table data for an array of objects (without headers)', function test( t ) { + var expected; + var table; + var data; + var v; + + data = [ + { + 'col1': 'hello', + 'col2': 45, + 'col3': true + }, + { + 'col1': null, + 'col2': undefined, + 'col3': 45.3 + } + ]; + table = ctor( data ); + + v = table.data; + expected = [ [ 'hello', 45, true ], [ null, undefined, 45.3 ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = [ 'col1', 'col2', 'col3' ]; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function throws an error if provided an invalid object of columns', function test( t ) { + var values; + var i; + + values = [ + { + 'data': { + 'col1': [ 'hello', true ], + 'col2': [ 45.3, null ] + }, + 'headers': [ 'col1', 'col2', 'col3' ] + }, + { + 'data': { + 'col1': [ 'hello', true ], + 'col2': [ 45.3 ] + }, + 'headers': [ 'col1', 'col2' ] + } + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), Error, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor( value.data, value.headers ); // eslint-disable-line no-unused-vars + }; + } +}); + +tape( 'the function sets the table data for an object of columns (with headers)', function test( t ) { + var expected; + var headers; + var table; + var data; + var v; + + data = { + 'col1': [ 'hello', true ], + 'col2': [ null, 45 ], + 'col3': [ undefined, 45.3 ] + }; + headers = [ 'col1', 'col2' ]; + table = ctor( data, headers ); + + v = table.data; + expected = [ [ 'hello', null ], [ true, 45 ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = [ 'col1', 'col2' ]; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function sets the table data for an object of columns (without headers)', function test( t ) { + var expected; + var table; + var data; + var v; + + data = { + 'col1': [ 'hello', true ], + 'col2': [ null, 45 ], + 'col3': [ undefined, 45.3 ] + }; + table = ctor( data ); + + v = table.data; + expected = [ [ 'hello', null, undefined ], [ true, 45, 45.3 ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = [ 'col1', 'col2', 'col3' ]; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function throws an error if provided an invalid array of arrays', function test( t ) { + var values; + var i; + + values = [ + { + 'data': [ [ 45, 33 ], [ 32.54, true, null ] ], + 'headers': [ 'col1', 'col2', 'col3' ] + }, + { + 'data': [ [ 45, 33, 'hello', undefined ], [ 32.54, true, null ] ], + 'headers': [ 'col1', 'col2', 'col3' ] + } + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), Error, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor( value.data, value.headers ); // eslint-disable-line no-unused-vars + }; + } +}); + +tape( 'the function sets the table data for an array of arrays (with headers)', function test( t ) { + var expected; + var headers; + var table; + var data; + var v; + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor( data, headers ); + + v = table.data; + expected = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = [ 'col1', 'col2', 'col3' ]; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function sets the table data for an array of arrays (without headers)', function test( t ) { + var expected; + var table; + var data; + var v; + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table = ctor( data ); + + v = table.data; + expected = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = null; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function throws an error if provided an invalid array of objects', function test( t ) { + t.throws( badValue, Error, 'throws an error' ); + t.end(); + + function badValue() { + var headers; + var buffer; + var table; + var data; + + buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; + data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); + headers = [ 'col1', 'col2', 'col3' ]; + table = ctor( data, headers ); // eslint-disable-line no-unused-vars + } +}); + +tape( 'the function sets the table data for a matrix-like ndarray (with headers)', function test( t ) { + var expected; + var headers; + var buffer; + var table; + var data; + var v; + + buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; + data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); + headers = [ 'col1', 'col2', 'col3', 'col4' ]; + table = ctor( data, headers ); + + v = table.data; + expected = [ [ 14, 2, 'hello', false ], [ 32.54, true, null, 'bye' ], [ 9, 10, 11, 12 ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = [ 'col1', 'col2', 'col3', 'col4' ]; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); + +tape( 'the function sets the table data for a matrix-like ndarray (without headers)', function test( t ) { + var expected; + var buffer; + var table; + var data; + var v; + + buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; + data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); + table = ctor( data ); + + v = table.data; + expected = [ [ 14, 2, 'hello', false ], [ 32.54, true, null, 'bye' ], [ 9, 10, 11, 12 ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + v = table.headers; + expected = null; + t.deepEqual( v, expected, 'sets table headers' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js deleted file mode 100644 index d12666c551ba..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parser.js +++ /dev/null @@ -1,240 +0,0 @@ -/** -* @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 tape = require( 'tape' ); -var ndarray = require( '@stdlib/ndarray/ctor' ); -var ctor = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof ctor, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function sets the table data for an array of objects (with headers)', function test( t ) { - var expected; - var headers; - var table; - var data; - var v; - - data = [ - { - 'col1': 'hello', - 'col2': 45, - 'col3': true - }, - { - 'col1': null, - 'col3': 45.3 - } - ]; - headers = [ 'col1', 'col2', 'col3' ]; - table = ctor(); - - table.setData( data, headers ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 'hello', 45, true ], [ null, undefined, 45.3 ] ]; - expected.headers = [ 'col1', 'col2', 'col3' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for an array of objects (without headers)', function test( t ) { - var expected; - var table; - var data; - var v; - - data = [ - { - 'col1': 'hello', - 'col2': 45, - 'col3': true - }, - { - 'col1': null, - 'col3': 45.3 - } - ]; - table = ctor(); - - table.setData( data ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 'hello', 45, true ], [ null, undefined, 45.3 ] ]; - expected.headers = [ 'col1', 'col2', 'col3' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for an object of columns (with headers)', function test( t ) { - var expected; - var headers; - var table; - var data; - var v; - - data = { - 'col1': [ 'hello', true ], - 'col2': [ null, 45 ] - }; - headers = [ 'col1', 'col2', 'col3' ]; - table = ctor(); - - table.setData( data, headers ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 'hello', null ], [ true, 45 ] ]; - expected.headers = [ 'col1', 'col2' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for an object of columns (without headers)', function test( t ) { - var expected; - var table; - var data; - var v; - - data = { - 'col1': [ 'hello', true ], - 'col2': [ null, 45 ] - }; - table = ctor(); - - table.setData( data ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 'hello', null ], [ true, 45 ] ]; - expected.headers = [ 'col1', 'col2' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for an array of arrays (with headers)', function test( t ) { - var expected; - var headers; - var table; - var data; - var v; - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table = ctor(); - - table.setData( data, headers ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - expected.headers = [ 'col1', 'col2', 'col3' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for an array of arrays (without headers)', function test( t ) { - var expected; - var table; - var data; - var v; - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - table = ctor(); - - table.setData( data ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - expected.headers = null; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for a matrix-like ndarray (with headers)', function test( t ) { - var expected; - var headers; - var buffer; - var table; - var data; - var v; - - buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; - data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); - headers = [ 'col1', 'col2', 'col3', 'col4' ]; - table = ctor(); - - table.setData( data, headers ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 14, 2, 'hello', false ], [ 32.54, true, null, 'bye' ], [ 9, 10, 11, 12 ] ]; - expected.headers = [ 'col1', 'col2', 'col3', 'col4' ]; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); - -tape( 'the function sets the table data for a matrix-like ndarray (without headers)', function test( t ) { - var expected; - var buffer; - var table; - var data; - var v; - - buffer = [ 14, 2, 'hello', false, 32.54, true, null, 'bye', 9, 10, 11, 12 ]; - data = ndarray( 'generic', buffer, [ 3, 4 ], [ 4, 1 ], 0, 'row-major' ); - table = ctor(); - - table.setData( data ); - v = table.getData(); - - expected = {}; - expected.data = [ [ 14, 2, 'hello', false ], [ 32.54, true, null, 'bye' ], [ 9, 10, 11, 12 ] ]; - expected.headers = null; - - t.deepEqual( v, expected, 'sets table data' ); - - t.end(); -}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js new file mode 100644 index 000000000000..92467d17b9c2 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js @@ -0,0 +1,133 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function appends a row to existing data', function test( t ) { + var expected; + var table; + var data; + var row; + var v; + + data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table = ctor( data ); + table.render = noop; + + row = [ 1, true, 'hello' ]; + table.push( row ); + v = table.data; + + expected = [ [ 45, 33, 'hello' ], [ 32.54, true, null ], [ 1, true, 'hello' ] ]; + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function creates table data if no existing data found', function test( t ) { + var expected; + var table; + var row; + var v; + + table = ctor(); + table.render = noop; + + row = [ 1, true, 'hello' ]; + table.push( row ); + v = table.data; + + expected = [ row ]; + t.deepEqual( v, expected, 'sets table data' ); + + t.end(); +}); + +tape( 'the function throws an error if provided incorrect number of columns', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor( [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ] ); // 3 columns + table.push( [ 1, 2 ] ); // 2 columns + } +}); + +tape( 'the function sets the number of columns if no existing columns found', function test( t ) { + t.throws( badValue, RangeError, 'throws an error' ); + t.end(); + + function badValue() { + var table = ctor(); + table.push( [ 1, 2, 3 ] ); // 3 columns + table.headers = [ 'col1', 'col2' ]; // 2 columns + } +}); + +tape( 'if appending data to the internal data buffer will result in the table data exceeding the data buffer size, the function will remove the first row', function test( t ) { + var expected; + var table; + var data; + var v; + + data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; + table = ctor( data, { + 'bufferSize': 2 + }); + table.render = noop; + + table.push( [ 7, 8, 9 ] ); + v = table.data; + + expected = [ [ 4, 5, 6 ], [ 7, 8, 9 ] ]; + t.deepEqual( v, expected, 'removes first row' ); + + t.end(); +}); + +tape( 'appending `data` triggers a `change` event', function test( t ) { + var table; + var data; + + data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; + table = ctor( data ); + table.render = noop; + + table.on( 'change', onChange ); + table.push( [ 7, 8, 9 ] ); + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js index c3870e155e4c..582217e2958a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js @@ -46,16 +46,12 @@ tape( 'the function returns an empty string if no table data provided ', functio tape( 'the function supports rendering a table', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; expected = [ '┌───────┬──────┬───────┐', @@ -75,13 +71,10 @@ tape( 'the function supports rendering a table', function test( t ) { tape( 'the function supports rendering a table (without headers)', function test( t ) { var expected; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - table.setData( data ); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; expected = [ '┌───────┬──────┬───────┐', @@ -98,16 +91,12 @@ tape( 'the function supports rendering a table (without headers)', function test tape( 'the function supports rendering a table (with row separators)', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; table.rowSeparator = '─'; expected = [ @@ -128,17 +117,13 @@ tape( 'the function supports rendering a table (with row separators)', function tape( 'the function supports rendering a table (without borders)', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); - table.borders = 'None'; + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; + table.borders = [ '', '', '', '' ]; expected = [ ' col1 │ col2 │ col3 ', @@ -155,17 +140,14 @@ tape( 'the function supports rendering a table (without borders)', function test tape( 'the function supports rendering a table (without column separators)', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); - table.columnSeparator = 'None'; + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; + table.columnSeparator = ''; expected = [ '┌────────────────────┐', @@ -184,17 +166,13 @@ tape( 'the function supports rendering a table (without column separators)', fun tape( 'the function supports rendering a table (without header separator)', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); - table.headerSeparator = 'None'; + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; + table.headerSeparator = ''; expected = [ '┌───────┬──────┬───────┐', @@ -210,58 +188,38 @@ tape( 'the function supports rendering a table (without header separator)', func t.end(); }); -tape( 'the function supports rendering a table (without corners)', function test( t ) { +tape( 'the function supports rendering a table with different cell paddings', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); - table.corners = 'None'; - + table.cellPaddingLeft = 2; + table.cellPaddingRight = 1; expected = [ - ' ───────┬──────┬─────── ', - '│ col1 │ col2 │ col3 │', - '├───────┼──────┼───────┤', - '│ 45 │ 33 │ hello │', - '│ 32.54 │ true │ null │', - ' ───────┴──────┴─────── ' + '┌────────┬───────┬────────┐', + '│ col1 │ col2 │ col3 │', + '├────────┼───────┼────────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└────────┴───────┴────────┘' ].join( '\n' ); - str = table.render(); t.strictEqual( str, expected, 'returns rendered table' ); - t.end(); -}); - -tape( 'the function supports rendering a table (without joints)', function test( t ) { - var expected; - var headers; - var table; - var data; - var str; - - table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); - table.joints = 'None'; - + table.cellPaddingLeft = [ 2, 0, 3 ]; + table.cellPaddingRight = [ 0, 1, 2 ]; expected = [ - '┌─────── ────── ───────┐', - '│ col1 │ col2 │ col3 │', - ' ─────── ────── ─────── ', - '│ 45 │ 33 │ hello │', - '│ 32.54 │ true │ null │', - '└─────── ────── ───────┘' + '┌───────┬─────┬──────────┐', + '│ col1│col2 │ col3 │', + '├───────┼─────┼──────────┤', + '│ 45│ 33 │ hello │', + '│ 32.54│true │ null │', + '└───────┴─────┴──────────┘' ].join( '\n' ); - str = table.render(); t.strictEqual( str, expected, 'returns rendered table' ); @@ -270,16 +228,12 @@ tape( 'the function supports rendering a table (without joints)', function test( tape( 'the function supports rendering a table with a margin', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; table.marginX = 1; table.marginY = 1; @@ -302,18 +256,14 @@ tape( 'the function supports rendering a table with a margin', function test( t tape( 'the function supports rendering a table with truncated data', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); - table.maxCellWidth = 4; - + table.maxCellWidth = 6; expected = [ '┌──────┬──────┬──────┐', '│ col1 │ col2 │ col3 │', @@ -322,7 +272,18 @@ tape( 'the function supports rendering a table with truncated data', function te '│ 3... │ true │ null │', '└──────┴──────┴──────┘' ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + table.maxCellWidth = [ 6, 3, 5 ]; + expected = [ + '┌──────┬───┬─────┐', + '│ col1 │ . │ ... │', + '├──────┼───┼─────┤', + '│ 45 │ . │ ... │', + '│ 3... │ . │ ... │', + '└──────┴───┴─────┘' + ].join( '\n' ); str = table.render(); t.strictEqual( str, expected, 'returns rendered table' ); @@ -331,16 +292,12 @@ tape( 'the function supports rendering a table with truncated data', function te tape( 'the function supports rendering a table with different alignments', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); - - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; table.alignment = 'right'; expected = [ @@ -352,7 +309,7 @@ tape( 'the function supports rendering a table with different alignments', funct '└───────┴──────┴───────┘' ].join( '\n' ); str = table.render(); - t.strictEqual( str, expected, 'returns right-aligned rendered table' ); + t.strictEqual( str, expected, 'returns rendered table' ); table.alignment = 'left'; expected = [ @@ -364,7 +321,7 @@ tape( 'the function supports rendering a table with different alignments', funct '└───────┴──────┴───────┘' ].join( '\n' ); str = table.render(); - t.strictEqual( str, expected, 'returns left-aligned rendered table' ); + t.strictEqual( str, expected, 'returns rendered table' ); table.alignment = 'center'; expected = [ @@ -376,23 +333,135 @@ tape( 'the function supports rendering a table with different alignments', funct '└───────┴──────┴───────┘' ].join( '\n' ); str = table.render(); - t.strictEqual( str, expected, 'returns center-aligned rendered table' ); + t.strictEqual( str, expected, 'returns rendered table' ); + + table.alignment = [ 'left', 'center', 'right' ]; + expected = [ + '┌───────┬──────┬───────┐', + '│ col1 │ col2 │ col3 │', + '├───────┼──────┼───────┤', + '│ 45 │ 33 │ hello │', + '│ 32.54 │ true │ null │', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); t.end(); }); -tape( 'the function supports rendering a wrapped table for long outputs', function test( t ) { +tape( 'the function supports rendering a table with different horizontal line separator modes', function test( t ) { var expected; - var headers; var table; - var data; var str; table = ctor(); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; + table.headerSeparator = '123'; + table.rowSeparator = '123'; + table.borders = [ '123', '│', '123', '│' ]; + + table.horizontalSeparatorMode = 'resume'; + expected = [ + '┌1231231┬231231┬2312312┐', + '│ col1 │ col2 │ col3 │', + '├1231231┼231231┼2312312┤', + '│ 45 │ 33 │ hello │', + '├1231231┼231231┼2312312┤', + '│ 32.54 │ true │ null │', + '└1231231┴231231┴2312312┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); - data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; - headers = [ 'col1', 'col2', 'col3' ]; - table.setData( data, headers ); + table.horizontalSeparatorMode = 'interpolate'; + expected = [ + '┌2312312┬123123┬2312312┐', + '│ col1 │ col2 │ col3 │', + '├2312312┼123123┼2312312┤', + '│ 45 │ 33 │ hello │', + '├2312312┼123123┼2312312┤', + '│ 32.54 │ true │ null │', + '└2312312┴123123┴2312312┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + table.horizontalSeparatorMode = 'repeat'; + expected = [ + '┌1231231┬123123┬1231231┐', + '│ col1 │ col2 │ col3 │', + '├1231231┼123123┼1231231┤', + '│ 45 │ 33 │ hello │', + '├1231231┼123123┼1231231┤', + '│ 32.54 │ true │ null │', + '└1231231┴123123┴1231231┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a table with different vertical line separator modes', function test( t ) { + var expected; + var table; + var str; + + table = ctor(); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; + table.columnSeparator = '123'; + table.borders = [ '─', '123', '─', '123' ]; + + table.verticalSeparatorMode = 'resume'; + expected = [ + '┌───────┬──────┬───────┐', + '1 col1 1 col2 1 col3 1', + '├───────┼──────┼───────┤', + '2 45 2 33 2 hello 2', + '3 32.54 3 true 3 null 3', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + table.verticalSeparatorMode = 'interpolate'; + expected = [ + '┌───────┬──────┬───────┐', + '2 col1 2 col2 2 col3 2', + '├───────┼──────┼───────┤', + '1 45 1 33 1 hello 1', + '2 32.54 2 true 2 null 2', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + table.verticalSeparatorMode = 'repeat'; + expected = [ + '┌───────┬──────┬───────┐', + '1 col1 1 col2 1 col3 1', + '├───────┼──────┼───────┤', + '1 45 1 33 1 hello 1', + '2 32.54 2 true 2 null 2', + '└───────┴──────┴───────┘' + ].join( '\n' ); + str = table.render(); + t.strictEqual( str, expected, 'returns rendered table' ); + + t.end(); +}); + +tape( 'the function supports rendering a wrapped table for long outputs', function test( t ) { + var expected; + var table; + var str; + + table = ctor(); + table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; + table.headers = [ 'col1', 'col2', 'col3' ]; table.maxOutputWidth = 16; expected = [ diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js index 2e34d82bed3e..9f8d6db4e535 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js @@ -21,6 +21,7 @@ // MODULES // var tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); var ctor = require( './../lib' ); @@ -44,8 +45,7 @@ tape( 'an instance throws an error if provided an invalid `rowSeparator` value', null, void 0, {}, - [], - '5437' + [] ]; for ( i = 0; i < values.length; i++ ) { @@ -70,11 +70,47 @@ tape( 'an instance supports setting and getting the property value', function te }); t.strictEqual( table.rowSeparator, '1', 'returns expected value' ); - table.rowSeparator = '!'; - t.strictEqual( table.rowSeparator, '!', 'returns expected value' ); + table.rowSeparator = '!/1'; + t.strictEqual( table.rowSeparator, '!/1', 'returns expected value' ); - table.rowSeparator = 'None'; - t.strictEqual( table.rowSeparator, 'None', 'returns expected value' ); + table.rowSeparator = ''; + t.strictEqual( table.rowSeparator, '', 'returns expected value' ); t.end(); }); + +tape( 'setting the `rowSeparator` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'rowSeparator': '1' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.rowSeparator = '23'; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `rowSeparator` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'rowSeparator': '1' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.rowSeparator = '1'; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js new file mode 100644 index 000000000000..d8a49ae57697 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js @@ -0,0 +1,119 @@ +/** +* @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 tape = require( 'tape' ); +var noop = require( '@stdlib/utils/noop' ); +var ctor = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof ctor, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'an instance throws an error if provided an invalid `verticalSeparatorMode` value', function test( t ) { + var values; + var i; + + values = [ + 5, + NaN, + true, + false, + null, + void 0, + {}, + [], + '1234', + 'beep' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + var table = ctor(); + table.verticalSeparatorMode = value; + }; + } +}); + +tape( 'an instance supports setting and getting the property value', function test( t ) { + var table; + + table = ctor( null, { + 'verticalSeparatorMode': 'interpolate' + }); + table.render = noop; + + t.strictEqual( table.verticalSeparatorMode, 'interpolate', 'returns expected value' ); + + table.verticalSeparatorMode = 'repeat'; + t.strictEqual( table.verticalSeparatorMode, 'repeat', 'returns expected value' ); + + table.verticalSeparatorMode = 'resume'; + t.strictEqual( table.verticalSeparatorMode, 'resume', 'returns expected value' ); + + t.end(); +}); + +tape( 'setting the `verticalSeparatorMode` property to a new value triggers a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'verticalSeparatorMode': 'interpolate' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.verticalSeparatorMode = 'resume'; + + function onChange() { + t.ok( true, 'triggers event' ); + t.end(); + } +}); + +tape( 'setting the `verticalSeparatorMode` property to its current value does not trigger a `change` event', function test( t ) { + var table; + + table = ctor( null, { + 'verticalSeparatorMode': 'repeat' + }); + table.render = noop; + + table.on( 'change', onChange ); + table.verticalSeparatorMode = 'repeat'; + + t.ok( true, 'does not trigger event' ); + t.end(); + + function onChange() { + t.ok( false, 'should not trigger event' ); + } +}); From 2c7c6043bb6a46b75b286c099147d251960cb307 Mon Sep 17 00:00:00 2001 From: Snehil Shah Date: Sat, 20 Jul 2024 20:29:10 +0000 Subject: [PATCH 03/34] docs: update jsdoc Signed-off-by: Snehil Shah --- .../@stdlib/plot/table/unicode/lib/props/borders/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/headers/set.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index f66106e202be..af94a32e1c88 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -36,7 +36,7 @@ var NUM_BORDERS = 4; * Sets the table's border characters. * * @private -* @param {string} borders - borders string +* @param {Array} borders - border characters * @throws {TypeError} must be an array of four strings */ function set( borders ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index a3d90bcc23ec..e283428aea26 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -29,7 +29,7 @@ var parseHeaders = require( './../../parser/parse_headers.js' ); // MAIN // /** -* Sets the table data. +* Sets the table headers. * * @private * @param {Collection} headers - table headers From 8d36829871d03218a5581f7f0471a58acdf8660e Mon Sep 17 00:00:00 2001 From: Snehil Shah Date: Sat, 27 Jul 2024 06:46:09 +0000 Subject: [PATCH 04/34] docs: add events to README Signed-off-by: Snehil Shah --- .../@stdlib/plot/table/unicode/README.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 98d9eeb72097..1faa698470e2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -506,6 +506,36 @@ var str = table.render(); * * * +### Events + +#### 'change' + +Emitted whenever a property value changes. + +```javascript +var table = new UnicodeTable(); + +table.on( 'change', onChange ); + +function onChange() { + console.log( 'A property was updated.' ); +} +``` + +#### 'render' + +Emitted whenever a sparkline is rendered. + +```javascript +var table = new UnicodeTable(); + +table.on( 'render', onRender ); + +function onRender( str ) { + console.log( 'Rendered table: %s', str ); +} +``` + From 9ea8bad77f909bf5415f992d019e4f12874ce33a Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Tue, 11 Feb 2025 01:40:58 -0800 Subject: [PATCH 05/34] refactor: update implementation and clean-up --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 570 ++++++++--- .../plot/table/unicode/benchmark/benchmark.js | 654 ++++++++++--- .../unicode/benchmark/benchmark.render.js | 42 +- .../@stdlib/plot/table/unicode/docs/repl.txt | 236 +++-- .../plot/table/unicode/examples/index.js | 28 +- .../plot/table/unicode/lib/defaults.js | 155 ++- .../{parser/parse_headers.js => every_by2.js} | 40 +- .../@stdlib/plot/table/unicode/lib/index.js | 7 +- .../@stdlib/plot/table/unicode/lib/main.js | 889 ++++++++++++------ .../@stdlib/plot/table/unicode/lib/parse.js | 83 -- .../unicode/lib/parser/parse_2d_array.js | 74 -- .../table/unicode/lib/parser/parse_object.js | 99 -- .../unicode/lib/parser/parse_objects_list.js | 84 -- .../lib/props/{alignment => align}/get.js | 16 +- .../plot/table/unicode/lib/props/align/set.js | 93 ++ .../table/unicode/lib/props/alignment/set.js | 77 -- .../unicode/lib/props/auto-render/get.js | 5 +- .../unicode/lib/props/auto-render/set.js | 19 +- .../unicode/lib/props/border-bottom/get.js | 38 + .../unicode/lib/props/border-bottom/set.js | 60 ++ .../props/{margin-y => border-left}/get.js | 11 +- .../unicode/lib/props/border-left/set.js | 60 ++ .../unicode/lib/props/border-right/get.js | 38 + .../unicode/lib/props/border-right/set.js | 60 ++ .../{max-output-width => border-top}/get.js | 11 +- .../table/unicode/lib/props/border-top/set.js | 60 ++ .../table/unicode/lib/props/borders/get.js | 14 +- .../table/unicode/lib/props/borders/set.js | 60 +- .../unicode/lib/props/buffer-size/get.js | 7 +- .../unicode/lib/props/buffer-size/set.js | 36 +- .../lib/props/cell-padding-left/get.js | 45 - .../lib/props/cell-padding-left/set.js | 62 -- .../lib/props/cell-padding-right/get.js | 45 - .../lib/props/cell-padding-right/set.js | 62 -- .../unicode/lib/props/column-separator/get.js | 7 +- .../unicode/lib/props/column-separator/set.js | 28 +- .../lib/props/corner-bottom-left/get.js | 38 + .../lib/props/corner-bottom-left/set.js | 63 ++ .../lib/props/corner-bottom-right/get.js | 38 + .../lib/props/corner-bottom-right/set.js | 63 ++ .../unicode/lib/props/corner-top-left/get.js | 38 + .../unicode/lib/props/corner-top-left/set.js | 63 ++ .../unicode/lib/props/corner-top-right/get.js | 38 + .../unicode/lib/props/corner-top-right/set.js | 63 ++ .../table/unicode/lib/props/corners/get.js | 14 +- .../table/unicode/lib/props/corners/set.js | 69 +- .../plot/table/unicode/lib/props/data/get.js | 19 +- .../plot/table/unicode/lib/props/data/set.js | 243 ++++- .../unicode/lib/props/header-separator/get.js | 7 +- .../unicode/lib/props/header-separator/set.js | 26 +- .../table/unicode/lib/props/headers/get.js | 8 +- .../table/unicode/lib/props/headers/set.js | 68 +- .../props/horizontal-separator-mode/get.js | 7 +- .../props/horizontal-separator-mode/set.js | 19 +- .../unicode/lib/props/joint-bottom/get.js | 38 + .../unicode/lib/props/joint-bottom/set.js | 63 ++ .../table/unicode/lib/props/joint-left/get.js | 38 + .../table/unicode/lib/props/joint-left/set.js | 63 ++ .../unicode/lib/props/joint-middle/get.js | 38 + .../unicode/lib/props/joint-middle/set.js | 63 ++ .../unicode/lib/props/joint-right/get.js | 38 + .../unicode/lib/props/joint-right/set.js | 63 ++ .../table/unicode/lib/props/joint-top/get.js | 38 + .../table/unicode/lib/props/joint-top/set.js | 63 ++ .../table/unicode/lib/props/joints/get.js | 12 +- .../table/unicode/lib/props/joints/set.js | 69 +- .../unicode/lib/props/margin-bottom/get.js | 38 + .../unicode/lib/props/margin-bottom/set.js | 53 ++ .../unicode/lib/props/margin-left/get.js | 38 + .../props/{margin-y => margin-left}/set.js | 25 +- .../unicode/lib/props/margin-right/get.js | 38 + .../unicode/lib/props/margin-right/set.js | 53 ++ .../table/unicode/lib/props/margin-top/get.js | 38 + .../lib/props/{margin-x => margin-top}/set.js | 25 +- .../lib/props/{margin-x => margins}/get.js | 11 +- .../table/unicode/lib/props/margins/set.js | 66 ++ .../unicode/lib/props/max-cell-width/get.js | 16 +- .../unicode/lib/props/max-cell-width/set.js | 86 +- .../table/unicode/lib/props/max-width/get.js | 38 + .../{max-output-width => max-width}/set.js | 36 +- .../unicode/lib/props/padding-left/get.js | 41 + .../unicode/lib/props/padding-left/set.js | 75 ++ .../unicode/lib/props/padding-right/get.js | 41 + .../unicode/lib/props/padding-right/set.js | 75 ++ .../unicode/lib/props/row-separator/get.js | 7 +- .../unicode/lib/props/row-separator/set.js | 28 +- .../lib/props/vertical-separator-mode/get.js | 7 +- .../lib/props/vertical-separator-mode/set.js | 27 +- .../@stdlib/plot/table/unicode/lib/push.js | 18 +- .../@stdlib/plot/table/unicode/lib/render.js | 751 +++++++++------ 90 files changed, 5075 insertions(+), 1901 deletions(-) rename lib/node_modules/@stdlib/plot/table/unicode/lib/{parser/parse_headers.js => every_by2.js} (50%) delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{alignment => align}/get.js (76%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{margin-y => border-left}/get.js (80%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{max-output-width => border-top}/get.js (80%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js delete mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{margin-y => margin-left}/set.js (65%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{margin-x => margin-top}/set.js (67%) rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{margin-x => margins}/get.js (82%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{max-output-width => max-width}/set.js (65%) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 1faa698470e2..148ac9cde14b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -30,7 +30,7 @@ limitations under the License. var UnicodeTable = require( '@stdlib/plot/table/unicode' ); ``` -#### UnicodeTable( \[data,] \[headers,] \[options] ) +#### UnicodeTable( \[data,] \[options] ) Returns a table instance. @@ -38,87 +38,140 @@ Returns a table instance. var table = new UnicodeTable(); ``` +The constructor accepts the following arguments: + +- **data**: table data provided as either an object, an array of objects, an array of arrays, or a two-dimensional [ndarray][@stdlib/ndarray/ctor] (_optional_). +- **options**: constructor options (_optional_). + The constructor accepts the following `options`: -- **alignment**: datum's cell alignment. Default: `'right'`. +- **align**: alignment of data within table cells. Must be one of the following: + + - `'right'`: right-aligned. + - `'left'`: left-aligned. + - `'center'`: center-aligned. + + To specify the alignment of data within each table column, provide an array of alignment specifiers. Default: `'right'`. -- **autoRender**: `boolean` indicating whether to re-render on a `change` event. Default: `false`. +- **autoRender**: boolean indicating whether to automatically re-render a table on a `change` event. Default: `false`. -- **borders**: border characters. Default: `[ '─', '│', '─', '│' ]`. +- **borderTop**: top table border character(s). Default: `'-'`. -- **bufferSize**: data buffer size. If provided, data is kept in a first-in first-out (FIFO) buffer which cannot exceed the buffer size. Default: `+infinity`. +- **borderRight**: right table border character(s). Default: `'|'`. -- **cellPaddingLeft**: cell's left padding. Default: `1`. +- **borderBottom**: bottom table border character(s). Default: `'-'`. -- **cellPaddingRight**: cell's right padding. Default: `1`. +- **borderLeft**: left table border character(s). Default: `'|'`. + +- **borders**: table border characters in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying borders individually. Default: `[ '─', '│', '─', '│' ]`. + +- **bufferSize**: data buffer size. If specified, data is kept in a first-in first-out (FIFO) buffer which cannot exceed the specified buffer size. Default: `+infinity`. - **columnSeparator**: column separator character(s). Default: `'│'`. -- **corners**: corner characters. Default: `[ '┌', '┐', '┘', '└' ]`. +- **cornerTopLeft**: top-left table corner grapheme cluster (i.e., visual character). Default: `'┌'`. + +- **cornerTopRight**: top-right table corner grapheme cluster (i.e., visual character). Default: `'┌'`. + +- **cornerBottomRight**: bottom-right table corner grapheme cluster (i.e., visual character). Default: `'┘'`. + +- **cornerBottomLeft**: bottom-left table corner grapheme cluster (i.e., visual character). Default: `'└'`. + +- **corners**: table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. This is a shorthand option instead of specifying corner character sequences individually. Default: `[ '┌', '┐', '┘', '└' ]`. + +- **headers**: table headers. - **headerSeparator**: header separator character(s). Default: `'─'`. -- **horizontalSeparatorMode**: Horizontal line separator mode. The following modes are supported: +- **horizontalSeparatorMode**: horizontal line separator mode. Must be one of the following: - `resume`: resume line sequence after a joint. - `interpolate`: skip line character at a joint. - `repeat`: repeat line sequence after a joint. - - Default: `resume`. -- **joints**: joint characters. Default: `[ '┼', '┬', '┤', '┴', '├' ]`. + Default: `'resume'`. + +- **jointMiddle**: joint grapheme cluster (i.e., visual character) connecting table cells within the middle of the table. Default: `'┼'`. + +- **jointTop**: joint grapheme cluster (i.e., visual character) connecting table cells along the top of the table. Default: `'┬'`. + +- **jointRight**: joint grapheme cluster (i.e., visual character) connecting table cells along the right of the table. Default: `'┤'`. + +- **jointBottom**: joint grapheme cluster (i.e., visual character) connecting table cells along the bottom of the table. Default: `'┴'`. + +- **jointLeft**: joint grapheme cluster (i.e., visual character) connecting table cells along the left of the table. Default: `'├'`. -- **marginX**: horizontal output margin. Default: `0`. +- **joints**: joint grapheme clusters (i.e., visual characters) connecting table cells in the order `[middle, top, right, bottom, left]`. This is a shorthand option instead of specifying join character sequences individually. Default: `[ '┼', '┬', '┤', '┴', '├' ]`. -- **marginY**: vertical output margin. Default: `0`. +- **marginTop**: margin at the top of the table in units of blank lines. Default: `0`. -- **maxCellWidth**: maximum cell width(s). Default: `+infinity`. +- **marginRight**: margin to the right of the table in units of whitespace. Default: `0`. -- **maxOutputWidth**: maximum output width. Default: `+infinity`. +- **marginBottom**: margin at the bottom of the table in units of blank lines. Default: `0`. + +- **marginLeft**: margin to the left of the table in units of whitespace. Default: `0`. + +- **margins**: table margins in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying margins individually. Default: `[ 0, 0, 0, 0 ]`. + +- **maxCellWidth**: maximum cell width(s) in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. + +- **maxWidth**: maximum table width in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. + +- **paddingLeft**: cell left padding in units of whitespace characters. Default: `1`. + +- **paddingRight**: cell right padding in units of whitespace characters. Default: `1`. - **rowSeparator**: row separator character(s). Default: `''`. -- **verticalSeparatorMode**: Vertical line separator mode. The following modes are supported: +- **verticalSeparatorMode**: vertical line separator mode. Must be one of the following: - - `resume`: resume line sequence after a joint. - - `interpolate`: skip line character at a joint. - - `repeat`: repeat line sequence after a joint. - - Default: `resume`. + - `'resume'`: resume line sequence after a joint. + - `'interpolate'`: skip line character at a joint. + - `'repeat'`: repeat line sequence after a joint. + + Default: `'resume'`. * * * ### Writable Properties - + -#### UnicodeTable.prototype.alignment +#### UnicodeTable.prototype.align -Alignment(s) of datum in cell. The value must be either `'right'`, `'left'`, or `'center'` or an array of them. +Alignment(s) of data within table cells. ```javascript var table = new UnicodeTable(); // Set: -table.alignment = 'center'; +table.align = 'center'; // Get: -var alignment = table.alignment; +var align = table.align; // returns 'center' // Set: -table.alignment = [ 'left', 'right', 'center' ]; +table.align = [ 'left', 'right', 'center' ]; // Get: -alignment = table.alignment; +align = table.align; // returns [ 'left', 'right', 'center' ] ``` +The following alignments are supported: + +- **right**: right-aligned. +- **left**: left-aligned. +- **center**: center-aligned. + +To specify the alignment for each column of table cells, set to an array of alignment values. + #### UnicodeTable.prototype.autoRender -Rendering mode. If `true`, an instance renders on each `'change'` event; otherwise, rendering must be triggered manually. +Rendering mode. If `true`, an instance automatically re-renders a table on each `'change'` event; otherwise, rendering must be triggered manually. ```javascript var table = new UnicodeTable(); @@ -131,11 +184,79 @@ var mode = table.autoRender; // returns false ``` + + +#### UnicodeTable.prototype.borderTop + +Top table border character(s). + +```javascript +var table = new UnicodeTable(); + +// Set: +table.borderTop = '='; + +// Get: +var border = table.borderTop; +// returns '=' +``` + + + +#### UnicodeTable.prototype.borderRight + +Right table border character(s). + +```javascript +var table = new UnicodeTable(); + +// Set: +table.borderRight = '!'; + +// Get: +var border = table.borderRight; +// returns '!' +``` + + + +#### UnicodeTable.prototype.borderBottom + +Bottom table border character(s). + +```javascript +var table = new UnicodeTable(); + +// Set: +table.borderBottom = '='; + +// Get: +var border = table.borderBottom; +// returns '=' +``` + + + +#### UnicodeTable.prototype.borderLeft + +Left table border character(s). + +```javascript +var table = new UnicodeTable(); + +// Set: +table.borderLeft = '!'; + +// Get: +var border = table.borderLeft; +// returns '!' +``` + #### UnicodeTable.prototype.borders -Border characters. Must be an array of `four` strings in the order `[ 'top', 'right', 'bottom', 'left' ]`. +Table border characters in the order `[ 'top', 'right', 'bottom', 'left' ]`. ```javascript var table = new UnicodeTable(); @@ -152,7 +273,7 @@ var borders = table.borders; #### UnicodeTable.prototype.bufferSize -Data buffer size. If set, this specifies the maximum number of rows which can be rendered. Once the data buffer is full, each new row results in the oldest row being removed. +Data buffer size. If set, this specifies the maximum number of rows which can be rendered. Once an internal data buffer is full, each new row results in the oldest row being removed. ```javascript var table = new UnicodeTable(); @@ -177,76 +298,96 @@ data = table.data; Setting a data buffer size is useful when rendering data streams. - + -#### UnicodeTable.prototype.cellPaddingLeft +#### UnicodeTable.prototype.columnSeparator -Cell's left padding(s). Pads the left side of the cell with whitespace characters. Pad each cell individually by providing an array of paddings. +Column separator character(s). If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. ```javascript var table = new UnicodeTable(); // Set: -table.cellPaddingLeft = 3; +table.columnSeparator = '|'; // Get: -var padding = table.cellPaddingLeft; -// returns 3 +var separator = table.columnSeparator; +// returns '|' +``` + + + +#### UnicodeTable.prototype.cornerTopLeft + +Top-left table corner grapheme cluster (i.e., visual character). + +```javascript +var table = new UnicodeTable(); // Set: -table.cellPaddingLeft = [ 3, 4 ]; +table.cornerTopLeft = '*'; // Get: -padding = table.cellPaddingLeft; -// returns [ 3, 4 ] +var corner = table.cornerTopLeft; +// returns '*' ``` - + -#### UnicodeTable.prototype.cellPaddingRight +#### UnicodeTable.prototype.cornerTopRight -Cell's right padding(s). Pads the right side of the cell with whitespace characters. Pad each cell individually by providing an array of paddings. +Top-right table corner grapheme cluster (i.e., visual character). ```javascript var table = new UnicodeTable(); // Set: -table.cellPaddingRight = 3; +table.cornerTopRight = '*'; // Get: -var padding = table.cellPaddingRight; -// returns 3 +var corner = table.cornerTopRight; +// returns '*' +``` + + + +#### UnicodeTable.prototype.cornerBottomRight + +Bottom-right table corner grapheme cluster (i.e., visual character). + +```javascript +var table = new UnicodeTable(); // Set: -table.cellPaddingRight = [ 3, 4 ]; +table.cornerBottomRight = '*'; // Get: -padding = table.cellPaddingRight; -// returns [ 3, 4 ] +var corner = table.cornerBottomRight; +// returns '*' ``` - + -#### UnicodeTable.prototype.columnSeparator +#### UnicodeTable.prototype.cornerBottomLeft -Column separator character(s). If provided a string with multiple graphmeme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. +Bottom-left table corner grapheme cluster (i.e., visual character). ```javascript var table = new UnicodeTable(); // Set: -table.columnSeparator = '|'; +table.cornerBottomLeft = '*'; // Get: -var separator = table.columnSeparator; -// returns '|' +var corner = table.cornerBottomLeft; +// returns '*' ``` #### UnicodeTable.prototype.corners -Corner characters. Must be an array of `four` grapheme clusters in the order `[ 'top-left', 'top-right', 'bottom-right', 'bottom-left' ]`. +Table corner grapheme clusters (i.e., visual characters) in the order `[ 'top-left', 'top-right', 'bottom-right', 'bottom-left' ]`. ```javascript var table = new UnicodeTable(); @@ -263,16 +404,18 @@ var corners = table.corners; #### UnicodeTable.prototype.data -Table data. Must be an array of arrays or a MatrixLike ndarray and should not exceed the `bufferSize`. +Table data. ```javascript +var ndarray2array = require( '@stdlib/ndarray/to-array' ); + var table = new UnicodeTable(); // Set: table.data = [ [ 1, 2 ], [ 3, 4 ] ]; // Get: -var data = table.data; +var data = ndarray2array( table.data ); // returns [ [ 1, 2 ], [ 3, 4 ] ] ``` @@ -280,7 +423,7 @@ var data = table.data; #### UnicodeTable.prototype.headers -Table headers. Must be an array. +Table headers. ```javascript var table = new UnicodeTable(); @@ -297,7 +440,7 @@ var headers = table.headers; #### UnicodeTable.prototype.headerSeparator -Header separator character(s). If provided a string with multiple graphmeme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. +Header separator character(s). If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. ```javascript var table = new UnicodeTable(); @@ -314,11 +457,7 @@ var separator = table.headerSeparator; #### UnicodeTable.prototype.horizontalSeparatorMode -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. +Horizontal line separator mode. ```javascript var table = new UnicodeTable(); @@ -331,11 +470,102 @@ var mode = table.horizontalSeparatorMode; // returns 'interpolate' ``` +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. + + + +#### UnicodeTable.prototype.jointMiddle + +Joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.jointMiddle = '*'; + +// Get: +var joint = table.jointMiddle; +// returns '*' +``` + + + +#### UnicodeTable.prototype.jointTop + +Joint grapheme cluster (i.e., visual character) connecting cells along the top of the table. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.jointTop = '*'; + +// Get: +var joint = table.jointTop; +// returns '*' +``` + + + +#### UnicodeTable.prototype.jointRight + +Joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.jointRight = '*'; + +// Get: +var joint = table.jointRight; +// returns '*' +``` + + + +#### UnicodeTable.prototype.jointBottom + +Joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.jointBottom = '*'; + +// Get: +var joint = table.jointBottom; +// returns '*' +``` + + + +#### UnicodeTable.prototype.jointLeft + +Joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.jointLeft = '*'; + +// Get: +var joint = table.jointLeft; +// returns '*' +``` + #### UnicodeTable.prototype.joints -Joint characters. Must be an array of `five` grapheme clusters in the order `[ 'middle', 'top', 'right', 'bottom', 'left' ]`. +Joint grapheme clusters (i.e., visual characters) in the order `[ 'middle', 'top', 'right', 'bottom', 'left' ]`. ```javascript var table = new UnicodeTable(); @@ -348,45 +578,96 @@ var joints = table.joints; // returns [ '*', '*', '*', '*', '*' ] ``` - + + +#### UnicodeTable.prototype.marginTop + +Margin at the top of the table in units of blank lines. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.marginTop = 2; + +// Get: +var margin = table.marginTop; +// returns 2 +``` + + + +#### UnicodeTable.prototype.marginRight + +Margin to the right of the table in units of whitespace. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.marginRight = 2; + +// Get: +var margin = table.marginRight; +// returns 2 +``` + + -#### UnicodeTable.prototype.marginX +#### UnicodeTable.prototype.marginBottom -Horizontal output margin. This will add margin to both left and right of the output. +Margin at the bottom of the table in units of blank lines. ```javascript var table = new UnicodeTable(); // Set: -table.marginX = 2; +table.marginBottom = 2; // Get: -var margin = table.marginX; +var margin = table.marginBottom; // returns 2 ``` - + -#### UnicodeTable.prototype.marginY +#### UnicodeTable.prototype.marginLeft -Vertical output margin. This will add margin to both top and bottom of the output. +Margin to the left of the table in units of whitespace. ```javascript var table = new UnicodeTable(); // Set: -table.marginY = 2; +table.marginLeft = 2; // Get: -var margin = table.marginY; +var margin = table.marginLeft; // returns 2 ``` + + +#### UnicodeTable.prototype.margins + +Table margins in the order of `[ top, right, bottom, left ]`. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.margins = [ 2, 2, 2, 2 ]; + +// Get: +var margins = table.margins; +// returns [ 2, 2, 2, 2 ] +``` + #### UnicodeTable.prototype.maxCellWidth -Maximum cell width. If a datum is longer than the maximum cell width, it is truncated. Truncate each cell individually by providing an array of widhts. +Maximum cell width in units of grapheme clusters (i.e., visual characters). If cell data is longer than the maximum cell width, the rendered cell data is truncated. To specify the maximum cell width for each column of cells, provide an array of maximum cell widths. ```javascript var table = new UnicodeTable(); @@ -405,28 +686,76 @@ table.maxCellWidth = [ 10, 15 ]; width = table.maxCellWidth; ``` - + -#### UnicodeTable.prototype.maxOutputWidth +#### UnicodeTable.prototype.maxWidth -Maximum output width. If the output is longer than the maximum output width, it is wrapped into multiple tables. +Maximum table width in units of grapheme clusters (i.e., visual characters). If the generated table is longer than the maximum table width, a generated table is split into multiple tables. ```javascript var table = new UnicodeTable(); // Set: -table.maxOutputWidth = 200; +table.maxWidth = 200; // Get: -var width = table.maxOutputWidth; +var width = table.maxWidth; // returns 200 ``` + + +#### UnicodeTable.prototype.paddingLeft + +Cell left padding(s) in units of whitespace. To specify the padding of each column of table cells, provide an array of paddings. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.paddingLeft = 3; + +// Get: +var padding = table.paddingLeft; +// returns 3 + +// Set: +table.paddingLeft = [ 3, 4 ]; + +// Get: +padding = table.paddingLeft; +// returns [ 3, 4 ] +``` + + + +#### UnicodeTable.prototype.paddingRight + +Cell right padding(s) in units of whitespace. To specify the padding of each column of table cells, provide an array of paddings. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.paddingRight = 3; + +// Get: +var padding = table.paddingRight; +// returns 3 + +// Set: +table.paddingRight = [ 3, 4 ]; + +// Get: +padding = table.paddingRight; +// returns [ 3, 4 ] +``` + #### UnicodeTable.prototype.rowSeparator -Row separator character(s). If provided a string with multiple graphmeme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. +Row separator character(s). If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. ```javascript var table = new UnicodeTable(); @@ -443,11 +772,7 @@ var separator = table.rowSeparator; #### UnicodeTable.prototype.verticalSeparatorMode -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. +Vertical line separator mode. ```javascript var table = new UnicodeTable(); @@ -460,28 +785,36 @@ var mode = table.verticalSeparatorMode; // returns 'interpolate' ``` +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. + * * * ### Methods -#### UnicodeTable.prototype.push( row ) +#### UnicodeTable.prototype.push( data ) -Appends a row to table data. The row must have the same number of columns as existing data. +Appends one or more rows to table data. Each provided row must have the same number of columns as existing table data. ```javascript +var ndarray2array = require( '@stdlib/ndarray/to-array' ); + var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // Get: -var data = table.data; +var data = ndarray2array( table.data ); // returns [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] // Push: table.push( [ 7, 8, 9 ] ); // Get: -data = table.data; +data = ndarray2array( table.data ); // returns [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ] ``` @@ -492,13 +825,10 @@ data = table.data; Renders a Unicode table. ```javascript -var headers; -var table; -var data; +var headers = [ 'col1', 'col2', 'col3' ]; +var data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; -headers = [ 'col1', 'col2', 'col3' ]; -data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; -table = new UnicodeTable( data, headers ); +var table = new UnicodeTable( data, headers ); var str = table.render(); // returns '...' @@ -524,7 +854,7 @@ function onChange() { #### 'render' -Emitted whenever a sparkline is rendered. +Emitted whenever a table is rendered. ```javascript var table = new UnicodeTable(); @@ -542,6 +872,12 @@ function onRender( str ) {
+* * * + +## Notes + +- Once a table instance has resolved the number of table columns (e.g., by setting table headers, binding table data, specifying column paddings, or specifying column alignments), the number of table columns is fixed. In order to remove or add table columns, create a new table instance with the desired configuration. +
@@ -559,27 +895,29 @@ function onRender( str ) { ```javascript var uniform = require( '@stdlib/random/array/uniform' ); var array = require( '@stdlib/ndarray/array' ); -var ctor = require( '@stdlib/plot/table/unicode' ); - -var headers; -var table; -var data; -var str; +var UnicodeTable = require( '@stdlib/plot/table/unicode' ); -// Generate some random data... -data = uniform( 50, 1, 100 ); -data = array( data, { +// Generate a random data set: +var data = array( uniform( 50, 1.0, 100.0 ), { 'shape': [ 10, 5 ] }); -// Generate headers... -headers = [ 'A', 'B', 'C', 'D', 'E' ]; +// Define column headers: +var headers = [ 'A', 'B', 'C', 'D', 'E' ]; // Create a table: -table = ctor( data, headers ); +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'columnSeparator': '#$%', + 'maxWidth': 200, + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right' +}); // Render the table: -str = table.render(); +var str = table.render(); console.log( str ); // => '...' ``` @@ -588,9 +926,9 @@ console.log( str ); -* * * + -## See Also +
@@ -600,6 +938,8 @@ console.log( str );
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor + diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index 14b46d529cc6..2ca75487fb68 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -93,7 +93,7 @@ bench( pkg+'::instantiation,data,headers', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ] ); + v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); if ( !( v instanceof UnicodeTable ) ) { b.fail( 'should return an instance' ); } @@ -112,21 +112,38 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { var i; opts = { - 'alignment': 'left', + 'align': 'left', 'autoRender': false, + 'borderTop': '1', + 'borderRight': '23', + 'borderBottom': '456', + 'borderLeft': '7890', 'borders': [ '1', '23', '456', '7890' ], 'bufferSize': 10, - 'cellPaddingLeft': 2, - 'cellPaddingRight': [ 2, 3, 4 ], 'columnSeparator': 'None', + 'cornerTopLeft': '*', + 'cornerTopRight': '*', + 'cornerBottomLeft': '*', + 'cornerBottomRight': '*', 'corners': [ '*', '*', '*', '*' ], + 'headers': [ 'col1', 'col2', 'col3' ], 'headerSeparator': '-=', 'horizontalSeparatorMode': 'repeat', + 'jointMiddle': '*', + 'jointTop': '*', + 'jointRight': '*', + 'jointBottom': '*', + 'jointLeft': '*', 'joints': [ '*', '*', '*', '*', '*' ], - 'marginX': 2, - 'marginY': 4, + 'marginTop': 4, + 'marginRight': 2, + 'marginBottom': 4, + 'marginLeft': 2, + 'margins': [ 4, 2, 4, 2 ], 'maxCellWidth': 10, - 'maxOutputWidth': 60, + 'maxWidth': 60, + 'paddingLeft': 2, + 'paddingRight': [ 2, 3, 4 ], 'rowSeparator': '_-', 'verticalSeparatorMode': 'resume' }; @@ -145,46 +162,7 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { b.end(); }); -bench( pkg+'::instantiation,data,headers,options', function benchmark( b ) { - var opts; - var v; - var i; - - opts = { - 'alignment': 'left', - 'autoRender': false, - 'borders': [ '1', '23', '456', '7890' ], - 'bufferSize': 10, - 'cellPaddingLeft': 2, - 'cellPaddingRight': [ 2, 3, 4 ], - 'columnSeparator': 'None', - 'corners': [ '*', '*', '*', '*' ], - 'headerSeparator': '-=', - 'horizontalSeparatorMode': 'repeat', - 'joints': [ '*', '*', '*', '*', '*' ], - 'marginX': 2, - 'marginY': 4, - 'maxCellWidth': 10, - 'maxOutputWidth': 60, - 'rowSeparator': '_-', - 'verticalSeparatorMode': 'resume' - }; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], [ 'col1', 'col2', 'col3' ], opts ); - if ( !( v instanceof UnicodeTable ) ) { - b.fail( 'should return an instance' ); - } - } - b.toc(); - if ( !( v instanceof UnicodeTable ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::set,get:alignment:string', function benchmark( b ) { +bench( pkg+'::set,get:align:value=string', function benchmark( b ) { var values; var v; var i; @@ -198,20 +176,20 @@ bench( pkg+'::set,get:alignment:string', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.alignment = values[ i % values.length ]; - if ( typeof v.alignment !== 'string' ) { + v.align = values[ i % values.length ]; + if ( typeof v.align !== 'string' ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.alignment !== 'string' ) { + if ( typeof v.align !== 'string' ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:alignment:array', function benchmark( b ) { +bench( pkg+'::set,get:align:value=array', function benchmark( b ) { var values; var v; var i; @@ -225,13 +203,13 @@ bench( pkg+'::set,get:alignment:array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.alignment = values[ i % values.length ]; - if ( typeof v.alignment !== 'object' || !v.alignment.length ) { + v.align = values[ i % values.length ]; + if ( typeof v.align !== 'object' || !v.align.length ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.alignment !== 'object' || !v.alignment.length ) { + if ( typeof v.align !== 'object' || !v.align.length ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -264,6 +242,110 @@ bench( pkg+'::set,get:autoRender', function benchmark( b ) { b.end(); }); +bench( pkg+'::set,get:borderTop', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1', + '2' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.borderTop = values[ i % values.length ]; + if ( typeof v.borderTop !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.borderTop !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:borderRight', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1', + '2' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.borderRight = values[ i % values.length ]; + if ( typeof v.borderRight !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.borderRight !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:borderBottom', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1', + '2' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.borderBottom = values[ i % values.length ]; + if ( typeof v.borderBottom !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.borderBottom !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:borderLeft', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '1', + '2' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.borderLeft = values[ i % values.length ]; + if ( typeof v.borderLeft !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.borderLeft !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:borders', function benchmark( b ) { var values; var v; @@ -320,136 +402,132 @@ bench( pkg+'::set,get:bufferSize', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:cellPaddingLeft:number', function benchmark( b ) { +bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { var values; var v; var i; values = [ - 1, - 2, - 3 + '|', + '123', + '🥀', + '' ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.cellPaddingLeft = values[ i % values.length ]; - if ( typeof v.cellPaddingLeft !== 'number' ) { - b.fail( 'should return a number' ); + v.columnSeparator = values[ i % values.length ]; + if ( typeof v.columnSeparator !== 'string' ) { + b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cellPaddingLeft !== 'number' ) { - b.fail( 'should return a number' ); + if ( typeof v.columnSeparator !== 'string' ) { + b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:cellPaddingLeft:array', function benchmark( b ) { +bench( pkg+'::set,get:cornerTopLeft', function benchmark( b ) { var values; var v; var i; values = [ - [ 1, 2 ], - [ 3, 4 ], - [ 5, 6 ] + '-', + '*' ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.cellPaddingLeft = values[ i % values.length ]; - if ( typeof v.cellPaddingLeft !== 'object' || !v.cellPaddingLeft.length ) { - b.fail( 'should return an array' ); + v.cornerTopLeft = values[ i % values.length ]; + if ( typeof v.cornerTopLeft !== 'string' ) { + b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cellPaddingLeft !== 'object' || !v.cellPaddingLeft.length ) { - b.fail( 'should return an array' ); + if ( typeof v.cornerTopLeft !== 'string' ) { + b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:cellPaddingRight:number', function benchmark( b ) { +bench( pkg+'::set,get:cornerTopRight', function benchmark( b ) { var values; var v; var i; values = [ - 1, - 2, - 3 + '-', + '*' ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.cellPaddingRight = values[ i % values.length ]; - if ( typeof v.cellPaddingRight !== 'number' ) { - b.fail( 'should return a number' ); + v.cornerTopRight = values[ i % values.length ]; + if ( typeof v.cornerTopRight !== 'string' ) { + b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cellPaddingRight !== 'number' ) { - b.fail( 'should return a number' ); + if ( typeof v.cornerTopRight !== 'string' ) { + b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:cellPaddingRight:array', function benchmark( b ) { +bench( pkg+'::set,get:cornerBottomRight', function benchmark( b ) { var values; var v; var i; values = [ - [ 1, 2 ], - [ 3, 4 ], - [ 5, 6 ] + '-', + '*' ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.cellPaddingRight = values[ i % values.length ]; - if ( typeof v.cellPaddingRight !== 'object' || !v.cellPaddingRight.length ) { - b.fail( 'should return an array' ); + v.cornerBottomRight = values[ i % values.length ]; + if ( typeof v.cornerBottomRight !== 'string' ) { + b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cellPaddingRight !== 'object' || !v.cellPaddingRight.length ) { - b.fail( 'should return an array' ); + if ( typeof v.cornerBottomRight !== 'string' ) { + b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { +bench( pkg+'::set,get:cornerBottomLeft', function benchmark( b ) { var values; var v; var i; values = [ - '|', - '123', - '🥀', - '' + '-', + '*' ]; v = new UnicodeTable(); b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.columnSeparator = values[ i % values.length ]; - if ( typeof v.columnSeparator !== 'string' ) { + v.cornerBottomLeft = values[ i % values.length ]; + if ( typeof v.cornerBottomLeft !== 'string' ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.columnSeparator !== 'string' ) { + if ( typeof v.cornerBottomLeft !== 'string' ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -482,13 +560,39 @@ bench( pkg+'::set,get:corners', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:data', function benchmark( b ) { +bench( pkg+'::set,get:data:value=nested_array', function benchmark( b ) { var values; var v; var i; values = [ [ [ 1, 2, 3 ], [ 4, 5, 6 ] ], + [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.data = values[ i % values.length ]; + if ( typeof v.data !== 'object' || !v.data.length ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( typeof v.data !== 'object' || !v.data.length ) { + b.fail( 'should return an ndarray' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:data:value=ndarray', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + ndarray( 'generic', [ 1, 2, 3, 4, 5, 6 ], [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ), ndarray( 'generic', [ 1, 2, 3, 4, 5, 6 ], [ 2, 3 ], [ 3, 1 ], 0, 'row-major' ) ]; v = new UnicodeTable(); @@ -497,12 +601,12 @@ bench( pkg+'::set,get:data', function benchmark( b ) { for ( i = 0; i < b.iterations; i++ ) { v.data = values[ i % values.length ]; if ( typeof v.data !== 'object' || !v.data.length ) { - b.fail( 'should return an array' ); + b.fail( 'should return an ndarray' ); } } b.toc(); if ( typeof v.data !== 'object' || !v.data.length ) { - b.fail( 'should return an array' ); + b.fail( 'should return an ndarray' ); } b.pass( 'benchmark finished' ); b.end(); @@ -515,7 +619,7 @@ bench( pkg+'::set,get:headers', function benchmark( b ) { values = [ [ 'col1', 'col2', 'col3' ], - [ 1, 2, 3] + [ 1, 2, 3 ] ]; v = new UnicodeTable(); @@ -589,6 +693,136 @@ bench( pkg+'::set,get:horizontalSeparatorMode', function benchmark( b ) { b.end(); }); +bench( pkg+'::set,get:jointMiddle', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + '*' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.jointMiddle = values[ i % values.length ]; + if ( typeof v.jointMiddle !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.jointMiddle !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:jointTop', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + '*' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.jointTop = values[ i % values.length ]; + if ( typeof v.jointTop !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.jointTop !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:jointRight', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + '*' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.jointRight = values[ i % values.length ]; + if ( typeof v.jointRight !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.jointRight !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:jointBottom', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + '*' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.jointBottom = values[ i % values.length ]; + if ( typeof v.jointBottom !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.jointBottom !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:jointLeft', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '-', + '*' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.jointLeft = values[ i % values.length ]; + if ( typeof v.jointLeft !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( typeof v.jointLeft !== 'string' ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:joints', function benchmark( b ) { var values; var v; @@ -615,7 +849,34 @@ bench( pkg+'::set,get:joints', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:marginX', function benchmark( b ) { +bench( pkg+'::set,get:marginTop', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 0, + 1, + 2 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.marginTop = values[ i % values.length ]; + if ( typeof v.marginTop !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.marginTop !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:marginRight', function benchmark( b ) { var values; var v; var i; @@ -629,20 +890,20 @@ bench( pkg+'::set,get:marginX', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.marginX = values[ i % values.length ]; - if ( typeof v.marginX !== 'number' ) { + v.marginRight = values[ i % values.length ]; + if ( typeof v.marginRight !== 'number' ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.marginX !== 'number' ) { + if ( typeof v.marginRight !== 'number' ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:marginY', function benchmark( b ) { +bench( pkg+'::set,get:marginBottom', function benchmark( b ) { var values; var v; var i; @@ -656,20 +917,73 @@ bench( pkg+'::set,get:marginY', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.marginY = values[ i % values.length ]; - if ( typeof v.marginY !== 'number' ) { + v.marginBottom = values[ i % values.length ]; + if ( typeof v.marginBottom !== 'number' ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.marginY !== 'number' ) { + if ( typeof v.marginBottom !== 'number' ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:maxCellWidth:number', function benchmark( b ) { +bench( pkg+'::set,get:marginLeft', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 0, + 1, + 2 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.marginLeft = values[ i % values.length ]; + if ( typeof v.marginLeft !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.marginLeft !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:margins', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 0, 0, 0, 0 ], + [ 1, 2, 3, 4 ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.margins = values[ i % values.length ]; + if ( typeof v.margins !== 'object' || !v.margins.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.margins !== 'object' || !v.margins.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:maxCellWidth:value=number', function benchmark( b ) { var values; var v; var i; @@ -697,7 +1011,7 @@ bench( pkg+'::set,get:maxCellWidth:number', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:maxCellWidth:array', function benchmark( b ) { +bench( pkg+'::set,get:maxCellWidth:value=array', function benchmark( b ) { var values; var v; var i; @@ -725,7 +1039,7 @@ bench( pkg+'::set,get:maxCellWidth:array', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:maxOutputWidth', function benchmark( b ) { +bench( pkg+'::set,get:maxWidth', function benchmark( b ) { var values; var v; var i; @@ -740,19 +1054,127 @@ bench( pkg+'::set,get:maxOutputWidth', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.maxOutputWidth = values[ i % values.length ]; - if ( typeof v.maxOutputWidth !== 'number' ) { + v.maxWidth = values[ i % values.length ]; + if ( typeof v.maxWidth !== 'number' ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.maxOutputWidth !== 'number' ) { + if ( typeof v.maxWidth !== 'number' ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); b.end(); }); +bench( pkg+'::set,get:paddingLeft:value=number', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 1, + 2, + 3 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.paddingLeft = values[ i % values.length ]; + if ( typeof v.paddingLeft !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.paddingLeft !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:paddingLeft:value=array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 1, 2 ], + [ 3, 4 ], + [ 5, 6 ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.paddingLeft = values[ i % values.length ]; + if ( typeof v.paddingLeft !== 'object' || !v.paddingLeft.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.paddingLeft !== 'object' || !v.paddingLeft.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:paddingRight:value=number', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 1, + 2, + 3 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.paddingRight = values[ i % values.length ]; + if ( typeof v.paddingRight !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( typeof v.paddingRight !== 'number' ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:paddingRight:value=array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 1, 2 ], + [ 3, 4 ], + [ 5, 6 ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.paddingRight = values[ i % values.length ]; + if ( typeof v.paddingRight !== 'object' || !v.paddingRight.length ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( typeof v.paddingRight !== 'object' || !v.paddingRight.length ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:rowSeparator', function benchmark( b ) { var values; var v; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js index 11c989b4bbd1..19a7d847c4ad 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js @@ -21,9 +21,8 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var random = require( '@stdlib/random/array/discrete-uniform' ); 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' ); @@ -41,42 +40,19 @@ var UnicodeTable = require( './../lib' ); * @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, { + data = random( rows*columns, 0, 100, { + 'dtype': 'float64' + }); + table.data = array( data, { 'shape': [ rows, columns ] }); - headers = []; - for ( i = 0; i < columns; i++ ) { - headers.push( randu() ); - } - table.data = data; - table.headers = headers; + table.headers = random( columns, 0, columns, { + 'dtype': 'generic' + }); return benchmark; - /** - * Generates a row of table data. - * - * @private - * @returns {Array} table data - */ - function row() { - var data; - var i; - - data = []; - for ( i = 0; i < columns; i++ ) { - data.push( randu() ); - } - return data; - } - /** * Benchmark function. * @@ -89,7 +65,7 @@ function createBenchmark( rows, columns, table ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - str = table.push( row() ).render(); + str = table.render(); if ( typeof str !== 'string' ) { b.fail( 'should return a string' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index 0947404ced32..48ac8e459653 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -1,112 +1,202 @@ -{{alias}}( [data,] [headers,] [options] ) +{{alias}}( [data,] [options] ) Returns a Unicode table instance. Parameters ---------- - data: Object|Array|Array|MatrixLike (optional) + data: Object|Array|Array|ndarray (optional) Table data. - headers: Collection (optional) - Table headers. - options: Object (optional) Table options. - options.alignment: Array|string (optional) - Datum's cell alignment(s). Default: 'right'. + options.align: Array|string (optional) + Cell alignment(s). Must be one of the following: + + - left: left-aligned. + - center: center-aligned. + - right: right-aligned. + + Default: 'right'. options.autoRender: boolean (optional) - Boolean indicating whether to re-render on a 'change' event. Default: - false. + Boolean indicating whether to automatically re-render on a 'change' + event. Default: false. - options.borders: Array (optional) - Border characters. Default: [ '─', '│', '─', '│' ]. + options.borderTop: string (optional) + Top table border character(s). 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.borderRight: string (optional) + Right table border character(s). Default: '|'. - options.cellPaddingLeft: Array|NonNegativeInteger - (optional) - Cell's left padding(s). Default: 1. + options.borderBottom: string (optional) + Bottom table border character(s). Default: '-'. - options.cellPaddingRight: Array|NonNegativeInteger - (optional) - Cell's right padding(s). Default: 1. + options.borderLeft: string (optional) + Left table border character(s). Default: '|'. + + options.borders: Array (optional) + Table border characters in the order [top, right, bottom, left]. + Default: [ '─', '│', '─', '│' ]. + + options.bufferSize: integer|null (optional) + Data buffer size. If specified, data is kept in a first-in first-out + (FIFO) buffer which cannot exceed the specified buffer size. Default: + +infinity. options.columnSeparator: string (optional) Column separator character(s). Default: '│'. + options.cornerTopLeft: string (optional) + Top-left table corner grapheme cluster (i.e., visual character). + Default: '┌'. + + options.cornerTopRight: string (optional) + Top-right table corner grapheme cluster (i.e., visual character). + Default: '┐'. + + options.cornerBottomRight: string (optional) + Bottom-right table corner grapheme cluster (i.e., visual character). + Default: '┘'. + + options.cornerBottomLeft: string (optional) + Bottom-left table corner grapheme cluster (i.e., visual character). + Default: '└'. + options.corners: Array (optional) - Corner characters. Default: [ '┌', '┐', '┘', '└' ]. + Table corner grapheme clusters (i.e., visual characters) in the order + [top-left, top-right, bottom-right, bottom-left]. Default: [ '┌', '┐', + '┘', '└' ]. + + options.headers: Array (optional) + Table headers. options.headerSeparator: string (optional) Header separator character(s). Default: '─'. options.horizontalSeparatorMode: string (optional) - Horizontal line separator mode. The following modes are supported: + Horizontal line separator mode. Must be one of the following: - resume: resume line sequence after a joint. - interpolate: skip line character at a joint. - repeat: repeat line sequence after a joint. - Default: `resume`. + Default: 'resume'. + + options.jointMiddle: string (optional) + Joint grapheme cluster (i.e., visual character) connecting cells within + the middle of the table. Default: '┼'. + + options.jointTop: string (optional) + Joint grapheme cluster (i.e., visual character) connecting cells along + the top of the table. Default: '┬'. + + options.jointRight: string (optional) + Joint grapheme cluster (i.e., visual character) connecting cells along + the right side of the table. Default: '┤'. + + options.jointBottom: string (optional) + Joint grapheme cluster (i.e., visual character) connecting cells along + the bottom of the table. Default: '┴'. + + options.jointLeft: string (optional) + Joint grapheme cluster (i.e., visual character) connecting cells along + the left side of the table. Default: '├'. options.joints: Array (optional) - Joint characters. Default: [ '┼', '┬', '┤', '┴', '├' ]. + Joint grapheme cluster (i.e., visual characters) in the order [middle, + top, right, bottom, left]. Default: [ '┼', '┬', '┤', '┴', '├' ]. + + options.marginTop: integer (optional) + Margin at the top of the table in units of blank lines. Default: 0. + + options.marginRight: integer (optional) + Margin to the right of the table in units of whitespace. Default: 0. + + options.marginBottom: integer (optional) + Margin at the bottom of the table in units of blank lines. Default: 0. - options.marginX: NonNegativeInteger (optional) - Horizontal output margin. Default: 0. + options.marginLeft: integer (optional) + Margin to the left of the table in units of whitespace. Default: 0. - options.marginY: NonNegativeInteger (optional) - Vertical output margin. Default: 0. + options.margins: Array (optional) + Table margins in the order [top, right, bottom, left]. Default: + [ 0, 0, 0, 0 ]. - options.maxCellWidth: Array|NonNegativeInteger|null - (optional) - Maximum cell width(s). Default: +infinity. + options.maxCellWidth: Array|integer|null (optional) + Maximum cell width(s) in units of grapheme clusters (i.e., visual + characters). Default: +infinity. - options.maxOutputWidth: NonNegativeInteger|null (optional) - Maximum output width. Default: +infinity. + options.maxWidth: integer|null (optional) + Maximum table width in units of grapheme clusters (i.e., visual + characters). Default: +infinity. + + options.paddingLeft: Array|integer (optional) + Cell left padding(s) in units of whitespace characters. Default: 1. + + options.paddingRight: Array|integer (optional) + Cell right padding(s) in units of whitespace characters. Default: 1. options.rowSeparator: string (optional) Row separator character(s). Default: ''. options.verticalSeparatorMode: string (optional) - Vertical line separator mode. The following modes are supported: + Vertical line separator mode. Must be one of the following: - resume: resume line sequence after a joint. - interpolate: skip line character at a joint. - repeat: repeat line sequence after a joint. - Default: `resume`. + Default: 'resume'. Returns ------- - table.alignment - Datum's cell alignment(s). + table: Table + Table instance. + + table.align + Cell alignment(s). table.autoRender - Rendering mode. If `true`, an instance renders on each 'change' event; - otherwise, rendering must be triggered manually. + Rendering mode. If `true`, an instance automatically re-renders on each + 'change' event; otherwise, rendering must be triggered manually. + + table.borderTop + Top table border character(s). + + table.borderRight + Right table border character(s). + + table.borderBottom + Bottom table border character(s). + + table.borderLeft + Left table border character(s). table.borders - Border characters. + Table border characters in the order [top, right, bottom, left]. table.bufferSize Data buffer size. - table.cellPaddingLeft - Cell's left Padding. - - table.cellPaddingRight - Cell's right Padding. - table.columnSeparator Column separator character(s). + table.cornerTopLeft + Top-left table corner grapheme cluster (i.e., visual character). + + table.cornerTopRight + Top-right table corner grapheme cluster (i.e., visual character). + + table.cornerBottomRight + Bottom-right table corner grapheme cluster (i.e., visual character). + + table.cornerBottomLeft + Bottom-left table corner grapheme cluster (i.e., visual character). + table.corners - Corner characters. + Corner grapheme clusters (i.e., visual characters) in the order + [top-left, top-right, bottom-right, bottom-left]. table.data Table data. @@ -120,20 +210,56 @@ table.horizontalSeparatorMode Horizontal line separator mode. + table.jointMiddle + Joint grapheme cluster (i.e., visual character) connecting cells within + the middle of the table. + + table.jointTop + Joint grapheme cluster (i.e., visual character) connecting cells along + the top of the table. + + table.jointRight + Joint grapheme cluster (i.e., visual character) connecting cells along + the right side of the table. + + table.jointBottom + Joint grapheme cluster (i.e., visual character) connecting cells along + the bottom of the table. + + table.jointLeft + Joint grapheme cluster (i.e., visual character) connecting cells along + the left side of the table. + table.joints - Joint characters. + Joint grapheme clusters (i.e., visual characters) in the order [middle, + top, right, bottom, left]. - table.marginX - Horizontal output margin. + table.marginTop + Top table margin. - table.marginY - Vertical output margin. + table.marginRight + Right table margin. + + table.marginBottom + Bottom table margin. + + table.marginLeft + Left table margin. + + table.margins + Table margins in the order [top, right, bottom, left]. table.maxCellWidth Maximum cell width. - table.maxOutputWidth - Maximum output width. + table.maxWidth + Maximum table width. + + table.paddingLeft + Cell left padding. + + table.paddingRight + Cell right padding. table.push( row ) Appends a row to table data. @@ -151,7 +277,7 @@ -------- > var data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; > var headers = [ 'col1', 'col2', 'col3' ]; - > var table = new {{alias}}( data, headers ); + > var table = new {{alias}}( data, { 'headers': headers } ); > table.render() '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 722cd52735c1..94ee231b1446 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -20,26 +20,28 @@ var uniform = require( '@stdlib/random/array/uniform' ); var array = require( '@stdlib/ndarray/array' ); -var ctor = require( './../lib' ); +var UnicodeTable = require( './../lib' ); -var headers; -var table; -var data; -var str; - -// Generate some random data... -data = uniform( 50, 1, 100 ); -data = array( data, { +// Generate a random data set: +var data = array( uniform( 50, 1.0, 100.0 ), { 'shape': [ 10, 5 ] }); -// Generate headers... -headers = [ 'A', 'B', 'C', 'D', 'E' ]; +// Define column headers: +var headers = [ 'A', 'B', 'C', 'D', 'E' ]; // Create a table: -table = ctor( data, headers ); +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'columnSeparator': '#$%', + 'maxWidth': 200, + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right' +}); // Render the table: -str = table.render(); +var str = table.render(); console.log( str ); // => '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index ad2e9a670cab..ede272af4943 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -35,49 +35,146 @@ function defaults() { var out = {}; // Cell alignment: - out.alignment = 'right'; + out.align = [ 'right' ]; - // Boolean indicating whether to re-render on a `change` event: + // Boolean indicating whether to automatically re-render on a `change` event: out.autoRender = false; // Border characters: - out.borders = [ '─', '│', '─', '│' ]; + out.borders = [ + { + + 'value': '-', + 'graphemes': [ '-' ], + 'length': 1 + }, + { + + 'value': '|', + 'graphemes': [ '|' ], + 'length': 1 + }, + { + + 'value': '-', + 'graphemes': [ '-' ], + 'length': 1 + }, + { + + 'value': '|', + 'graphemes': [ '|' ], + 'length': 1 + } + ]; // Buffer size: out.bufferSize = FLOAT64_MAX; - // Cell padding: - out.cellPaddingLeft = 1; - out.cellPaddingRight = 1; - - // Corner characters: - out.corners = [ '┌', '┐', '┘', '└' ]; - - // Column separator character: - out.columnSeparator = '│'; - - // Header separator character: - out.headerSeparator = '─'; - - // Joint characters: - out.joints = [ '┼', '┬', '┤', '┴', '├' ]; - - // Line separator mode: + // Corner grapheme clusters: + out.corners = [ + { + + 'value': '┌', + 'graphemes': [ '┌' ], + 'length': 1 + }, + { + + 'value': '┐', + 'graphemes': [ '┐' ], + 'length': 1 + }, + { + + 'value': '┘', + 'graphemes': [ '┘' ], + 'length': 1 + }, + { + + 'value': '└', + 'graphemes': [ '└' ], + 'length': 1 + } + ]; + + // Column separator: + out.columnSeparator = { + 'value': '|', + 'graphemes': [ '|' ], + 'length': 1 + }; + + // Column headers: + out.headers = null; + + // Header separator: + out.headerSeparator = { + 'value': '-', + 'graphemes': [ '-' ], + 'length': 1 + }; + + // Horizontal line separator mode: out.horizontalSeparatorMode = 'resume'; - out.verticalSeparatorMode = 'resume'; - // Output margins: - out.marginX = 0; - out.marginY = 0; + // Joint grapheme clusters: + out.joints = [ + { + + 'value': '┼', + 'graphemes': [ '┼' ], + 'length': 1 + }, + { + + 'value': '┬', + 'graphemes': [ '┬' ], + 'length': 1 + }, + { + + 'value': '┤', + 'graphemes': [ '┤' ], + 'length': 1 + }, + { + + 'value': '┴', + 'graphemes': [ '┴' ], + 'length': 1 + }, + { + + 'value': '├', + 'graphemes': [ '├' ], + 'length': 1 + } + ]; + + // Table margins: + out.margins = [ 0, 0, 0, 0 ]; // Maximum cell width: - out.maxCellWidth = FLOAT64_MAX; + out.maxCellWidth = [ FLOAT64_MAX ]; + + // Maximum table width: + out.maxWidth = FLOAT64_MAX; - // Maximum output width: - out.maxOutputWidth = FLOAT64_MAX; + // Cell padding: + out.paddingLeft = [ 1 ]; + out.paddingRight = [ 1 ]; - // Row separator character: - out.rowSeparator = ''; + // Row separator: + out.rowSeparator = { + 'value': '', + 'graphemes': [], + 'length': 0 + }; + + // Vertical line separator mode: + out.verticalSeparatorMode = 'resume'; return out; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js similarity index 50% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js index 53fa83ce1a7a..83516c6834b3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_headers.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js @@ -21,38 +21,32 @@ // MAIN // /** -* Parses an array into table headers. +* Tests whether all element pairs from two arrays pass a test implemented by a binary predicate function. * * @private -* @param {Collection} headers - column names -* @param {Array} [columnWidths] - column widths -* @returns {Object} table metadata +* @param {Collection} x - first input array +* @param {Collection} y - second input array +* @param {Function} predicate - predicate function +* @param {*} thisArg - predicate function execution context +* @returns {boolean} boolean indicating whether all elements pass a test */ -function parseHeaders( headers, columnWidths ) { - var header; +function everyBy2( x, y, predicate, thisArg ) { // FIXME: move to array/base + var len; var i; - if ( columnWidths ) { - for ( i = 0; i < headers.length; i++ ) { - header = String( headers[ i ] ); - if ( header.length > columnWidths[ i ] ) { - columnWidths[ i ] = header.length; - } - } - } else { - columnWidths = []; - for ( i = 0; i < headers.length; i++ ) { - columnWidths.push( String( headers[ i ] ).length ); + len = x.length; + if ( len !== y.length ) { + return false; + } + for ( i = 0; i < len; i++ ) { + if ( !predicate.call( thisArg, x[ i ], y[ i ], i, [ x, y ] ) ) { + return false; } } - return { - 'headers': headers, - 'columnWidths': columnWidths, - 'data': null - }; + return true; } // EXPORTS // -module.exports = parseHeaders; +module.exports = everyBy2; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js index ec280ed94dab..5e0c90062302 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js @@ -27,8 +27,11 @@ * var UnicodeTable = require( '@stdlib/plot/table/unicode' ); * * var data = [ [ 1, 2 ], [ 3, 4 ] ]; -* var headers = [ 'A', 'B' ] -* var table = UnicodeTable( data, headers ); +* var headers = [ 'A', 'B' ]; +* +* var table = UnicodeTable( data, { +* 'headers': headers +* }); * * var str = table.render(); * // returns '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index e10232b7f300..1037107056c3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -16,34 +16,43 @@ * limitations under the License. */ -/* eslint-disable max-lines */ - 'use strict'; // MODULES // var EventEmitter = require( 'events' ).EventEmitter; var logger = require( 'debug' ); -var format = require( '@stdlib/string/format' ); +var setReadWriteAccessor = require( '@stdlib/utils/define-read-write-accessor' ); var defineProperty = require( '@stdlib/utils/define-property' ); var objectKeys = require( '@stdlib/utils/keys' ); var inherit = require( '@stdlib/utils/inherit' ); var isObject = require( '@stdlib/assert/is-plain-object' ); -var isCollection = require( '@stdlib/assert/is-collection' ); -var mergeFcn = require( '@stdlib/utils/merge' ).factory; var pick = require( '@stdlib/utils/pick' ); -var setAlignment = require( './props/alignment/set.js' ); -var getAlignment = require( './props/alignment/get.js' ); +var format = require( '@stdlib/string/format' ); +var setAlign = require( './props/align/set.js' ); +var getAlign = require( './props/align/get.js' ); var setAutoRender = require( './props/auto-render/set.js' ); var getAutoRender = require( './props/auto-render/get.js' ); +var setBorderTop = require( './props/border-top/set.js' ); +var getBorderTop = require( './props/border-top/get.js' ); +var setBorderRight = require( './props/border-right/set.js' ); +var getBorderRight = require( './props/border-right/get.js' ); +var setBorderBottom = require( './props/border-bottom/set.js' ); +var getBorderBottom = require( './props/border-bottom/get.js' ); +var setBorderLeft = require( './props/border-left/set.js' ); +var getBorderLeft = require( './props/border-left/get.js' ); var setBorders = require( './props/borders/set.js' ); var getBorders = require( './props/borders/get.js' ); var setBufferSize = require( './props/buffer-size/set.js' ); var getBufferSize = require( './props/buffer-size/get.js' ); -var setCellPaddingLeft = require( './props/cell-padding-left/set.js' ); -var getCellPaddingLeft = require( './props/cell-padding-left/get.js' ); -var setCellPaddingRight = require( './props/cell-padding-right/set.js' ); -var getCellPaddingRight = require( './props/cell-padding-right/get.js' ); +var setCornerTopLeft = require( './props/corner-top-left/set.js' ); +var getCornerTopLeft = require( './props/corner-top-left/get.js' ); +var setCornerTopRight = require( './props/corner-top-right/set.js' ); +var getCornerTopRight = require( './props/corner-top-right/get.js' ); +var setCornerBottomRight = require( './props/corner-bottom-right/set.js' ); +var getCornerBottomRight = require( './props/corner-bottom-right/get.js' ); +var setCornerBottomLeft = require( './props/corner-bottom-left/set.js' ); +var getCornerBottomLeft = require( './props/corner-bottom-left/get.js' ); var setCorners = require( './props/corners/set.js' ); var getCorners = require( './props/corners/get.js' ); var setColumnSeparator = require( './props/column-separator/set.js' ); @@ -56,16 +65,36 @@ var setHeaderSeparator = require( './props/header-separator/set.js' ); var getHeaderSeparator = require( './props/header-separator/get.js' ); var setHorizontalSeparatorMode = require( './props/horizontal-separator-mode/set.js' ); // eslint-disable-line id-length var getHorizontalSeparatorMode = require( './props/horizontal-separator-mode/get.js' ); // eslint-disable-line id-length +var setJointMiddle = require( './props/joint-middle/set.js' ); +var getJointMiddle = require( './props/joint-middle/get.js' ); +var setJointTop = require( './props/joint-top/set.js' ); +var getJointTop = require( './props/joint-top/get.js' ); +var setJointRight = require( './props/joint-right/set.js' ); +var getJointRight = require( './props/joint-right/get.js' ); +var setJointBottom = require( './props/joint-bottom/set.js' ); +var getJointBottom = require( './props/joint-bottom/get.js' ); +var setJointLeft = require( './props/joint-left/set.js' ); +var getJointLeft = require( './props/joint-left/get.js' ); var setJoints = require( './props/joints/set.js' ); var getJoints = require( './props/joints/get.js' ); -var setMarginX = require( './props/margin-x/set.js' ); -var getMarginX = require( './props/margin-x/get.js' ); -var setMarginY = require( './props/margin-y/set.js' ); -var getMarginY = require( './props/margin-y/get.js' ); +var setMarginTop = require( './props/margin-top/set.js' ); +var getMarginTop = require( './props/margin-top/get.js' ); +var setMarginRight = require( './props/margin-right/set.js' ); +var getMarginRight = require( './props/margin-right/get.js' ); +var setMarginBottom = require( './props/margin-bottom/set.js' ); +var getMarginBottom = require( './props/margin-bottom/get.js' ); +var setMarginLeft = require( './props/margin-left/set.js' ); +var getMarginLeft = require( './props/margin-left/get.js' ); +var setMargins = require( './props/margins/set.js' ); +var getMargins = require( './props/margins/get.js' ); var setMaxCellWidth = require( './props/max-cell-width/set.js' ); var getMaxCellWidth = require( './props/max-cell-width/get.js' ); -var setMaxOutputWidth = require( './props/max-output-width/set.js' ); -var getMaxOutputWidth = require( './props/max-output-width/get.js' ); +var setMaxWidth = require( './props/max-width/set.js' ); +var getMaxWidth = require( './props/max-width/get.js' ); +var setPaddingLeft = require( './props/padding-left/set.js' ); +var getPaddingLeft = require( './props/padding-left/get.js' ); +var setPaddingRight = require( './props/padding-right/set.js' ); +var getPaddingRight = require( './props/padding-right/get.js' ); var setRowSeparator = require( './props/row-separator/set.js' ); var getRowSeparator = require( './props/row-separator/get.js' ); var setVerticalSeparatorMode = require( './props/vertical-separator-mode/set.js' ); @@ -73,113 +102,162 @@ var getVerticalSeparatorMode = require( './props/vertical-separator-mode/get.js' var defaults = require( './defaults.js' ); var render = require( './render.js' ); var push = require( './push.js' ); -var parse = require( './parse.js' ); // VARIABLES // var debug = logger( 'table:unicode:main' ); -var merge = mergeFcn({ - 'extend': false -}); - // List of private properties (note: keep in alphabetical order): var PRIVATE_PROPS = [ - '_alignment', + '_align', '_autoRender', '_borders', '_bufferSize', - '_cellPaddingLeft', - '_cellPaddingRight', '_corners', '_columnSeparator', - '_columnWidths', '_data', '_headers', '_headerSeparator', '_horizontalSeparatorMode', '_joints', - '_marginX', - '_marginY', + '_margins', '_maxCellWidth', - '_maxOutputWidth', + '_maxWidth', '_numColumns', + '_paddingLeft', + '_paddingRight', + '_quiet', '_rowSeparator', '_verticalSeparatorMode' ]; // List of options properties (note: keep in alphabetical order): var OPTIONS_PROPS = [ - 'alignment', + 'align', 'autoRender', 'borders', 'bufferSize', - 'cellPaddingLeft', - 'cellPaddingRight', 'columnSeparator', + 'cornerBottomLeft', + 'cornerBottomRight', 'corners', + 'cornerTopLeft', + 'cornerTopRight', + 'headers', 'headerSeparator', 'horizontalSeparatorMode', + 'jointBottomLeft', + 'jointBottomRight', + 'jointMiddle', 'joints', - 'marginX', - 'marginY', + 'jointTopLeft', + 'jointTopRight', + 'marginBottom', + 'marginLeft', + 'marginRight', + 'marginTop', + 'margins', 'maxCellWidth', - 'maxOutputWidth', + 'maxWidth', + 'paddingLeft', + 'paddingRight', 'rowSeparator', 'verticalSeparatorMode' ]; +// FUNCTIONS // + +/** +* Initializes private instance properties. +* +* @private +* @param {UnicodeTable} table - table instance +* @param {Object} defaults - default property values +* @returns {UnicodeTable} table instance +*/ +function initializePrivateProperties( table, defaults ) { // eslint-disable-line id-length + var i; + + for ( i = 0; i < PRIVATE_PROPS.length; i++ ) { + defineProperty( table, PRIVATE_PROPS[ i ], { + 'configurable': false, + 'enumerable': false, + 'writable': true, + 'value': defaults[ PRIVATE_PROPS[ i ].substring( 1 ) ] || null + }); + } + return table; +} + + // MAIN // /** * Unicode table constructor. * * @constructor -* @param {(Object|Array|Array|MatrixLike)} [data] - table data -* @param {Collection} [headers] - table headers +* @param {(Object|Collection|Collection|MatrixLike)} [data] - table data * @param {Options} [options] - table options -* @param {(Array|string)} [options.alignment='right'] - datum's cell alignment(s) +* @param {(Collection|string)} [options.align='right'] - cell alignment(s) * @param {boolean} [options.autoRender=false] - boolean indicating whether to re-render on each `change` event -* @param {Array} [options.borders=[ '─', '│', '─', '│' ]] - border characters +* @param {string} [options.borderTop='-'] - top table border character(s) +* @param {string} [options.borderRight='|'] - right table border character(s) +* @param {string} [options.borderBottom='-'] - bottom table border character(s) +* @param {string} [options.borderLeft='|'] - left table border character(s) +* @param {Collection} [options.borders=[ '─', '│', '─', '│' ]] - table border characters * @param {(PositiveInteger|null)} [options.bufferSize] - size of data buffer -* @param {(Array|NonNegativeInteger)} [options.cellPaddingLeft=1] - cell's left padding -* @param {(Array|NonNegativeInteger)} [options.cellPaddingRight=1] - cell's right padding * @param {string} [options.columnSeparator='│'] - column separator character(s) -* @param {Array} [options.corners=[ '┌', '┐', '┘', '└' ]] - corner characters +* @param {string} [options.cornerTopLeft='┌'] - top-left table corner grapheme cluster (i.e., visual character) +* @param {string} [options.cornerTopRight='┐'] - top-right table corner grapheme cluster (i.e., visual character) +* @param {string} [options.cornerBottomRight='┘''] - bottom-right table corner grapheme cluster (i.e., visual character) +* @param {string} [options.cornerBottomLeft='└'] - bottom-left table corner grapheme cluster (i.e., visual character) +* @param {Collection} [options.corners=[ '┌', '┐', '┘', '└' ]] - table corner grapheme clusters (i.e., visual characters) +* @param {Collection} [options.headers] - table headers * @param {string} [options.headerSeparator='─'] - header separator character(s) * @param {string} [options.horizontalSeparatorMode='resume'] - horizontal line separator mode -* @param {Array} [options.joints=[ '┼', '┬', '┤', '┴', '├' ]] - joint characters -* @param {NonNegativeInteger} [options.marginX=0] - horizontal output margin -* @param {NonNegativeInteger} [options.marginY=0] - vertical output margin -* @param {(Array|NonNegativeInteger)} [options.maxCellWidth] - maximum cell width(s) -* @param {NonNegativeInteger} [options.maxOutputWidth] - maximum output width +* @param {string} [options.jointMiddle='┼'] - joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table +* @param {string} [options.jointTop='┬'] - joint grapheme cluster (i.e., visual character) connecting cells along the top of the table +* @param {string} [options.jointRight='┤'] - joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table +* @param {string} [options.jointBottom='┴'] - joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table +* @param {string} [options.jointLeft='├'] - joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table +* @param {Collection} [options.joints=[ '┼', '┬', '┤', '┴', '├' ]] - joint grapheme clusters (i.e., visual characters) +* @param {NonNegativeInteger} [options.marginTop=0] - margin at the top of the table in units of blank lines +* @param {NonNegativeInteger} [options.marginRight=0] - margin to the right of the table in units of whitespace +* @param {NonNegativeInteger} [options.marginBottom=0] - margin at the bottom of the table in units of blank lines +* @param {NonNegativeInteger} [options.marginLeft=0] - margin to the left of the table in units of whitespace +* @param {NonNegativeIntegerArray} [options.margins=[0, 0, 0, 0]] - table margins +* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.maxCellWidth] - maximum cell width(s) +* @param {NonNegativeInteger} [options.maxWidth] - maximum table width +* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.paddingLeft=1] - cell left padding in units of whitespace +* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.paddingRight=1] - cell right padding in units of whitespace * @param {string} [options.rowSeparator=''] - row separator character(s) * @param {string} [options.verticalSeparatorMode='resume'] - vertical line separator mode +* @throws {TypeError} data argument must be an object, an array of objects, an array of arrays, or a two-dimensional ndarray +* @throws {TypeError} options argument must be an object * @throws {TypeError} must provide valid options * @returns {UnicodeTable} table instance * * @example -* var UnicodeTable = require( '@stdlib/plot/table/unicode' ); -* * var data = [ [ 1, 2 ], [ 3, 4 ] ]; -* var headers = [ 'A', 'B' ] -* var table = UnicodeTable( data, headers ); +* var headers = [ 'A', 'B' ]; +* +* var table = UnicodeTable( data, { +* 'headers': headers +* }); * * var str = table.render(); * // returns '...' */ function UnicodeTable() { - var headers; var options; - var parsed; var nargs; - var data; var opts; var keys; var self; var key; + var flg; var i; nargs = arguments.length; @@ -190,76 +268,46 @@ function UnicodeTable() { if ( nargs === 1 ) { return new UnicodeTable( arguments[ 0 ] ); } - if ( nargs === 2 ) { - return new UnicodeTable( arguments[ 0 ], arguments[ 1 ] ); - } - return new UnicodeTable( arguments[ 0 ], arguments[ 1 ], arguments[ 2 ] ); // eslint-disable-line max-len + return new UnicodeTable( arguments[ 0 ], arguments[ 1 ] ); } - self = this; + // Initialize private instance properties: + initializePrivateProperties( this, defaults() ); + this._quiet = false; - // Extract table-specific options... - opts = defaults(); + // Resolve input arguments... if ( nargs === 0 ) { - data = null; - headers = null; + flg = false; options = {}; } else if ( nargs === 1 ) { - data = arguments[ 0 ]; - headers = null; + flg = true; options = {}; - } else if ( nargs === 2 ) { - if ( isCollection( arguments[ 1 ] ) ) { - data = arguments[ 0 ]; - headers = arguments[ 1 ]; - options = {}; - } else { - data = arguments[ 0 ]; - headers = null; - options = arguments[ 1 ]; - if ( !isObject( options ) ) { - throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - } } else { - data = arguments[ 0 ]; - headers = arguments[ 1 ]; - options = arguments[ 2 ]; + flg = true; + options = arguments[ 1 ]; if ( !isObject( options ) ) { throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); } } - opts = merge( opts, pick( options, OPTIONS_PROPS ) ); + // Extract provided options while ignoring any extraneous/unsupported options properties: + opts = pick( options, OPTIONS_PROPS ); debug( 'Creating an instance with the following configuration: %s.', JSON.stringify( opts ) ); - // Initialize private table-specific properties... - for ( i = 0; i < PRIVATE_PROPS.length; i++ ) { - defineProperty( this, PRIVATE_PROPS[i], { - 'configurable': false, - 'enumerable': false, - 'writable': true, - 'value': null - }); - } - // Set table data and headers... - if ( data || headers ) { - parsed = parse( data, headers ); - this._data = parsed.data; - this._headers = parsed.headers; - this._columnWidths = parsed.columnWidths; - this._numColumns = parsed.columnWidths.length; - } - - // Set table-specific properties... + // Validate provided options by assigning values to table properties... keys = objectKeys( opts ); for ( i = 0; i < keys.length; i++ ) { key = keys[ i ]; this[ key ] = opts[ key ]; } + // If we were provided a data argument, initialize table data... + if ( flg ) { + this.data = arguments[ 0 ]; + } // Add event listeners: this.on( 'change', onChange ); this.on( 'render', onRender ); + self = this; return this; /** @@ -292,9 +340,9 @@ function UnicodeTable() { inherit( UnicodeTable, EventEmitter ); /** -* Alignment(s) of datum in cell. +* Alignment(s) of data within in each table cell. * -* @name alignment +* @name align * @memberof UnicodeTable.prototype * @type {(Array|string)} * @throws {TypeError} must be a supported alignment string or an array of alignment strings @@ -302,29 +350,28 @@ inherit( UnicodeTable, EventEmitter ); * * @example * var table = new UnicodeTable(); -* table.alignment = 'left'; -* var alignment = table.alignment; +* +* table.align = 'left'; +* +* var align = table.align; * // returns 'left' * * @example * var table = new UnicodeTable(); -* table.alignment = [ 'left', 'right', 'center' ]; -* var alignment = table.alignment; +* +* table.align = [ 'left', 'right', 'center' ]; +* +* var align = table.align; * // returns [ 'left', 'right', 'center' ] */ -defineProperty( UnicodeTable.prototype, 'alignment', { - 'configurable': false, - 'enumerable': true, - 'set': setAlignment, - 'get': getAlignment -}); +setReadWriteAccessor( UnicodeTable.prototype, 'align', getAlign, setAlign ); /** * Rendering mode. * * ## Notes * -* - If `true`, an instance re-renders on each `change` event. +* - If `true`, an instance automatically re-renders a table on each `change` event. * * @name autoRender * @memberof UnicodeTable.prototype @@ -334,41 +381,111 @@ defineProperty( UnicodeTable.prototype, 'alignment', { * * @example * var table = new UnicodeTable(); +* * table.autoRender = true; +* * var mode = table.autoRender; * // returns true */ -defineProperty( UnicodeTable.prototype, 'autoRender', { - 'configurable': false, - 'enumerable': true, - 'set': setAutoRender, - 'get': getAutoRender -}); +setReadWriteAccessor( UnicodeTable.prototype, 'autoRender', getAutoRender, setAutoRender ); + +/** +* Top table border character(s). +* +* @name borderTop +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '-' +* +* @example +* var table = new UnicodeTable(); +* +* table.borderTop = '='; +* +* var border = table.borderTop; +* // returns '=' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'borderTop', getBorderTop, setBorderTop ); /** -* Border characters. +* Right table border character(s). +* +* @name borderRight +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '-' +* +* @example +* var table = new UnicodeTable(); +* +* table.borderRight = '|'; +* +* var border = table.borderRight; +* // returns '|' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'borderRight', getBorderRight, setBorderRight ); + +/** +* Bottom table border character(s). +* +* @name borderBottom +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '-' +* +* @example +* var table = new UnicodeTable(); +* +* table.borderBottom = '='; +* +* var border = table.borderBottom; +* // returns '=' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'borderBottom', getBorderBottom, setBorderBottom ); + +/** +* Left table border character(s). +* +* @name borderLeft +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '-' +* +* @example +* var table = new UnicodeTable(); +* +* table.borderLeft = '|'; +* +* var border = table.borderLeft; +* // returns '|' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'borderLeft', getBorderLeft, setBorderLeft ); + +/** +* Border characters in the order of `[top, right, bottom, left]`. * * @name borders * @memberof UnicodeTable.prototype * @type {Array} * @throws {TypeError} must be an array of four strings -* @default '[ "─", "│", "─", "│" ]' +* @default [ "─", "│", "─", "│" ] * * @example * var table = new UnicodeTable(); +* * table.borders = [ '=', '!', '=', '!' ]; +* * var borders = table.borders; * // returns [ '=', '!', '=', '!' ] */ -defineProperty( UnicodeTable.prototype, 'borders', { - 'configurable': false, - 'enumerable': true, - 'set': setBorders, - 'get': getBorders -}); +setReadWriteAccessor( UnicodeTable.prototype, 'borders', getBorders, setBorders ); /** -* Size of data buffer. +* Size of internal data buffer. * * @name bufferSize * @memberof UnicodeTable.prototype @@ -378,92 +495,105 @@ defineProperty( UnicodeTable.prototype, 'borders', { * * @example * var table = new UnicodeTable(); +* * table.bufferSize = 20; */ -defineProperty( UnicodeTable.prototype, 'bufferSize', { - 'configurable': false, - 'enumerable': true, - 'set': setBufferSize, - 'get': getBufferSize -}); +setReadWriteAccessor( UnicodeTable.prototype, 'bufferSize', getBufferSize, setBufferSize ); /** -* Cell's left padding. +* Top-left table corner grapheme cluster (i.e., visual character). * -* @name cellPaddingLeft +* @name cornerTopLeft * @memberof UnicodeTable.prototype -* @type {(Array|NonNegativeInteger)} -* @throws {TypeError} must be a non-negative integer or an array of non-negative integers -* @default '1' +* @type {string} +* @throws {TypeError} must be a string +* @default '┌' * * @example * var table = new UnicodeTable(); -* table.cellPaddingLeft = 3; -* var padding = table.cellPaddingLeft; -* // returns 3 +* +* table.cornerTopLeft = '*'; +* +* var corner = table.cornerTopLeft; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopLeft', getCornerTopLeft, setCornerTopLeft ); + +/** +* Top-right table corner grapheme cluster (i.e., visual character). +* +* @name cornerTopRight +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '┐' * * @example * var table = new UnicodeTable(); -* table.cellPaddingLeft = [ 3, 2 ]; -* var paddings = table.cellPaddingLeft; -* // returns [ 3, 2 ] +* +* table.cornerTopRight = '*'; +* +* var corner = table.cornerTopRight; +* // returns '*' */ -defineProperty( UnicodeTable.prototype, 'cellPaddingLeft', { - 'configurable': false, - 'enumerable': true, - 'set': setCellPaddingLeft, - 'get': getCellPaddingLeft -}); +setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopRight', getCornerTopRight, setCornerTopRight ); /** -* Cell's right padding. +* Bottom-right table corner grapheme cluster (i.e., visual character). * -* @name cellPaddingRight +* @name cornerBottomRight * @memberof UnicodeTable.prototype -* @type {(Array|NonNegativeInteger)} -* @throws {TypeError} must be a non-negative integer or an array of non-negative integers -* @default '1' +* @type {string} +* @throws {TypeError} must be a string +* @default '┘' * * @example * var table = new UnicodeTable(); -* table.cellPaddingRight = 3; -* var padding = table.cellPaddingRight; -* // returns 3 +* +* table.cornerBottomRight = '*'; +* +* var corner = table.cornerBottomRight; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomRight', getCornerBottomRight, setCornerBottomRight ); + +/** +* Bottom-left table corner grapheme cluster (i.e., visual character). +* +* @name cornerBottomLeft +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '└' * * @example * var table = new UnicodeTable(); -* table.cellPaddingRight = [ 3, 2 ]; -* var paddings = table.cellPaddingRight; -* // returns [ 3, 2 ] +* +* table.cornerBottomLeft = '*'; +* +* var corner = table.cornerBottomLeft; +* // returns '*' */ -defineProperty( UnicodeTable.prototype, 'cellPaddingRight', { - 'configurable': false, - 'enumerable': true, - 'set': setCellPaddingRight, - 'get': getCellPaddingRight -}); +setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomLeft', getCornerBottomLeft, setCornerBottomLeft ); /** -* Corner characters. +* Table corner grapheme clusters (i.e., visual characters) in the order of `[top-left, top-right, bottom-right, bottom-left]`. * * @name corners * @memberof UnicodeTable.prototype * @type {Array} * @throws {TypeError} must be an array of four grapheme clusters -* @default '[ "┌", "┐", "┘", "└" ]' +* @default [ "┌", "┐", "┘", "└" ] * * @example * var table = new UnicodeTable(); +* * table.corners = [ '*', '*', '*', '*' ]; +* * var corners = table.corners; * // returns [ '*', '*', '*', '*' ] */ -defineProperty( UnicodeTable.prototype, 'corners', { - 'configurable': false, - 'enumerable': true, - 'set': setCorners, - 'get': getCorners -}); +setReadWriteAccessor( UnicodeTable.prototype, 'corners', getCorners, setCorners ); /** * Column separator character(s). @@ -476,39 +606,35 @@ defineProperty( UnicodeTable.prototype, 'corners', { * * @example * var table = new UnicodeTable(); +* * table.columnSeparator = '$='; +* * var separator = table.columnSeparator; * // returns '$=' */ -defineProperty( UnicodeTable.prototype, 'columnSeparator', { - 'configurable': false, - 'enumerable': true, - 'set': setColumnSeparator, - 'get': getColumnSeparator -}); +setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSeparator, setColumnSeparator ); /** * Table data. * * @name data * @memberof UnicodeTable.prototype -* @type {Array|MatrixLike} -* @throws {TypeError} must be a 2 dimensional array/ndarray -* @throws {RangeError} must provide correct number of columns -* @throws {RangeError} rows must not exceed maximum data buffer size +* @type {ndarray} +* @throws {TypeError} must be an object, an array of objects, an array of arrays or a two-dimensional ndarray +* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} number of rows must not exceed the maximum data buffer size * * @example +* var ndarray2array = require( '@stdlib/ndarray/to-array' ); +* * var table = new UnicodeTable(); +* * table.data = [ [ 'a', 'b' ], [ 1, 2 ] ]; -* var data = table.data; +* +* var data = ndarray2array( table.data ); * // returns [ [ 'a', 'b' ], [ 1, 2 ] ] */ -defineProperty( UnicodeTable.prototype, 'data', { - 'configurable': false, - 'enumerable': true, - 'set': setData, - 'get': getData -}); +setReadWriteAccessor( UnicodeTable.prototype, 'data', getData, setData ); /** * Table headers. @@ -516,21 +642,18 @@ defineProperty( UnicodeTable.prototype, 'data', { * @name headers * @memberof UnicodeTable.prototype * @type {Collection} -* @throws {TypeError} must be a collection -* @throws {RangeError} must provide correct number of columns +* @throws {TypeError} must be an array-like object +* @throws {RangeError} must provide the correct number of columns * * @example * var table = new UnicodeTable(); +* * table.headers = [ 'name', 'age' ]; +* * var headers = table.headers; * // returns [ 'name', 'age' ] */ -defineProperty( UnicodeTable.prototype, 'headers', { - 'configurable': false, - 'enumerable': true, - 'set': setHeaders, - 'get': getHeaders -}); +setReadWriteAccessor( UnicodeTable.prototype, 'headers', getHeaders, setHeaders ); /** * Header separator character(s). @@ -543,16 +666,13 @@ defineProperty( UnicodeTable.prototype, 'headers', { * * @example * var table = new UnicodeTable(); +* * table.headerSeparator = '$='; +* * var separator = table.headerSeparator; * // returns '$=' */ -defineProperty( UnicodeTable.prototype, 'headerSeparator', { - 'configurable': false, - 'enumerable': true, - 'set': setHeaderSeparator, - 'get': getHeaderSeparator -}); +setReadWriteAccessor( UnicodeTable.prototype, 'headerSeparator', getHeaderSeparator, setHeaderSeparator ); /** * Horizontal line separator mode. @@ -560,137 +680,327 @@ defineProperty( UnicodeTable.prototype, 'headerSeparator', { * @name horizontalSeparatorMode * @memberof UnicodeTable.prototype * @type {string} -* @throws {TypeError} must be a supported line separator mode string +* @throws {TypeError} must be a supported line separator mode * @default 'resume' * * @example * var table = new UnicodeTable(); +* * table.horizontalSeparatorMode = 'repeat'; +* * var mode = table.horizontalSeparatorMode; * // returns 'repeat' */ -defineProperty( UnicodeTable.prototype, 'horizontalSeparatorMode', { - 'configurable': false, - 'enumerable': true, - 'set': setHorizontalSeparatorMode, - 'get': getHorizontalSeparatorMode -}); +setReadWriteAccessor( UnicodeTable.prototype, 'horizontalSeparatorMode', getHorizontalSeparatorMode, setHorizontalSeparatorMode ); /** -* Joint characters. +* Joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +* +* @name jointMiddle +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '┼' +* +* @example +* var table = new UnicodeTable(); +* +* table.jointMiddle = '*'; +* +* var joint = table.jointMiddle; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'jointMiddle', getJointMiddle, setJointMiddle ); + +/** +* Joint grapheme cluster (i.e., visual character) connecting cells at the top of the table. +* +* @name jointTop +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '┬' +* +* @example +* var table = new UnicodeTable(); +* +* table.jointTop = '*'; +* +* var joint = table.jointTop; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'jointTop', getJointTop, setJointTop ); + +/** +* Joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +* +* @name jointRight +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '┤' +* +* @example +* var table = new UnicodeTable(); +* +* table.jointRight = '*'; +* +* var joint = table.jointRight; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'jointRight', getJointRight, setJointRight ); + +/** +* Joint grapheme cluster (i.e., visual character) connecting cells at the bottom of the table. +* +* @name jointBottom +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '┴' +* +* @example +* var table = new UnicodeTable(); +* +* table.jointBottom = '*'; +* +* var joint = table.jointBottom; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'jointBottom', getJointBottom, setJointBottom ); + +/** +* Joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +* +* @name jointLeft +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '├' +* +* @example +* var table = new UnicodeTable(); +* +* table.jointLeft = '*'; +* +* var joint = table.jointLeft; +* // returns '*' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'jointLeft', getJointLeft, setJointLeft ); + +/** +* Joint grapheme clusters (i.e., visual characters) in the order of `[middle, top, right, bottom, left]`. * * @name joints * @memberof UnicodeTable.prototype * @type {Array} * @throws {TypeError} must be an array of five grapheme clusters -* @default '[ "┼", "┬", "┤", "┴", "├" ]' +* @default [ "┼", "┬", "┤", "┴", "├" ] * * @example * var table = new UnicodeTable(); +* * table.joints = [ '*', '*', '*', '*', '*' ]; +* * var joints = table.joints; * // returns [ '*', '*', '*', '*', '*' ] */ -defineProperty( UnicodeTable.prototype, 'joints', { - 'configurable': false, - 'enumerable': true, - 'set': setJoints, - 'get': getJoints -}); +setReadWriteAccessor( UnicodeTable.prototype, 'joints', getJoints, setJoints ); + +/** +* Margin at the top of the table in units of blank lines. +* +* @name marginTop +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a nonnegative integer +* @default 0 +* +* @example +* var table = new UnicodeTable(); +* +* table.marginTop = 2; +* +* var margin = table.marginTop; +* // returns 2 +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'marginTop', getMarginTop, setMarginTop ); + +/** +* Margin to the right of the table in units of whitespace. +* +* @name marginRight +* @memberof UnicodeTable.prototype +* @type {NonNegativeInteger} +* @throws {TypeError} must be a nonnegative integer +* @default 0 +* +* @example +* var table = new UnicodeTable(); +* +* table.marginRight = 2; +* +* var margin = table.marginRight; +* // returns 2 +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'marginRight', getMarginRight, setMarginRight ); /** -* Horizontal output margin. +* Margin at the bottom of the table in units of blank lines. * -* @name marginX +* @name marginBottom * @memberof UnicodeTable.prototype * @type {NonNegativeInteger} -* @throws {TypeError} must be a non-negative integer -* @default '0' +* @throws {TypeError} must be a nonnegative integer +* @default 0 * * @example * var table = new UnicodeTable(); -* table.marginX = 2; -* var margin = table.marginX; +* +* table.marginBottom = 2; +* +* var margin = table.marginBottom; * // returns 2 */ -defineProperty( UnicodeTable.prototype, 'marginX', { - 'configurable': false, - 'enumerable': true, - 'set': setMarginX, - 'get': getMarginX -}); +setReadWriteAccessor( UnicodeTable.prototype, 'marginBottom', getMarginBottom, setMarginBottom ); /** -* Vertical output margin. +* Margin to the left of the table in units of whitespace. * -* @name marginY +* @name marginLeft * @memberof UnicodeTable.prototype * @type {NonNegativeInteger} -* @throws {TypeError} must be a non-negative integer -* @default '0' +* @throws {TypeError} must be a nonnegative integer +* @default 0 * * @example * var table = new UnicodeTable(); -* table.marginY = 2; -* var margin = table.marginY; +* +* table.marginLeft = 2; +* +* var margin = table.marginLeft; * // returns 2 */ -defineProperty( UnicodeTable.prototype, 'marginY', { - 'configurable': false, - 'enumerable': true, - 'set': setMarginY, - 'get': getMarginY -}); +setReadWriteAccessor( UnicodeTable.prototype, 'marginLeft', getMarginLeft, setMarginLeft ); /** -* Maximum cell width. +* Table margins in order of `[top, right, bottom, left]`. +* +* @name margins +* @memberof UnicodeTable.prototype +* @type {NonNegativeIntegerArray} +* @throws {TypeError} must be an array of nonnegative integers +* @default [ 0, 0, 0, 0 ] +* +* @example +* var table = new UnicodeTable(); +* +* table.margins = [ 2, 2, 2, 2 ]; +* +* var margins = table.margins; +* // returns [ 2, 2, 2, 2 ] +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins ); + +/** +* Maximum cell width(s) in units of grapheme clusters (i.e., visual characters). * * @name maxCellWidth * @memberof UnicodeTable.prototype * @type {(Array|NonNegativeInteger|null)} -* @throws {TypeError} must be a non-negative integer, an array of non-negative integers or null -* @default '+infinity' +* @throws {TypeError} must be a nonnegative integer, an array of nonnegative integers, or null +* @default +infinity * * @example * var table = new UnicodeTable(); +* * table.maxCellWidth = 10; +* * var width = table.maxCellWidth; * // returns 10 * * @example * var table = new UnicodeTable(); +* * table.maxCellWidth = [ 10, 8 ]; -* var widhts = table.maxCellWidth; +* +* var widths = table.maxCellWidth; * // returns [ 10, 8 ] */ -defineProperty( UnicodeTable.prototype, 'maxCellWidth', { - 'configurable': false, - 'enumerable': true, - 'set': setMaxCellWidth, - 'get': getMaxCellWidth -}); +setReadWriteAccessor( UnicodeTable.prototype, 'maxCellWidth', getMaxCellWidth, setMaxCellWidth ); /** -* Maximum output width. +* Maximum table width in units of grapheme clusters (i.e., visual characters). * -* @name maxOutputWidth +* @name maxWidth * @memberof UnicodeTable.prototype * @type {(NonNegativeInteger|null)} -* @throws {TypeError} must be a non-negative integer or null -* @default '+infinity' +* @throws {TypeError} must be a nonnegative integer or null +* @default +infinity * * @example * var table = new UnicodeTable(); -* table.maxOutputWidth = 50; -* var width = table.maxOutputWidth; +* +* table.maxWidth = 50; +* +* var width = table.maxWidth; * // returns 50 */ -defineProperty( UnicodeTable.prototype, 'maxOutputWidth', { - 'configurable': false, - 'enumerable': true, - 'set': setMaxOutputWidth, - 'get': getMaxOutputWidth -}); +setReadWriteAccessor( UnicodeTable.prototype, 'maxWidth', getMaxWidth, setMaxWidth ); + +/** +* Cell left padding(s) in units of whitespace. +* +* @name paddingLeft +* @memberof UnicodeTable.prototype +* @type {(Collection|NonNegativeInteger)} +* @throws {TypeError} must be a nonnegative integer or an array of nonnegative integers +* @default 1 +* +* @example +* var table = new UnicodeTable(); +* +* table.paddingLeft = 3; +* +* var padding = table.paddingLeft; +* // returns 3 +* +* @example +* var table = new UnicodeTable(); +* +* table.paddingLeft = [ 3, 2 ]; +* +* var paddings = table.paddingLeft; +* // returns [ 3, 2 ] +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'paddingLeft', getPaddingLeft, setPaddingLeft ); + +/** +* Cell right padding(s) in units of whitespace. +* +* @name paddingRight +* @memberof UnicodeTable.prototype +* @type {(Collection|NonNegativeInteger)} +* @throws {TypeError} must be a nonnegative integer or an array of nonnegative integers +* @default 1 +* +* @example +* var table = new UnicodeTable(); +* +* table.paddingRight = 3; +* +* var padding = table.paddingRight; +* // returns 3 +* +* @example +* var table = new UnicodeTable(); +* +* table.paddingRight = [ 3, 2 ]; +* +* var paddings = table.paddingRight; +* // returns [ 3, 2 ] +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'paddingRight', getPaddingRight, setPaddingRight ); /** * Row separator character(s). @@ -703,16 +1013,13 @@ defineProperty( UnicodeTable.prototype, 'maxOutputWidth', { * * @example * var table = new UnicodeTable(); +* * table.rowSeparator = '$='; +* * var separator = table.rowSeparator; * // returns '$=' */ -defineProperty( UnicodeTable.prototype, 'rowSeparator', { - 'configurable': false, - 'enumerable': true, - 'set': setRowSeparator, - 'get': getRowSeparator -}); +setReadWriteAccessor( UnicodeTable.prototype, 'rowSeparator', getRowSeparator, setRowSeparator ); /** * Vertical line separator mode. @@ -720,39 +1027,40 @@ defineProperty( UnicodeTable.prototype, 'rowSeparator', { * @name verticalSeparatorMode * @memberof UnicodeTable.prototype * @type {string} -* @throws {TypeError} must be a supported line separator mode string +* @throws {TypeError} must be a supported line separator mode * @default 'resume' * * @example * var table = new UnicodeTable(); +* * table.verticalSeparatorMode = 'repeat'; +* * var mode = table.verticalSeparatorMode; * // returns 'repeat' */ -defineProperty( UnicodeTable.prototype, 'verticalSeparatorMode', { - 'configurable': false, - 'enumerable': true, - 'set': setVerticalSeparatorMode, - 'get': getVerticalSeparatorMode -}); +setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVerticalSeparatorMode, setVerticalSeparatorMode ); +/* eslint-disable-next-line stdlib/jsdoc-doctest */ // FIXME /** -* Appends row to table data. +* Appends one or more rows to a table. * * @name push * @memberof UnicodeTable.prototype * @type {Function} -* @param {Collection} row - row to add -* @throws {TypeError} must provide a collection with equal number of columns to existing data +* @param {(Object|Collection|VectorLike|MatrixLike)} data - row(s) to add +* @throws {TypeError} must provide an object, an array-like object, or an ndarray +* @throws {TypeError} must provide data containing the correct number of columns * @returns {UnicodeTable} class instance * * @example +* var ndarray2array = require( '@stdlib/ndarray/to-array' ); +* * var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ] ); -* var data = table.data; +* var data = ndarray2array( table.data ); * // returns [ [ 1, 2 ], [ 3, 4 ] ] * * table.push( [ 5, 6 ] ); -* data = table.data; +* data = ndarray2array( table.data ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] */ UnicodeTable.prototype.push = push; @@ -763,11 +1071,14 @@ UnicodeTable.prototype.push = push; * @name render * @memberof UnicodeTable.prototype * @type {Function} -* @throws {Error} output must be able to accommodate every column individually +* @throws {Error} unable to accommodate all table columns within maximum table width * @returns {string} rendered table * * @example -* var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ], [ 'A', 'B' ] ); +* var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ], { +* 'headers': [ 'A', 'B' ] +* }); +* * var str = table.render(); * // returns '...' */ diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js deleted file mode 100644 index 42c00ebc3e32..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parse.js +++ /dev/null @@ -1,83 +0,0 @@ -/** -* @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 format = require( '@stdlib/string/format' ); -var isMatrixLike = require( '@stdlib/assert/is-matrix-like' ); -var isPlainObject = require( '@stdlib/assert/is-plain-object' ); -var isObjectArray = require( '@stdlib/assert/is-object-array' ); -var isArrayArray = require( '@stdlib/assert/is-array-array' ); -var isCollection = require( '@stdlib/assert/is-collection' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); -var parseObject = require( './parser/parse_object.js' ); -var parseObjectsList = require( './parser/parse_objects_list.js' ); -var parse2dArray = require( './parser/parse_2d_array.js' ); -var parseHeaders = require( './parser/parse_headers.js' ); - - -// MAIN // - -/** -* Sets the table data. -* -* @private -* @param {(Object|Array|Array|MatrixLike)} data - table data -* @param {Collection} headers - table headers -* @throws {TypeError} first argument must be an object, array of objects, or a 2 dimensional array/ndarray -* @throws {TypeError} second argument must be a collection -* @returns {Object} table metadata -*/ -function setData( data, headers ) { - var parsed; - - if ( headers && !isCollection( headers ) ) { - throw new TypeError( format( 'invalid argument. `%s` argument must be a collection. Value: `%s`.', 'headers', headers ) ); - } - if ( !data ) { - if ( !headers ) { - return { - 'data': null, - 'headers': null, - 'columnWidths': null - }; - } - parsed = parseHeaders( headers ); - return parsed; - } - // Parse according to data-type... - if ( isMatrixLike( data ) ) { - parsed = parse2dArray( ndarray2array( data ), headers ); - } else if ( isArrayArray( data ) ) { - parsed = parse2dArray( data, headers ); - } else if ( isObjectArray( data ) ) { - parsed = parseObjectsList( data, headers ); - } else if ( isPlainObject( data ) ) { - parsed = parseObject( data, headers ); - } else { - throw new TypeError( format( 'invalid argument. `%s` argument must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', 'data', data ) ); - } - return parsed; -} - - -// EXPORTS // - -module.exports = setData; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js deleted file mode 100644 index 999afcf7b2a5..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_2d_array.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @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'; - -// MAIN // - -/** -* Parses 2D array into tabular data. -* -* @private -* @param {Array} data - tabular data -* @param {Collection} [headers] - column names -* @throws {RangeError} must provide correct number of columns -* @returns {Object} table metadata -*/ -function parse2dArray( data, headers ) { - var widths = []; - var cols; - var len; - var i; - var j; - - // If headers exist, initialize the widths array... - if ( headers ) { - cols = headers.length; - for ( i = 0; i < cols; i++ ) { - widths.push( String( headers[ i ] ).length ); - } - } else { - headers = null; - cols = data[ 0 ].length; - for ( i = 0; i < cols; i++ ) { - widths.push( 0 ); - } - } - // Calculating max widths of all columns: - for ( i = 0; i < data.length; i++ ) { - if ( cols !== data[ i ].length ) { - throw new RangeError( 'invalid data. All rows must have equal number of columns' ); - } - for ( j = 0; j < cols; j++ ) { - len = String( data[ i ][ j ] ).length; - if ( len > widths[ j ] ) { - widths[ j ] = len; - } - } - } - return { - 'headers': headers, - 'data': data, - 'columnWidths': widths - }; -} - - -// EXPORTS // - -module.exports = parse2dArray; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js deleted file mode 100644 index 1f6582f550fc..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_object.js +++ /dev/null @@ -1,99 +0,0 @@ -/** -* @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 objectKeys = require( '@stdlib/utils/keys' ); -var isCollection = require( '@stdlib/assert/is-collection' ); -var format = require( '@stdlib/string/format' ); -var hasOwnProp = require( '@stdlib/assert/has-own-property' ); - - -// MAIN // - -/** -* Parses an object into tabular data. -* -* @private -* @param {Object} data - tabular data -* @param {Collection} [headers] - column names -* @throws {Error} must provide correct number of rows -* @throws {Error} headers must exist in the object -* @throws {Error} each key must correspond to a collection -* @returns {Object} table metadata -*/ -function parseObject( data, headers ) { - var header; - var widths; - var cols; - var rows; - var len; - var i; - var j; - - // If headers don't exist, extract headers from data: - if ( !headers ) { - headers = objectKeys( data ); - } - - // Parsing data into a 2D array: - rows = []; // final data after parsing - widths = []; // max widths of each column - for ( i = 0; i < headers.length; i++ ) { - header = String( headers[ i ] ); - - if ( !hasOwnProp( data, header ) ) { - throw new Error( format( 'invalid data. Column `%s` not found in data. Value: `%s`.', header, data ) ); - } - if ( !isCollection( data[ header ] ) ) { - throw new Error( format( 'invalid data. Each key must correspond to an array. Value: `%s`.', data ) ); - } - widths.push( header.length ); - for ( j = 0; j < data[ header ].length; j++ ) { - len = String( data[ header ][ j ] ).length; - - // Updating max width of column: - if ( len > widths[ i ] ) { - widths[ i ] = len; - } - if ( !rows[ j ] ) { - rows[ j ] = []; - } - rows[ j ][ i ] = data[ header ][ j ]; - } - } - // Checking if all columns have the same number of rows... - cols = data[ headers[ 0 ] ].length; - for ( i = 1; i < headers.length; i++ ) { - if ( cols !== data[ headers[ i ] ].length ) { - throw new Error( 'invalid data. All columns must have the same number of rows' ); - } - } - return { - 'headers': headers, - 'data': rows, - 'columnWidths': widths - }; -} - - -// EXPORTS // - -module.exports = parseObject; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js deleted file mode 100644 index 79894ea57a8d..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/parser/parse_objects_list.js +++ /dev/null @@ -1,84 +0,0 @@ -/** -* @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 format = require( '@stdlib/string/format' ); -var objectKeys = require( '@stdlib/utils/keys' ); -var hasOwnProp = require( '@stdlib/assert/has-own-property' ); - - -// MAIN // - -/** -* Parses array of objects into tabular data. -* -* @private -* @param {Array} data - tabular data -* @param {Collection} [headers] - column names -* @throws {Error} must provide valid data -* @returns {Object} table metadata -*/ -function parseObjectsList( data, headers ) { - var header; - var widths; - var rows; - var len; - var i; - var j; - - // If headers don't exist, extract headers from data: - if ( !headers ) { - headers = objectKeys( data[ 0 ] ); - } - - // Parsing data into a 2D array... - rows = []; // final data after parsing - widths = []; // max widths of each column - for ( i = 0; i < headers.length; i++ ) { // initialize widths - widths.push( String( headers[ i ] ).length ); - } - for ( i = 0; i < data.length; i++ ) { - rows[ i ] = []; - for ( j = 0; j < headers.length; j++ ) { - header = headers[ j ]; - if ( !hasOwnProp( data[ i ], header ) ) { - throw new Error( format( 'invalid data. Column `%s` not found in data. Value: `%s`.', header, data ) ); - } - len = String( data[ i ][ header ] ).length; - - // Updating max width of column: - if ( len > widths[ j ] ) { - widths[ j ] = len; - } - rows[ i ][ j ] = data[ i ][ header ]; - } - } - return { - 'headers': headers, - 'data': rows, - 'columnWidths': widths - }; -} - - -// EXPORTS // - -module.exports = parseObjectsList; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js similarity index 76% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js index 09175302ff9e..da864865ecf7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js @@ -16,27 +16,23 @@ * limitations under the License. */ -'use strict'; - -// MODULES // - -var isArray = require( '@stdlib/assert/is-array' ); +/* eslint-disable no-invalid-this */ +'use strict'; // MAIN // /** -* Returns the table's cell alignment(s). +* Returns the alignment(s) of data within table cells. * * @private * @returns {(Array|string)} cell alignment(s) */ function get() { - /* eslint-disable no-invalid-this */ - if ( isArray( this._alignment ) ) { - return this._alignment.slice(); + if ( this._align.length > 1 ) { + return this._align.slice(); } - return this._alignment; + return this._align[ 0 ]; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js new file mode 100644 index 000000000000..267c6ad61881 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js @@ -0,0 +1,93 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var contains = require( '@stdlib/array/base/assert/contains' ).factory; +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isCollection = require( '@stdlib/assert/is-collection' ); +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var isAlignment = contains( [ 'right', 'center', 'left' ] ); + + +// MAIN // + +/** +* Sets the alignment(s) of data within table cells. +* +* @private +* @param {(Array|string)} value - cell alignment(s) +* @throws {TypeError} must be a supported alignment or an array of alignments +* @throws {RangeError} must provide the correct number of columns +*/ +function set( value ) { + var tmp; + var i; + if ( isString( value ) ) { + if ( !isAlignment( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a supported alignment. Value: `%s`.', 'align', value ) ); + } + value = [ value ]; + if ( !isEqualArray( value, this._align ) ) { + this._align = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + if ( !isCollection( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string or an array of strings. Value: `%s`.', 'align', value ) ); + } + tmp = []; + for ( i = 0; i < value.length; i++ ) { + if ( !isAlignment( value[ i ] ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of supported alignments. Value: `["%s"]`.', 'align', copy( value ) ).join( '", "' ) ); + } + // Explicitly copy to a new array to avoid external mutation: + tmp.push( value[ i ] ); + } + if ( this._numColumns ) { + if ( tmp.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'align', this._numColumns, tmp.join( '", "' ) ) ); + } + } else { + this._numColumns = tmp.length; + } + if ( !isEqualArray( tmp, this._align ) ) { + this._align = tmp; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js deleted file mode 100644 index f17065fdb39b..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/alignment/set.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @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 contains = require( '@stdlib/array/base/assert/contains' ).factory; -var isString = require( '@stdlib/assert/is-string' ); -var isStringArray = require( '@stdlib/assert/is-string-array' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); -var format = require( '@stdlib/string/format' ); - - -// VARIABLES // - -var isValidAlignment = contains( [ 'right', 'center', 'left' ] ); - - -// MAIN // - -/** -* Sets the table's cell alignment(s). -* -* @private -* @param {(Array|string)} alignment - cell alignment(s) -* @throws {TypeError} must be a supported alignment string or an array of alignment strings -* @throws {RangeError} must provide correct number of columns if providing an array -*/ -function set( alignment ) { - /* eslint-disable no-invalid-this */ - var i; - if ( isString( alignment ) ) { - if ( !isValidAlignment( alignment ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a supported alignment string. Value: `%s`.', 'alignment', alignment ) ); - } - } else if ( isStringArray( alignment ) ) { - for ( i = 0; i < alignment.length; i++ ) { - if ( !isValidAlignment( alignment[ i ] ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of supported alignment strings. Value: `%s`.', 'alignment', alignment ) ); - } - } - if ( this._numColumns ) { - if ( alignment.length !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'alignment', this._numColumns, alignment.length ) ); - } - } else { - this._numColumns = alignment.length; - } - } else { - throw new TypeError( format( 'invalid assignment. `%s` must be a string or an array of strings. Value: `%s`.', 'alignment', alignment ) ); - } - if ( !isEqual( alignment, this._alignment ) ) { - this._alignment = alignment; - this.emit( 'change' ); - } -} - - -// EXPORTS // - -module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js index 19f5a8e9b3df..790280334aef 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js @@ -16,8 +16,12 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** * Returns the rendering mode. * @@ -25,7 +29,6 @@ * @returns {boolean} rendering mode */ function get() { - /* eslint-disable no-invalid-this */ return this._autoRender; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js index 343a2305a3ae..698a606fa709 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js @@ -16,6 +16,8 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // @@ -30,17 +32,18 @@ var format = require( '@stdlib/string/format' ); * Sets the rendering mode. * * @private -* @param {boolean} bool - boolean indicating whether to re-render on a change event +* @param {boolean} value - boolean indicating whether to automatically re-render on a `change` event * @throws {TypeError} must be a boolean */ -function set( bool ) { - /* eslint-disable no-invalid-this */ - if ( !isBoolean( bool ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a boolean. Value: `%s`.', 'autoRender', bool ) ); +function set( value ) { + if ( !isBoolean( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a boolean. Value: `%s`.', 'autoRender', value ) ); } - if ( bool !== this._autoRender ) { - this._autoRender = bool; - this.emit( 'change' ); + if ( value !== this._autoRender ) { + this._autoRender = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js new file mode 100644 index 000000000000..632531a5242c --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the table bottom border character(s). +* +* @private +* @returns {string} border character(s) +*/ +function get() { + return this._borders[ 2 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js new file mode 100644 index 000000000000..56372b8779d6 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -0,0 +1,60 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table bottom border character(s). +* +* @private +* @param {string} value - border character(s) +* @throws {TypeError} must be a string +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderBottom', value ) ); + } + if ( value !== this._borders[ 2 ].value ) { + ch = splitGraphemeClusters( value ); + this._borders[ 2 ] = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js similarity index 80% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js index b8672fbdf6f2..242b97064e44 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js @@ -16,17 +16,20 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** -* Returns the table's vertical margin. +* Returns the table left border character(s). * * @private -* @returns {NonNegativeInteger} Y margin +* @returns {string} border character(s) */ function get() { - /* eslint-disable no-invalid-this */ - return this._marginY; + return this._borders[ 3 ].value; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js new file mode 100644 index 000000000000..b4812f0c3871 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -0,0 +1,60 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table left border character(s). +* +* @private +* @param {string} value - border character(s) +* @throws {TypeError} must be a string +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderLeft', value ) ); + } + if ( value !== this._borders[ 3 ].value ) { + ch = splitGraphemeClusters( value ); + this._borders[ 3 ] = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js new file mode 100644 index 000000000000..de77eee7a524 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the table right border character(s). +* +* @private +* @returns {string} border character(s) +*/ +function get() { + return this._borders[ 1 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js new file mode 100644 index 000000000000..d063bc0131c7 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -0,0 +1,60 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table right border character(s). +* +* @private +* @param {string} value - border character(s) +* @throws {TypeError} must be a string +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderRight', value ) ); + } + if ( value !== this._borders[ 1 ].value ) { + ch = splitGraphemeClusters( value ); + this._borders[ 1 ] = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js similarity index 80% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js index 606e4d09337a..533d7a64ac43 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js @@ -16,17 +16,20 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** -* Returns the table's max output width. +* Returns the table top border character(s). * * @private -* @returns {NonNegativeInteger} max output width +* @returns {string} border character(s) */ function get() { - /* eslint-disable no-invalid-this */ - return this._maxOutputWidth; + return this._borders[ 0 ].value; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js new file mode 100644 index 000000000000..a3fd38797ed0 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -0,0 +1,60 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table top border character(s). +* +* @private +* @param {string} value - border character(s) +* @throws {TypeError} must be a string +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderTop', value ) ); + } + if ( value !== this._borders[ 0 ].value ) { + ch = splitGraphemeClusters( value ); + this._borders[ 0 ] = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js index ab66d4f30ab2..96d7b3a389d9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js @@ -16,17 +16,25 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MODULES // + +var pluck = require( '@stdlib/utils/pluck' ); // TODO: replace with array/base utility + + +// MAIN // + /** -* Returns the table's border characters. +* Returns table border characters. * * @private * @returns {Array} borders */ function get() { - /* eslint-disable no-invalid-this */ - return this._borders.slice(); + return pluck( this._borders, 'value' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index af94a32e1c88..df117d9d0a76 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -16,13 +16,17 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isStringArray = require( '@stdlib/assert/is-string-array' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); +var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives; +var copy = require( '@stdlib/array/base/copy' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var everyBy2 = require( './../../every_by2.js' ); // VARIABLES // @@ -30,23 +34,55 @@ var format = require( '@stdlib/string/format' ); var NUM_BORDERS = 4; +// FUNCTIONS // + +/** +* Predicate function which tests whether two elements are equal. +* +* @private +* @param {Object} v1 - first value +* @param {Object} v2 - second value +* @returns {boolean} boolean indicating whether two elements are equal +*/ +function predicate( v1, v2 ) { + return ( v1.value === v2.value ); +} + + // MAIN // /** -* Sets the table's border characters. +* Sets the table border characters in the order `[top, right, bottom, left]`. * * @private -* @param {Array} borders - border characters -* @throws {TypeError} must be an array of four strings +* @param {Collection} values - border characters +* @throws {TypeError} must be an array of strings +* @throws {RangeError} must provide four strings */ -function set( borders ) { - /* eslint-disable no-invalid-this */ - if ( !isStringArray( borders ) || borders.length !== NUM_BORDERS ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of four strings. Value: `%s`.', 'borders', borders ) ); +function set( values ) { + var data; + var ch; + var i; + if ( !isStringArray( values ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings. Value: `%s`.', 'borders', values ) ); + } + if ( values.length !== NUM_BORDERS ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d. Value: `["%s"]`.', 'borders', NUM_BORDERS, copy( values ).join( '", "' ) ) ); + } + data = []; + for ( i = 0; i < NUM_BORDERS; i++ ) { + ch = splitGraphemeClusters( values[ i ] ); + data.push({ + 'value': values[ i ], + 'graphemes': ch, + 'length': ch.length + }); } - if ( !isEqual( borders, this._borders ) ) { - this._borders = borders; - this.emit( 'change' ); + if ( !everyBy2( data, this._borders, predicate ) ) { + this._borders = data; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js index 0e647aff2dee..6c1042af9251 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js @@ -16,16 +16,19 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** -* Returns the data buffer size. +* Returns the internal data buffer size. * * @private * @returns {PositiveInteger} data buffer size */ function get() { - /* eslint-disable no-invalid-this */ return this._bufferSize; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js index d34fddaa3360..5c1d473ef839 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js @@ -16,14 +16,16 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive; var isNull = require( '@stdlib/assert/is-null' ); -var format = require( '@stdlib/string/format' ); var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); +var format = require( '@stdlib/string/format' ); // MAIN // @@ -32,25 +34,27 @@ var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); * Sets the data buffer size. * * @private -* @param {(PositiveInteger|null)} size - data buffer size +* @param {(PositiveInteger|null)} value - data buffer size * @throws {TypeError} must be a positive integer or null -* @throws {RangeError} must be greater than or equal to the number of rows +* @throws {RangeError} must be greater than or equal to the number of table rows */ -function set( size ) { - /* eslint-disable no-invalid-this */ - var FLG = isNull( size ); - if ( !isPositiveInteger( size ) && !FLG ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a positive integer or null. Value: `%s`.', 'bufferSize', size ) ); - } - if ( FLG ) { - size = FLOAT64_MAX; +function set( value ) { + var s; + if ( isNull( value ) ) { + s = FLOAT64_MAX; + } else if ( isPositiveInteger( value ) ) { + s = value; + } else { + throw new TypeError( format( 'invalid assignment. `%s` must be a positive integer or null. Value: `%s`.', 'bufferSize', value ) ); } - if ( this._data && size < this._data.length ) { - throw new RangeError( format( 'invalid assignment. `%s` size is less than the number of data elements. Number of elements: `%u`. Value: `%u`.', 'bufferSize', this._data.length, size ) ); + if ( this._data && s < this._data.length ) { + throw new RangeError( format( 'invalid assignment. `%s` must be greater than or equal to the number of table rows. Number of rows: %u. Value: `%u`.', 'bufferSize', this._data.length, s ) ); } - if ( size !== this._bufferSize ) { - this._bufferSize = size; - this.emit( 'change' ); + if ( s !== this._bufferSize ) { + this._bufferSize = s; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js deleted file mode 100644 index ba983074f66c..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/get.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @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 isArray = require( '@stdlib/assert/is-array' ); - - -// MAIN // - -/** -* Returns the cell's left padding(s). -* -* @private -* @returns {(Array|NonNegativeInteger)} cell's left padding(s) -*/ -function get() { - /* eslint-disable no-invalid-this */ - if ( isArray( this._cellPaddingLeft ) ) { - return this._cellPaddingLeft.slice(); - } - return this._cellPaddingLeft; -} - - -// EXPORTS // - -module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js deleted file mode 100644 index 5d5094ceebdb..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-left/set.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); -var format = require( '@stdlib/string/format' ); - - -// MAIN // - -/** -* Sets the cell's left padding(s). -* -* @private -* @param {(Array|NonNegativeInteger)} padding - cell's left padding(s) -* @throws {TypeError} must provide a non-negative integer -* @throws {RangeError} must provide correct number of columns if providing an array -*/ -function set( padding ) { - /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( padding ) && !isNonNegativeIntegerArray( padding ) ) { // eslint-disable-line max-len - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'cellPadding', padding ) ); - } - if ( isNonNegativeIntegerArray( padding ) ) { - if ( this._numColumns ) { - if ( padding.length !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'padding', this._numColumns, padding.length ) ); - } - } else { - this._numColumns = padding.length; - } - } - if ( !isEqual( padding, this._cellPaddingLeft ) ) { - this._cellPaddingLeft = padding; - this.emit( 'change' ); - } -} - - -// EXPORTS // - -module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js deleted file mode 100644 index a16f7fafb3e1..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/get.js +++ /dev/null @@ -1,45 +0,0 @@ -/** -* @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 isArray = require( '@stdlib/assert/is-array' ); - - -// MAIN // - -/** -* Returns the cell's right padding(s). -* -* @private -* @returns {(Array|NonNegativeInteger)} cell's right padding(s) -*/ -function get() { - /* eslint-disable no-invalid-this */ - if ( isArray( this._cellPaddingRight ) ) { - return this._cellPaddingRight.slice(); - } - return this._cellPaddingRight; -} - - -// EXPORTS // - -module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js deleted file mode 100644 index 45329e67db29..000000000000 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/cell-padding-right/set.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); -var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); -var format = require( '@stdlib/string/format' ); - - -// MAIN // - -/** -* Sets the cell's right padding(s). -* -* @private -* @param {(Array|NonNegativeInteger)} padding - cell's right padding(s) -* @throws {TypeError} must provide a non-negative integer -* @throws {RangeError} must provide correct number of columns if providing an array -*/ -function set( padding ) { - /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( padding ) && !isNonNegativeIntegerArray( padding ) ) { // eslint-disable-line max-len - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'cellPadding', padding ) ); - } - if ( isNonNegativeIntegerArray( padding ) ) { - if ( this._numColumns ) { - if ( padding.length !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'padding', this._numColumns, padding.length ) ); - } - } else { - this._numColumns = padding.length; - } - } - if ( !isEqual( padding, this._cellPaddingRight ) ) { - this._cellPaddingRight = padding; - this.emit( 'change' ); - } -} - - -// EXPORTS // - -module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js index 69395f1df009..39376ad4ce35 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js @@ -16,8 +16,12 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** * Returns the column separator character(s). * @@ -25,8 +29,7 @@ * @returns {string} column separator */ function get() { - /* eslint-disable no-invalid-this */ - return this._columnSeparator; + return this._columnSeparator.value; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 2e97c7cc4b91..93487a281c7d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -16,11 +16,14 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isString = require( '@stdlib/assert/is-string' ); +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); @@ -30,17 +33,24 @@ var format = require( '@stdlib/string/format' ); * Sets the column separator character(s). * * @private -* @param {string} separator - column separator +* @param {string} value - column separator * @throws {TypeError} must be a string */ -function set( separator ) { - /* eslint-disable no-invalid-this */ - if ( !isString( separator ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', separator ) ); +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', value ) ); } - if ( separator !== this._columnSeparator ) { - this._columnSeparator = separator; - this.emit( 'change' ); + if ( value !== this._columnSeparator.value ) { + ch = splitGraphemeClusters( value ); + this._columnSeparator = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js new file mode 100644 index 000000000000..15403f5cf60b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the bottom-left table corner grapheme cluster (i.e., visual character). +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._corners[ 3 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js new file mode 100644 index 000000000000..8c571b151c1e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the bottom-left table corner grapheme cluster (i.e., visual character). +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomLeft', value ) ); + } + ch = splitGraphemeClusters( value ); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomLeft', value ) ); + } + if ( value !== this._corners[ 3 ].value ) { + this._corners[ 3 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js new file mode 100644 index 000000000000..8b7fbba89830 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the bottom-right table corner grapheme cluster (i.e., visual character). +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._corners[ 2 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js new file mode 100644 index 000000000000..7c57d5de9546 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the bottom-right table corner grapheme cluster (i.e., visual character). +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomRight', value ) ); + } + ch = splitGraphemeClusters( value ); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomRight', value ) ); + } + if ( value !== this._corners[ 2 ].value ) { + this._corners[ 2 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js new file mode 100644 index 000000000000..75987df00fc4 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the top-left table corner grapheme cluster (i.e., visual character). +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._corners[ 0 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js new file mode 100644 index 000000000000..a1b2c5c9d376 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the top-left table corner grapheme cluster (i.e., visual character). +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopLeft', value ) ); + } + ch = splitGraphemeClusters( value ); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopLeft', value ) ); + } + if ( value !== this._corners[ 0 ].value ) { + this._corners[ 0 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js new file mode 100644 index 000000000000..cec1d97f5069 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the top-right table corner grapheme cluster (i.e., visual character). +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._corners[ 1 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js new file mode 100644 index 000000000000..a0095c9c12bb --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the top-right table corner grapheme cluster (i.e., visual character). +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopRight', value ) ); + } + ch = splitGraphemeClusters( value ); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopRight', value ) ); + } + if ( value !== this._corners[ 1 ].value ) { + this._corners[ 1 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js index bb498efeb240..4b3dadca5a16 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js @@ -16,17 +16,25 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MODULES // + +var pluck = require( '@stdlib/utils/pluck' ); // TODO: replace with array/base utility + + +// MAIN // + /** -* Returns the table's corner characters. +* Returns the table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. * * @private * @returns {Array} corners */ function get() { - /* eslint-disable no-invalid-this */ - return this._corners.slice(); + return pluck( this._corners, 'value' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index 74633d863669..d3a5905b74d0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -16,14 +16,18 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isStringArray = require( '@stdlib/assert/is-string-array' ); -var numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isCollection = require( '@stdlib/assert/is-collection' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var copy = require( '@stdlib/array/base/copy' ); var format = require( '@stdlib/string/format' ); +var everyBy2 = require( './../../every_by2.js' ); // VARIABLES // @@ -31,30 +35,65 @@ var format = require( '@stdlib/string/format' ); var NUM_CORNERS = 4; +// FUNCTIONS // + +/** +* Predicate function which tests whether two elements are equal. +* +* @private +* @param {Object} v1 - first value +* @param {Object} v2 - second value +* @returns {boolean} boolean indicating whether two elements are equal +*/ +function predicate( v1, v2 ) { + return ( v1.value === v2.value ); +} + + // MAIN // /** -* Sets the table's corner characters. +* Sets the table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. * * @private -* @param {Array} corners - corners -* @throws {TypeError} must be an array of four grapheme clusters +* @param {Array} values - corners +* @throws {TypeError} must be an array of strings +* @throws {TypeError} each array element must be a single grapheme cluster +* @throws {RangeError} must provide four strings */ -function set( corners ) { - /* eslint-disable no-invalid-this */ +function set( values ) { + var data; + var ch; + var v; var i; - if ( !isStringArray( corners ) || corners.length !== NUM_CORNERS ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of four grapheme clusters. Value: `%s`.', 'corners', corners ) ); + if ( !isCollection( values ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings. Value: `%s`.', 'corners', values ) ); } + if ( values.length !== NUM_CORNERS ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d. Value: `["%s"]`.', 'corners', NUM_CORNERS, copy( values ).join( '", "' ) ) ); + } + data = []; for ( i = 0; i < NUM_CORNERS; i++ ) { - if ( numGraphemeClusters( corners[ i ] ) !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of four grapheme clusters. Value: `%s`.', 'corners', corners ) ); + v = values[ i ]; + if ( !isString( v ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); + } + ch = splitGraphemeClusters( v ); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } + data.push({ + 'value': v, + 'graphemes': ch, + 'length': 1 + }); } - if ( !isEqual( corners, this._corners ) ) { - this._corners = corners; - this.emit( 'change' ); + if ( !everyBy2( data, this._corners, predicate ) ) { + this._corners = data; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js index 26e6b99c9d67..e71010fa8bc9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js @@ -16,27 +16,32 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isArray = require( '@stdlib/assert/is-array' ); +var isNull = require( '@stdlib/assert/is-null' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); +var pluck = require( '@stdlib/utils/pluck' ); // MAIN // /** -* Returns table data. +* Returns table data as a read-only ndarray view. * * @private -* @returns {Array|null} table data +* @returns {(ndarray|null)} table data */ function get() { - /* eslint-disable no-invalid-this */ - if ( isArray( this._data ) ) { - return this._data.slice(); + var out; + if ( isNull( this._data ) ) { + return null; } - return this._data; + out = pluck( this._data.data, 'raw' ); + return new ndarray( 'generic', out, this._data.shape, this._data.strides, this._data.offset, this._data.order ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index 3d6583c3da87..7e76acdb26ef 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -16,16 +16,178 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var format = require( '@stdlib/string/format' ); var isMatrixLike = require( '@stdlib/assert/is-matrix-like' ); -var isArrayArray = require( '@stdlib/assert/is-array-array' ); -var ndarray2array = require( '@stdlib/ndarray/to-array' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); -var parse2dArray = require( './../../parser/parse_2d_array.js' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var hasOwnProp = require( '@stdlib/assert/has-own-property' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); +var assign = require( '@stdlib/ndarray/base/assign' ); +var ndarray = require( '@stdlib/ndarray/ctor' ); +var emptyLike = require( '@stdlib/ndarray/empty-like' ); +var flatten2d = require( '@stdlib/array/base/flatten2d' ); +var shape = require( '@stdlib/array/shape' ); +var objectKeys = require( '@stdlib/utils/keys' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var DTYPE = 'generic'; +var ORDER = 'row-major'; + + +// FUNCTIONS // + +/** +* Creates a two-dimensional ndarray having a specified data buffer and shape. +* +* @private +* @param {Array} buffer - data buffer +* @param {NonNegativeIntegerArray} shape - shape +* @returns {ndarray} two-dimensional ndarray +*/ +function matrix( buffer, shape ) { + return new ndarray( DTYPE, buffer, shape, shape2strides( shape, ORDER ), 0, ORDER ); // eslint-disable-line max-len +} + +/** +* Converts table data provided as an array-like object. +* +* @private +* @param {Collection} data - input data +* @param {(ObjectArray|null)} headers - table headers +* @throws {TypeError} invalid input data +* @returns {(Object|Error)} table data +*/ +function convertCollection( data, headers ) { + var keys; + var out; + var flg; + var sh; + var d; + var i; + var j; + var k; + + sh = shape( data ); + + // If we were provided a nested array, flatten in row-major order... + if ( sh.length >= 2 ) { + sh = [ sh[ 0 ], sh[ 1 ] ]; // only concern ourselves with the first two dimensions + return { + 'data': matrix( flatten2d( data, sh, false ), sh ), + 'headers': null + }; + } + // If we were provided a one-dimensional array, assume that we were provided a list of objects... + + // If we don't already have headers, infer the headers from the first array element... + if ( headers === null ) { + keys = objectKeys( data[ 0 ] ); + flg = true; + } else { + keys = headers; + } + out = []; + for ( i = 0; i < sh[ 0 ]; i++ ) { + d = data[ i ]; + for ( j = 0; j < keys.length; j++ ) { + k = keys[ j ]; + if ( hasOwnProp( d, k ) ) { + out.push( d[ k ] ); + } else { + return new Error( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. One or more of the provided data elements is missing expected column data. Expected columns: ["%s"]. Value: `%s`.', 'data', keys.join( '", "' ), JSON.stringify( data ) ) ); + } + } + } + return { + 'data': matrix( out, [ sh[ 0 ], keys.length ] ), + 'headers': ( flg ) ? keys : null + }; +} + +/** +* Converts table data provided as an object. +* +* @private +* @param {*} data - input data +* @param {(ObjectArray|null)} headers - table headers +* @throws {TypeError} invalid input data +* @returns {(Object|Error)} table data +*/ +function convertOther( data, headers ) { + var keys; + var out; + var flg; + var M; + var N; + var i; + var j; + var k; + + // If we don't already have headers, infer the headers from the provided object... + if ( headers === null ) { + keys = objectKeys( data ); + flg = true; + } else { + keys = headers; + } + // If provided an empty object (or an object without enumerable properties), likely a user error... + if ( keys.length === 0 ) { + return new Error( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. Value: `%s`.', 'data', JSON.stringify( data ) ) ); + } + // Validate that each column of data is the same length... + M = data[ keys[0] ].length; + N = keys.length; + for ( i = 1; i < N; i++ ) { + if ( data[ keys[i] ].length !== M ) { + return new Error( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. Each provided data column must have the same number of rows. Value: `%s`.', 'data', JSON.stringify( data ) ) ); + } + } + // Flatten the dictionary of columns into a row-major linear buffer... + out = []; + for ( i = 0; i < M; i++ ) { + for ( j = 0; j < N; j++ ) { + k = keys[ j ]; + out.push( data[ k ][ i ] ); + } + } + return { + 'data': matrix( out, [ M, N ] ), + 'headers': ( flg ) ? keys : null + }; +} + +/** +* Normalizes table data. +* +* @private +* @param {Array} buffer - data buffer +* @returns {Array} modified data buffer +*/ +function normalizeData( buffer ) { + var ch; + var v; + var i; + for ( i = 0; i < buffer.length; i++ ) { + v = String( buffer[ i ] ); + ch = splitGraphemeClusters( v ); + buffer[ i ] = { + 'raw': buffer[ i ], + 'value': v, + 'graphemes': ch, + 'length': ch.length + }; + } + return buffer; +} // MAIN // @@ -34,34 +196,69 @@ var parse2dArray = require( './../../parser/parse_2d_array.js' ); * Sets the table data. * * @private -* @param {Array|MatrixLike} data - table data -* @throws {TypeError} must be a 2 dimensional array/ndarray -* @throws {RangeError} must provide correct number of columns -* @throws {RangeError} rows must not exceed maximum data buffer size +* @param {(Object|Collection|Collection|MatrixLike)} data - table data +* @throws {TypeError} must be an object, an array of objects, an array of arrays, or a two-dimensional ndarray +* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} number of rows must not exceed the maximum data buffer size */ function set( data ) { - /* eslint-disable no-invalid-this */ - var parsed; + var headers; + var out; + var tmp; + + // If provided an ndarray, explicitly copy ndarray data to a new contiguous ndarray in order to allow mutation of the underlying "generic" buffer and for the purposes of maintaining an internal FIFO queue... if ( isMatrixLike( data ) ) { - data = ndarray2array( data ); + out = emptyLike( data, { + 'dtype': DTYPE + }); + assign( [ data, out ] ); } - if ( !isArrayArray( data ) ) { - throw new TypeError( format( 'invalid argument. `%s` must be an object, array of objects, or a 2 dimensional array/ndarray. Value: `%s`.', 'data', data ) ); + // If provided a collection, convert to an ndarray... + else if ( isCollection( data ) ) { + out = convertCollection( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers` is intentional, as we only want the list of header values (if they exist) + if ( out instanceof Error ) { + throw out; + } + if ( out.headers ) { + headers = out.headers; + } + out = out.data; // ndarray } - parsed = parse2dArray( data, this._headers ); - if ( parsed.data.length > this._bufferSize ) { - throw new RangeError( format( 'invalid assignment. `%s` length exceeds maximum data buffer size. Buffer size: `%u`. Length: `%u`.', 'data', this._bufferSize, parsed.data.length ) ); + // If provided anything else, process as a dictionary of columns... + else { + out = convertOther( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers` is intentional, as we only want the list of header values (if they exist) + if ( out instanceof Error ) { + throw out; + } + if ( out.headers ) { + headers = out.headers; + } + out = out.data; // ndarray } + // Ensure that the provided data does not have too many rows... + if ( numelDimension( out, 0 ) > this._bufferSize ) { + throw new RangeError( format( 'invalid assignment. `%s` exceeds maximum data buffer size. Buffer size: %u. Number of rows: `%u`.', 'data', this._bufferSize, numelDimension( out, 0 ) ) ); + } + // Ensure that the provided data has the expected number of columns... if ( this._numColumns ) { - if ( parsed.columnWidths.length !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'data', this._numColumns, parsed.columnWidths.length ) ); + if ( numelDimension( out, 1 ) !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have %d columns in order to match the number of table columns. Number of columns: `%u`.', 'data', this._numColumns, numelDimension( out, 1 ) ) ); } } else { - this._numColumns = parsed.columnWidths.length; + this._numColumns = numelDimension( out, 1 ); + } + // Normalize the underlying table data buffer: + normalizeData( out.data ); + + // Anytime a user sets table data, assume that the data has changed (note: performing a deep equality check is likely too expensive and not worth the effort) and thus, if not in "quiet" mode, always emit a 'change' event... + this._data = out; + if ( headers !== void 0 ) { + tmp = this._quiet; + this._quiet = true; // avoid triggering a 'change' event + this.headers = headers; // NOTE: assigning to `this.headers` is intentional in order to ensure proper processing of headers + this._quiet = tmp; } - if ( !isEqual( parsed.data, this._data ) ) { - this._data = parsed.data; - this._columnWidths = parsed.columnWidths; + if ( !this._quiet ) { this.emit( 'change' ); } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js index 251f39912e81..d495b513093f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js @@ -16,8 +16,12 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** * Returns the header separator character(s). * @@ -25,8 +29,7 @@ * @returns {string} header separator */ function get() { - /* eslint-disable no-invalid-this */ - return this._headerSeparator; + return this._headerSeparator.value; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index 592bb4bc9090..dbf98f4ad010 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -16,11 +16,14 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // var isString = require( '@stdlib/assert/is-string' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); @@ -30,17 +33,24 @@ var format = require( '@stdlib/string/format' ); * Sets the header separator character(s). * * @private -* @param {string} separator - header separator +* @param {string} value - header separator * @throws {TypeError} must be a string */ -function set( separator ) { - /* eslint-disable no-invalid-this */ - if ( !isString( separator ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', separator ) ); +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', value ) ); } - if ( separator !== this._headerSeparator ) { - this._headerSeparator = separator; - this.emit( 'change' ); + if ( value !== this._headerSeparator.value ) { + ch = splitGraphemeClusters( value ); + this._headerSeparator = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js index f92278d36f41..0b60b91a3cd7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js @@ -16,11 +16,14 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // var isArray = require( '@stdlib/assert/is-array' ); +var pluck = require( '@stdlib/utils/pluck' ); // TODO: replace with array/base utility // MAIN // @@ -29,12 +32,11 @@ var isArray = require( '@stdlib/assert/is-array' ); * Returns table headers. * * @private -* @returns {Array|null} table headers +* @returns {(Array|null)} table headers */ function get() { - /* eslint-disable no-invalid-this */ if ( isArray( this._headers ) ) { - return this._headers.slice(); + return pluck( this._headers, 'value' ); } return this._headers; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index e283428aea26..3b74da482d90 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -16,14 +16,32 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var format = require( '@stdlib/string/format' ); var isCollection = require( '@stdlib/assert/is-collection' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); -var parseHeaders = require( './../../parser/parse_headers.js' ); +var copy = require( '@stdlib/array/base/copy' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); +var everyBy2 = require( './../../every_by2.js' ); + + +// FUNCTIONS // + +/** +* Predicate function which tests whether two elements are equal. +* +* @private +* @param {Object} v1 - first value +* @param {Object} v2 - second value +* @returns {boolean} boolean indicating whether two elements are equal +*/ +function predicate( v1, v2 ) { + return ( v1.value === v2.value ); +} // MAIN // @@ -32,28 +50,42 @@ var parseHeaders = require( './../../parser/parse_headers.js' ); * Sets the table headers. * * @private -* @param {Collection} headers - table headers +* @param {Collection} values - table headers * @throws {TypeError} must be a collection -* @throws {RangeError} must provide correct number of columns +* @throws {RangeError} must provide the correct number of columns */ -function set( headers ) { - /* eslint-disable no-invalid-this */ - var parsed; - if ( !isCollection( headers ) ) { - throw new TypeError( format( 'invalid argument. `%s` must be a collection. Value: `%s`.', 'headers', headers ) ); +function set( values ) { + var data; + var len; + var ch; + var v; + var i; + if ( !isCollection( values ) ) { + throw new TypeError( format( 'invalid argument. `%s` must be an array-like object. Value: `%s`.', 'headers', values ) ); } - parsed = parseHeaders( headers, this._columnWidths ); + len = values.length; if ( this._numColumns ) { - if ( parsed.headers.length !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'headers', this._numColumns, parsed.columnWidths.length ) ); + if ( len !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'headers', this._numColumns, copy( values ).join( '", "' ) ) ); } } else { - this._numColumns = parsed.columnWidths.length; + this._numColumns = len; + } + data = []; + for ( i = 0; i < len; i++ ) { + v = String( values[ i ] ); + ch = splitGraphemeClusters( v ); + data.push({ + 'value': v, + 'graphemes': ch, + 'length': ch.length + }); } - if ( !isEqual( parsed.headers, this._headers ) ) { - this._headers = parsed.headers; - this._columnWidths = parsed.columnWidths; - this.emit( 'change' ); + if ( this._headers === null || !everyBy2( data, this._headers, predicate ) ) { // eslint-disable-line max-len + this._headers = data; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js index f23865de9cdf..ff7a9a0b4b55 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js @@ -16,16 +16,19 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** -* Returns the table's horizontal line separator mode. +* Returns the horizontal line separator mode. * * @private * @returns {string} line separator mode */ function get() { - /* eslint-disable no-invalid-this */ return this._horizontalSeparatorMode; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js index aa31f0ef2cfb..0f9d367065f4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js @@ -16,37 +16,40 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // var contains = require( '@stdlib/array/base/assert/contains' ).factory; -var isString = require( '@stdlib/assert/is-string' ); var format = require( '@stdlib/string/format' ); // VARIABLES // -var isValidMode = contains( [ 'resume', 'interpolate', 'repeat' ] ); +var MODES = [ 'resume', 'interpolate', 'repeat' ]; +var isMode = contains( MODES ); // MAIN // /** -* Sets the table's horizontal line separator mode. +* Sets the horizontal line separator mode. * * @private * @param {string} mode - line separator mode -* @throws {TypeError} must be a supported line separator mode string +* @throws {TypeError} must be a supported line separator mode */ function set( mode ) { - /* eslint-disable no-invalid-this */ - if ( !isString( mode ) || !isValidMode( mode ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a valid line separator mode string. Value: `%s`.', 'lineSeparatorMode', mode ) ); + if ( !isMode( mode ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be one of the following: "%s". Value: `%s`.', 'horizontalSeparatorMode', MODES.join( '", "' ), mode ) ); } if ( mode !== this._horizontalSeparatorMode ) { this._horizontalSeparatorMode = mode; - this.emit( 'change' ); + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js new file mode 100644 index 000000000000..18ab17069f35 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table. +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._joints[ 3 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js new file mode 100644 index 000000000000..69767ea4da9e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table. +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointBottom', value ) ); + } + ch = splitGraphemeClusters( value); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointBottom', value ) ); + } + if ( value !== this._joints[ 3 ].value ) { + this._joints[ 3 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js new file mode 100644 index 000000000000..fae760254809 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._joints[ 4 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js new file mode 100644 index 000000000000..df9581860767 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointLeft', value ) ); + } + ch = splitGraphemeClusters( value); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointLeft', value ) ); + } + if ( value !== this._joints[ 4 ].value ) { + this._joints[ 4 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js new file mode 100644 index 000000000000..ed7cc9f99592 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._joints[ 0 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js new file mode 100644 index 000000000000..cfb707e1bd60 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointMiddle', value ) ); + } + ch = splitGraphemeClusters( value); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointMiddle', value ) ); + } + if ( value !== this._joints[ 0 ].value ) { + this._joints[ 0 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js new file mode 100644 index 000000000000..4b6789df989c --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._joints[ 2 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js new file mode 100644 index 000000000000..164ebb50da2c --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointRight', value ) ); + } + ch = splitGraphemeClusters( value); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointRight', value ) ); + } + if ( value !== this._joints[ 2 ].value ) { + this._joints[ 2 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js new file mode 100644 index 000000000000..f02397d558c5 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the top of the table. +* +* @private +* @returns {string} grapheme cluster +*/ +function get() { + return this._joints[ 1 ].value; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js new file mode 100644 index 000000000000..7fc7cf5ad1a2 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -0,0 +1,63 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the top of the table. +* +* @private +* @param {string} value - grapheme cluster +* @throws {TypeError} must be a string containing a single grapheme cluster +*/ +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointTop', value ) ); + } + ch = splitGraphemeClusters( value); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointTop', value ) ); + } + if ( value !== this._joints[ 1 ].value ) { + this._joints[ 1 ] = { + 'value': value, + 'graphemes': ch, + 'length': 1 + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js index 1d2ba1b9cb38..3715c668ed35 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js @@ -16,8 +16,17 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MODULES // + +var pluck = require( '@stdlib/utils/pluck' ); // TODO: use array/base utility + + +// MAIN // + /** * Returns the joint characters. * @@ -25,8 +34,7 @@ * @returns {Array} joint characters */ function get() { - /* eslint-disable no-invalid-this */ - return this._joints.slice(); + return pluck( this._joints, 'value' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 3307a16f32d4..6a391ce98662 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -16,14 +16,18 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isStringArray = require( '@stdlib/assert/is-string-array' ); -var numGraphemeClusters = require( '@stdlib/string/num-grapheme-clusters' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isCollection = require( '@stdlib/assert/is-collection' ); +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var copy = require( '@stdlib/array/base/copy' ); var format = require( '@stdlib/string/format' ); +var everyBy2 = require( './../../every_by2.js' ); // VARIABLES // @@ -31,30 +35,65 @@ var format = require( '@stdlib/string/format' ); var NUM_JOINTS = 5; +// FUNCTIONS // + +/** +* Predicate function which tests whether two elements are equal. +* +* @private +* @param {Object} v1 - first value +* @param {Object} v2 - second value +* @returns {boolean} boolean indicating whether two elements are equal +*/ +function predicate( v1, v2 ) { + return ( v1.value === v2.value ); +} + + // MAIN // /** -* Sets the joint characters. +* Sets the joint grapheme clusters (i.e., visual characters) in the order `[middle, top, right, bottom, left ]`. * * @private -* @param {Array} joints - joint characters -* @throws {TypeError} must be an array of five grapheme clusters +* @param {Array} values - joint characters +* @throws {TypeError} must be an array of strings +* @throws {TypeError} each array element must be a single grapheme cluster +* @throws {RangeError} must provide five strings */ -function set( joints ) { - /* eslint-disable no-invalid-this */ +function set( values ) { + var data; + var ch; + var v; var i; - if ( !isStringArray( joints ) || joints.length !== NUM_JOINTS ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of five grapheme clusters. Value: `%s`.', 'joints', joints ) ); + if ( !isCollection( values ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings. Value: `%s`.', 'joints', values ) ); } + if ( values.length !== NUM_JOINTS ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d. Value: `["%s"]`.', 'joints', NUM_JOINTS, copy( values ).join( '", "' ) ) ); + } + data = []; for ( i = 0; i < NUM_JOINTS; i++ ) { - if ( numGraphemeClusters( joints[ i ] ) !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of five grapheme clusters. Value: `%s`.', 'joints', joints ) ); + v = values[ i ]; + if ( !isString( v ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); + } + ch = splitGraphemeClusters( v ); + if ( ch.length !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } + data.push({ + 'value': v, + 'graphemes': ch, + 'length': 1 + }); } - if ( !isEqual( joints, this._joints ) ) { - this._joints = joints; - this.emit( 'change' ); + if ( !everyBy2( data, this._joints, predicate ) ) { + this._joints = data; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js new file mode 100644 index 000000000000..fd07f8562101 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the table's bottom margin in units of blank lines. +* +* @private +* @returns {NonNegativeInteger} bottom margin +*/ +function get() { + return this._margins[ 2 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js new file mode 100644 index 000000000000..8e27f129595e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js @@ -0,0 +1,53 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's bottom margin in units of blank lines. +* +* @private +* @param {NonNegativeInteger} value - bottom margin +* @throws {TypeError} must provide a nonnegative integer +*/ +function set( value ) { + if ( !isNonNegativeInteger( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer. Value: `%s`.', 'marginBottom', value ) ); + } + if ( value !== this._margins[ 2 ] ) { + this._margins[ 2 ] = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js new file mode 100644 index 000000000000..7c714e7c32b9 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the table's left margin in units of whitespace. +* +* @private +* @returns {NonNegativeInteger} left margin +*/ +function get() { + return this._margins[ 3 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js similarity index 65% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js index 2ba10b80f880..0b102fa77edf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-y/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js @@ -16,31 +16,34 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table's vertical margin. +* Sets the table's left margin in units of whitespace. * * @private -* @param {NonNegativeInteger} y - Y margin -* @throws {TypeError} must provide a non-negative integer +* @param {NonNegativeInteger} value - left margin +* @throws {TypeError} must provide a nonnegative integer */ -function set( y ) { - /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( y ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'marginY', y ) ); +function set( value ) { + if ( !isNonNegativeInteger( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer. Value: `%s`.', 'marginLeft', value ) ); } - if ( y !== this._marginY ) { - this._marginY = y; - this.emit( 'change' ); + if ( value !== this._margins[ 3 ] ) { + this._margins[ 3 ] = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js new file mode 100644 index 000000000000..62cffa1a34db --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the table's right margin in units of whitespace. +* +* @private +* @returns {NonNegativeInteger} right margin +*/ +function get() { + return this._margins[ 1 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js new file mode 100644 index 000000000000..d8d2cc6979c1 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js @@ -0,0 +1,53 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table's right margin in units of whitespace. +* +* @private +* @param {NonNegativeInteger} value - right margin +* @throws {TypeError} must provide a nonnegative integer +*/ +function set( value ) { + if ( !isNonNegativeInteger( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer. Value: `%s`.', 'marginRight', value ) ); + } + if ( value !== this._margins[ 1 ] ) { + this._margins[ 1 ] = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js new file mode 100644 index 000000000000..42cd6a30a011 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the table's top margin in units of blank lines. +* +* @private +* @returns {NonNegativeInteger} top margin +*/ +function get() { + return this._margins[ 0 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js similarity index 67% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js index c424112179be..d11611dc2992 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js @@ -16,31 +16,34 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table's horizontal margin. +* Sets the table's top margin in units of blank lines. * * @private -* @param {NonNegativeInteger} x - X margin -* @throws {TypeError} must provide a non-negative integer +* @param {NonNegativeInteger} value - top margin +* @throws {TypeError} must provide a nonnegative integer */ -function set( x ) { - /* eslint-disable no-invalid-this */ - if ( !isNonNegativeInteger( x ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer. Value: `%s`.', 'marginX', x ) ); +function set( value ) { + if ( !isNonNegativeInteger( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer. Value: `%s`.', 'marginTop', value ) ); } - if ( x !== this._marginX ) { - this._marginX = x; - this.emit( 'change' ); + if ( value !== this._margins[ 0 ] ) { + this._margins[ 0 ] = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js similarity index 82% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js index 395cb89f03d9..c3cc25de9d3b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-x/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js @@ -16,17 +16,20 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** -* Returns the table's horizontal margin. +* Returns table margins. * * @private -* @returns {NonNegativeInteger} X margin +* @returns {NonNegativeIntegerArray} margins */ function get() { - /* eslint-disable no-invalid-this */ - return this._marginX; + return this._margins.slice(); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js new file mode 100644 index 000000000000..80be2f39ccc1 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js @@ -0,0 +1,66 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives; +var copy = require( '@stdlib/array/base/copy' ); +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var NUM_MARGINS = 4; + + +// MAIN // + +/** +* Sets the table margins in the order `[top, right, bottom, left]`. +* +* @private +* @param {Collection} values - margins +* @throws {TypeError} must be an array of nonnegative integers +* @throws {RangeError} must provide four nonnegative integers +*/ +function set( values ) { + var data; + if ( !isNonNegativeIntegerArray( values ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of nonnegative integers. Value: `%s`.', 'margins', values ) ); + } + data = copy( values ); + if ( data.length !== NUM_MARGINS ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d. Value: `[%s]`.', 'margins', NUM_MARGINS, data.join( ', ' ) ) ); + } + if ( !isEqualArray( data, this._margins ) ) { + this._margins = data; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js index 2936f0d15728..8722ed45d8ec 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js @@ -16,27 +16,23 @@ * limitations under the License. */ -'use strict'; - -// MODULES // - -var isArray = require( '@stdlib/assert/is-array' ); +/* eslint-disable no-invalid-this */ +'use strict'; // MAIN // /** -* Returns the table's max cell width(s). +* Returns the maximum cell width(s) for each table column. * * @private -* @returns {(Array|NonNegativeInteger)} max cell width(s) +* @returns {(NonNegativeIntegerArray|NonNegativeInteger)} maximum cell width(s) */ function get() { - /* eslint-disable no-invalid-this */ - if ( isArray( this._maxCellWidth ) ) { + if ( this._maxCellWidth.length > 1 ) { return this._maxCellWidth.slice(); } - return this._maxCellWidth; + return this._maxCellWidth[ 0 ]; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js index 8f9f31341fd5..34742e694c34 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js @@ -16,65 +16,79 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); -var isArray = require( '@stdlib/assert/is-array' ); +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var isCollection = require( '@stdlib/assert/is-collection' ); var isNull = require( '@stdlib/assert/is-null' ); -var isEqual = require( '@stdlib/assert/deep-equal' ); -var format = require( '@stdlib/string/format' ); +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); +var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table's max cell width(s). +* Sets the maximum cell width(s) for each table column. * * @private -* @param {(Array|NonNegativeInteger|null)} width - max cell width(s) -* @throws {TypeError} must provide a non-negative integer, an array of non-negative integers or null -* @throws {RangeError} must provide correct number of columns if providing an array +* @param {(Collection|NonNegativeInteger|null)} value - maximum cell width(s) +* @throws {TypeError} must be a nonnegative integer, an array of nonnegative integers, or null +* @throws {RangeError} must provide the correct number of columns */ -function set( width ) { - /* eslint-disable no-invalid-this */ +function set( value ) { var out; - var FLG; + var len; + var v; var i; - FLG = isNull( width ); - if ( !isNonNegativeInteger( width ) && !isArray( width ) && !FLG ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'width', width ) ); - } - if ( isArray( width ) ) { - out = []; - for ( i = 0; i < width.length; i++ ) { - if ( isNull( width[ i ] ) ) { - out.push( FLOAT64_MAX ); - continue; - } - if ( !isNonNegativeInteger( width[ i ] ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or an array of non-negative integers. Value: `%s`.', 'width', width ) ); - } - out.push( width[ i ] ); + if ( !isCollection( value ) ) { + if ( isNull( value ) ) { + out = [ FLOAT64_MAX ]; + } else if ( isNonNegativeInteger( value ) ) { + out = [ value ]; + } else { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', 'maxCellWidth', value ) ); } - if ( this._numColumns ) { - if ( out.length !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have `%d` number of columns. Value: `%d`.', 'width', this._numColumns, width.length ) ); + if ( !isEqualArray( out, this._maxCellWidth ) ) { + this._maxCellWidth = out; + if ( !this._quiet ) { + this.emit( 'change' ); } - } else { - this._numColumns = out.length; } - } else if ( FLG ) { - out = FLOAT64_MAX; + return; + } + len = value.length; + if ( this._numColumns ) { + if ( len !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'maxCellWidth', this._numColumns, copy( value ).join( '", "' ) ) ); + } } else { - out = width; + this._numColumns = len; } - if ( !isEqual( out, this._maxCellWidth ) ) { + out = []; + for ( i = 0; i < len; i++ ) { + v = value[ i ]; + if ( isNull( v ) ) { + out.push( FLOAT64_MAX ); + continue; + } + if ( isNonNegativeInteger( v ) ) { + out.push( v ); + continue; + } + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `["%s"]`.', 'maxCellWidth', copy( value ).join( '", "' ) ) ); + } + if ( !isEqualArray( out, this._maxCellWidth ) ) { this._maxCellWidth = out; - this.emit( 'change' ); + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js new file mode 100644 index 000000000000..c0b66e2d7b5e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js @@ -0,0 +1,38 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the maximum table width in units of grapheme clusters (i.e., visual characters). +* +* @private +* @returns {NonNegativeInteger} maximum width +*/ +function get() { + return this._maxWidth; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js similarity index 65% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js index b87da48ef6cc..1774d8119ca9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-output-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js @@ -16,37 +16,41 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; var isNull = require( '@stdlib/assert/is-null' ); -var format = require( '@stdlib/string/format' ); var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); +var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table's max output width. +* Sets the maximum table width. * * @private -* @param {(NonNegativeInteger|null)} width - max output width -* @throws {TypeError} must provide a non-negative integer or null +* @param {(NonNegativeInteger|null)} value - maximum width +* @throws {TypeError} must provide a nonnegative integer or null */ -function set( width ) { - /* eslint-disable no-invalid-this */ - var FLG = isNull( width ); - if ( !isNonNegativeInteger( width ) && !FLG ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a non-negative integer or null. Value: `%s`.', 'maxOutputWidth', width ) ); - } - if ( FLG ) { - width = FLOAT64_MAX; +function set( value ) { + var w; + if ( isNull( value ) ) { + w = FLOAT64_MAX; + } else if ( isNonNegativeInteger( value ) ) { + w = value; + } else { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or null. Value: `%s`.', 'maxWidth', w ) ); } - if ( width !== this._maxOutputWidth ) { - this._maxOutputWidth = width; - this.emit( 'change' ); + if ( w !== this._maxWidth ) { + this._maxWidth = w; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js new file mode 100644 index 000000000000..d3da1b6a3cb7 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js @@ -0,0 +1,41 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the cell left padding(s) in units of whitespace characters. +* +* @private +* @returns {(NonNegativeIntegerArray|NonNegativeInteger)} cell left padding(s) +*/ +function get() { + if ( this._paddingLeft.length > 1 ) { + return this._paddingLeft.slice(); + } + return this._paddingLeft[ 0 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js new file mode 100644 index 000000000000..aaca27371e4d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js @@ -0,0 +1,75 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives; +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table cell left padding(s) in units of whitespace. +* +* @private +* @param {(Array|NonNegativeInteger)} value - cell left padding(s) +* @throws {TypeError} must provide a nonnegative integer or an array of nonnegative integers +* @throws {RangeError} must provide the correct number of columns +*/ +function set( value ) { + if ( isNonNegativeInteger( value ) ) { + value = [ value ]; + if ( !isEqualArray( value, this._paddingLeft ) ) { + this._paddingLeft = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + if ( !isNonNegativeIntegerArray( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', 'paddingLeft', value ) ); + } + if ( this._numColumns ) { + if ( value.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `[%s]`.', 'paddingLeft', this._numColumns, copy( value ).join( ', ' ) ) ); + } + } else { + this._numColumns = value.length; + } + value = copy( value ); + if ( !isEqualArray( value, this._paddingLeft ) ) { + this._paddingLeft = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js new file mode 100644 index 000000000000..50703e027068 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js @@ -0,0 +1,41 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the cell right padding(s) in units of whitespace. +* +* @private +* @returns {(NonNegativeIntegerArray|NonNegativeInteger)} cell right padding(s) +*/ +function get() { + if ( this._paddingRight.length > 1 ) { + return this._paddingRight.slice(); + } + return this._paddingRight[ 0 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js new file mode 100644 index 000000000000..378c252f46de --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js @@ -0,0 +1,75 @@ +/** +* @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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives; +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table cell right padding(s) in units of whitespace. +* +* @private +* @param {(Array|NonNegativeInteger)} value - cell right padding(s) +* @throws {TypeError} must provide a nonnegative integer or an array of nonnegative integers +* @throws {RangeError} must provide the correct number of columns +*/ +function set( value ) { + if ( isNonNegativeInteger( value ) ) { + value = [ value ]; + if ( !isEqualArray( value, this._paddingRight ) ) { + this._paddingRight = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + if ( !isNonNegativeIntegerArray( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', 'paddingRight', value ) ); + } + if ( this._numColumns ) { + if ( value.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `[%s]`.', 'paddingRight', this._numColumns, copy( value ).join( ', ' ) ) ); + } + } else { + this._numColumns = value.length; + } + value = copy( value ); + if ( !isEqualArray( value, this._paddingRight ) ) { + this._paddingRight = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js index ba503a4e2ddb..911273e299c6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js @@ -16,8 +16,12 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** * Returns the row separator character(s). * @@ -25,8 +29,7 @@ * @returns {string} row separator */ function get() { - /* eslint-disable no-invalid-this */ - return this._rowSeparator; + return this._rowSeparator.value; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index 3b2c96821a39..16e49c6d8169 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -16,11 +16,14 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // -var isString = require( '@stdlib/assert/is-string' ); +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); @@ -30,17 +33,24 @@ var format = require( '@stdlib/string/format' ); * Sets the row separator character(s). * * @private -* @param {string} separator - row separator +* @param {string} value - row separator * @throws {TypeError} must be a string */ -function set( separator ) { - /* eslint-disable no-invalid-this */ - if ( !isString( separator ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', separator ) ); +function set( value ) { + var ch; + if ( !isString( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', value ) ); } - if ( separator !== this._rowSeparator ) { - this._rowSeparator = separator; - this.emit( 'change' ); + if ( value !== this._rowSeparator.value ) { + ch = splitGraphemeClusters( value ); + this._rowSeparator = { + 'value': value, + 'graphemes': ch, + 'length': ch.length + }; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js index b8760b12e1c2..66cbc2904d7b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js @@ -16,16 +16,19 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; +// MAIN // + /** -* Returns the table's vertical line separator mode. +* Returns the vertical line separator mode. * * @private * @returns {string} line separator mode */ function get() { - /* eslint-disable no-invalid-this */ return this._verticalSeparatorMode; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js index 9c40fb45a651..e05041642de1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js @@ -16,37 +16,40 @@ * limitations under the License. */ +/* eslint-disable no-invalid-this */ + 'use strict'; // MODULES // var contains = require( '@stdlib/array/base/assert/contains' ).factory; -var isString = require( '@stdlib/assert/is-string' ); var format = require( '@stdlib/string/format' ); // VARIABLES // -var isValidMode = contains( [ 'resume', 'interpolate', 'repeat' ] ); +var MODES = [ 'resume', 'interpolate', 'repeat' ]; +var isMode = contains( MODES ); // MAIN // /** -* Sets the table's vertical line separator mode. +* Sets the vertical line separator mode. * * @private -* @param {string} mode - line separator mode -* @throws {TypeError} must be a supported line separator mode string +* @param {string} value - line separator mode +* @throws {TypeError} must be a supported line separator mode */ -function set( mode ) { - /* eslint-disable no-invalid-this */ - if ( !isString( mode ) || !isValidMode( mode ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a valid line separator mode string. Value: `%s`.', 'lineSeparatorMode', mode ) ); +function set( value ) { + if ( !isMode( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be one of the following: "%s". Value: `%s`.', 'verticalSeparatorMode', MODES.join( '", "' ), value ) ); } - if ( mode !== this._verticalSeparatorMode ) { - this._verticalSeparatorMode = mode; - this.emit( 'change' ); + if ( value !== this._verticalSeparatorMode ) { + this._verticalSeparatorMode = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index 85b3393a3344..976e3d45e9ac 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -16,30 +16,32 @@ * limitations under the License. */ +/* eslint-disable */ /* no-invalid-this */ // FIXME + 'use strict'; // MODULES // -var format = require( '@stdlib/string/format' ); var isCollection = require( '@stdlib/assert/is-collection' ); -var parse2dArray = require( './parser/parse_2d_array.js' ); +var format = require( '@stdlib/string/format' ); // MAIN // /** -* Appends row. +* Appends one or more rows to table data. * * @private -* @param {Collection} row - row to add -* @throws {TypeError} must provide a collection -* @throws {RangeError} must provide correct number of columns +* @param {(Object|Collection|VectorLike|MatrixLike)} data - row to add +* @throws {TypeError} must provide an object, an array-like object, or an ndarray +* @throws {RangeError} must provide the correct number of columns * @returns {UnicodeTable} class instance */ -function push( row ) { - /* eslint-disable no-invalid-this */ +function push( data ) { var parsed; +// FIXME: should we allow an object to allow unordered, but keyed, data? Probably, yes. + if ( !isCollection ) { throw new TypeError( format( 'invalid argument. Must provide a collection. Value: `%s`.', row ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 601f3d6ad632..19773b45b780 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -16,23 +16,353 @@ * limitations under the License. */ -/* eslint-disable no-invalid-this, no-underscore-dangle, max-lines-per-function */ +/* eslint-disable no-invalid-this */ 'use strict'; // MODULES // -var format = require( '@stdlib/string/format' ); -var repeat = require( '@stdlib/string/repeat' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); -var isString = require( '@stdlib/assert/is-string' ); -var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); -var filled = require( '@stdlib/array/base/filled' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); var floor = require( '@stdlib/math/base/special/floor' ); var ceil = require( '@stdlib/math/base/special/ceil' ); -var min = require( '@stdlib/math/base/special/min' ); -var slice = require( '@stdlib/array/slice' ); -var truncate = require( '@stdlib/string/truncate' ); +var min = require( '@stdlib/math/base/special/fast/min' ); +var zeros = require( '@stdlib/array/base/zeros' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var repeat = require( '@stdlib/string/repeat' ); +var format = require( '@stdlib/string/format' ); + + +// FUNCTIONS // + +/** +* Converts a one-dimensional array to a two-dimensional ndarray. +* +* @private +* @param {Collection} data - input data +* @returns {ndarray} two-dimensional ndarray +*/ +function array2matrix( data ) { + return new ndarray( 'generic', data, [ 1, data.length ], [ data.length, 1 ], 0, 'row-major' ); +} + +/** +* Resolves individual column widths based on table data and specified paddings. +* +* @private +* @param {NonNegativeInteger} nrows - number of table rows +* @param {NonNegativeInteger} ncols - number of table columns +* @param {ndarray} data - table data +* @param {(ndarray|null)} headers - table headers +* @param {NonNegativeIntegerArray} leftPadding - left padding +* @param {NonNegativeIntegerArray} rightPadding - right padding +* @returns {NonNegativeIntegerArray} column widths +*/ +function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) { // eslint-disable-line max-len + var lpad; + var rpad; + var out; + var len; + var M; + var N; + var v; + var i; + var j; + + M = leftPadding.length; + N = rightPadding.length; + + out = zeros( ncols ); + if ( headers ) { + for ( j = 0; j < ncols; j++ ) { + lpad = leftPadding[ j%M ]; + rpad = rightPadding[ j%N ]; + v = headers.get( 0, j ); + len = lpad + v.length + rpad; + if ( len > out[ j ] ) { + out[ j ] = len; + } + } + } + for ( i = 0; i < nrows; i++ ) { + for ( j = 0; j < ncols; j++ ) { + lpad = leftPadding[ j%M ]; + rpad = rightPadding[ j%N ]; + v = data.get( i, j ); + len = lpad + v.length + rpad; + if ( len > out[ j ] ) { + out[ j ] = len; + } + } + } + return out; +} + +/** +* Computes a column width. +* +* @private +* @param {NonNegativeInteger} ngraphemes - number of grapheme clusters +* @param {NonNegativeInteger} maxWidth - maximum column width (in units of grapheme clusters) +* @returns {NonNegativeInteger} width (in units of grapheme clusters) +*/ +function columnWidth( ngraphemes, maxWidth ) { + return min( ngraphemes, maxWidth ); +} + +/** +* Resolves the column indices at which to wrap table rows. +* +* @private +* @param {Object} ctx - context object +* @param {NonNegativeInteger} ctx.maxWidth - maximum table width (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.columnWidths - column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.maxWidths - maximum column widths (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.marginL - left table margin +* @param {NonNegativeInteger} ctx.marginR - right table margin +* @param {NonNegativeInteger} ctx.borderL - left border length (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.borderR - right border length (in units of grapheme clusters) +* @param {Object} ctx.columnSeparator - column separator +* @returns {(NonNegativeIntegerArray|Error)} list of column indices or an error +*/ +function wrappedColumnIndices( ctx ) { + var indices; + var width; + var ncols; + var len; + var mw; + var w; + var i; + + ncols = ctx.columnWidths.length; + + // Initialize an array of indices at which to wrap table rows: + indices = [ 0 ]; + + // Calculate fixed horizontal length: + len = ctx.marginL + ctx.borderR + ctx.borderL + ctx.marginR; + + // Resolve the column breakpoints... + width = 0; + for ( i = 0; i < ncols; i++ ) { + mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; + w = columnWidth( ctx.columnWidths[ i ], mw ); + if ( w > ctx.maxWidth ) { + // The column cannot be accommodated according to the current table configuration, as the column widths exceeds the maximum allowed table width... + return new Error( format( 'invalid operation. The resolved column width for column %d exceeds the maximum allowed table width. Consider either increasing `maxWidth` or decreasing `maxCellWidth`. Maximum width: %d. Maximum cell width: %d. Column width: %d.', ctx.maxWidth, mw, ctx.columnWidths[ i ] ) ); + } + width += w; + + // If the computed width exceeds the maximum table width, we need to wrap table rows to a new table... + if ( width+len > ctx.maxWidth ) { + indices.push( i ); + width = 0; + continue; + } + // For all columns apart from the last (which has a border, not a column separator), include the width of the column separator... + if ( i < ncols-1 ) { + width += ctx.columnSeparator.length; + } + } + // Include a final "index" to serve as the index upper bound: + indices.push( ncols ); + + return indices; +} + +/** +* Renders a specified number of whitespace characters. +* +* @private +* @param {NonNegativeInteger} len - number of whitespace characters +* @returns {string} output string +*/ +function renderWhitespace( len ) { + return repeat( ' ', len ); +} + +/** +* Renders a vertical margin. +* +* @private +* @param {Array} out - output array +* @param {NonNegativeInteger} margin - vertical margin +* @returns {Array} output array +*/ +function renderVerticalMargin( out, margin ) { + var i; + for ( i = 0; i < margin; i++ ) { + out.push( '' ); + } + return out; +} + +/** +* Renders a table line. +* +* @private +* @param {NonNegativeInteger} start - starting column index (inclusive) +* @param {NonNegativeInteger} end - ending column index (exclusive) +* @param {Object} ch - line characters +* @param {Object} ctx - context object +* @param {NonNegativeIntegerArray} ctx.columnWidths - column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.maxWidths - maximum column widths (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.marginL - left table margin +* @param {NonNegativeInteger} ctx.marginR - right table margin +* @param {NonNegativeInteger} ctx.borderL - left border length (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.borderR - right border length (in units of grapheme clusters) +* @param {string} ctx.jointL - left joint +* @param {string} ctx.jointM - middle joint +* @param {string} ctx.jointR - right joint +* @param {Object} ctx.columnSeparator - column separator +* @param {string} ctx.mode - horizontal separator mode +* @returns {string} rendered line +*/ +function renderLine( start, end, ch, ctx ) { + var hidx; + var out; + var mw; + var w; + var i; + var j; + + // Initialize an index variable for determining how to handle horizontal separators: + hidx = 0; + + // Render left margin: + out = renderWhitespace( ctx.marginL ); + + // Render left joint: + if ( ctx.borderL > 0 ) { + out += ctx.jointL; + if ( ctx.mode === 'interpolate' ) { + hidx += 1; + } + } + // Render a table line... + for ( i = start; i < end; i++ ) { + // If columns are separated by a column separator, render the middle joint... + if ( i > start && ctx.columnSeparator.length > 0 ) { + out += ctx.jointM; + if ( ctx.mode === 'interpolate' ) { + hidx += 1; + } else if ( ctx.mode === 'repeat' ) { + hidx = 0; + } + } + // Render as many of the line characters as can visually fit across a column... + mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; + w = columnWidth( ctx.columnWidths[ i ], mw ); + for ( j = 0; j < w; j++ ) { + out += ch[ hidx%ch.length ]; + hidx += 1; + } + } + // Render right joint: + if ( ctx.borderR > 0 ) { + out += ctx.jointR; + } + // Render right margin: + out += renderWhitespace( ctx.marginR ); + + return out; +} + +/** +* Renders a data row. +* +* @private +* @param {NonNegativeInteger} row - row index +* @param {NonNegativeInteger} start - starting column index (inclusive) +* @param {NonNegativeInteger} end - ending column index (exclusive) +* @param {ndarray} data - table data +* @param {Object} ctx - context object +* @param {NonNegativeInteger} ctx.columnWidths - column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.maxWidths - maximum column widths (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.marginL - left table margin +* @param {NonNegativeInteger} ctx.marginR - right table margin +* @param {NonNegativeIntegerArray} ctx.paddingL - left cell padding +* @param {NonNegativeIntegerArray} ctx.paddingR - right cell padding +* @param {Object} ctx.borderL - left border object +* @param {Object} ctx.borderR - right border object +* @param {Object} ctx.columnSeparator - column separator +* @param {StringArray} ctx.alignments - cell alignments +* @param {NonNegativeInteger} vidx - vertical line index +* @returns {string} rendered line +*/ +function renderRow( row, start, end, data, ctx, vidx ) { + var lpad; + var rpad; + var out; + var len; + var mw; + var w; + var d; + var v; + var i; + + // Render left margin: + out = renderWhitespace( ctx.marginL ); + + // Render left border: + if ( ctx.borderL.length > 0 ) { + out += ctx.borderL.graphemes[ vidx%ctx.borderL.length ]; + } + for ( i = start; i < end; i++ ) { + // Render column separator: + if ( i > start && ctx.columnSeparator.length > 0 ) { + out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.length ]; // eslint-disable-line max-len + } + // Resolve cell paddings: + lpad = ctx.paddingL[ i%ctx.paddingL.length ]; + rpad = ctx.paddingR[ i%ctx.paddingR.length ]; + + // Render left cell padding: + out += renderWhitespace( lpad ); + + // Resolve cell data: + v = data.get( row, i ); + len = v.length + lpad + rpad; // number of grapheme clusters + + // Determine whether we need to truncate rendered data: + mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; + w = ctx.columnWidths[ i ]; + if ( w > mw ) { + // Truncate rendered data: + w = mw; + d = v.graphemes.slice( 0, mw-lpad-rpad ).join( '' ); + } else { + d = v.value; + } + // Render cell contents: + switch ( ctx.alignments[ i%ctx.alignments.length ] ) { + case 'left': + out += d; + out += renderWhitespace( w-len ); + break; + case 'center': + out += renderWhitespace( ceil( (w-len)/2 ) ); + out += d; + out += renderWhitespace( floor( (w-len)/2 ) ); + break; + case 'right': + out += renderWhitespace( w-len ); + out += d; + break; + default: + break; + } + // Render right cell padding: + out += renderWhitespace( rpad ); + } + // Render right border: + if ( ctx.borderR.length > 0 ) { + out += ctx.borderR.graphemes[ vidx%ctx.borderR.length ]; + } + // Render right margin: + out += renderWhitespace( ctx.marginR ); + + return out; +} // MAIN // @@ -45,332 +375,159 @@ var truncate = require( '@stdlib/string/truncate' ); * @returns {string} rendered table */ function render() { - var verticalLineIdx; - var columnSeparator; - var headerSeparator; - var maxCellWidths; - var paddingsRight; - var rowSeparator; - var paddingsLeft; - var wrapIndices; - var alignments; - var borders; - var widths; + var colWidths; + var headers; var start; - var table; - var wraps; - var self; - var row; + var nrows; + var ncols; + var vidx; + var lctx; + var rctx; + var line; var end; var out; + var idx; var i; var j; - self = this; - out = ''; - - // Resolve table properties: - resolveProps(); + if ( this._data === null && this._headers === null ) { + return ''; + } + nrows = numelDimension( this._data, 0 ); + ncols = numelDimension( this._data, 1 ); + + // Convert the list of headers to a two-dimensional ndarray: + headers = ( this._headers ) ? array2matrix( this._headers ) : null; + + // Resolve the column widths needed to fit column data: + colWidths = columnWidths( nrows, ncols, this._data, headers, this._paddingLeft, this._paddingRight ); // eslint-disable-line max-len + + // Resolve indices at which to wrap the table rows: + idx = wrappedColumnIndices({ + 'maxWidth': this._maxWidth, + 'columnWidths': colWidths, + 'maxWidths': this._maxCellWidth, + 'marginL': this._margins[ 3 ], + 'marginR': this._margins[ 1 ], + 'borderL': this._borders[ 3 ].length, + 'borderR': this._borders[ 1 ].length, + 'columnSeparator': this._columnSeparator + }); + if ( idx instanceof Error ) { + throw idx; + } - // Resolve indices to wrap the table at: - wrapIndices = resolveWrapping(); + // Define a "line" context for rendering non-data content: + lctx = { + 'columnWidths': colWidths, + 'maxWidths': this._maxCellWidth, + 'marginL': this._margins[ 3 ], + 'marginR': this._margins[ 1 ], + 'borderL': this._borders[ 3 ].length, + 'borderR': this._borders[ 1 ].length, + 'jointL': '', + 'jointM': '', + 'jointR': '', + 'columnSeparator': this._columnSeparator, + 'mode': this._horizontalSeparatorMode + }; + + // Define a "row" context for rendering column data: + rctx = { + 'columnWidths': colWidths, + 'maxWidths': this._maxCellWidth, + 'marginL': this._margins[ 3 ], + 'marginR': this._margins[ 1 ], + 'paddingL': this._paddingLeft, + 'paddingR': this._paddingRight, + 'borderL': this._borders[ 3 ], + 'borderR': this._borders[ 1 ], + 'columnSeparator': this._columnSeparator, + 'alignments': this._align + }; + + // Initialize an array for pushing rendered lines: + out = []; // Render top margin: - out += repeat( '\n', this._marginY ); + out = renderVerticalMargin( out, this._margins[ 0 ] ); - // Render table: - wraps = []; - for ( j = 0; j < wrapIndices.length - 1; j++ ) { - table = ''; - verticalLineIdx = 0; - start = wrapIndices[ j ]; - end = wrapIndices[ j + 1 ]; + // Render one or more tables... + for ( j = 0; j < idx.length-1; j++ ) { + start = idx[ j ]; + end = idx[ j+1 ]; + vidx = 0; // Render top border: - if ( borders[ 0 ].length !== 0 ) { - widths = slice( this._columnWidths, start, end ); - table += renderLine( borders[ 0 ], widths, this._corners[ 0 ], this._joints[ 1 ], this._corners[ 1 ] ); // eslint-disable-line max-len - table += '\n'; + if ( this._borders[ 0 ].length > 0 ) { + lctx.jointL = this._corners[ 0 ].value; + lctx.jointM = this._joints[ 1 ].value; + lctx.jointR = this._corners[ 1 ].value; + line = renderLine( start, end, this._borders[ 0 ].graphemes, lctx ); + out.push( line ); if ( this._verticalSeparatorMode === 'interpolate' ) { - verticalLineIdx += 1; + vidx += 1; } } - // Render headers: if ( this._headers ) { - row = slice( this._headers, start, end ); - widths = slice( this._columnWidths, start, end ); - table += renderRow( row, widths ); - table += '\n'; - verticalLineIdx += 1; + line = renderRow( 0, start, end, headers, rctx, vidx ); + out.push( line ); + vidx += 1; } - // Render header separator: - if ( this._headers && headerSeparator.length !== 0 ) { - widths = slice( this._columnWidths, start, end ); - table += renderLine( headerSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len - table += '\n'; + if ( this._headers && this._headerSeparator.length !== 0 ) { + lctx.jointL = this._joints[ 4 ].value; + lctx.jointM = this._joints[ 0 ].value; + lctx.jointR = this._joints[ 2 ].value; + line = renderLine( start, end, this._headerSeparator.graphemes, lctx ); // eslint-disable-line max-len + out.push( line ); if ( this._verticalSeparatorMode === 'interpolate' ) { - verticalLineIdx += 1; + vidx += 1; } else if ( this._verticalSeparatorMode === 'repeat' ) { - verticalLineIdx = 0; + vidx = 0; } } - - // Render data: + // Render table rows: if ( this._data ) { - for ( i = 0; i < this._data.length; i++ ) { - // Render row: - row = slice( this._data[ i ], start, end ); - widths = slice( this._columnWidths, start, end ); - table += renderRow( row, widths ); - if ( i !== this._data.length - 1 ) { - table += '\n'; - } - verticalLineIdx += 1; + for ( i = 0; i < nrows; i++ ) { + // Render a row of table data: + line = renderRow( i, start, end, this._data, rctx, vidx ); + out.push( line ); + vidx += 1; // Render row separator: - if ( rowSeparator.length !== 0 && i !== this._data.length - 1 ) { // eslint-disable-line max-len - widths = slice( this._columnWidths, start, end ); - table += renderLine( rowSeparator, widths, this._joints[ 4 ], this._joints[ 0 ], this._joints[ 2 ] ); // eslint-disable-line max-len - table += '\n'; + if ( this._rowSeparator.length > 0 && i < nrows-1 ) { + lctx.jointL = this._joints[ 4 ].value; + lctx.jointM = this._joints[ 0 ].value; + lctx.jointR = this._joints[ 2 ].value; + line = renderLine( start, end, this._rowSeparator.graphemes, lctx ); // eslint-disable-line max-len + out.push( line ); if ( this._verticalSeparatorMode === 'interpolate' ) { - verticalLineIdx += 1; + vidx += 1; } else if ( this._verticalSeparatorMode === 'repeat' ) { - verticalLineIdx = 0; + vidx = 0; } } } } - // Render bottom border: - if ( borders[ 2 ].length !== 0 ) { - table += '\n'; - widths = slice( this._columnWidths, start, end ); - table += renderLine( borders[ 2 ], widths, this._corners[ 3 ], this._joints[ 3 ], this._corners[ 2 ] ); // eslint-disable-line max-len + if ( this._borders[ 2 ].length > 0 ) { + lctx.jointL = this._corners[ 3 ].value; + lctx.jointM = this._joints[ 3 ].value; + lctx.jointR = this._corners[ 2 ].value; + line = renderLine( start, end, this._borders[ 2 ].graphemes, lctx ); + out.push( line ); } - wraps.push( table ); } - out += wraps.join( '\n' ); - // Render bottom margin: - out += repeat( '\n', this._marginY ); + out = renderVerticalMargin( out, this._margins[ 2 ] ); + + // Convert the output array to a newline-delimited string: + out = out.join( '\n' ); this.emit( 'render', out ); return out; - - /** - * Resolves table properties for rendering. - * - * @private - */ - function resolveProps() { - var i; - if ( isString( self._alignment ) ) { - alignments = filled( self._alignment, self._numColumns ); - } else { - alignments = self._alignment; - } - if ( isNonNegativeInteger( self._cellPaddingLeft ) ) { - paddingsLeft = filled( self._cellPaddingLeft, self._numColumns ); - } else { - paddingsLeft = self._cellPaddingLeft; - } - if ( isNonNegativeInteger( self._cellPaddingRight ) ) { - paddingsRight = filled( self._cellPaddingRight, self._numColumns ); - } else { - paddingsRight = self._cellPaddingRight; - } - if ( isNonNegativeInteger( self._maxCellWidth ) ) { - maxCellWidths = filled( self._maxCellWidth, self._numColumns ); - } else { - maxCellWidths = self._maxCellWidth; - } - borders = []; - for ( i = 0; i < self._borders.length; i++ ) { - borders.push( splitGraphemeClusters( self._borders[ i ] ) ); - } - columnSeparator = splitGraphemeClusters( self._columnSeparator ); - headerSeparator = splitGraphemeClusters( self._headerSeparator ); - rowSeparator = splitGraphemeClusters( self._rowSeparator ); - } - - /** - * Resolves columns to wrap the table at (includes bounding indices). - * - * @private - * @throws {Error} output must be able to accommodate every column individually - * @returns {Array} list of column indices - */ - function resolveWrapping() { - var outputWidth; - var fixedLength; - var indices; - - // Initialize with zeroth index: - indices = [ 0 ]; - - // Calculate fixed horizontal length: - fixedLength = 2 * self._marginX; - if ( borders[ 1 ] !== 0 ) { - fixedLength += 1; - } - if ( borders[ 3 ] !== 0 ) { - fixedLength += 1; - } - if ( !self._columnWidths ) { - return indices; - } - outputWidth = 0; - for ( i = 0; i < self._columnWidths.length; i++ ) { - outputWidth += min( self._columnWidths[ i ] + ( paddingsLeft[ i ] + paddingsRight[ i ] ), maxCellWidths[ i ] ); // eslint-disable-line max-len - - // If output crosses the maximum, time to wrap: - if ( outputWidth + fixedLength > self._maxOutputWidth ) { - if ( i === indices[ indices.length - 1 ] ) { - // The output width cannot accommodate current column: - throw new Error( format( 'invalid operation. `maxOutputWidth` must be able to accommodate every column individually. Value: `%s`', self._maxOutputWidth ) ); - } - indices.push( i ); - outputWidth = 0; - continue; - } - // Include column separator. Exclude for last column as we included them as borders: - if ( i !== self._columnWidths.length - 1 && columnSeparator.length !== 0 ) { // eslint-disable-line max-len - outputWidth += 1; - } - } - // Include last bounding index: - indices.push( self._columnWidths.length ); - return indices; - } - - /** - * Renders a line. - * - * @private - * @param {string} lineChars - line character - * @param {Array} columnWidths - column widths - * @param {string} jointL - left joint - * @param {string} jointM - middle joint - * @param {jointR} jointR - right joint - * @returns {string} rendered line - */ - function renderLine( lineChars, columnWidths, jointL, jointM, jointR ) { - var horizontalLineIdx; - var colWidth; - var out; - var i; - var j; - - out = ''; - horizontalLineIdx = 0; - - // Render left margin: - out += repeat( ' ', self._marginX ); - - // Render left joint: - if ( borders[ 3 ].length !== 0 ) { - out += jointL; - if ( self._horizontalSeparatorMode === 'interpolate' ) { - horizontalLineIdx += 1; - } - } - // Render line: - for ( i = 0; i < columnWidths.length; i++ ) { - // If columns are separated, render the middle joint... - if ( columnSeparator.length !== 0 && i !== 0 ) { - out += jointM; - if ( self._horizontalSeparatorMode === 'interpolate' ) { - horizontalLineIdx += 1; - } else if ( self._horizontalSeparatorMode === 'repeat' ) { - horizontalLineIdx = 0; - } - } - colWidth = min( columnWidths[ i ] + ( paddingsLeft[ i ] + paddingsRight[ i ] ), maxCellWidths[ i ] ); // eslint-disable-line max-len - for ( j = 0; j < colWidth; j++ ) { - out += lineChars[ horizontalLineIdx % lineChars.length ]; - horizontalLineIdx += 1; - } - } - // Render right joint: - if ( borders[ 1 ].length !== 0 ) { - out += jointR; - } - // Render right margin: - out += repeat( ' ', self._marginX ); - return out; - } - - /** - * Renders a data row. - * - * @private - * @param {Array} data - row data - * @param {Array} columnWidths - column widths - * @returns {string} rendered line - */ - function renderRow( data, columnWidths ) { - var maxDatumWidth; - var width; - var datum; - var out; - var i; - - out = ''; - - // Render left margin: - out += repeat( ' ', self._marginX ); - - // Render left border: - if ( borders[ 3 ].length !== 0 ) { - out += borders[ 3 ][ verticalLineIdx % borders[ 3 ].length ]; - } - for ( i = 0; i < columnWidths.length; i++ ) { - // Render column separator... - if ( columnSeparator.length !== 0 && i !== 0 ) { - out += columnSeparator[ verticalLineIdx % columnSeparator.length ]; // eslint-disable-line max-len - } - // Render left cell padding: - out += repeat( ' ', paddingsLeft[ i ] ); - - // If datum is longer than what is allowed by `maxCellWidth`, truncate it... - datum = String( data[ i ] ); - maxDatumWidth = maxCellWidths[ i ] - ( paddingsLeft[ i ] + paddingsRight[ i ] ); // eslint-disable-line max-len - width = columnWidths[ i ]; - if ( width > maxDatumWidth ) { - datum = truncate( datum, maxDatumWidth ); - width = maxDatumWidth; - } - // Render datum: - switch ( alignments[ i ] ) { - case 'left': - out += datum; - out += repeat( ' ', width - datum.length ); - break; - case 'center': - out += repeat( ' ', ceil( ( width - datum.length ) / 2 ) ); - out += datum; - out += repeat( ' ', floor( ( width - datum.length ) / 2 ) ); - break; - case 'right': - out += repeat( ' ', width - datum.length ); - out += datum; - break; - default: - break; - } - // Render right cell padding: - out += repeat( ' ', paddingsRight[ i ] ); - } - // Render right border: - if ( borders[ 1 ].length !== 0 ) { - out += borders[ 1 ][ verticalLineIdx % borders[ 1 ].length ]; - } - // Render right margin: - out += repeat( ' ', self._marginX ); - return out; - } } From 2fe6d53a341d6bc0aa278327b67e144434fd108b Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 11 Feb 2025 09:45:57 +0000 Subject: [PATCH 06/34] chore: update copyright years --- lib/node_modules/@stdlib/plot/table/unicode/README.md | 2 +- .../@stdlib/plot/table/unicode/benchmark/benchmark.js | 2 +- .../@stdlib/plot/table/unicode/benchmark/benchmark.render.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/examples/index.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/index.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/main.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/align/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/align/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/auto-render/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/auto-render/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-bottom/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-bottom/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-top/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-top/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/borders/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/borders/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/buffer-size/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/buffer-size/set.js | 2 +- .../plot/table/unicode/lib/props/column-separator/get.js | 2 +- .../plot/table/unicode/lib/props/column-separator/set.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-left/get.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-left/set.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-right/get.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js | 2 +- .../plot/table/unicode/lib/props/corner-top-right/get.js | 2 +- .../plot/table/unicode/lib/props/corner-top-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corners/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corners/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/data/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/data/set.js | 2 +- .../plot/table/unicode/lib/props/header-separator/get.js | 2 +- .../plot/table/unicode/lib/props/header-separator/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/headers/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/headers/set.js | 2 +- .../table/unicode/lib/props/horizontal-separator-mode/get.js | 2 +- .../table/unicode/lib/props/horizontal-separator-mode/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-middle/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-middle/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-top/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-top/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joints/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joints/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-top/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-top/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margins/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margins/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-width/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-width/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/row-separator/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/row-separator/set.js | 2 +- .../plot/table/unicode/lib/props/vertical-separator-mode/get.js | 2 +- .../plot/table/unicode/lib/props/vertical-separator-mode/set.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/push.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/render.js | 2 +- .../@stdlib/plot/table/unicode/test/test.alignment.js | 2 +- .../@stdlib/plot/table/unicode/test/test.auto_render.js | 2 +- .../@stdlib/plot/table/unicode/test/test.borders.js | 2 +- .../@stdlib/plot/table/unicode/test/test.buffer_size.js | 2 +- .../@stdlib/plot/table/unicode/test/test.cell_padding_left.js | 2 +- .../@stdlib/plot/table/unicode/test/test.cell_padding_right.js | 2 +- .../@stdlib/plot/table/unicode/test/test.column_separator.js | 2 +- .../@stdlib/plot/table/unicode/test/test.corners.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js | 2 +- .../@stdlib/plot/table/unicode/test/test.header_separator.js | 2 +- .../@stdlib/plot/table/unicode/test/test.headers.js | 2 +- .../plot/table/unicode/test/test.horizontal_separator_mode.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js | 2 +- .../@stdlib/plot/table/unicode/test/test.margin_x.js | 2 +- .../@stdlib/plot/table/unicode/test/test.margin_y.js | 2 +- .../@stdlib/plot/table/unicode/test/test.max_cell_width.js | 2 +- .../@stdlib/plot/table/unicode/test/test.max_output_width.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js | 2 +- .../@stdlib/plot/table/unicode/test/test.row_separator.js | 2 +- .../plot/table/unicode/test/test.vertical_separator_mode.js | 2 +- 104 files changed, 104 insertions(+), 104 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 148ac9cde14b..627d7ac129b8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2024 The Stdlib Authors. +Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index 2ca75487fb68..747088dc509c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js index 19a7d847c4ad..581b31276824 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 94ee231b1446..a59e4f89f4d8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index ede272af4943..e87886674981 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js index 83516c6834b3..7ce28c7872ed 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js index 5e0c90062302..b26a88326868 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 1037107056c3..d8ed375c352d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js index da864865ecf7..853a535cda3e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js index 267c6ad61881..331e99624f02 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js index 790280334aef..cdb60cfc9c29 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js index 698a606fa709..90f0e2c275ff 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js index 632531a5242c..c58a9d052c1d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index 56372b8779d6..fe29a638634f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js index 242b97064e44..be3d6698b140 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index b4812f0c3871..7e791dc65323 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js index de77eee7a524..3a54aff7e65c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index d063bc0131c7..0657776f53e8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js index 533d7a64ac43..51040187f4c5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index a3fd38797ed0..4ef04b31c5e9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js index 96d7b3a389d9..750b41958a9d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index df117d9d0a76..9cab54d6c96b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js index 6c1042af9251..6ebd438a2dd5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js index 5c1d473ef839..557d12e6d514 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js index 39376ad4ce35..3c7d942d1993 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 93487a281c7d..576166ebceaf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js index 15403f5cf60b..7e259f29e281 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 8c571b151c1e..ed8f7165e580 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js index 8b7fbba89830..f5b80542be91 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 7c57d5de9546..6164a9e7e60d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js index 75987df00fc4..cb074bd55b83 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index a1b2c5c9d376..d2ec6030482c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js index cec1d97f5069..1e06d2534890 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index a0095c9c12bb..5b7fa8db00f0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js index 4b3dadca5a16..92508e499359 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index d3a5905b74d0..76080989586f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js index e71010fa8bc9..6c7a7fddd5ae 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index 7e76acdb26ef..b980a2bc64c3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js index d495b513093f..06ca94fedf78 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index dbf98f4ad010..6189989e2268 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js index 0b60b91a3cd7..cad5aaab7349 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index 3b74da482d90..027a05729ace 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js index ff7a9a0b4b55..5fe60b31a75d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js index 0f9d367065f4..7437153f0a3f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js index 18ab17069f35..62fefcc27639 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 69767ea4da9e..a8dfb301b913 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js index fae760254809..8e39e4c93703 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index df9581860767..fb85b046462e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js index ed7cc9f99592..2530b2e2bf34 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index cfb707e1bd60..307c7fd44473 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js index 4b6789df989c..10c3de867fed 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index 164ebb50da2c..77c28a63176e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js index f02397d558c5..5801f28f4fb7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index 7fc7cf5ad1a2..c7e8d19a670d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js index 3715c668ed35..35342a1f8a09 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 6a391ce98662..7c29add757ad 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js index fd07f8562101..cca4ecf1f1d5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js index 8e27f129595e..20d947b126d9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js index 7c714e7c32b9..60d07ab925b7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js index 0b102fa77edf..5d963ae81725 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js index 62cffa1a34db..2a44f953ec4f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js index d8d2cc6979c1..55de5f768ba6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js index 42cd6a30a011..c04cd9c5e295 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js index d11611dc2992..d3083b291e9d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js index c3cc25de9d3b..3ec4f567c710 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js index 80be2f39ccc1..8b6b11113436 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js index 8722ed45d8ec..7c874f925da3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js index 34742e694c34..dfbc675f1303 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js index c0b66e2d7b5e..18d9347136b8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js index 1774d8119ca9..4448644a2717 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js index d3da1b6a3cb7..6a6de580238a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js index aaca27371e4d..12c32b2f3825 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js index 50703e027068..009f65e9a89d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js index 378c252f46de..213dd244227e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js index 911273e299c6..288229454f76 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index 16e49c6d8169..e1880058ef11 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js index 66cbc2904d7b..27e5dd3b4a3f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js index e05041642de1..3caa819734a3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index 976e3d45e9ac..aeb254847396 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 19773b45b780..2f795a06fcfa 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js index 0fa4b33bbf2b..ab0ab2bf4c0c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js index 05bbdbe6c379..7d97b96eb9dd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js index 086c9d6d8885..2db9916b098c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js index b44594ac2e68..077b4d703f1f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js index 51486f34c220..a959f06f3da0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js index 15655cb96d46..a55c1efea2ff 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js index 9cc52ba6ca42..40e584a68748 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js index 18d774c1abc1..7dbb7456af15 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js index fee3f5527cc3..f331b64e3c4e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js index fc5ecaac3057..684fbf0e9f7f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js index fdffdba4976d..0e97e5d6cb65 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js index eee3b275a76e..aead2f2fde37 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js index f414ae198739..2cb31f24cb16 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.js index 9858a4d627f6..55df92cea146 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js index 9ed2bf13acc9..3226b8eec5b6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js index e119935f5776..d65a35e89699 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js index aceff08bed43..ffdb0621d548 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js index c44982a0f1c7..e29a1ed015b7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js index 41560f3d54e2..15f6142322ff 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js index 47180d39e893..da2618b5e101 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js index 92467d17b9c2..35c842a5a2f0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js index 582217e2958a..376a44402bfd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js index 9f8d6db4e535..7648decfa8f8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js index d8a49ae57697..c36f603764ce 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. From 68986f4160dc83cd60439b65fbdd8b32d0976171 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 11 Feb 2025 09:45:57 +0000 Subject: [PATCH 07/34] chore: update copyright years --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- lib/node_modules/@stdlib/plot/table/unicode/README.md | 2 +- .../@stdlib/plot/table/unicode/benchmark/benchmark.js | 2 +- .../@stdlib/plot/table/unicode/benchmark/benchmark.render.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/examples/index.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/index.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/main.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/align/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/align/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/auto-render/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/auto-render/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-bottom/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-bottom/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-top/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/border-top/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/borders/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/borders/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/buffer-size/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/buffer-size/set.js | 2 +- .../plot/table/unicode/lib/props/column-separator/get.js | 2 +- .../plot/table/unicode/lib/props/column-separator/set.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-left/get.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-left/set.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-right/get.js | 2 +- .../plot/table/unicode/lib/props/corner-bottom-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js | 2 +- .../plot/table/unicode/lib/props/corner-top-right/get.js | 2 +- .../plot/table/unicode/lib/props/corner-top-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corners/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/corners/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/data/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/data/set.js | 2 +- .../plot/table/unicode/lib/props/header-separator/get.js | 2 +- .../plot/table/unicode/lib/props/header-separator/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/headers/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/headers/set.js | 2 +- .../table/unicode/lib/props/horizontal-separator-mode/get.js | 2 +- .../table/unicode/lib/props/horizontal-separator-mode/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-middle/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-middle/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-top/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joint-top/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joints/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/joints/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-top/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margin-top/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margins/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/margins/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-width/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/max-width/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-left/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-left/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-right/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/padding-right/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/row-separator/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/props/row-separator/set.js | 2 +- .../plot/table/unicode/lib/props/vertical-separator-mode/get.js | 2 +- .../plot/table/unicode/lib/props/vertical-separator-mode/set.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/push.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/lib/render.js | 2 +- .../@stdlib/plot/table/unicode/test/test.alignment.js | 2 +- .../@stdlib/plot/table/unicode/test/test.auto_render.js | 2 +- .../@stdlib/plot/table/unicode/test/test.borders.js | 2 +- .../@stdlib/plot/table/unicode/test/test.buffer_size.js | 2 +- .../@stdlib/plot/table/unicode/test/test.cell_padding_left.js | 2 +- .../@stdlib/plot/table/unicode/test/test.cell_padding_right.js | 2 +- .../@stdlib/plot/table/unicode/test/test.column_separator.js | 2 +- .../@stdlib/plot/table/unicode/test/test.corners.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js | 2 +- .../@stdlib/plot/table/unicode/test/test.header_separator.js | 2 +- .../@stdlib/plot/table/unicode/test/test.headers.js | 2 +- .../plot/table/unicode/test/test.horizontal_separator_mode.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js | 2 +- .../@stdlib/plot/table/unicode/test/test.margin_x.js | 2 +- .../@stdlib/plot/table/unicode/test/test.margin_y.js | 2 +- .../@stdlib/plot/table/unicode/test/test.max_cell_width.js | 2 +- .../@stdlib/plot/table/unicode/test/test.max_output_width.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js | 2 +- lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js | 2 +- .../@stdlib/plot/table/unicode/test/test.row_separator.js | 2 +- .../plot/table/unicode/test/test.vertical_separator_mode.js | 2 +- 104 files changed, 104 insertions(+), 104 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 148ac9cde14b..627d7ac129b8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -2,7 +2,7 @@ @license Apache-2.0 -Copyright (c) 2024 The Stdlib Authors. +Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index 2ca75487fb68..747088dc509c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js index 19a7d847c4ad..581b31276824 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 94ee231b1446..a59e4f89f4d8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index ede272af4943..e87886674981 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js index 83516c6834b3..7ce28c7872ed 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/every_by2.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js index 5e0c90062302..b26a88326868 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/index.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 1037107056c3..d8ed375c352d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js index da864865ecf7..853a535cda3e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js index 267c6ad61881..331e99624f02 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js index 790280334aef..cdb60cfc9c29 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js index 698a606fa709..90f0e2c275ff 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/auto-render/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js index 632531a5242c..c58a9d052c1d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index 56372b8779d6..fe29a638634f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js index 242b97064e44..be3d6698b140 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index b4812f0c3871..7e791dc65323 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js index de77eee7a524..3a54aff7e65c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index d063bc0131c7..0657776f53e8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js index 533d7a64ac43..51040187f4c5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index a3fd38797ed0..4ef04b31c5e9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js index 96d7b3a389d9..750b41958a9d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index df117d9d0a76..9cab54d6c96b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js index 6c1042af9251..6ebd438a2dd5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js index 5c1d473ef839..557d12e6d514 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js index 39376ad4ce35..3c7d942d1993 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 93487a281c7d..576166ebceaf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js index 15403f5cf60b..7e259f29e281 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 8c571b151c1e..ed8f7165e580 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js index 8b7fbba89830..f5b80542be91 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 7c57d5de9546..6164a9e7e60d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js index 75987df00fc4..cb074bd55b83 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index a1b2c5c9d376..d2ec6030482c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js index cec1d97f5069..1e06d2534890 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index a0095c9c12bb..5b7fa8db00f0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js index 4b3dadca5a16..92508e499359 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index d3a5905b74d0..76080989586f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js index e71010fa8bc9..6c7a7fddd5ae 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index 7e76acdb26ef..b980a2bc64c3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js index d495b513093f..06ca94fedf78 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index dbf98f4ad010..6189989e2268 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js index 0b60b91a3cd7..cad5aaab7349 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index 3b74da482d90..027a05729ace 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js index ff7a9a0b4b55..5fe60b31a75d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js index 0f9d367065f4..7437153f0a3f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/horizontal-separator-mode/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js index 18ab17069f35..62fefcc27639 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 69767ea4da9e..a8dfb301b913 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js index fae760254809..8e39e4c93703 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index df9581860767..fb85b046462e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js index ed7cc9f99592..2530b2e2bf34 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index cfb707e1bd60..307c7fd44473 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js index 4b6789df989c..10c3de867fed 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index 164ebb50da2c..77c28a63176e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js index f02397d558c5..5801f28f4fb7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index 7fc7cf5ad1a2..c7e8d19a670d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js index 3715c668ed35..35342a1f8a09 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 6a391ce98662..7c29add757ad 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js index fd07f8562101..cca4ecf1f1d5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js index 8e27f129595e..20d947b126d9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-bottom/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js index 7c714e7c32b9..60d07ab925b7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js index 0b102fa77edf..5d963ae81725 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js index 62cffa1a34db..2a44f953ec4f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js index d8d2cc6979c1..55de5f768ba6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js index 42cd6a30a011..c04cd9c5e295 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js index d11611dc2992..d3083b291e9d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margin-top/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js index c3cc25de9d3b..3ec4f567c710 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js index 80be2f39ccc1..8b6b11113436 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/margins/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js index 8722ed45d8ec..7c874f925da3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js index 34742e694c34..dfbc675f1303 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js index c0b66e2d7b5e..18d9347136b8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js index 1774d8119ca9..4448644a2717 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js index d3da1b6a3cb7..6a6de580238a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js index aaca27371e4d..12c32b2f3825 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js index 50703e027068..009f65e9a89d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js index 378c252f46de..213dd244227e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js index 911273e299c6..288229454f76 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index 16e49c6d8169..e1880058ef11 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js index 66cbc2904d7b..27e5dd3b4a3f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/get.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js index e05041642de1..3caa819734a3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/vertical-separator-mode/set.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index 976e3d45e9ac..aeb254847396 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 19773b45b780..2f795a06fcfa 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js index 0fa4b33bbf2b..ab0ab2bf4c0c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.alignment.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js index 05bbdbe6c379..7d97b96eb9dd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.auto_render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js index 086c9d6d8885..2db9916b098c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.borders.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js index b44594ac2e68..077b4d703f1f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.buffer_size.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js index 51486f34c220..a959f06f3da0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_left.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js index 15655cb96d46..a55c1efea2ff 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.cell_padding_right.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js index 9cc52ba6ca42..40e584a68748 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.column_separator.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js index 18d774c1abc1..7dbb7456af15 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.corners.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js index fee3f5527cc3..f331b64e3c4e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.data.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js index fc5ecaac3057..684fbf0e9f7f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.header_separator.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js index fdffdba4976d..0e97e5d6cb65 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.headers.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js index eee3b275a76e..aead2f2fde37 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.horizontal_separator_mode.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js index f414ae198739..2cb31f24cb16 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.joints.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.js index 9858a4d627f6..55df92cea146 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js index 9ed2bf13acc9..3226b8eec5b6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js index e119935f5776..d65a35e89699 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_x.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js index aceff08bed43..ffdb0621d548 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.margin_y.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js index c44982a0f1c7..e29a1ed015b7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js index 41560f3d54e2..15f6142322ff 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_output_width.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js index 47180d39e893..da2618b5e101 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.parse.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js index 92467d17b9c2..35c842a5a2f0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.push.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js index 582217e2958a..376a44402bfd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js index 9f8d6db4e535..7648decfa8f8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.row_separator.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js index d8a49ae57697..c36f603764ce 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.vertical_separator_mode.js @@ -1,7 +1,7 @@ /** * @license Apache-2.0 * -* Copyright (c) 2024 The Stdlib Authors. +* Copyright (c) 2025 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. From 4a4b5ec3302a1801501657058b031a15abbb11b2 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 12 Feb 2025 16:24:42 -0800 Subject: [PATCH 08/34] refactor: implement a FIFO array and refactor `push` logic --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 12 +- .../plot/table/unicode/examples/index.js | 35 + .../plot/table/unicode/lib/array2matrix.js | 51 + .../table/unicode/lib/convert_collection.js | 97 ++ .../table/unicode/lib/convert_dictionary.js | 104 ++ .../plot/table/unicode/lib/defaults.js | 32 +- .../@stdlib/plot/table/unicode/lib/fifo.js | 896 ++++++++++++++++++ .../@stdlib/plot/table/unicode/lib/main.js | 1 - .../plot/table/unicode/lib/normalize.js | 65 ++ .../unicode/lib/props/border-bottom/set.js | 2 +- .../unicode/lib/props/border-left/set.js | 2 +- .../unicode/lib/props/border-right/set.js | 2 +- .../table/unicode/lib/props/border-top/set.js | 2 +- .../table/unicode/lib/props/borders/set.js | 2 +- .../unicode/lib/props/buffer-size/set.js | 31 +- .../unicode/lib/props/column-separator/set.js | 2 +- .../lib/props/corner-bottom-left/set.js | 2 +- .../lib/props/corner-bottom-right/set.js | 2 +- .../unicode/lib/props/corner-top-left/set.js | 2 +- .../unicode/lib/props/corner-top-right/set.js | 2 +- .../table/unicode/lib/props/corners/set.js | 2 +- .../plot/table/unicode/lib/props/data/get.js | 45 +- .../plot/table/unicode/lib/props/data/set.js | 198 +--- .../unicode/lib/props/header-separator/set.js | 2 +- .../table/unicode/lib/props/headers/set.js | 2 +- .../unicode/lib/props/joint-bottom/set.js | 2 +- .../table/unicode/lib/props/joint-left/set.js | 2 +- .../unicode/lib/props/joint-middle/set.js | 2 +- .../unicode/lib/props/joint-right/set.js | 2 +- .../table/unicode/lib/props/joint-top/set.js | 2 +- .../table/unicode/lib/props/joints/set.js | 2 +- .../unicode/lib/props/row-separator/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/push.js | 181 +++- .../@stdlib/plot/table/unicode/lib/render.js | 53 +- 34 files changed, 1565 insertions(+), 276 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/array2matrix.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/convert_collection.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/convert_dictionary.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/fifo.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 627d7ac129b8..2e6111de403f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -276,6 +276,8 @@ var borders = table.borders; Data buffer size. If set, this specifies the maximum number of rows which can be rendered. Once an internal data buffer is full, each new row results in the oldest row being removed. ```javascript +var ndarray2array = require( '@stdlib/ndarray/to-array' ); + var table = new UnicodeTable(); // Set: @@ -287,12 +289,12 @@ var size = table.bufferSize; table.data = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]; -var data = table.data; +var data = ndarray2array( table.data ); // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] table.push( [ 7, 8 ] ); -data = table.data; +data = ndarray2array( table.data ); // returns [ [ 3, 4 ], [ 5, 6 ], [ 7, 8 ] ] ``` @@ -419,6 +421,8 @@ var data = ndarray2array( table.data ); // returns [ [ 1, 2 ], [ 3, 4 ] ] ``` +The returned [ndarray][@stdlib/ndarray/ctor] is a **read-only** view of table data. + #### UnicodeTable.prototype.headers @@ -828,7 +832,9 @@ Renders a Unicode table. var headers = [ 'col1', 'col2', 'col3' ]; var data = [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]; -var table = new UnicodeTable( data, headers ); +var table = new UnicodeTable( data, { + 'headers': headers +}); var str = table.render(); // returns '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index a59e4f89f4d8..9caf0e74ee7d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -45,3 +45,38 @@ var table = new UnicodeTable( data, { var str = table.render(); console.log( str ); // => '...' + +// Push new data to the table: +table.push( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' + +// Limit the number of table rows: +table.bufferSize = 10; + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' + +// Push new data to the table: +table.push( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' + +// Increase the number of allowed table rows: +table.bufferSize = 15; + +// Push new data to the table: +table.push( [ 11.0, 12.0, 13.0, 14.0, 15.0 ] ); + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/array2matrix.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/array2matrix.js new file mode 100644 index 000000000000..5fd3360237ce --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/array2matrix.js @@ -0,0 +1,51 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var FifoArray = require( './fifo.js' ); + + +// VARIABLES // + +var DTYPE = 'generic'; +var ORDER = 'row-major'; + + +// MAIN // + +/** +* Creates a two-dimensional ndarray having a specified data buffer and shape. +* +* @private +* @param {Collection} buffer - data buffer +* @param {NonNegativeIntegerArray} shape - shape +* @returns {ndarray} two-dimensional ndarray +*/ +function array2matrix( buffer, shape ) { + return new ndarray( DTYPE, new FifoArray( buffer ), shape, shape2strides( shape, ORDER ), 0, ORDER ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = array2matrix; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/convert_collection.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/convert_collection.js new file mode 100644 index 000000000000..9f076cc4743e --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/convert_collection.js @@ -0,0 +1,97 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 hasOwnProp = require( '@stdlib/assert/has-own-property' ); +var flatten2d = require( '@stdlib/array/base/flatten2d' ); +var shape = require( '@stdlib/array/shape' ); +var objectKeys = require( '@stdlib/utils/keys' ); +var array2matrix = require( './array2matrix.js' ); + + +// FUNCTIONS // + +/** +* Converts table data provided as an array-like object. +* +* @private +* @param {Collection} data - input data +* @param {(ObjectArray|null)} headers - table headers +* @throws {TypeError} invalid input data +* @returns {Object} table data +*/ +function convertCollection( data, headers ) { + var keys; + var out; + var flg; + var obj; + var sh; + var d; + var i; + var j; + var k; + + obj = { + 'data': null, + 'headers': null, + 'code': '' + }; + + sh = shape( data ); + + // If we were provided a nested array, flatten in row-major order... + if ( sh.length >= 2 ) { + sh = [ sh[ 0 ], sh[ 1 ] ]; // only concern ourselves with the first two dimensions + obj.data = array2matrix( flatten2d( data, sh, false ), sh ); + return obj; + } + // If we were provided a one-dimensional array, assume that we were provided a list of objects... + + // If we don't already have headers, infer the headers from the first array element... + if ( headers === null ) { + keys = objectKeys( data[ 0 ] ); + flg = true; + } else { + keys = headers; + } + out = []; + for ( i = 0; i < sh[ 0 ]; i++ ) { + d = data[ i ]; + for ( j = 0; j < keys.length; j++ ) { + k = keys[ j ]; + if ( hasOwnProp( d, k ) ) { + out.push( d[ k ] ); + } else { + obj.headers = keys; + obj.code = 'ERR_MISSING_COLUMNS'; + return obj; + } + } + } + obj.data = array2matrix( out, [ sh[ 0 ], keys.length ] ); + obj.headers = ( flg ) ? keys : null; + return obj; +} + + +// EXPORTS // + +module.exports = convertCollection; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/convert_dictionary.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/convert_dictionary.js new file mode 100644 index 000000000000..8f8318782641 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/convert_dictionary.js @@ -0,0 +1,104 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 isCollection = require( '@stdlib/assert/is-collection' ); +var objectKeys = require( '@stdlib/utils/keys' ); +var array2matrix = require( './array2matrix.js' ); + + +// MAIN // + +/** +* Converts table data provided as a dictionary of columns. +* +* @private +* @param {*} data - input data +* @param {(ObjectArray|null)} headers - table headers +* @throws {TypeError} invalid input data +* @returns {Object} table data +*/ +function convertDictionary( data, headers ) { + var keys; + var out; + var flg; + var obj; + var col; + var M; + var N; + var i; + var j; + var k; + + obj = { + 'data': null, + 'headers': null, + 'code': '' + }; + + // If we don't already have headers, infer the headers from the provided object... + if ( headers === null ) { + keys = objectKeys( data ); + flg = true; + } else { + keys = headers; + } + // If provided an empty object (or an object without enumerable properties), likely a user error... + if ( keys.length === 0 ) { + obj.code = 'ERR_EMPTY_OBJECT'; + return obj; + } + // Validate that property value is a collection (column) of data having the same length... + col = data[ keys[ 0 ] ]; + if ( !isCollection( col ) ) { + obj.code = 'ERR_INVALID_OBJECT'; + return obj; + } + M = col.length; + N = keys.length; + for ( i = 1; i < N; i++ ) { + col = data[ keys[ i ] ]; + if ( !isCollection( col ) ) { + obj.code = 'ERR_INVALID_OBJECT'; + return obj; + } + if ( col.length !== M ) { + obj.code = 'ERR_UNEQUAL_COLUMN_LENGTHS'; + return obj; + } + } + // Flatten the dictionary of columns into a row-major linear buffer... + out = []; + for ( i = 0; i < M; i++ ) { + for ( j = 0; j < N; j++ ) { + k = keys[ j ]; + out.push( data[ k ][ i ] ); + } + } + obj.data = array2matrix( out, [ M, N ] ); + obj.headers = ( flg ) ? keys : null; + return obj; +} + + +// EXPORTS // + +module.exports = convertDictionary; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index e87886674981..fa52023d585b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -46,25 +46,25 @@ function defaults() { 'value': '-', 'graphemes': [ '-' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '|', 'graphemes': [ '|' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '-', 'graphemes': [ '-' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '|', 'graphemes': [ '|' ], - 'length': 1 + 'ngraphemes': 1 } ]; @@ -77,25 +77,25 @@ function defaults() { 'value': '┌', 'graphemes': [ '┌' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '┐', 'graphemes': [ '┐' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '┘', 'graphemes': [ '┘' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '└', 'graphemes': [ '└' ], - 'length': 1 + 'ngraphemes': 1 } ]; @@ -103,7 +103,7 @@ function defaults() { out.columnSeparator = { 'value': '|', 'graphemes': [ '|' ], - 'length': 1 + 'ngraphemes': 1 }; // Column headers: @@ -113,7 +113,7 @@ function defaults() { out.headerSeparator = { 'value': '-', 'graphemes': [ '-' ], - 'length': 1 + 'ngraphemes': 1 }; // Horizontal line separator mode: @@ -125,31 +125,31 @@ function defaults() { 'value': '┼', 'graphemes': [ '┼' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '┬', 'graphemes': [ '┬' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '┤', 'graphemes': [ '┤' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '┴', 'graphemes': [ '┴' ], - 'length': 1 + 'ngraphemes': 1 }, { 'value': '├', 'graphemes': [ '├' ], - 'length': 1 + 'ngraphemes': 1 } ]; @@ -170,7 +170,7 @@ function defaults() { out.rowSeparator = { 'value': '', 'graphemes': [], - 'length': 0 + 'ngraphemes': 0 }; // Vertical line separator mode: diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/fifo.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/fifo.js new file mode 100644 index 000000000000..e69f1a781941 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/fifo.js @@ -0,0 +1,896 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-restricted-syntax, no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive; +var isArray = require( '@stdlib/assert/is-array' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var setReadOnlyAccessor = require( '@stdlib/utils/define-nonenumerable-read-only-accessor' ); +var setNonEnumerableProperty = require( '@stdlib/utils/define-nonenumerable-property' ); +var min = require( '@stdlib/math/base/special/fast/min' ); +var zeros = require( '@stdlib/array/base/zeros' ); +var resolveGetter = require( '@stdlib/array/base/resolve-getter' ); +var format = require( '@stdlib/string/format' ); + + +// FUNCTIONS // + +/** +* Returns a boolean indicating if a value is a FIFO array. +* +* @private +* @param {*} value - value to test +* @returns {boolean} boolean indicating if a value is a FIFO array +*/ +function isFifoArray( value ) { + return ( + value instanceof FifoArray || + ( + typeof value === 'object' && + value !== null && + value.constructor.name === 'FifoArray' && + typeof value._length === 'number' && // eslint-disable-line no-underscore-dangle + typeof value._offset === 'number' && // eslint-disable-line no-underscore-dangle + typeof value._buffer === 'object' // eslint-disable-line no-underscore-dangle + ) + ); +} + +/** +* Resolves an index into the underlying buffer. +* +* @private +* @param {NonNegativeInteger} size - capacity +* @param {NonNegativeInteger} offset - index of the first indexed element +* @param {NonNegativeInteger} idx - view index +* @returns {NonNegativeInteger} buffer index +*/ +function toIndex( size, offset, idx ) { + return ( offset+idx ) % size; +} + + +// MAIN // + +/** +* FIFO queue array constructor. +* +* @private +* @constructor +* @param {(NonNegativeInteger|Array)} [arg] - queue capacity or an array-like object containing initial values +* @throws {TypeError} invalid first argument +* @returns {FifoArray} FIFO array +* +* @example +* var arr = new FifoArray( 10 ); +* // returns +*/ +function FifoArray() { // TODO: move to array/generic-fifo + var nargs; + var arg; + var buf; + var len; + + nargs = arguments.length; + if ( !( this instanceof FifoArray ) ) { + if ( nargs === 0 ) { + return new FifoArray(); + } + return new FifoArray( arguments[ 0 ] ); + } + if ( nargs === 0 ) { + buf = []; + len = 0; + } else { + arg = arguments[ 0 ]; + if ( isNonNegativeInteger( arg ) ) { + buf = zeros( arg ); + len = 0; + } else if ( isArray( arg ) ) { + buf = arg; // NOTE: not copying is intentional in order to allow creating a FIFO view; however, it does mean that an input argument will be mutated! + len = arg.length; + } else { + throw new TypeError( format( 'invalid argument. Unsupported argument type. Value: `%s`.', arg ) ); + } + } + setReadOnly( this, '_buffer', buf ); + setNonEnumerableProperty( this, '_size', buf.length ); + setNonEnumerableProperty( this, '_length', len ); + setNonEnumerableProperty( this, '_offset', 0 ); + return this; +} + +/** +* Constructor name. +* +* @name name +* @memberof FifoArray +* @readonly +* @type {string} +* @default 'FifoArray' +* +* @example +* var name = FifoArray.name; +* // returns 'FifoArray' +*/ +setReadOnly( FifoArray, 'name', 'FifoArray' ); + +/** +* Converts a view index to an index into the underlying data buffer. +* +* @private +* @name _idx +* @memberof FifoArray.prototype +* @type {Function} +* @param {NonNegativeInteger} idx - view index +* @returns {NonNegativeInteger} buffer index +*/ +setReadOnly( FifoArray.prototype, '_idx', function get( idx ) { + return toIndex( this._size, this._offset, idx ); +}); + +/** +* Increments the pointer to the first indexed element (i.e., the "oldest" element) in the underlying data buffer. +* +* @private +* @name _nextOffset +* @memberof FifoArray.prototype +* @type {Function} +* @returns {NonNegativeInteger} index offset +*/ +setReadOnly( FifoArray.prototype, '_nextOffset', function nextOffset() { + return ( this._offset+1 ) % this._size; +}); + +/** +* Decrements the pointer to the first indexed element (i.e., the "oldest" element) in the underlying data buffer. +* +* @private +* @name _prevOffset +* @memberof FifoArray.prototype +* @type {Function} +* @returns {NonNegativeInteger} index offset +*/ +setReadOnly( FifoArray.prototype, '_prevOffset', function prevOffset() { + var idx = this._offset - 1; + if ( idx < 0 ) { + idx = this._size - 1; + } + return idx; +}); + +/** +* Returns a queue element located at integer position (index) `i`, with support for both nonnegative and negative integer indices. +* +* @name at +* @memberof FifoArray.prototype +* @type {Function} +* @param {integer} idx - element index +* @throws {TypeError} `this` must be a FIFO array +* @throws {TypeError} must provide an integer +* @returns {(*|void)} queue element +* +* @example +* var arr = new FifoArray( [ 0, 0, 0 ] ); +* +* arr.set( 1, 0 ); +* arr.set( 2, 1 ); +* arr.set( 3, 2 ); +* +* var v = arr.at( 0 ); +* // returns 1 +* +* v = arr.at( -1 ); +* // returns 3 +* +* v = arr.at( 100 ); +* // returns undefined +*/ +setReadOnly( FifoArray.prototype, 'at', function at( idx ) { + var buf; + var len; + + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + if ( !isInteger( idx ) ) { + throw new TypeError( format( 'invalid argument. Must provide an integer. Value: `%s`.', idx ) ); + } + len = this._length; + buf = this._buffer; + if ( idx < 0 ) { + idx += len; + } + if ( idx < 0 || idx >= len ) { + return; + } + return buf[ this._idx( idx ) ]; +}); + +/** +* Clears a queue. +* +* @name clear +* @memberof FifoArray.prototype +* @type {Function} +* @throws {TypeError} `this` must be a FIFO array +* @returns {FifoArray} Fifo array +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var len = arr.length; +* // returns 3 +* +* arr.clear(); +* +* len = arr.length; +* // returns 0 +*/ +setReadOnly( FifoArray.prototype, 'clear', function clear() { + var i; + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + // Reset buffer elements in order to free up references... + for ( i = 0; i < this._length; i++ ) { + this._buffer[ this._idx( i ) ] = 0; + } + // Reset the queue: + this._length = 0; + this._offset = 0; + + return this; +}); + +/** +* Returns an element from the queue. +* +* @name get +* @memberof FifoArray.prototype +* @type {Function} +* @param {NonNegativeInteger} idx - element index +* @throws {TypeError} `this` must be a FIFO array +* @throws {TypeError} must provide a nonnegative integer +* @returns {(*|void)} array element +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var v = arr.get( 0 ); +* // returns 1 +* +* arr.set( [ 5, 6 ], 0 ); +* +* v = arr.get( 0 ); +* // returns 5 +* +* v = arr.get( 100 ); +* // returns undefined +*/ +setReadOnly( FifoArray.prototype, 'get', function get( idx ) { + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + if ( !isNonNegativeInteger( idx ) ) { + throw new TypeError( format( 'invalid argument. Must provide a nonnegative integer. Value: `%s`.', idx ) ); + } + if ( idx >= this._length ) { + return; + } + return this._buffer[ this._idx( idx ) ]; +}); + +/** +* Number of queued elements. +* +* @name length +* @memberof FifoArray.prototype +* @readonly +* @type {NonNegativeInteger} +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var len = arr.length; +* // returns 3 +*/ +setReadOnlyAccessor( FifoArray.prototype, 'length', function get() { + return this._length; +}); + +/** +* Removes the oldest element from the queue and returns that removed element. +* +* ## Notes +* +* - If the queue is empty, the method returns `undefined`. +* +* @name pop +* @memberof FifoArray.prototype +* @type {Function} +* @throws {TypeError} `this` must be a FIFO array +* @returns {(*|void)} queue element +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var v = arr.get( 0 ); +* // returns 1 +* +* var len = arr.length; +* // returns 3 +* +* v = arr.pop(); +* // returns 1 +* +* len = arr.length; +* // returns 2 +* +* v = arr.get( 0 ); +* // returns 2 +*/ +setReadOnly( FifoArray.prototype, 'pop', function pop() { + var v; + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + if ( this._length === 0 ) { + return; + } + // Retrieve the oldest element: + v = this._buffer[ this._offset ]; + + // Reset the buffer element in order to free up references: + this._buffer[ this._offset ] = 0; + + // Increment the pointer to the first indexed element to point to the next oldest element in the queue: + this._offset = this._nextOffset(); + + // Decrement the queue length: + this._length -= 1; + + return v; +}); + +/** +* Adds one or more elements to the end of the queue and returns the number of queued elements. +* +* @name push +* @memberof FifoArray.prototype +* @type {Function} +* @param {...*} value - one or more values to queue +* @throws {TypeError} `this` must be a FIFO array +* @returns {NonNegativeInteger} number of queued elements +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var v = arr.get( 0 ); +* // returns 1 +* +* var len = arr.length; +* // returns 3 +* +* // Push a single element to an already full queue: +* len = arr.push( 4 ); +* // returns 3 +* +* len = arr.length; +* // returns 3 +* +* v = arr.get( 0 ); +* // returns 2 +* +* v = arr.get( arr.length-1 ); +* // returns 4 +* +* // Push multiple elements to an already full queue: +* len = arr.push( 5, 6 ); +* // returns 3 +* +* v = arr.get( 0 ); +* // returns 4 +* +* v = arr.get( arr.length-1 ); +* // returns 6 +* +* // Resize the queue to allow more queued elements: +* arr.resize( 10 ); +* +* len = arr.length; +* // returns 3 +* +* // Push multiple elements to a partially full queue: +* len = arr.push( 7, 8, 9 ); +* // returns 6 +* +* v = arr.get( 0 ); +* // returns 4 +* +* v = arr.get( arr.length-1 ); +* // returns 9 +* +* len = arr.length; +* // returns 6 +* +* // Push multiple elements to fill the queue: +* len = arr.push( 10, 11, 12, 13, 14 ); +* // returns 10 +* +* v = arr.get( 0 ); +* // returns 5 +* +* v = arr.get( arr.length-1 ); +* // returns 14 +* +* // Shrink the queue: +* arr.resize( 3 ); +* +* len = arr.length; +* // returns 3 +* +* v = arr.get( 0 ); +* // returns 12 +* +* v = arr.get( arr.length-1 ); +* // returns 14 +*/ +setReadOnly( FifoArray.prototype, 'push', function push() { + var nargs; + var len; + var N; + var M; + var i; + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + nargs = arguments.length; + len = this._length; + + // Check for trivial cases in which there is nothing to queue... + if ( this._size === 0 || nargs === 0 ) { + return len; + } + // Check whether we have yet to fill the queue and don't need to worry about replacing previously queued elements... + N = this._size - len; + if ( N > 0 ) { + M = min( nargs, N ); + for ( i = 0; i < M; i++ ) { + this._buffer[ this._idx( len+i ) ] = arguments[ i ]; + } + } else { + M = 0; + } + // If the queue is full, we need to replace previously queued elements... + for ( i = M; i < nargs; i++ ) { + this._buffer[ this._offset ] = arguments[ i ]; + this._offset = this._nextOffset(); + } + this._length += M; + return this._length; +}); + +/** +* Resizes the queue capacity. +* +* @name resize +* @memberof FifoArray.prototype +* @type {Function} +* @param {NonNegativeInteger} size - queue capacity +* @throws {TypeError} `this` must be a FIFO array +* @throws {TypeError} must provide a nonnegative integer +* @returns {FifoArray} Fifo array +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var size = arr.size; +* // returns 3 +* +* arr.resize( 10 ); +* +* size = arr.size; +* // returns 10 +* +* arr.resize( 2 ); +* +* size = arr.size; +* // returns 2 +* +* var v = arr.get( 0 ); +* // returns 2 +*/ +setReadOnly( FifoArray.prototype, 'resize', function resize( size ) { + var buf; + var tmp; + var S; + var N; + var M; + var i; + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + if ( !isNonNegativeInteger( size ) ) { + throw new TypeError( format( 'invalid argument. Must provide a nonnegative integer. Value: `%s`.', size ) ); + } + buf = this._buffer; + S = this._size; + N = this._length; + + // Case: no resizing necessary + if ( size === S ) { + return this; + } + // Case: queue has not reached capacity, so queue should be contiguous, and we are asked to simply increase the queue capacity + if ( this._offset+N <= S && size > S ) { + // We can just extend the underlying buffer... + for ( i = 0; i < size-S; i++ ) { + buf.push( 0 ); + } + this._size = size; + return this; + } + // Case: queue has either reached capacity, in which case the queue is no longer guaranteed to be contiguous, or we need to shrink the queue capacity; in either case, copy to a temporary copy in order to allow for shrinking/growing the buffer without losing references to buffer data + tmp = []; + for ( i = 0; i < N; i++ ) { + tmp.push( buf[ this._idx( i ) ] ); + } + // Case: grow the queue + if ( size > S ) { + for ( i = 0; i < size-S; i++ ) { + buf.push( 0 ); + } + // Copy over all previously queued elements... + for ( i = 0; i < N; i++ ) { + buf[ i ] = tmp[ i ]; + } + // Reset the offset given that we just copied: + this._offset = 0; + + // Update the queue size: + this._size = size; + + return this; + } + // Case: shrink the queue + this._size = size; + buf.length = size; + S = size; + + // Determine the number of queued elements to keep... + if ( S >= N ) { + M = N; + } else { + M = S; + } + // Copy over only the most recently queued elements... + for ( i = 0; i < M; i++ ) { + buf[ i ] = tmp[ N-M+i ]; + } + // Reset the offset given that we just copied: + this._offset = 0; + + // Update the queue size: + this._size = size; + + // Update the number of queued elements: + this._length = M; + + return this; +}); + +/** +* Sets a queue element. +* +* ## Notes +* +* - When provided an array, we must check whether the source array shares the same buffer as the target array and whether the underlying memory overlaps. In particular, we are concerned with the following scenario: +* +* ```text +* buf: --------------------- +* src: --------------------- +* ``` +* +* In the above, as we copy values from `src`, we will overwrite values in the `src` view, resulting in duplicated values copied into the end of `buf`, which is not intended. Hence, to avoid overwriting source values, we must **copy** source values to a temporary array. +* +* In the other overlapping scenario, +* +* ```text +* buf: --------------------- +* src: --------------------- +* ``` +* +* by the time we begin copying into the overlapping region, we are copying from the end of `src`, a non-overlapping region, which means we don't run the risk of copying copied values, rather than the original `src` values, as intended. +* +* @name set +* @memberof FifoArray.prototype +* @type {Function} +* @param {(Collection|FifoArray|*)} value - value(s) +* @param {NonNegativeInteger} [i=0] - element index at which to start writing values +* @throws {TypeError} `this` must be a FIFO array +* @throws {TypeError} index argument must be a nonnegative integer +* @throws {RangeError} index argument is out-of-bounds +* @throws {RangeError} target array lacks sufficient storage to accommodate source values +* @returns {void} +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var v = arr.get( 0 ); +* // returns 1 +* +* arr.set( [ 5, 6 ], 0 ); +* +* v = arr.get( 0 ); +* // returns 5 +*/ +setReadOnly( FifoArray.prototype, 'set', function set( value ) { + var sbuf; + var idx; + var buf; + var tmp; + var get; + var N; + var i; + + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + if ( arguments.length > 1 ) { + idx = arguments[ 1 ]; + if ( !isNonNegativeInteger( idx ) ) { + throw new TypeError( format( 'invalid argument. Index argument must be a nonnegative integer. Value: `%s`.', idx ) ); + } + } else { + idx = 0; + } + buf = this._buffer; + if ( isCollection( value ) ) { + N = value.length; + if ( idx+N > this._length ) { + throw new RangeError( 'invalid arguments. Target array lacks sufficient storage to accommodate source values.' ); + } + if ( isFifoArray( value ) ) { + sbuf = value._buffer; // eslint-disable-line no-underscore-dangle + } else { + sbuf = value; + } + // Check for potentially overlapping memory... + if ( sbuf === buf ) { + // We need to copy source values... (note: we are being conservative here given that FIFO arrays have additional indexing misdirection complexity and figuring out whether there is actual overlap is likely more trouble than it is worth) + get = resolveGetter( sbuf ); + tmp = []; + for ( i = 0; i < sbuf.length; i++ ) { + tmp.push( get( sbuf, i ) ); + } + sbuf = tmp; + } + get = resolveGetter( sbuf ); + for ( i = 0; i < N; idx++, i++ ) { + buf[ this._idx( idx ) ] = get( sbuf, i ); + } + return; + } + if ( idx >= this._length ) { + throw new RangeError( format( 'invalid argument. Index argument is out-of-bounds. Value: `%u`.', idx ) ); + } + buf[ this._idx( idx ) ] = value; +}); + +/** +* Queue capacity. +* +* @name size +* @memberof FifoArray.prototype +* @readonly +* @type {NonNegativeInteger} +* +* @example +* var arr = new FifoArray( 10 ); +* +* var len = arr.length; +* // returns 0 +* +* var size = arr.size; +* // returns 10 +*/ +setReadOnlyAccessor( FifoArray.prototype, 'size', function get() { + return this._size; +}); + +/** +* Removes the newest element from the queue and returns that removed element. +* +* ## Notes +* +* - If the queue is empty, the method returns `undefined`. +* +* @name shift +* @memberof FifoArray.prototype +* @type {Function} +* @throws {TypeError} `this` must be a FIFO array +* @returns {(*|void)} queue element +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var len = arr.length; +* // returns 3 +* +* var v = arr.shift(); +* // returns 3 +* +* len = arr.length; +* // returns 2 +*/ +setReadOnly( FifoArray.prototype, 'shift', function shift() { + var v; + var i; + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + if ( this._length === 0 ) { + return; + } + // Resolve the buffer index of the newest element: + i = this._idx( this._length-1 ); + + // Retrieve the newest element: + v = this._buffer[ i ]; + + // Reset the buffer element in order to free up references: + this._buffer[ i ] = 0; + + // Decrement the queue length: + this._length -= 1; + + return v; +}); + +/** +* Adds one or more elements to the beginning of the queue and returns the number of queued elements. +* +* ## Notes +* +* - If provided multiple elements, the method queues those elements in the reverse order as they are provided, such that the first element is considered the "oldest" element and each subsequent element is considered "newer". The ensures that the first indexed element is the "oldest" queued element and matches `Array.prototype.unshift` behavior in which multiple provided elements are inserted as a chunk at the beginning of an array, in the exact same order in which the elements were passed in. +* - Calling this method `n` times with a single argument does **not** yield the same results as calling this method one time with `n` arguments. +* +* @name unshift +* @memberof FifoArray.prototype +* @type {Function} +* @param {...*} value - one or more values to queue +* @throws {TypeError} `this` must be a FIFO array +* @returns {NonNegativeInteger} number of queued elements +* +* @example +* var arr = new FifoArray( [ 1, 2, 3 ] ); +* +* var v = arr.get( 0 ); +* // returns 1 +* +* var len = arr.length; +* // returns 3 +* +* // Add a single element to an already full queue: +* len = arr.unshift( 4 ); +* // returns 3 +* +* len = arr.length; +* // returns 3 +* +* v = arr.get( 0 ); +* // returns 4 +* +* v = arr.get( arr.length-1 ); +* // returns 2 +* +* // Add multiple elements to an already full queue: +* len = arr.unshift( 5, 6 ); +* // returns 3 +* +* v = arr.get( 0 ); +* // returns 5 +* +* v = arr.get( arr.length-1 ); +* // returns 4 +* +* // Resize the queue to allow more queued elements: +* arr.resize( 10 ); +* +* len = arr.length; +* // returns 3 +* +* // Add multiple elements to a partially full queue: +* len = arr.unshift( 7, 8, 9 ); +* // returns 6 +* +* v = arr.get( 0 ); +* // returns 7 +* +* v = arr.get( arr.length-1 ); +* // returns 4 +* +* len = arr.length; +* // returns 6 +* +* // Add multiple elements to fill the queue: +* len = arr.unshift( 10, 11, 12, 13, 14 ); +* // returns 10 +* +* v = arr.get( 0 ); +* // returns 10 +* +* v = arr.get( arr.length-1 ); +* // returns 6 +* +* // Shrink the queue: +* arr.resize( 3 ); +* +* len = arr.length; +* // returns 3 +* +* v = arr.get( 0 ); +* // returns 9 +* +* v = arr.get( arr.length-1 ); +* // returns 6 +*/ +setReadOnly( FifoArray.prototype, 'unshift', function unshift() { + var nargs; + var len; + var N; + var M; + var i; + if ( !isFifoArray( this ) ) { + throw new TypeError( 'invalid invocation. `this` is not a FIFO array.' ); + } + nargs = arguments.length; + len = this._length; + + // Check for trivial cases in which there is nothing to queue... + if ( this._size === 0 || nargs === 0 ) { + return len; + } + // Compute the queue length adjustment... + N = this._size - len; + if ( N > 0 ) { + M = min( nargs, N ); + } else { + M = 0; + } + // Insert elements in the queue in reverse order to match `Array.prototype.unshift` behavior... + for ( i = 0; i < nargs; i++ ) { + this._offset = this._prevOffset(); + this._buffer[ this._offset ] = arguments[ nargs-1-i ]; + } + this._length += M; + return this._length; +}); + + +// EXPORTS // + +module.exports = FifoArray; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index d8ed375c352d..c8973608a024 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -1040,7 +1040,6 @@ setReadWriteAccessor( UnicodeTable.prototype, 'rowSeparator', getRowSeparator, s */ setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVerticalSeparatorMode, setVerticalSeparatorMode ); -/* eslint-disable-next-line stdlib/jsdoc-doctest */ // FIXME /** * Appends one or more rows to a table. * diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js new file mode 100644 index 000000000000..7bff93ac0a84 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -0,0 +1,65 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var accessors = require( '@stdlib/array/base/accessors' ); + + +// MAIN // + +/** +* Normalizes table data. +* +* @private +* @param {Collection} buffer - linear data buffer +* @returns {Collection} modified data buffer +*/ +function normalize( buffer ) { + var obj; + var get; + var set; + var raw; + var ch; + var v; + var i; + + obj = accessors( buffer ); + get = obj.accessors[ 0 ]; + set = obj.accessors[ 1 ]; + for ( i = 0; i < buffer.length; i++ ) { + raw = get( buffer, i ); + v = String( raw ); + ch = splitGraphemeClusters( v ); + set( buffer, i, { + 'raw': raw, + 'value': v, + 'graphemes': ch, + 'ngraphemes': ch.length + }); + } + return buffer; +} + + +// EXPORTS // + +module.exports = normalize; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index fe29a638634f..d8abd61a0996 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -46,7 +46,7 @@ function set( value ) { this._borders[ 2 ] = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index 7e791dc65323..f59281ecacf0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -46,7 +46,7 @@ function set( value ) { this._borders[ 3 ] = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index 0657776f53e8..99abcca8229f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -46,7 +46,7 @@ function set( value ) { this._borders[ 1 ] = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index 4ef04b31c5e9..dca1d8d189f8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -46,7 +46,7 @@ function set( value ) { this._borders[ 0 ] = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index 9cab54d6c96b..54977b99e77c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -75,7 +75,7 @@ function set( values ) { data.push({ 'value': values[ i ], 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }); } if ( !everyBy2( data, this._borders, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js index 557d12e6d514..bb7d98801a25 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/buffer-size/set.js @@ -24,6 +24,13 @@ var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive; var isNull = require( '@stdlib/assert/is-null' ); +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var getStrides = require( '@stdlib/ndarray/base/strides' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var getDType = require( '@stdlib/ndarray/base/dtype' ); +var getOrder = require( '@stdlib/ndarray/base/order' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); var format = require( '@stdlib/string/format' ); @@ -36,9 +43,12 @@ var format = require( '@stdlib/string/format' ); * @private * @param {(PositiveInteger|null)} value - data buffer size * @throws {TypeError} must be a positive integer or null -* @throws {RangeError} must be greater than or equal to the number of table rows */ function set( value ) { + var ncols; + var data; + var buf; + var sh; var s; if ( isNull( value ) ) { s = FLOAT64_MAX; @@ -47,10 +57,23 @@ function set( value ) { } else { throw new TypeError( format( 'invalid assignment. `%s` must be a positive integer or null. Value: `%s`.', 'bufferSize', value ) ); } - if ( this._data && s < this._data.length ) { - throw new RangeError( format( 'invalid assignment. `%s` must be greater than or equal to the number of table rows. Number of rows: %u. Value: `%u`.', 'bufferSize', this._data.length, s ) ); - } if ( s !== this._bufferSize ) { + data = this._data; + + // Check whether we need to shrink the internal FIFO queue... + if ( data && s < numelDimension( data, 0 ) ) { + ncols = numelDimension( data, 1 ); + buf = getData( data ); // FIFO queue + + // Resize the FIFO queue to hold only enough elements to support the current table size: + buf.resize( s*ncols ); + sh = [ s, ncols ]; + + // Create a new ndarray view, where we assume that the previous view was in row-major order, thus leaving strides the same: + this._data = new ndarray( getDType( data ), buf, sh, getStrides( data, false ), getOffset( data ), getOrder( data ) ); // eslint-disable-line max-len + } + // Otherwise, if we need to grow the internal FIFO queue, wait to do that until new data is pushed to the table... + this._bufferSize = s; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 576166ebceaf..771897333114 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -46,7 +46,7 @@ function set( value ) { this._columnSeparator = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index ed8f7165e580..227c1721ea4d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -49,7 +49,7 @@ function set( value ) { this._corners[ 3 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 6164a9e7e60d..0cc68d96f6d3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -49,7 +49,7 @@ function set( value ) { this._corners[ 2 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index d2ec6030482c..baf3ead07f83 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -49,7 +49,7 @@ function set( value ) { this._corners[ 0 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index 5b7fa8db00f0..a64f16b32e85 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -49,7 +49,7 @@ function set( value ) { this._corners[ 1 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index 76080989586f..964449dd7592 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -86,7 +86,7 @@ function set( values ) { data.push({ 'value': v, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }); } if ( !everyBy2( data, this._corners, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js index 6c7a7fddd5ae..0901dbec926f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/get.js @@ -23,8 +23,38 @@ // MODULES // var isNull = require( '@stdlib/assert/is-null' ); +var resolveGetter = require( '@stdlib/array/base/resolve-getter' ); +var getShape = require( '@stdlib/ndarray/base/shape' ); +var getDType = require( '@stdlib/ndarray/base/dtype' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var getOrder = require( '@stdlib/ndarray/base/order' ); +var getStrides = require( '@stdlib/ndarray/base/strides' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); var ndarray = require( '@stdlib/ndarray/ctor' ); -var pluck = require( '@stdlib/utils/pluck' ); + + +// FUNCTIONS // + +/** +* Extracts a property value from each element in an array of objects. +* +* @private +* @param {Collection} arr - input array +* @param {(string|symbol)} prop - property value +* @returns {Array} output array +*/ +function pluck( arr, prop ) { // TODO: considering moving to array/base/pluck; added here in order to support accessor arrays; however, it does make certain assumptions that utils/base/pluck does not. + var out; + var get; + var i; + + get = resolveGetter( arr ); + out = []; + for ( i = 0; i < arr.length; i++ ) { + out.push( get( arr, i )[ prop ] ); + } + return out; +} // MAIN // @@ -36,12 +66,17 @@ var pluck = require( '@stdlib/utils/pluck' ); * @returns {(ndarray|null)} table data */ function get() { - var out; - if ( isNull( this._data ) ) { + var view; + var buf; + + view = this._data; + if ( isNull( view ) ) { return null; } - out = pluck( this._data.data, 'raw' ); - return new ndarray( 'generic', out, this._data.shape, this._data.strides, this._data.offset, this._data.order ); + buf = pluck( getData( view ), 'raw' ); + return new ndarray( getDType( view ), buf, getShape( view ), getStrides( view ), getOffset( view ), getOrder( view ), { // eslint-disable-line max-len + 'readonly': true + }); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index b980a2bc64c3..11af5eebd832 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -24,17 +24,18 @@ var isMatrixLike = require( '@stdlib/assert/is-matrix-like' ); var isCollection = require( '@stdlib/assert/is-collection' ); -var hasOwnProp = require( '@stdlib/assert/has-own-property' ); var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); -var shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); var assign = require( '@stdlib/ndarray/base/assign' ); -var ndarray = require( '@stdlib/ndarray/ctor' ); -var emptyLike = require( '@stdlib/ndarray/empty-like' ); -var flatten2d = require( '@stdlib/array/base/flatten2d' ); -var shape = require( '@stdlib/array/shape' ); -var objectKeys = require( '@stdlib/utils/keys' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var getShape = require( '@stdlib/ndarray/shape' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); +var zeros = require( '@stdlib/array/base/zeros' ); var format = require( '@stdlib/string/format' ); +var normalizeData = require( './../../normalize.js' ); +var convertDictionary = require( './../../convert_dictionary.js' ); +var convertCollection = require( './../../convert_collection.js' ); +var FifoArray = require( './../../fifo.js' ); // VARIABLES // @@ -43,153 +44,6 @@ var DTYPE = 'generic'; var ORDER = 'row-major'; -// FUNCTIONS // - -/** -* Creates a two-dimensional ndarray having a specified data buffer and shape. -* -* @private -* @param {Array} buffer - data buffer -* @param {NonNegativeIntegerArray} shape - shape -* @returns {ndarray} two-dimensional ndarray -*/ -function matrix( buffer, shape ) { - return new ndarray( DTYPE, buffer, shape, shape2strides( shape, ORDER ), 0, ORDER ); // eslint-disable-line max-len -} - -/** -* Converts table data provided as an array-like object. -* -* @private -* @param {Collection} data - input data -* @param {(ObjectArray|null)} headers - table headers -* @throws {TypeError} invalid input data -* @returns {(Object|Error)} table data -*/ -function convertCollection( data, headers ) { - var keys; - var out; - var flg; - var sh; - var d; - var i; - var j; - var k; - - sh = shape( data ); - - // If we were provided a nested array, flatten in row-major order... - if ( sh.length >= 2 ) { - sh = [ sh[ 0 ], sh[ 1 ] ]; // only concern ourselves with the first two dimensions - return { - 'data': matrix( flatten2d( data, sh, false ), sh ), - 'headers': null - }; - } - // If we were provided a one-dimensional array, assume that we were provided a list of objects... - - // If we don't already have headers, infer the headers from the first array element... - if ( headers === null ) { - keys = objectKeys( data[ 0 ] ); - flg = true; - } else { - keys = headers; - } - out = []; - for ( i = 0; i < sh[ 0 ]; i++ ) { - d = data[ i ]; - for ( j = 0; j < keys.length; j++ ) { - k = keys[ j ]; - if ( hasOwnProp( d, k ) ) { - out.push( d[ k ] ); - } else { - return new Error( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. One or more of the provided data elements is missing expected column data. Expected columns: ["%s"]. Value: `%s`.', 'data', keys.join( '", "' ), JSON.stringify( data ) ) ); - } - } - } - return { - 'data': matrix( out, [ sh[ 0 ], keys.length ] ), - 'headers': ( flg ) ? keys : null - }; -} - -/** -* Converts table data provided as an object. -* -* @private -* @param {*} data - input data -* @param {(ObjectArray|null)} headers - table headers -* @throws {TypeError} invalid input data -* @returns {(Object|Error)} table data -*/ -function convertOther( data, headers ) { - var keys; - var out; - var flg; - var M; - var N; - var i; - var j; - var k; - - // If we don't already have headers, infer the headers from the provided object... - if ( headers === null ) { - keys = objectKeys( data ); - flg = true; - } else { - keys = headers; - } - // If provided an empty object (or an object without enumerable properties), likely a user error... - if ( keys.length === 0 ) { - return new Error( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. Value: `%s`.', 'data', JSON.stringify( data ) ) ); - } - // Validate that each column of data is the same length... - M = data[ keys[0] ].length; - N = keys.length; - for ( i = 1; i < N; i++ ) { - if ( data[ keys[i] ].length !== M ) { - return new Error( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. Each provided data column must have the same number of rows. Value: `%s`.', 'data', JSON.stringify( data ) ) ); - } - } - // Flatten the dictionary of columns into a row-major linear buffer... - out = []; - for ( i = 0; i < M; i++ ) { - for ( j = 0; j < N; j++ ) { - k = keys[ j ]; - out.push( data[ k ][ i ] ); - } - } - return { - 'data': matrix( out, [ M, N ] ), - 'headers': ( flg ) ? keys : null - }; -} - -/** -* Normalizes table data. -* -* @private -* @param {Array} buffer - data buffer -* @returns {Array} modified data buffer -*/ -function normalizeData( buffer ) { - var ch; - var v; - var i; - for ( i = 0; i < buffer.length; i++ ) { - v = String( buffer[ i ] ); - ch = splitGraphemeClusters( v ); - buffer[ i ] = { - 'raw': buffer[ i ], - 'value': v, - 'graphemes': ch, - 'length': ch.length - }; - } - return buffer; -} - - // MAIN // /** @@ -205,19 +59,20 @@ function set( data ) { var headers; var out; var tmp; + var sh; - // If provided an ndarray, explicitly copy ndarray data to a new contiguous ndarray in order to allow mutation of the underlying "generic" buffer and for the purposes of maintaining an internal FIFO queue... + // If provided an ndarray, explicitly copy ndarray data to a new contiguous ndarray in order to allow mutation of the underlying buffer and for the purposes of maintaining an internal FIFO queue... if ( isMatrixLike( data ) ) { - out = emptyLike( data, { - 'dtype': DTYPE - }); + sh = getShape( data ); + out = new FifoArray( zeros( sh[0]*sh[1] ) ); + out = new ndarray( DTYPE, out, sh, shape2strides( sh, ORDER ), 0, ORDER ); assign( [ data, out ] ); } // If provided a collection, convert to an ndarray... else if ( isCollection( data ) ) { - out = convertCollection( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers` is intentional, as we only want the list of header values (if they exist) - if ( out instanceof Error ) { - throw out; + out = convertCollection( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers`, is intentional, as we only want the list of header values (if they exist) + if ( out.code ) { // out.code === 'ERR_MISSING_COLUMNS' + throw new TypeError( format( 'invalid assignment. `%s` must be either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. One or more of the provided data elements is missing expected column data. Expected columns: ["%s"]. Value: `%s`.', 'data', out.headers.join( '", "' ), JSON.stringify( data ) ) ); } if ( out.headers ) { headers = out.headers; @@ -226,9 +81,16 @@ function set( data ) { } // If provided anything else, process as a dictionary of columns... else { - out = convertOther( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers` is intentional, as we only want the list of header values (if they exist) - if ( out instanceof Error ) { - throw out; + out = convertDictionary( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers`, is intentional, as we only want the list of header values (if they exist) + if ( out.code ) { + if ( out.code === 'ERR_EMPTY_OBJECT' ) { + throw new TypeError( format( 'invalid assignment. `%s` must be either an object containing columns of data, an array of objects, an array of arrays, or a two-dimensional ndarray. Value: `%s`.', 'data', JSON.stringify( data ) ) ); + } + if ( out.code === 'ERR_INVALID_OBJECT' ) { + throw new TypeError( format( 'invalid assignment. `%s` must be either an object containing columns of data, an array of objects, an array of arrays, or a two-dimensional ndarray. Value: `%s`.', 'data', JSON.stringify( data ) ) ); + } + // out.code === 'ERR_UNEQUAL_COLUMN_LENGTHS' + throw new TypeError( format( 'invalid assignment. `%s` must be either an object containing columns of data, an array of objects, an array of arrays, or a two-dimensional ndarray. Each provided data column must have the same number of rows. Value: `%s`.', 'data', JSON.stringify( data ) ) ); } if ( out.headers ) { headers = out.headers; @@ -237,18 +99,18 @@ function set( data ) { } // Ensure that the provided data does not have too many rows... if ( numelDimension( out, 0 ) > this._bufferSize ) { - throw new RangeError( format( 'invalid assignment. `%s` exceeds maximum data buffer size. Buffer size: %u. Number of rows: `%u`.', 'data', this._bufferSize, numelDimension( out, 0 ) ) ); + throw new RangeError( format( 'invalid assignment. `%s` exceeds maximum data buffer size. Either increase the table buffer size or provide fewer rows of data. Buffer size: %u. Number of rows: %u.', 'data', this._bufferSize, numelDimension( out, 0 ) ) ); } // Ensure that the provided data has the expected number of columns... if ( this._numColumns ) { if ( numelDimension( out, 1 ) !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have %d columns in order to match the number of table columns. Number of columns: `%u`.', 'data', this._numColumns, numelDimension( out, 1 ) ) ); + throw new RangeError( format( 'invalid assignment. `%s` must have %d columns in order to match the number of table columns. Number of columns: %u.', 'data', this._numColumns, numelDimension( out, 1 ) ) ); } } else { this._numColumns = numelDimension( out, 1 ); } // Normalize the underlying table data buffer: - normalizeData( out.data ); + normalizeData( getData( out ) ); // Anytime a user sets table data, assume that the data has changed (note: performing a deep equality check is likely too expensive and not worth the effort) and thus, if not in "quiet" mode, always emit a 'change' event... this._data = out; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index 6189989e2268..dc74092a6b07 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -46,7 +46,7 @@ function set( value ) { this._headerSeparator = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index 027a05729ace..3ca6e1452e15 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -78,7 +78,7 @@ function set( values ) { data.push({ 'value': v, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }); } if ( this._headers === null || !everyBy2( data, this._headers, predicate ) ) { // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index a8dfb301b913..f73b10284edd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -49,7 +49,7 @@ function set( value ) { this._joints[ 3 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index fb85b046462e..383651fe3d47 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -49,7 +49,7 @@ function set( value ) { this._joints[ 4 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index 307c7fd44473..4cfb0b50974a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -49,7 +49,7 @@ function set( value ) { this._joints[ 0 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index 77c28a63176e..2f63d91dbbeb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -49,7 +49,7 @@ function set( value ) { this._joints[ 2 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index c7e8d19a670d..73f2bab6e732 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -49,7 +49,7 @@ function set( value ) { this._joints[ 1 ] = { 'value': value, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 7c29add757ad..56b74a4bf8eb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -86,7 +86,7 @@ function set( values ) { data.push({ 'value': v, 'graphemes': ch, - 'length': 1 + 'ngraphemes': 1 }); } if ( !everyBy2( data, this._joints, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index e1880058ef11..ee52a34540c4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -46,7 +46,7 @@ function set( value ) { this._rowSeparator = { 'value': value, 'graphemes': ch, - 'length': ch.length + 'ngraphemes': ch.length }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index aeb254847396..8f96582054d2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -16,14 +16,32 @@ * limitations under the License. */ -/* eslint-disable */ /* no-invalid-this */ // FIXME +/* eslint-disable no-invalid-this */ 'use strict'; // MODULES // +var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' ); var isCollection = require( '@stdlib/assert/is-collection' ); +var isPlainObjectArray = require( '@stdlib/assert/is-plain-object-array' ); +var isObject = require( '@stdlib/assert/is-object' ); +var ndarraylike2ndarray = require( '@stdlib/ndarray/base/ndarraylike2ndarray' ); +var getShape = require( '@stdlib/ndarray/base/shape' ); +var getStrides = require( '@stdlib/ndarray/base/strides' ); +var getOffset = require( '@stdlib/ndarray/base/offset' ); +var getOrder = require( '@stdlib/ndarray/base/order' ); +var getDType = require( '@stdlib/ndarray/base/dtype' ); +var getData = require( '@stdlib/ndarray/base/data-buffer' ); +var emptyLike = require( '@stdlib/ndarray/empty-like' ); +var expandDims = require( '@stdlib/ndarray/base/expand-dimensions' ); +var ndarray = require( '@stdlib/ndarray/base/ctor' ); +var assign = require( '@stdlib/ndarray/base/assign' ); +var arrayShape = require( '@stdlib/array/shape' ); var format = require( '@stdlib/string/format' ); +var convertDictionary = require( './convert_dictionary.js' ); +var convertCollection = require( './convert_collection.js' ); +var normalizeData = require( './normalize.js' ); // MAIN // @@ -33,44 +51,153 @@ var format = require( '@stdlib/string/format' ); * * @private * @param {(Object|Collection|VectorLike|MatrixLike)} data - row to add -* @throws {TypeError} must provide an object, an array-like object, or an ndarray +* @throws {TypeError} must provide an object, an array-like object, a one-dimensional ndarray, or a two-dimensional ndarray * @throws {RangeError} must provide the correct number of columns * @returns {UnicodeTable} class instance */ function push( data ) { - var parsed; + var headers; + var view; + var out; + var arr; + var tmp; + var flg; + var buf; + var ash; + var csh; + var N; + var i; + var j; -// FIXME: should we allow an object to allow unordered, but keyed, data? Probably, yes. + if ( isndarrayLike( data ) ) { + arr = ndarraylike2ndarray( data ); + ash = getShape( arr, false ); + if ( ash.length > 2 ) { + throw new TypeError( 'invalid argument. Input ndarray has too many dimensions. Must provide either a one-dimensional or a two-dimensional ndarray.' ); + } + // Convert a one-dimensional ndarray to a two-dimensional ndarray... + if ( ash.length === 1 ) { + arr = expandDims( arr, 0 ); + } + // Record that we have not yet copied the underlying data buffer: + flg = false; + } + // If provided a collection, convert to an ndarray... + else if ( isCollection( data ) ) { + ash = arrayShape( data ); - if ( !isCollection ) { - throw new TypeError( format( 'invalid argument. Must provide a collection. Value: `%s`.', row ) ); + // Check whether we were provided a one-dimensional array... + if ( ash.length === 1 ) { + if ( !isPlainObjectArray( data ) ) { + // Assume that we were provided an array of column values belonging to a single row: + data = [ data ]; + } + // Otherwise, assume that we were provided a list of objects... + } + out = convertCollection( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers`, is intentional, as we only want the list of header values (if they exist) + if ( out.code ) { // out.code === 'ERR_MISSING_COLUMNS' + throw new TypeError( format( 'invalid argument. Must provide either an object, an array of column values, an array of objects, an array of arrays, a one-dimensional ndarray, or a two-dimensional ndarray. One or more of the provided data elements is missing expected column data. Expected columns: ["%s"]. Value: `%s`.', 'data', out.headers.join( '", "' ), JSON.stringify( data ) ) ); + } + if ( out.headers ) { + headers = out.headers; + } + arr = out.data; // ndarray + + // Record that we have copied provided table data to a new data buffer: + flg = false; } - // If data doesn't already exist, parse row as new data... - if ( !this._data || !this._data.length ) { - parsed = parse2dArray( [ row ], this._headers ); - if ( this._numColumns ) { - if ( parsed.columnWidths.length !== this._numColumns ) { - throw new RangeError( format( 'invalid argument. `%s` must have `%d` number of columns. Value: `%d`.', 'data', this._numColumns, parsed.columnWidths.length ) ); + // If provided anything else, try to either process as an object containing unordered column data or a dictionary of columns... + else { + out = convertDictionary( data, this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers`, is intentional, as we only want the list of header values (if they exist) + if ( out.code ) { + // Ensure that we were provided an object... + if ( !isObject( data ) ) { + throw new TypeError( format( 'invalid argument. Must provide either an object, an array of column values, an array of objects, an array of arrays, a one-dimensional ndarray, or a two-dimensional ndarray. Value: `%s`.', JSON.stringify( data ) ) ); + } + // If we failed to process as a dictionary of columns, attempt to process as a single object containing key-value pairs: + tmp = convertCollection( [ data ], this.headers ); // NOTE: the use of `this.headers`, rather than `this._headers`, is intentional, as we only want the list of header values (if they exist) + if ( tmp.code ) { + if ( out.code === 'ERR_EMPTY_OBJECT' ) { + throw new TypeError( format( 'invalid argument. Must provide either an object, an array of column values, an array of objects, an array of arrays, a one-dimensional ndarray, or a two-dimensional ndarray. Value: `%s`.', JSON.stringify( data ) ) ); + } + if ( out.code === 'ERR_INVALID_OBJECT' ) { + throw new TypeError( format( 'invalid argument. Must provide either an object, an array of objects, an array of arrays, or a two-dimensional ndarray. Value: `%s`.', JSON.stringify( data ) ) ); + } + // out.code === 'ERR_UNEQUAL_COLUMN_LENGTHS' + throw new TypeError( format( 'invalid argument. Must provide either an object, an array of column values, an array of objects, an array of arrays, a one-dimensional ndarray, or a two-dimensional ndarray. Each provided data column must have the same number of rows. Value: `%s`.', JSON.stringify( data ) ) ); } - } else { - this._numColumns = parsed.columnWidths.length; + // If we made it here, we were successful in treating the data as unordered column data: + out = tmp; } - this._data = parsed.data; - this._headers = parsed.headers; - this._columnWidths = parsed.columnWidths; - this.emit( 'change' ); - return this; + if ( out.headers ) { + headers = out.headers; + } + arr = out.data; // ndarray + + // Record that we have copied provided table data to a new data buffer: + flg = false; + } + // Check whether to initialize table data... + view = this._data; + if ( view === null ) { + this.data = arr; + return; } - if ( this._numColumns !== row.length ) { - throw new RangeError( format( 'invalid argument. `%s` must have `%d` number of columns. Value: `%d`.', 'data', this._numColumns, row.length ) ); + // Ensure that the provided data does not have too many rows... + ash = getShape( arr, false ); + if ( ash[ 0 ] > this._bufferSize ) { + // In principle, we could apply the FIFO queue here, but, if a table is limited to, e.g., 5 rows and a user is providing 10 rows of data, they are probably doing something wrong... + throw new RangeError( format( 'invalid argument. Input argument exceeds maximum data buffer size. Buffer size: %u. Number of rows: %u.', this._bufferSize, ash[ 0 ] ) ); } - if ( this._data.length >= this._bufferSize ) { - this._data.shift(); + // Ensure that the provided data has the expected number of columns... + if ( ash[ 1 ] !== this._numColumns ) { + throw new RangeError( format( 'invalid argument. Input argument must have %d columns in order to match the number of table columns. Number of columns: %u.', this._numColumns, ash[ 1 ] ) ); + } + // If we have yet to copy provided table data to a new data buffer, do so now in order to prevent mutation of input data... + if ( !flg ) { + out = emptyLike( arr, { + 'dtype': 'generic' + }); + assign( [ arr, out ] ); + arr = out; + } + // Normalize the incoming table data: + normalizeData( getData( arr ) ); + + // Get the current number of table rows and columns: + csh = getShape( view ); + + // Compute the number of combined rows based on the current number of table rows and the incoming data: + N = csh[ 0 ] + ash[ 0 ]; + + // If the number of combined rows exceeds the maximum buffer size, cap the number of rows to the buffer size limit... + if ( N > this._bufferSize ) { + N = this._bufferSize; + } + // Resolve the underlying FIFO queue: + buf = getData( view ); + + // Adjust the capacity of the underlying FIFO queue to accommodate table data: + buf.resize( N * csh[1] ); + + // Push provided data directly to the queue... + for ( i = 0; i < ash[ 0 ]; i++ ) { + for ( j = 0; j < ash[ 1 ]; j++ ) { + buf.push( arr.get( i, j ) ); + } + } + // Create a new ndarray view atop the underlying FIFO queue: + this._data = new ndarray( getDType( view ), buf, [ N, csh[1] ], getStrides( view, false ), getOffset( view ), getOrder( view ) ); // eslint-disable-line max-len + + if ( this._headers === null && headers !== void 0 ) { + tmp = this._quiet; + this._quiet = true; // avoid triggering a 'change' event + this.headers = headers; // NOTE: assigning to `this.headers` is intentional in order to ensure proper processing of headers + this._quiet = tmp; + } + if ( !this._quiet ) { + this.emit( 'change' ); } - this._data.push( row ); - parsed = parse2dArray( this._data, this._headers ); - this._columnWidths = parsed.columnWidths; - this.emit( 'change' ); return this; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 2f795a06fcfa..4f37a8fcd0f3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -27,24 +27,13 @@ var floor = require( '@stdlib/math/base/special/floor' ); var ceil = require( '@stdlib/math/base/special/ceil' ); var min = require( '@stdlib/math/base/special/fast/min' ); var zeros = require( '@stdlib/array/base/zeros' ); -var ndarray = require( '@stdlib/ndarray/base/ctor' ); var repeat = require( '@stdlib/string/repeat' ); var format = require( '@stdlib/string/format' ); +var array2matrix = require( './array2matrix.js' ); // FUNCTIONS // -/** -* Converts a one-dimensional array to a two-dimensional ndarray. -* -* @private -* @param {Collection} data - input data -* @returns {ndarray} two-dimensional ndarray -*/ -function array2matrix( data ) { - return new ndarray( 'generic', data, [ 1, data.length ], [ data.length, 1 ], 0, 'row-major' ); -} - /** * Resolves individual column widths based on table data and specified paddings. * @@ -77,7 +66,7 @@ function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) lpad = leftPadding[ j%M ]; rpad = rightPadding[ j%N ]; v = headers.get( 0, j ); - len = lpad + v.length + rpad; + len = lpad + v.ngraphemes + rpad; if ( len > out[ j ] ) { out[ j ] = len; } @@ -88,7 +77,7 @@ function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) lpad = leftPadding[ j%M ]; rpad = rightPadding[ j%N ]; v = data.get( i, j ); - len = lpad + v.length + rpad; + len = lpad + v.ngraphemes + rpad; if ( len > out[ j ] ) { out[ j ] = len; } @@ -160,7 +149,7 @@ function wrappedColumnIndices( ctx ) { } // For all columns apart from the last (which has a border, not a column separator), include the width of the column separator... if ( i < ncols-1 ) { - width += ctx.columnSeparator.length; + width += ctx.columnSeparator.ngraphemes; } } // Include a final "index" to serve as the index upper bound: @@ -241,7 +230,7 @@ function renderLine( start, end, ch, ctx ) { // Render a table line... for ( i = start; i < end; i++ ) { // If columns are separated by a column separator, render the middle joint... - if ( i > start && ctx.columnSeparator.length > 0 ) { + if ( i > start && ctx.columnSeparator.ngraphemes > 0 ) { out += ctx.jointM; if ( ctx.mode === 'interpolate' ) { hidx += 1; @@ -304,13 +293,13 @@ function renderRow( row, start, end, data, ctx, vidx ) { out = renderWhitespace( ctx.marginL ); // Render left border: - if ( ctx.borderL.length > 0 ) { - out += ctx.borderL.graphemes[ vidx%ctx.borderL.length ]; + if ( ctx.borderL.ngraphemes > 0 ) { + out += ctx.borderL.graphemes[ vidx%ctx.borderL.ngraphemes ]; } for ( i = start; i < end; i++ ) { // Render column separator: - if ( i > start && ctx.columnSeparator.length > 0 ) { - out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.length ]; // eslint-disable-line max-len + if ( i > start && ctx.columnSeparator.ngraphemes > 0 ) { + out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.ngraphemes ]; // eslint-disable-line max-len } // Resolve cell paddings: lpad = ctx.paddingL[ i%ctx.paddingL.length ]; @@ -321,7 +310,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { // Resolve cell data: v = data.get( row, i ); - len = v.length + lpad + rpad; // number of grapheme clusters + len = lpad + v.ngraphemes + rpad; // number of grapheme clusters // Determine whether we need to truncate rendered data: mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; @@ -355,8 +344,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { out += renderWhitespace( rpad ); } // Render right border: - if ( ctx.borderR.length > 0 ) { - out += ctx.borderR.graphemes[ vidx%ctx.borderR.length ]; + if ( ctx.borderR.ngraphemes > 0 ) { + out += ctx.borderR.graphemes[ vidx%ctx.borderR.ngraphemes ]; } // Render right margin: out += renderWhitespace( ctx.marginR ); @@ -397,7 +386,7 @@ function render() { ncols = numelDimension( this._data, 1 ); // Convert the list of headers to a two-dimensional ndarray: - headers = ( this._headers ) ? array2matrix( this._headers ) : null; + headers = ( this._headers ) ? array2matrix( this._headers, [ 1, this._headers.length ] ) : null; // eslint-disable-line max-len // Resolve the column widths needed to fit column data: colWidths = columnWidths( nrows, ncols, this._data, headers, this._paddingLeft, this._paddingRight ); // eslint-disable-line max-len @@ -409,8 +398,8 @@ function render() { 'maxWidths': this._maxCellWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], - 'borderL': this._borders[ 3 ].length, - 'borderR': this._borders[ 1 ].length, + 'borderL': this._borders[ 3 ].ngraphemes, + 'borderR': this._borders[ 1 ].ngraphemes, 'columnSeparator': this._columnSeparator }); if ( idx instanceof Error ) { @@ -423,8 +412,8 @@ function render() { 'maxWidths': this._maxCellWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], - 'borderL': this._borders[ 3 ].length, - 'borderR': this._borders[ 1 ].length, + 'borderL': this._borders[ 3 ].ngraphemes, + 'borderR': this._borders[ 1 ].ngraphemes, 'jointL': '', 'jointM': '', 'jointR': '', @@ -459,7 +448,7 @@ function render() { vidx = 0; // Render top border: - if ( this._borders[ 0 ].length > 0 ) { + if ( this._borders[ 0 ].ngraphemes > 0 ) { lctx.jointL = this._corners[ 0 ].value; lctx.jointM = this._joints[ 1 ].value; lctx.jointR = this._corners[ 1 ].value; @@ -476,7 +465,7 @@ function render() { vidx += 1; } // Render header separator: - if ( this._headers && this._headerSeparator.length !== 0 ) { + if ( this._headers && this._headerSeparator.ngraphemes !== 0 ) { lctx.jointL = this._joints[ 4 ].value; lctx.jointM = this._joints[ 0 ].value; lctx.jointR = this._joints[ 2 ].value; @@ -497,7 +486,7 @@ function render() { vidx += 1; // Render row separator: - if ( this._rowSeparator.length > 0 && i < nrows-1 ) { + if ( this._rowSeparator.ngraphemes > 0 && i < nrows-1 ) { lctx.jointL = this._joints[ 4 ].value; lctx.jointM = this._joints[ 0 ].value; lctx.jointR = this._joints[ 2 ].value; @@ -512,7 +501,7 @@ function render() { } } // Render bottom border: - if ( this._borders[ 2 ].length > 0 ) { + if ( this._borders[ 2 ].ngraphemes > 0 ) { lctx.jointL = this._corners[ 3 ].value; lctx.jointM = this._joints[ 3 ].value; lctx.jointR = this._corners[ 2 ].value; From db9d55b1abd0fc966bc4749be3b1adc01adecf89 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 12 Feb 2025 16:31:15 -0800 Subject: [PATCH 09/34] docs: update example --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 2e6111de403f..0c1574439129 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -926,6 +926,41 @@ var table = new UnicodeTable( data, { var str = table.render(); console.log( str ); // => '...' + +// Push new data to the table: +table.push( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] ); + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' + +// Limit the number of table rows: +table.bufferSize = 10; + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' + +// Push new data to the table: +table.push( [ 6.0, 7.0, 8.0, 9.0, 10.0 ] ); + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' + +// Increase the number of allowed table rows: +table.bufferSize = 15; + +// Push new data to the table: +table.push( [ 11.0, 12.0, 13.0, 14.0, 15.0 ] ); + +// Re-render the table: +str = table.render(); +console.log( str ); +// => '...' ``` From 478b46230b88218ecab0b32bedf01d67e4a1c7f4 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 12 Feb 2025 16:57:45 -0800 Subject: [PATCH 10/34] docs: add streaming example --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../plot/table/unicode/examples/streaming.js | 81 +++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js new file mode 100644 index 000000000000..aa6288483b44 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js @@ -0,0 +1,81 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 linspace = require( '@stdlib/array/base/linspace' ); +var array = require( '@stdlib/ndarray/array' ); +var stdout = require( '@stdlib/streams/node/stdout' ); +var UnicodeTable = require( './../lib' ); + +// Define the number of table rows and columns: +var nrows = 10; +var ncols = 5; + +// Generate a data set: +var start = 0; +var end = 49; +var data = array( linspace( start, end, nrows*ncols ), { + 'shape': [ nrows, ncols ] +}); + +// Define column headers: +var headers = [ 'A', 'B', 'C', 'D', 'E' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'columnSeparator': '#$%', + 'maxWidth': 200, + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right', + 'bufferSize': nrows +}); + +// Render the table: +var str = table.render(); +stdout.write( str+'\n' ); + +// Compute the number of lines: +var N = str.split( '\n' ).length; + +// Periodically update the table with new data: +var id = setInterval( onInterval, 2000 ); +setTimeout( onTimeout, 11000 ); + +function onInterval() { + start = end; + end += ncols - 1; + table.push( linspace( start, end, ncols ) ); + clearPreviousLines( N ); + stdout.write( table.render()+'\n' ); +} + +function onTimeout() { + clearInterval( id ); +} + +function clearPreviousLines( count ) { + var i; + for ( i = 0; i < count; i++ ) { + stdout.write( '\x1b[F' ); // move cursor up one line + stdout.write( '\x1b[2K' ); // clear entire line + } +} From d1b8126349d2b4aee776f425c3b509bcacb2a70a Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 12 Feb 2025 23:17:51 -0800 Subject: [PATCH 11/34] docs: add complex number example --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../plot/table/unicode/examples/complex.js | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/complex.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/complex.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/complex.js new file mode 100644 index 000000000000..631897b7e66d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/complex.js @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 random = require( '@stdlib/random/base/discrete-uniform' ); +var Complex128 = require( '@stdlib/complex/float64/ctor' ); +var filled2dBy = require( '@stdlib/array/base/filled2d-by' ); +var UnicodeTable = require( './../lib' ); + +function clbk( indices ) { + if ( indices[ 1 ] === 0 ) { + return indices[ 0 ]; + } + return new Complex128( random( 0, 10 ), random( 0, 10 ) ); +} + +// Generate a random data set: +var data = filled2dBy( [ 10, 4 ], clbk ); + +// Define column headers: +var headers = [ 'Row', 'Col 0', 'Col 1', 'Col 2' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-' +}); + +// Render the table: +var str = table.render(); +console.log( str ); +// => '...' From b11a2c91725def7e2c0de4e9606d5b68bb2b8740 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 00:55:39 -0800 Subject: [PATCH 12/34] feat: add support for getting and setting individual data elements --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../plot/table/unicode/examples/sparklines.js | 160 ++++++++++++++++++ .../plot/table/unicode/examples/streaming.js | 17 +- .../@stdlib/plot/table/unicode/lib/get.js | 66 ++++++++ .../@stdlib/plot/table/unicode/lib/main.js | 66 +++++++- .../@stdlib/plot/table/unicode/lib/set.js | 71 ++++++++ 5 files changed, 373 insertions(+), 7 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/sparklines.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/set.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/sparklines.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/sparklines.js new file mode 100644 index 000000000000..3e1d9c4834e5 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/sparklines.js @@ -0,0 +1,160 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 randi = require( '@stdlib/random/base/discrete-uniform' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var filled2dBy = require( '@stdlib/array/base/filled2d-by' ); +var ColumnChart = require( '@stdlib/plot/sparklines/unicode/column' ); +var TristateChart = require( '@stdlib/plot/sparklines/unicode/tristate' ); +var LineChart = require( '@stdlib/plot/sparklines/unicode/line' ); +var stdout = require( '@stdlib/streams/node/stdout' ); +var UnicodeTable = require( './../lib' ); + +// Generate some random data sets: +var x0 = discreteUniform( 10, 0, 100, { + 'dtype': 'float64' +}); +var x1 = discreteUniform( 10, -1, 1, { + 'dtype': 'int8' +}); +var x2 = discreteUniform( 10, 0, 100, { + 'dtype': 'float64' +}); + +// Create various sparkline charts: +var chart0 = new ColumnChart( x0, { + 'yMin': 0, + 'yMax': 100, + 'bufferSize': 10 +}); +var chart1 = new TristateChart( x1, { + 'bufferSize': 10 +}); +var chart2 = new LineChart( x2, { + 'yMin': 0, + 'yMax': 100, + 'bufferSize': 10 +}); + +// Add the charts to a hash: +var charts = [ + chart0, + chart1, + chart2 +]; + +// Define the number of table rows and columns: +var nrows = 3; +var ncols = 4; + +// Define a callback for generating a data set: +function clbk( indices ) { + if ( indices[ 1 ] < ncols-1 ) { + return indices[ 0 ]; + } + return charts[ indices[ 0 ] ].render(); +} + +// Create a data set: +var data = filled2dBy( [ nrows, ncols ], clbk ); + +// Define column headers: +var headers = [ 'Row', 'Col 1', 'Col 2', 'Sparkline' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'align': 'right', + 'marginLeft': 5 +}); + +// Render the table: +var str = table.render(); +stdout.write( str+'\n' ); + +// Compute the number of lines: +var N = str.split( '\n' ).length; + +// Created a throttled event listener: +var listener = throttledListener( onUpdate, 250 ); + +// Listen for change events: +var i; +for ( i = 0; i < charts.length; i++ ) { + charts[ i ].on( 'change', listener ); +} + +// Periodically update the sparkline charts with new data: +var id = setInterval( update, 1000 ); + +// After some time, stop updating and close: +setTimeout( onTimeout, 11000 ); + +function throttledListener( clbk, limit ) { + var flg = false; + return listener; + + function listener() { + if ( flg ) { + return; + } + flg = true; + setTimeout( onTimeout, limit ); + } + + function onTimeout() { + flg = false; + clbk(); + } +} + +function update() { + // Push data to the individual charts: + chart0.push( randi( 0, 100 ) ); + chart1.push( randi( -1, 1 ) ); + chart2.push( randi( 0, 100 ) ); +} + +function onUpdate() { + var i; + + // Re-render the sparklines: + for ( i = 0; i < charts.length; i++ ) { + table.set( i, ncols-1, charts[ i ].render() ); + } + // Remove the previously rendered table: + clearPreviousLines( N ); + + // Re-render the table: + stdout.write( table.render()+'\n' ); +} + +function onTimeout() { + clearInterval( id ); +} + +function clearPreviousLines( count ) { + var i; + for ( i = 0; i < count; i++ ) { + stdout.write( '\x1b[F' ); // move cursor up one line + stdout.write( '\x1b[2K' ); // clear entire line + } +} diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js index aa6288483b44..e9fd48d8ea83 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/streaming.js @@ -27,9 +27,11 @@ var UnicodeTable = require( './../lib' ); var nrows = 10; var ncols = 5; -// Generate a data set: +// Define initial bounds for generated data: var start = 0; var end = 49; + +// Generate a data set: var data = array( linspace( start, end, nrows*ncols ), { 'shape': [ nrows, ncols ] }); @@ -57,14 +59,23 @@ stdout.write( str+'\n' ); var N = str.split( '\n' ).length; // Periodically update the table with new data: -var id = setInterval( onInterval, 2000 ); +var id = setInterval( update, 2000 ); + +// After some time, stop updating and close: setTimeout( onTimeout, 11000 ); -function onInterval() { +function update() { + // Update data bounds: start = end; end += ncols - 1; + + // Push a new row to the table: table.push( linspace( start, end, ncols ) ); + + // Remove the previously rendered table: clearPreviousLines( N ); + + // Re-render the table: stdout.write( table.render()+'\n' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js new file mode 100644 index 000000000000..83e637fcb64d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js @@ -0,0 +1,66 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Retrieves a single data element from a table. +* +* @private +* @param {NonNegativeInteger} i - index for the first dimension (i.e., zero-based row number) +* @param {NonNegativeInteger} j - index for the second dimension (i.e., zero-based column number) +* @throws {TypeError} first argument must be a nonnegative integer +* @throws {TypeError} second argument must be a nonnegative integer +* @throws {RangeError} index is out-of-bounds +* @returns {*} data element +*/ +function get( i, j ) { + var nrows; + var ncols; + if ( !isNonNegativeInteger( i ) ) { + throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', i ) ); + } + if ( !isNonNegativeInteger( j ) ) { + throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', j ) ); + } + nrows = numelDimension( this._data, 0 ); + if ( i >= nrows ) { + throw new RangeError( format( 'invalid argument. First argument must be on the interval: [0,%u]. Value: `%s`.', nrows-1, i ) ); + } + ncols = numelDimension( this._data, 1 ); + if ( j >= ncols ) { + throw new RangeError( format( 'invalid argument. Second argument must be on the interval: [0,%u]. Value: `%s`.', ncols-1, j ) ); + } + return this._data.get( i, j ).raw; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index c8973608a024..8dceb4085117 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -22,7 +22,8 @@ var EventEmitter = require( 'events' ).EventEmitter; var logger = require( 'debug' ); -var setReadWriteAccessor = require( '@stdlib/utils/define-read-write-accessor' ); +var setReadWriteAccessor = require( '@stdlib/utils/define-nonenumerable-read-write-accessor' ); +var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); var defineProperty = require( '@stdlib/utils/define-property' ); var objectKeys = require( '@stdlib/utils/keys' ); var inherit = require( '@stdlib/utils/inherit' ); @@ -102,6 +103,8 @@ var getVerticalSeparatorMode = require( './props/vertical-separator-mode/get.js' var defaults = require( './defaults.js' ); var render = require( './render.js' ); var push = require( './push.js' ); +var getter = require( './get.js' ); +var setter = require( './set.js' ); // VARIABLES // @@ -1040,6 +1043,32 @@ setReadWriteAccessor( UnicodeTable.prototype, 'rowSeparator', getRowSeparator, s */ setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVerticalSeparatorMode, setVerticalSeparatorMode ); +/** +* Retrieves a single data element from a table. +* +* @name get +* @memberof UnicodeTable.prototype +* @type {Function} +* @param {NonNegativeInteger} i - index for the first dimension (i.e., zero-based row number) +* @param {NonNegativeInteger} j - index for the second dimension (i.e., zero-based column number) +* @throws {TypeError} first argument must be a nonnegative integer +* @throws {TypeError} second argument must be a nonnegative integer +* @throws {RangeError} index is out-of-bounds +* @returns {*} data element +* +* @example +* var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ], { +* 'headers': [ 'A', 'B' ] +* }); +* +* var v = table.get( 0, 0 ); +* // returns 1 +* +* v = table.get( 1, 1 ); +* // returns 4 +*/ +setReadOnly( UnicodeTable.prototype, 'get', getter ); + /** * Appends one or more rows to a table. * @@ -1049,7 +1078,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVertic * @param {(Object|Collection|VectorLike|MatrixLike)} data - row(s) to add * @throws {TypeError} must provide an object, an array-like object, or an ndarray * @throws {TypeError} must provide data containing the correct number of columns -* @returns {UnicodeTable} class instance +* @returns {UnicodeTable} table instance * * @example * var ndarray2array = require( '@stdlib/ndarray/to-array' ); @@ -1062,7 +1091,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVertic * data = ndarray2array( table.data ); * // returns [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] */ -UnicodeTable.prototype.push = push; +setReadOnly( UnicodeTable.prototype, 'push', push ); /** * Renders a table. @@ -1081,7 +1110,36 @@ UnicodeTable.prototype.push = push; * var str = table.render(); * // returns '...' */ -UnicodeTable.prototype.render = render; +setReadOnly( UnicodeTable.prototype, 'render', render ); + +/** +* Sets a single data element in a table to a specified value. +* +* @name set +* @memberof UnicodeTable.prototype +* @type {Function} +* @param {NonNegativeInteger} i - index for the first dimension (i.e., zero-based row number) +* @param {NonNegativeInteger} j - index for the second dimension (i.e., zero-based column number) +* @param {*} value - value to set +* @throws {TypeError} first argument must be a nonnegative integer +* @throws {TypeError} second argument must be a nonnegative integer +* @throws {RangeError} index is out-of-bounds +* @returns {UnicodeTable} table instance +* +* @example +* var table = new UnicodeTable( [ [ 1, 2 ], [ 3, 4 ] ], { +* 'headers': [ 'A', 'B' ] +* }); +* +* var v = table.get( 1, 0 ); +* // returns 3 +* +* table.set( 1, 0, 5 ); +* +* v = table.get( 1, 0 ); +* // returns 5 +*/ +setReadOnly( UnicodeTable.prototype, 'set', setter ); // EXPORTS // diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js new file mode 100644 index 000000000000..ac397cc30bee --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js @@ -0,0 +1,71 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); +var format = require( '@stdlib/string/format' ); +var normalizeData = require( './normalize.js' ); + + +// MAIN // + +/** +* Sets a single data element in a table to a specified value. +* +* @private +* @param {NonNegativeInteger} i - index for the first dimension (i.e., zero-based row number) +* @param {NonNegativeInteger} j - index for the second dimension (i.e., zero-based column number) +* @param {*} value - value to set +* @throws {TypeError} first argument must be a nonnegative integer +* @throws {TypeError} second argument must be a nonnegative integer +* @throws {RangeError} index is out-of-bounds +* @returns {UnicodeTable} table instance +*/ +function set( i, j, value ) { + var nrows; + var ncols; + var v; + if ( !isNonNegativeInteger( i ) ) { + throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', i ) ); + } + if ( !isNonNegativeInteger( j ) ) { + throw new TypeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%s`.', j ) ); + } + nrows = numelDimension( this._data, 0 ); + if ( i >= nrows ) { + throw new RangeError( format( 'invalid argument. First argument must be on the interval: [0,%u]. Value: `%s`.', nrows-1, i ) ); + } + ncols = numelDimension( this._data, 1 ); + if ( j >= ncols ) { + throw new RangeError( format( 'invalid argument. Second argument must be on the interval: [0,%u]. Value: `%s`.', ncols-1, j ) ); + } + v = normalizeData( [ value ] ); + this._data.set( i, j, v[ 0 ] ); + return this; +} + + +// EXPORTS // + +module.exports = set; From c045e403e137f68a3de6adc136a0a8893e69964e Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 01:02:33 -0800 Subject: [PATCH 13/34] docs: document methods --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 40 +++++++++++++++++++ .../@stdlib/plot/table/unicode/docs/repl.txt | 6 +++ .../@stdlib/plot/table/unicode/lib/get.js | 2 +- .../@stdlib/plot/table/unicode/lib/main.js | 2 +- .../@stdlib/plot/table/unicode/lib/set.js | 2 +- 5 files changed, 49 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 0c1574439129..2420a1d50aab 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -799,6 +799,25 @@ The following modes are supported: ### Methods + + +#### UnicodeTable.prototype.get( i, j ) + +Retrieves the data for a specified table cell. + +```javascript +var ndarray2array = require( '@stdlib/ndarray/to-array' ); + +var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); + +// Retrieve individual cell data: +var v = table.get( 0, 0 ); +// returns 1 + +v = table.get( 1, 2 ); +// returns 6 +``` + #### UnicodeTable.prototype.push( data ) @@ -840,6 +859,27 @@ var str = table.render(); // returns '...' ``` + + +#### UnicodeTable.prototype.set( i, j, value ) + +Sets the data for a specified table cell to a provided value. + +```javascript +var ndarray2array = require( '@stdlib/ndarray/to-array' ); + +var table = new UnicodeTable( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); + +// Retrieve individual cell data: +var v = table.get( 1, 1 ); +// returns 5 + +table.set( 1, 1, 7 ); + +v = table.get( 1, 1 ); +// returns 7 +``` + * * * ### Events diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index 48ac8e459653..c6b4c953e542 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -201,6 +201,9 @@ table.data Table data. + table.get( i, j ) + Retrieves the data for a specified table cell. + table.headers Table headers. @@ -270,6 +273,9 @@ table.rowSeparator Row separator character(s). + table.set( i, j, value ) + Sets the data for a specified table cell to a provided value. + table.verticalSeparatorMode Vertical line separator mode. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js index 83e637fcb64d..b5e2a75b2868 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/get.js @@ -30,7 +30,7 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Retrieves a single data element from a table. +* Retrieves the data for a specified table cell. * * @private * @param {NonNegativeInteger} i - index for the first dimension (i.e., zero-based row number) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 8dceb4085117..e14418781e39 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -1044,7 +1044,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'rowSeparator', getRowSeparator, s setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVerticalSeparatorMode, setVerticalSeparatorMode ); /** -* Retrieves a single data element from a table. +* Retrieves the data for a specified table cell. * * @name get * @memberof UnicodeTable.prototype diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js index ac397cc30bee..24db8772f70c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js @@ -31,7 +31,7 @@ var normalizeData = require( './normalize.js' ); // MAIN // /** -* Sets a single data element in a table to a specified value. +* Sets the data for a specified table cell to a provided value. * * @private * @param {NonNegativeInteger} i - index for the first dimension (i.e., zero-based row number) From 274f158bcb9e3e071744458cff6ff99366b3b010 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 15:43:43 -0800 Subject: [PATCH 14/34] feat: add support for specifying a format string --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 28 ++ .../plot/table/unicode/benchmark/benchmark.js | 250 ++++++++++++------ .../@stdlib/plot/table/unicode/docs/repl.txt | 6 + .../plot/table/unicode/examples/index.js | 3 +- .../plot/table/unicode/lib/defaults.js | 3 + .../@stdlib/plot/table/unicode/lib/main.js | 24 ++ .../plot/table/unicode/lib/normalize.js | 32 ++- .../plot/table/unicode/lib/props/data/set.js | 15 +- .../table/unicode/lib/props/format/get.js | 41 +++ .../table/unicode/lib/props/format/set.js | 75 ++++++ .../@stdlib/plot/table/unicode/lib/push.js | 2 +- .../@stdlib/plot/table/unicode/lib/set.js | 8 +- 12 files changed, 386 insertions(+), 101 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/set.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 2420a1d50aab..52559d37f95a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -79,6 +79,8 @@ The constructor accepts the following `options`: - **corners**: table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. This is a shorthand option instead of specifying corner character sequences individually. Default: `[ '┌', '┐', '┘', '└' ]`. +- **format**: cell [format][@stdlib/string/format] string(s). Default: `'%s'`. + - **headers**: table headers. - **headerSeparator**: header separator character(s). Default: `'─'`. @@ -423,6 +425,30 @@ var data = ndarray2array( table.data ); The returned [ndarray][@stdlib/ndarray/ctor] is a **read-only** view of table data. + + +#### UnicodeTable.prototype.format + +Cell [format][@stdlib/string/format] string(s) for rendering cell contents. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.format = '%d'; + +// Get: +var fmt = table.format; +// returns '%d' + +// Set: +table.format = [ '%s', '%d' ]; + +// Get: +fmt = table.format; +// returns [ '%s', '%d' ] +``` + #### UnicodeTable.prototype.headers @@ -1021,6 +1047,8 @@ console.log( str ); [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor +[@stdlib/string/format]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/format + diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index 747088dc509c..dab98f994108 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -21,6 +21,11 @@ // MODULES // var bench = require( '@stdlib/bench' ); +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive; +var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var isArray = require( '@stdlib/assert/is-array' ); +var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' ); var ndarray = require( '@stdlib/ndarray/ctor' ); var pkg = require( './../package.json' ).name; var UnicodeTable = require( './../lib' ); @@ -126,6 +131,7 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { 'cornerBottomLeft': '*', 'cornerBottomRight': '*', 'corners': [ '*', '*', '*', '*' ], + 'format': '%d', 'headers': [ 'col1', 'col2', 'col3' ], 'headerSeparator': '-=', 'horizontalSeparatorMode': 'repeat', @@ -177,12 +183,12 @@ bench( pkg+'::set,get:align:value=string', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.align = values[ i % values.length ]; - if ( typeof v.align !== 'string' ) { + if ( !isString( v.align ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.align !== 'string' ) { + if ( !isString( v.align ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -204,12 +210,12 @@ bench( pkg+'::set,get:align:value=array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.align = values[ i % values.length ]; - if ( typeof v.align !== 'object' || !v.align.length ) { + if ( !isArray( v.align ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.align !== 'object' || !v.align.length ) { + if ( !isArray( v.align ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -230,12 +236,12 @@ bench( pkg+'::set,get:autoRender', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.autoRender = values[ i % values.length ]; - if ( typeof v.autoRender !== 'boolean' ) { + if ( !isBoolean( v.autoRender ) ) { b.fail( 'should return a boolean' ); } } b.toc(); - if ( typeof v.autoRender !== 'boolean' ) { + if ( !isBoolean( v.autoRender ) ) { b.fail( 'should return a boolean' ); } b.pass( 'benchmark finished' ); @@ -256,12 +262,12 @@ bench( pkg+'::set,get:borderTop', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.borderTop = values[ i % values.length ]; - if ( typeof v.borderTop !== 'string' ) { + if ( !isString( v.borderTop ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.borderTop !== 'string' ) { + if ( !isString( v.borderTop ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -282,12 +288,12 @@ bench( pkg+'::set,get:borderRight', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.borderRight = values[ i % values.length ]; - if ( typeof v.borderRight !== 'string' ) { + if ( !isString( v.borderRight ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.borderRight !== 'string' ) { + if ( !isString( v.borderRight ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -308,12 +314,12 @@ bench( pkg+'::set,get:borderBottom', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.borderBottom = values[ i % values.length ]; - if ( typeof v.borderBottom !== 'string' ) { + if ( !isString( v.borderBottom ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.borderBottom !== 'string' ) { + if ( !isString( v.borderBottom ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -334,12 +340,12 @@ bench( pkg+'::set,get:borderLeft', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.borderLeft = values[ i % values.length ]; - if ( typeof v.borderLeft !== 'string' ) { + if ( !isString( v.borderLeft ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.borderLeft !== 'string' ) { + if ( !isString( v.borderLeft ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -362,12 +368,12 @@ bench( pkg+'::set,get:borders', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.borders = values[ i % values.length ]; - if ( typeof v.borders !== 'object' || !v.borders.length ) { + if ( !isArray( v.borders ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.borders !== 'object' || !v.borders.length ) { + if ( !isArray( v.borders ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -390,12 +396,12 @@ bench( pkg+'::set,get:bufferSize', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.bufferSize = values[ i % values.length ]; - if ( typeof v.bufferSize !== 'number' ) { + if ( !isNumber( v.bufferSize ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.bufferSize !== 'number' ) { + if ( !isNumber( v.bufferSize ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -418,12 +424,12 @@ bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.columnSeparator = values[ i % values.length ]; - if ( typeof v.columnSeparator !== 'string' ) { + if ( !isString( v.columnSeparator ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.columnSeparator !== 'string' ) { + if ( !isString( v.columnSeparator ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -444,12 +450,12 @@ bench( pkg+'::set,get:cornerTopLeft', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.cornerTopLeft = values[ i % values.length ]; - if ( typeof v.cornerTopLeft !== 'string' ) { + if ( !isString( v.cornerTopLeft ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cornerTopLeft !== 'string' ) { + if ( !isString( v.cornerTopLeft ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -470,12 +476,12 @@ bench( pkg+'::set,get:cornerTopRight', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.cornerTopRight = values[ i % values.length ]; - if ( typeof v.cornerTopRight !== 'string' ) { + if ( !isString( v.cornerTopRight ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cornerTopRight !== 'string' ) { + if ( !isString( v.cornerTopRight ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -496,12 +502,12 @@ bench( pkg+'::set,get:cornerBottomRight', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.cornerBottomRight = values[ i % values.length ]; - if ( typeof v.cornerBottomRight !== 'string' ) { + if ( !isString( v.cornerBottomRight ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cornerBottomRight !== 'string' ) { + if ( !isString( v.cornerBottomRight ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -522,12 +528,12 @@ bench( pkg+'::set,get:cornerBottomLeft', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.cornerBottomLeft = values[ i % values.length ]; - if ( typeof v.cornerBottomLeft !== 'string' ) { + if ( !isString( v.cornerBottomLeft ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.cornerBottomLeft !== 'string' ) { + if ( !isString( v.cornerBottomLeft ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -548,12 +554,12 @@ bench( pkg+'::set,get:corners', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.corners = values[ i % values.length ]; - if ( typeof v.corners !== 'object' || !v.corners.length ) { + if ( !isArray( v.corners ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.corners !== 'object' || !v.corners.length ) { + if ( !isArray( v.corners ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -574,12 +580,44 @@ bench( pkg+'::set,get:data:value=nested_array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.data = values[ i % values.length ]; - if ( typeof v.data !== 'object' || !v.data.length ) { + if ( typeof v.data !== 'object' ) { b.fail( 'should return an ndarray' ); } } b.toc(); - if ( typeof v.data !== 'object' || !v.data.length ) { + if ( !isndarrayLike( v.data ) ) { + b.fail( 'should return an ndarray' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:data:value=dictionary_of_columns', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + { + 'a': [ 1, 2, 3 ], + 'b': [ 4, 5, 6 ] + }, + { + 'a': [ 1, 2, 3 ], + 'b': [ 4, 5, 6 ] + } + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.data = values[ i % values.length ]; + if ( typeof v.data !== 'object' ) { + b.fail( 'should return an ndarray' ); + } + } + b.toc(); + if ( !isndarrayLike( v.data ) ) { b.fail( 'should return an ndarray' ); } b.pass( 'benchmark finished' ); @@ -600,18 +638,70 @@ bench( pkg+'::set,get:data:value=ndarray', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.data = values[ i % values.length ]; - if ( typeof v.data !== 'object' || !v.data.length ) { + if ( typeof v.data !== 'object' ) { b.fail( 'should return an ndarray' ); } } b.toc(); - if ( typeof v.data !== 'object' || !v.data.length ) { + if ( !isndarrayLike( v.data ) ) { b.fail( 'should return an ndarray' ); } b.pass( 'benchmark finished' ); b.end(); }); +bench( pkg+'::set,get:format:value=string', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + '%d', + '%f' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.format = values[ i % values.length ]; + if ( !isString( v.format ) ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( !isString( v.format ) ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:format:value=array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ '%d' ], + [ '%f' ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.format = values[ i % values.length ]; + if ( !isArray( v.format ) ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( !isArray( v.format ) ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:headers', function benchmark( b ) { var values; var v; @@ -626,12 +716,12 @@ bench( pkg+'::set,get:headers', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.headers = values[ i % values.length ]; - if ( typeof v.headers !== 'object' || !v.headers.length ) { + if ( !isArray( v.headers ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.headers !== 'object' || !v.headers.length ) { + if ( !isArray( v.headers ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -654,12 +744,12 @@ bench( pkg+'::set,get:headerSeparator', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.headerSeparator = values[ i % values.length ]; - if ( typeof v.headerSeparator !== 'string' ) { + if ( !isString( v.headerSeparator ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.headerSeparator !== 'string' ) { + if ( !isString( v.headerSeparator ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -681,12 +771,12 @@ bench( pkg+'::set,get:horizontalSeparatorMode', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.horizontalSeparatorMode = values[ i % values.length ]; - if ( typeof v.horizontalSeparatorMode !== 'string' ) { + if ( !isString( v.horizontalSeparatorMode ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.horizontalSeparatorMode !== 'string' ) { + if ( !isString( v.horizontalSeparatorMode ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -707,12 +797,12 @@ bench( pkg+'::set,get:jointMiddle', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.jointMiddle = values[ i % values.length ]; - if ( typeof v.jointMiddle !== 'string' ) { + if ( !isString( v.jointMiddle ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.jointMiddle !== 'string' ) { + if ( !isString( v.jointMiddle ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -733,12 +823,12 @@ bench( pkg+'::set,get:jointTop', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.jointTop = values[ i % values.length ]; - if ( typeof v.jointTop !== 'string' ) { + if ( !isString( v.jointTop ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.jointTop !== 'string' ) { + if ( !isString( v.jointTop ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -759,12 +849,12 @@ bench( pkg+'::set,get:jointRight', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.jointRight = values[ i % values.length ]; - if ( typeof v.jointRight !== 'string' ) { + if ( !isString( v.jointRight ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.jointRight !== 'string' ) { + if ( !isString( v.jointRight ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -785,12 +875,12 @@ bench( pkg+'::set,get:jointBottom', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.jointBottom = values[ i % values.length ]; - if ( typeof v.jointBottom !== 'string' ) { + if ( !isString( v.jointBottom ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.jointBottom !== 'string' ) { + if ( !isString( v.jointBottom ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -811,12 +901,12 @@ bench( pkg+'::set,get:jointLeft', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.jointLeft = values[ i % values.length ]; - if ( typeof v.jointLeft !== 'string' ) { + if ( !isString( v.jointLeft ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.jointLeft !== 'string' ) { + if ( !isString( v.jointLeft ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -837,12 +927,12 @@ bench( pkg+'::set,get:joints', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.joints = values[ i % values.length ]; - if ( typeof v.joints !== 'object' || !v.joints.length ) { + if ( !isArray( v.joints ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.joints !== 'object' || !v.joints.length ) { + if ( !isArray( v.joints ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -864,12 +954,12 @@ bench( pkg+'::set,get:marginTop', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.marginTop = values[ i % values.length ]; - if ( typeof v.marginTop !== 'number' ) { + if ( !isNumber( v.marginTop ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.marginTop !== 'number' ) { + if ( !isNumber( v.marginTop ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -891,12 +981,12 @@ bench( pkg+'::set,get:marginRight', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.marginRight = values[ i % values.length ]; - if ( typeof v.marginRight !== 'number' ) { + if ( !isNumber( v.marginRight ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.marginRight !== 'number' ) { + if ( !isNumber( v.marginRight ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -918,12 +1008,12 @@ bench( pkg+'::set,get:marginBottom', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.marginBottom = values[ i % values.length ]; - if ( typeof v.marginBottom !== 'number' ) { + if ( !isNumber( v.marginBottom ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.marginBottom !== 'number' ) { + if ( !isNumber( v.marginBottom ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -945,12 +1035,12 @@ bench( pkg+'::set,get:marginLeft', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.marginLeft = values[ i % values.length ]; - if ( typeof v.marginLeft !== 'number' ) { + if ( !isNumber( v.marginLeft ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.marginLeft !== 'number' ) { + if ( !isNumber( v.marginLeft ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -971,12 +1061,12 @@ bench( pkg+'::set,get:margins', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.margins = values[ i % values.length ]; - if ( typeof v.margins !== 'object' || !v.margins.length ) { + if ( !isArray( v.margins ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.margins !== 'object' || !v.margins.length ) { + if ( !isArray( v.margins ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -999,12 +1089,12 @@ bench( pkg+'::set,get:maxCellWidth:value=number', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.maxCellWidth = values[ i % values.length ]; - if ( typeof v.maxCellWidth !== 'number' ) { + if ( !isNumber( v.maxCellWidth ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.maxCellWidth !== 'number' ) { + if ( !isNumber( v.maxCellWidth ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -1027,12 +1117,12 @@ bench( pkg+'::set,get:maxCellWidth:value=array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.maxCellWidth = values[ i % values.length ]; - if ( typeof v.maxCellWidth !== 'object' || !v.maxCellWidth.length ) { + if ( !isArray( v.maxCellWidth ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.maxCellWidth !== 'object' || !v.maxCellWidth.length ) { + if ( !isArray( v.maxCellWidth ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -1055,12 +1145,12 @@ bench( pkg+'::set,get:maxWidth', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.maxWidth = values[ i % values.length ]; - if ( typeof v.maxWidth !== 'number' ) { + if ( !isNumber( v.maxWidth ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.maxWidth !== 'number' ) { + if ( !isNumber( v.maxWidth ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -1082,12 +1172,12 @@ bench( pkg+'::set,get:paddingLeft:value=number', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.paddingLeft = values[ i % values.length ]; - if ( typeof v.paddingLeft !== 'number' ) { + if ( !isNumber( v.paddingLeft ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.paddingLeft !== 'number' ) { + if ( !isNumber( v.paddingLeft ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -1109,12 +1199,12 @@ bench( pkg+'::set,get:paddingLeft:value=array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.paddingLeft = values[ i % values.length ]; - if ( typeof v.paddingLeft !== 'object' || !v.paddingLeft.length ) { + if ( !isArray( v.paddingLeft ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.paddingLeft !== 'object' || !v.paddingLeft.length ) { + if ( !isArray( v.paddingLeft ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -1136,12 +1226,12 @@ bench( pkg+'::set,get:paddingRight:value=number', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.paddingRight = values[ i % values.length ]; - if ( typeof v.paddingRight !== 'number' ) { + if ( !isNumber( v.paddingRight ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( typeof v.paddingRight !== 'number' ) { + if ( !isNumber( v.paddingRight ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); @@ -1163,12 +1253,12 @@ bench( pkg+'::set,get:paddingRight:value=array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.paddingRight = values[ i % values.length ]; - if ( typeof v.paddingRight !== 'object' || !v.paddingRight.length ) { + if ( !isArray( v.paddingRight ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( typeof v.paddingRight !== 'object' || !v.paddingRight.length ) { + if ( !isArray( v.paddingRight ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); @@ -1191,12 +1281,12 @@ bench( pkg+'::set,get:rowSeparator', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.rowSeparator = values[ i % values.length ]; - if ( typeof v.rowSeparator !== 'string' ) { + if ( !isString( v.rowSeparator ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.rowSeparator !== 'string' ) { + if ( !isString( v.rowSeparator ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); @@ -1218,12 +1308,12 @@ bench( pkg+'::set,get:verticalSeparatorMode', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { v.verticalSeparatorMode = values[ i % values.length ]; - if ( typeof v.verticalSeparatorMode !== 'string' ) { + if ( !isString( v.verticalSeparatorMode ) ) { b.fail( 'should return a string' ); } } b.toc(); - if ( typeof v.verticalSeparatorMode !== 'string' ) { + if ( !isString( v.verticalSeparatorMode ) ) { b.fail( 'should return a string' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index c6b4c953e542..f9b3324b16ac 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -68,6 +68,9 @@ [top-left, top-right, bottom-right, bottom-left]. Default: [ '┌', '┐', '┘', '└' ]. + options.format: Array|string (optional) + Cell format string(s). Default: '%s'. + options.headers: Array (optional) Table headers. @@ -201,6 +204,9 @@ table.data Table data. + table.format + Cell format. + table.get( i, j ) Retrieves the data for a specified table cell. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 9caf0e74ee7d..3b87732d2df3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -38,7 +38,8 @@ var table = new UnicodeTable( data, { 'maxWidth': 200, 'marginLeft': 5, 'marginRight': 5, - 'align': 'right' + 'align': 'right', + 'format': '%0.5f' }); // Render the table: diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index fa52023d585b..74672db653ea 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -106,6 +106,9 @@ function defaults() { 'ngraphemes': 1 }; + // Cell format string: + out.format = [ '%s' ]; + // Column headers: out.headers = null; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index e14418781e39..3769ca46cf40 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -60,6 +60,8 @@ var setColumnSeparator = require( './props/column-separator/set.js' ); var getColumnSeparator = require( './props/column-separator/get.js' ); var setData = require( './props/data/set.js' ); var getData = require( './props/data/get.js' ); +var setFormat = require( './props/format/set.js' ); +var getFormat = require( './props/format/get.js' ); var setHeaders = require( './props/headers/set.js' ); var getHeaders = require( './props/headers/get.js' ); var setHeaderSeparator = require( './props/header-separator/set.js' ); @@ -120,6 +122,7 @@ var PRIVATE_PROPS = [ '_corners', '_columnSeparator', '_data', + '_format', '_headers', '_headerSeparator', '_horizontalSeparatorMode', @@ -147,6 +150,7 @@ var OPTIONS_PROPS = [ 'corners', 'cornerTopLeft', 'cornerTopRight', + 'format', 'headers', 'headerSeparator', 'horizontalSeparatorMode', @@ -217,6 +221,7 @@ function initializePrivateProperties( table, defaults ) { // eslint-disable-line * @param {string} [options.cornerBottomRight='┘''] - bottom-right table corner grapheme cluster (i.e., visual character) * @param {string} [options.cornerBottomLeft='└'] - bottom-left table corner grapheme cluster (i.e., visual character) * @param {Collection} [options.corners=[ '┌', '┐', '┘', '└' ]] - table corner grapheme clusters (i.e., visual characters) +* @param {(string|StringArray)} [options.format='%s'] - cell format string(s) * @param {Collection} [options.headers] - table headers * @param {string} [options.headerSeparator='─'] - header separator character(s) * @param {string} [options.horizontalSeparatorMode='resume'] - horizontal line separator mode @@ -639,6 +644,25 @@ setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSepara */ setReadWriteAccessor( UnicodeTable.prototype, 'data', getData, setData ); +/** +* Cell format string(s). +* +* @name format +* @memberof UnicodeTable.prototype +* @type {(string|StringArray)} +* @throws {TypeError} must be a string or an array of strings +* @default '%s' +* +* @example +* var table = new UnicodeTable(); +* +* table.format = '%d'; +* +* var fmt = table.format; +* // returns '%d' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'format', getFormat, setFormat ); + /** * Table headers. * diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index 7bff93ac0a84..135f69d26a4e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -22,6 +22,7 @@ var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var accessors = require( '@stdlib/array/base/accessors' ); +var format = require( '@stdlib/string/format' ); // MAIN // @@ -31,9 +32,11 @@ var accessors = require( '@stdlib/array/base/accessors' ); * * @private * @param {Collection} buffer - linear data buffer +* @param {NonNegativeIntegerArray} shape - table data shape +* @param {StringArray} fmts - format strings * @returns {Collection} modified data buffer */ -function normalize( buffer ) { +function normalize( buffer, shape, fmts ) { var obj; var get; var set; @@ -41,20 +44,27 @@ function normalize( buffer ) { var ch; var v; var i; + var j; + var k; obj = accessors( buffer ); get = obj.accessors[ 0 ]; set = obj.accessors[ 1 ]; - for ( i = 0; i < buffer.length; i++ ) { - raw = get( buffer, i ); - v = String( raw ); - ch = splitGraphemeClusters( v ); - set( buffer, i, { - 'raw': raw, - 'value': v, - 'graphemes': ch, - 'ngraphemes': ch.length - }); + + k = 0; + for ( i = 0; i < shape[ 0 ]; i++ ) { + for ( j = 0; j < shape[ 1 ]; j++ ) { + raw = get( buffer, k ); + v = format( fmts[ j%fmts.length ], raw ); + ch = splitGraphemeClusters( v ); + set( buffer, k, { + 'raw': raw, + 'value': v, + 'graphemes': ch, + 'ngraphemes': ch.length + }); + k += 1; + } } return buffer; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index 11af5eebd832..409ce92727c3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -24,10 +24,10 @@ var isMatrixLike = require( '@stdlib/assert/is-matrix-like' ); var isCollection = require( '@stdlib/assert/is-collection' ); -var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); var assign = require( '@stdlib/ndarray/base/assign' ); var ndarray = require( '@stdlib/ndarray/base/ctor' ); var getShape = require( '@stdlib/ndarray/shape' ); +var getBaseShape = require( '@stdlib/ndarray/base/shape' ); var getData = require( '@stdlib/ndarray/base/data-buffer' ); var shape2strides = require( '@stdlib/ndarray/base/shape2strides' ); var zeros = require( '@stdlib/array/base/zeros' ); @@ -98,19 +98,20 @@ function set( data ) { out = out.data; // ndarray } // Ensure that the provided data does not have too many rows... - if ( numelDimension( out, 0 ) > this._bufferSize ) { - throw new RangeError( format( 'invalid assignment. `%s` exceeds maximum data buffer size. Either increase the table buffer size or provide fewer rows of data. Buffer size: %u. Number of rows: %u.', 'data', this._bufferSize, numelDimension( out, 0 ) ) ); + sh = getBaseShape( out, false ); + if ( sh[ 0 ] > this._bufferSize ) { + throw new RangeError( format( 'invalid assignment. `%s` exceeds maximum data buffer size. Either increase the table buffer size or provide fewer rows of data. Buffer size: %u. Number of rows: %u.', 'data', this._bufferSize, sh[ 0 ] ) ); } // Ensure that the provided data has the expected number of columns... if ( this._numColumns ) { - if ( numelDimension( out, 1 ) !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have %d columns in order to match the number of table columns. Number of columns: %u.', 'data', this._numColumns, numelDimension( out, 1 ) ) ); + if ( sh[ 1 ] !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have %d columns in order to match the number of table columns. Number of columns: %u.', 'data', this._numColumns, sh[ 1 ] ) ); } } else { - this._numColumns = numelDimension( out, 1 ); + this._numColumns = sh[ 1 ]; } // Normalize the underlying table data buffer: - normalizeData( getData( out ) ); + normalizeData( getData( out ), sh, this._format ); // Anytime a user sets table data, assume that the data has changed (note: performing a deep equality check is likely too expensive and not worth the effort) and thus, if not in "quiet" mode, always emit a 'change' event... this._data = out; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/get.js new file mode 100644 index 000000000000..50f4d79a82de --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/get.js @@ -0,0 +1,41 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the cell format string(s). +* +* @private +* @returns {(StringArray|string)} cell format string(s) +*/ +function get() { + if ( this._format.length > 1 ) { + return this._format.slice(); + } + return this._format[ 0 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/set.js new file mode 100644 index 000000000000..6efa9f64aac6 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/format/set.js @@ -0,0 +1,75 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives; +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the table cell format string(s). +* +* @private +* @param {(StringArray|string)} value - cell format string(s) +* @throws {TypeError} must provide a string or an array of strings +* @throws {RangeError} must provide the correct number of columns +*/ +function set( value ) { + if ( isString( value ) ) { + value = [ value ]; + if ( !isEqualArray( value, this._format ) ) { + this._format = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + if ( !isStringArray( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string or an array of strings. Value: `%s`.', 'format', value ) ); + } + if ( this._numColumns ) { + if ( value.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `[%s]`.', 'format', this._numColumns, copy( value ).join( ', ' ) ) ); + } + } else { + this._numColumns = value.length; + } + value = copy( value ); + if ( !isEqualArray( value, this._format ) ) { + this._format = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index 8f96582054d2..bea743417aab 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -162,7 +162,7 @@ function push( data ) { arr = out; } // Normalize the incoming table data: - normalizeData( getData( arr ) ); + normalizeData( getData( arr ), ash, this._format ); // Get the current number of table rows and columns: csh = getShape( view ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js index 24db8772f70c..be88f3d1a123 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js @@ -45,6 +45,7 @@ var normalizeData = require( './normalize.js' ); function set( i, j, value ) { var nrows; var ncols; + var fmt; var v; if ( !isNonNegativeInteger( i ) ) { throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', i ) ); @@ -60,8 +61,13 @@ function set( i, j, value ) { if ( j >= ncols ) { throw new RangeError( format( 'invalid argument. Second argument must be on the interval: [0,%u]. Value: `%s`.', ncols-1, j ) ); } - v = normalizeData( [ value ] ); + // Assume that, if a user is setting a new value, that means the data is different... (note: this provides an escape hatch for the same instance of a mutable class to be provided and have that instance trigger a 'change' event when its internal data/state has changed without the **reference** to that class instance having changed; meaning, two values may strictly compare as equal, but are allowed to render differently due to internal state changes) + fmt = this._format[ j%this._format.length ]; + v = normalizeData( [ value ], [ 1, 1 ], [ fmt ] ); this._data.set( i, j, v[ 0 ] ); + if ( !this._quiet ) { + this.emit( 'change' ); + } return this; } From 3509f9d01c5ff5f290d42b7e3d3847051b15b32c Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 15:45:48 -0800 Subject: [PATCH 15/34] docs: update example --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/plot/table/unicode/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 52559d37f95a..5f0778ea9139 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -985,7 +985,8 @@ var table = new UnicodeTable( data, { 'maxWidth': 200, 'marginLeft': 5, 'marginRight': 5, - 'align': 'right' + 'align': 'right', + 'format': '%0.5f' }); // Render the table: From 7e1b3a09f1850da07a6c6c612b337ecc7b3a5f16 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 15:46:31 -0800 Subject: [PATCH 16/34] style: disable lint rule --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/lib/props/data/set.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index 409ce92727c3..f8361cf2ea3b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -65,7 +65,7 @@ function set( data ) { if ( isMatrixLike( data ) ) { sh = getShape( data ); out = new FifoArray( zeros( sh[0]*sh[1] ) ); - out = new ndarray( DTYPE, out, sh, shape2strides( sh, ORDER ), 0, ORDER ); + out = new ndarray( DTYPE, out, sh, shape2strides( sh, ORDER ), 0, ORDER ); // eslint-disable-line max-len assign( [ data, out ] ); } // If provided a collection, convert to an ndarray... From a130400833478efcac5d2c375b2a24a834a24c94 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 18:21:10 -0800 Subject: [PATCH 17/34] feat!: rename property/option and support separate header alignment --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/plot/table/unicode/README.md | 137 ++++++++++++------ .../plot/table/unicode/benchmark/benchmark.js | 73 ++++++++-- .../@stdlib/plot/table/unicode/docs/repl.txt | 20 ++- .../table/unicode/examples/ansi_styling.js | 49 +++++++ .../plot/table/unicode/examples/emoji.js | 46 ++++++ .../plot/table/unicode/examples/index.js | 7 + .../plot/table/unicode/lib/defaults.js | 7 +- .../@stdlib/plot/table/unicode/lib/main.js | 134 ++++++++++------- .../unicode/lib/props/header-align/get.js | 44 ++++++ .../unicode/lib/props/header-align/set.js | 103 +++++++++++++ .../get.js | 10 +- .../set.js | 18 +-- .../@stdlib/plot/table/unicode/lib/render.js | 12 +- .../plot/table/unicode/test/test.main.js | 4 +- ...cell_width.js => test.max_column_width.js} | 48 +++--- .../plot/table/unicode/test/test.render.js | 4 +- 16 files changed, 561 insertions(+), 155 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{max-cell-width => max-column-width}/get.js (80%) rename lib/node_modules/@stdlib/plot/table/unicode/lib/props/{max-cell-width => max-column-width}/set.js (84%) rename lib/node_modules/@stdlib/plot/table/unicode/test/{test.max_cell_width.js => test.max_column_width.js} (61%) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 5f0778ea9139..5cee05caa000 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -81,6 +81,14 @@ The constructor accepts the following `options`: - **format**: cell [format][@stdlib/string/format] string(s). Default: `'%s'`. +- **headerAlign**: alignment of data within table header cells. Must be one of the following: + + - `'right'`: right-aligned. + - `'left'`: left-aligned. + - `'center'`: center-aligned. + + To specify the alignment of data within each table column, provide an array of alignment specifiers. Default: `'right'`. + - **headers**: table headers. - **headerSeparator**: header separator character(s). Default: `'─'`. @@ -115,7 +123,7 @@ The constructor accepts the following `options`: - **margins**: table margins in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying margins individually. Default: `[ 0, 0, 0, 0 ]`. -- **maxCellWidth**: maximum cell width(s) in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. +- **maxColumnWidth**: maximum cell width(s) in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. - **maxWidth**: maximum table width in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. @@ -150,14 +158,14 @@ var table = new UnicodeTable(); table.align = 'center'; // Get: -var align = table.align; +var v = table.align; // returns 'center' // Set: table.align = [ 'left', 'right', 'center' ]; // Get: -align = table.align; +v = table.align; // returns [ 'left', 'right', 'center' ] ``` @@ -182,7 +190,7 @@ var table = new UnicodeTable(); table.autoRender = false; // Get: -var mode = table.autoRender; +var v = table.autoRender; // returns false ``` @@ -199,7 +207,7 @@ var table = new UnicodeTable(); table.borderTop = '='; // Get: -var border = table.borderTop; +var v = table.borderTop; // returns '=' ``` @@ -216,7 +224,7 @@ var table = new UnicodeTable(); table.borderRight = '!'; // Get: -var border = table.borderRight; +var v = table.borderRight; // returns '!' ``` @@ -233,7 +241,7 @@ var table = new UnicodeTable(); table.borderBottom = '='; // Get: -var border = table.borderBottom; +var v = table.borderBottom; // returns '=' ``` @@ -250,7 +258,7 @@ var table = new UnicodeTable(); table.borderLeft = '!'; // Get: -var border = table.borderLeft; +var v = table.borderLeft; // returns '!' ``` @@ -267,7 +275,7 @@ var table = new UnicodeTable(); table.borders = [ '=', '!', '=', '!' ]; // Get: -var borders = table.borders; +var v = table.borders; // returns [ '=', '!', '=', '!' ] ``` @@ -286,7 +294,7 @@ var table = new UnicodeTable(); table.bufferSize = 3; // Get: -var size = table.bufferSize; +var v = table.bufferSize; // returns 3 table.data = [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ]; @@ -315,7 +323,7 @@ var table = new UnicodeTable(); table.columnSeparator = '|'; // Get: -var separator = table.columnSeparator; +var v = table.columnSeparator; // returns '|' ``` @@ -332,7 +340,7 @@ var table = new UnicodeTable(); table.cornerTopLeft = '*'; // Get: -var corner = table.cornerTopLeft; +var v = table.cornerTopLeft; // returns '*' ``` @@ -349,7 +357,7 @@ var table = new UnicodeTable(); table.cornerTopRight = '*'; // Get: -var corner = table.cornerTopRight; +var v = table.cornerTopRight; // returns '*' ``` @@ -366,7 +374,7 @@ var table = new UnicodeTable(); table.cornerBottomRight = '*'; // Get: -var corner = table.cornerBottomRight; +var v = table.cornerBottomRight; // returns '*' ``` @@ -383,7 +391,7 @@ var table = new UnicodeTable(); table.cornerBottomLeft = '*'; // Get: -var corner = table.cornerBottomLeft; +var v = table.cornerBottomLeft; // returns '*' ``` @@ -400,7 +408,7 @@ var table = new UnicodeTable(); table.corners = [ '*', '*', '*', '*' ]; // Get: -var corners = table.corners; +var v = table.corners; // returns [ '*', '*', '*', '*' ] ``` @@ -438,17 +446,51 @@ var table = new UnicodeTable(); table.format = '%d'; // Get: -var fmt = table.format; +var v = table.format; // returns '%d' // Set: table.format = [ '%s', '%d' ]; // Get: -fmt = table.format; +v = table.format; // returns [ '%s', '%d' ] ``` + + +#### UnicodeTable.prototype.headerAlign + +Alignment(s) of data within table header cells. + +```javascript +var table = new UnicodeTable(); + +// Set: +table.headerAlign = 'center'; + +// Get: +var v = table.headerAlign; +// returns 'center' + +// Set: +table.headerAlign = [ 'left', 'right', 'center' ]; + +// Get: +v = table.headerAlign; +// returns [ 'left', 'right', 'center' ] +``` + +By default and when set to `null`, the alignment of header cell data matches that of [`table.align`](#prop-align). To specify an alignment which diverges from data cell alignment, specify an alternative alignment. + +The following alignments are supported: + +- **right**: right-aligned. +- **left**: left-aligned. +- **center**: center-aligned. + +To specify the alignment for each header column individually, set to an array of alignment values. + #### UnicodeTable.prototype.headers @@ -462,7 +504,7 @@ var table = new UnicodeTable(); table.headers = [ 'A', 'B' ]; // Get: -var headers = table.headers; +var v = table.headers; // returns [ 'A', 'B' ] ``` @@ -479,7 +521,7 @@ var table = new UnicodeTable(); table.headerSeparator = '-'; // Get: -var separator = table.headerSeparator; +var v = table.headerSeparator; // returns '-' ``` @@ -496,7 +538,7 @@ var table = new UnicodeTable(); table.horizontalSeparatorMode = 'interpolate'; // Get: -var mode = table.horizontalSeparatorMode; +var v = table.horizontalSeparatorMode; // returns 'interpolate' ``` @@ -519,7 +561,7 @@ var table = new UnicodeTable(); table.jointMiddle = '*'; // Get: -var joint = table.jointMiddle; +var v = table.jointMiddle; // returns '*' ``` @@ -536,7 +578,7 @@ var table = new UnicodeTable(); table.jointTop = '*'; // Get: -var joint = table.jointTop; +var v = table.jointTop; // returns '*' ``` @@ -553,7 +595,7 @@ var table = new UnicodeTable(); table.jointRight = '*'; // Get: -var joint = table.jointRight; +var v = table.jointRight; // returns '*' ``` @@ -570,7 +612,7 @@ var table = new UnicodeTable(); table.jointBottom = '*'; // Get: -var joint = table.jointBottom; +var v = table.jointBottom; // returns '*' ``` @@ -587,7 +629,7 @@ var table = new UnicodeTable(); table.jointLeft = '*'; // Get: -var joint = table.jointLeft; +var v = table.jointLeft; // returns '*' ``` @@ -604,7 +646,7 @@ var table = new UnicodeTable(); table.joints = [ '*', '*', '*', '*', '*' ]; // Get: -var joints = table.joints; +var v = table.joints; // returns [ '*', '*', '*', '*', '*' ] ``` @@ -621,7 +663,7 @@ var table = new UnicodeTable(); table.marginTop = 2; // Get: -var margin = table.marginTop; +var v = table.marginTop; // returns 2 ``` @@ -638,7 +680,7 @@ var table = new UnicodeTable(); table.marginRight = 2; // Get: -var margin = table.marginRight; +var v = table.marginRight; // returns 2 ``` @@ -655,7 +697,7 @@ var table = new UnicodeTable(); table.marginBottom = 2; // Get: -var margin = table.marginBottom; +var v = table.marginBottom; // returns 2 ``` @@ -672,7 +714,7 @@ var table = new UnicodeTable(); table.marginLeft = 2; // Get: -var margin = table.marginLeft; +var v = table.marginLeft; // returns 2 ``` @@ -689,13 +731,13 @@ var table = new UnicodeTable(); table.margins = [ 2, 2, 2, 2 ]; // Get: -var margins = table.margins; +var v = table.margins; // returns [ 2, 2, 2, 2 ] ``` -#### UnicodeTable.prototype.maxCellWidth +#### UnicodeTable.prototype.maxColumnWidth Maximum cell width in units of grapheme clusters (i.e., visual characters). If cell data is longer than the maximum cell width, the rendered cell data is truncated. To specify the maximum cell width for each column of cells, provide an array of maximum cell widths. @@ -703,17 +745,17 @@ Maximum cell width in units of grapheme clusters (i.e., visual characters). If c var table = new UnicodeTable(); // Set: -table.maxCellWidth = 10; +table.maxColumnWidth = 10; // Get: -var width = table.maxCellWidth; +var v = table.maxColumnWidth; // returns 10 // Set: -table.maxCellWidth = [ 10, 15 ]; +table.maxColumnWidth = [ 10, 15 ]; // Get: -width = table.maxCellWidth; +v = table.maxColumnWidth; ``` @@ -729,7 +771,7 @@ var table = new UnicodeTable(); table.maxWidth = 200; // Get: -var width = table.maxWidth; +var v = table.maxWidth; // returns 200 ``` @@ -746,14 +788,14 @@ var table = new UnicodeTable(); table.paddingLeft = 3; // Get: -var padding = table.paddingLeft; +var v = table.paddingLeft; // returns 3 // Set: table.paddingLeft = [ 3, 4 ]; // Get: -padding = table.paddingLeft; +v = table.paddingLeft; // returns [ 3, 4 ] ``` @@ -770,14 +812,14 @@ var table = new UnicodeTable(); table.paddingRight = 3; // Get: -var padding = table.paddingRight; +var v = table.paddingRight; // returns 3 // Set: table.paddingRight = [ 3, 4 ]; // Get: -padding = table.paddingRight; +v = table.paddingRight; // returns [ 3, 4 ] ``` @@ -794,7 +836,7 @@ var table = new UnicodeTable(); table.rowSeparator = '-'; // Get: -var separator = table.rowSeparator; +var v = table.rowSeparator; // returns '-' ``` @@ -811,7 +853,7 @@ var table = new UnicodeTable(); table.verticalSeparatorMode = 'interpolate'; // Get: -var mode = table.verticalSeparatorMode; +var v = table.verticalSeparatorMode; // returns 'interpolate' ``` @@ -986,6 +1028,13 @@ var table = new UnicodeTable( data, { 'marginLeft': 5, 'marginRight': 5, 'align': 'right', + 'headerAlign': [ + 'left', + 'center', + 'right', + 'center', + 'left' + ], 'format': '%0.5f' }); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index dab98f994108..0bb69fb67f86 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -132,6 +132,7 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { 'cornerBottomRight': '*', 'corners': [ '*', '*', '*', '*' ], 'format': '%d', + 'headerAlign': 'center', 'headers': [ 'col1', 'col2', 'col3' ], 'headerSeparator': '-=', 'horizontalSeparatorMode': 'repeat', @@ -146,7 +147,7 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { 'marginBottom': 4, 'marginLeft': 2, 'margins': [ 4, 2, 4, 2 ], - 'maxCellWidth': 10, + 'maxColumnWidth': 10, 'maxWidth': 60, 'paddingLeft': 2, 'paddingRight': [ 2, 3, 4 ], @@ -702,6 +703,60 @@ bench( pkg+'::set,get:format:value=array', function benchmark( b ) { b.end(); }); +bench( pkg+'::set,get:headerAlign:value=string', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 'left', + 'center', + 'right' + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.headerAlign = values[ i % values.length ]; + if ( !isString( v.headerAlign ) ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( !isString( v.headerAlign ) ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:headerAlign:value=array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 'left', 'right' ], + [ 'center', 'right' ], + [ 'left', 'center' ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.headerAlign = values[ i % values.length ]; + if ( !isArray( v.headerAlign ) ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( !isArray( v.headerAlign ) ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:headers', function benchmark( b ) { var values; var v; @@ -1073,7 +1128,7 @@ bench( pkg+'::set,get:margins', function benchmark( b ) { b.end(); }); -bench( pkg+'::set,get:maxCellWidth:value=number', function benchmark( b ) { +bench( pkg+'::set,get:maxColumnWidth:value=number', function benchmark( b ) { var values; var v; var i; @@ -1088,20 +1143,20 @@ bench( pkg+'::set,get:maxCellWidth:value=number', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.maxCellWidth = values[ i % values.length ]; - if ( !isNumber( v.maxCellWidth ) ) { + v.maxColumnWidth = values[ i % values.length ]; + if ( !isNumber( v.maxColumnWidth ) ) { b.fail( 'should return a number' ); } } b.toc(); - if ( !isNumber( v.maxCellWidth ) ) { + if ( !isNumber( v.maxColumnWidth ) ) { b.fail( 'should return a number' ); } b.pass( 'benchmark finished' ); b.end(); }); -bench( pkg+'::set,get:maxCellWidth:value=array', function benchmark( b ) { +bench( pkg+'::set,get:maxColumnWidth:value=array', function benchmark( b ) { var values; var v; var i; @@ -1116,13 +1171,13 @@ bench( pkg+'::set,get:maxCellWidth:value=array', function benchmark( b ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - v.maxCellWidth = values[ i % values.length ]; - if ( !isArray( v.maxCellWidth ) ) { + v.maxColumnWidth = values[ i % values.length ]; + if ( !isArray( v.maxColumnWidth ) ) { b.fail( 'should return an array' ); } } b.toc(); - if ( !isArray( v.maxCellWidth ) ) { + if ( !isArray( v.maxColumnWidth ) ) { b.fail( 'should return an array' ); } b.pass( 'benchmark finished' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index f9b3324b16ac..65e84ca7ea25 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -71,6 +71,15 @@ options.format: Array|string (optional) Cell format string(s). Default: '%s'. + options.headerAlign: Array|string|null (optional) + Header cell alignment(s). Must be one of the following: + + - left: left-aligned. + - center: center-aligned. + - right: right-aligned. + + Default: 'right'. + options.headers: Array (optional) Table headers. @@ -126,8 +135,8 @@ Table margins in the order [top, right, bottom, left]. Default: [ 0, 0, 0, 0 ]. - options.maxCellWidth: Array|integer|null (optional) - Maximum cell width(s) in units of grapheme clusters (i.e., visual + options.maxColumnWidth: Array|integer|null (optional) + Maximum column width(s) in units of grapheme clusters (i.e., visual characters). Default: +infinity. options.maxWidth: integer|null (optional) @@ -210,6 +219,9 @@ table.get( i, j ) Retrieves the data for a specified table cell. + table.headerAlign + Header cell alignment(s). + table.headers Table headers. @@ -258,8 +270,8 @@ table.margins Table margins in the order [top, right, bottom, left]. - table.maxCellWidth - Maximum cell width. + table.maxColumnWidth + Maximum column width. table.maxWidth Maximum table width. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js new file mode 100644 index 000000000000..9234387c1a9f --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -0,0 +1,49 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 UnicodeTable = require( './../lib' ); + +// Define a data set containing emoji: +var data = [ + [ + '\u001b[31mbeep\u001b[0m', // red + '\u001b[1mboop\u001b[0m', // bold + '\u001b[44mfoo\u001b[0m', // blue_bg + '\u001b[4m\u001b[47mbar\u001b[0m\u001b[0m' // underline, white_bg + ] +]; + +// Define column headers: +var headers = [ 'A', 'B', 'C', 'D' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'columnSeparator': '|', + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right' +}); + +// Render the table: +var str = table.render(); +console.log( str ); +// => '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js new file mode 100644 index 000000000000..347334fec6fe --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js @@ -0,0 +1,46 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 UnicodeTable = require( './../lib' ); + +// Define a data set containing emoji: +var data = [ + [ '😀', '🙌🏼', '👩🏾‍🚀', '👑', '🐇' ], + [ '🙏🏻', '👉', '👏', '🤙', '☝🏿' ] +]; + +// Define column headers: +var headers = [ '1️⃣', '2️⃣', '3️⃣', '4️⃣', '5️⃣' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'columnSeparator': '|', + 'cellWidth': 10, + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right' +}); + +// Render the table: +var str = table.render(); +console.log( str ); +// => '...' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 3b87732d2df3..567e9e5db632 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -39,6 +39,13 @@ var table = new UnicodeTable( data, { 'marginLeft': 5, 'marginRight': 5, 'align': 'right', + 'headerAlign': [ + 'left', + 'center', + 'right', + 'center', + 'left' + ], 'format': '%0.5f' }); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index 74672db653ea..03a530791751 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -109,6 +109,9 @@ function defaults() { // Cell format string: out.format = [ '%s' ]; + // Header alignment: + out.headerAlign = null; + // Column headers: out.headers = null; @@ -159,8 +162,8 @@ function defaults() { // Table margins: out.margins = [ 0, 0, 0, 0 ]; - // Maximum cell width: - out.maxCellWidth = [ FLOAT64_MAX ]; + // Maximum column width: + out.maxColumnWidth = [ FLOAT64_MAX ]; // Maximum table width: out.maxWidth = FLOAT64_MAX; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 3769ca46cf40..4fb5f8ffe2a3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -64,6 +64,8 @@ var setFormat = require( './props/format/set.js' ); var getFormat = require( './props/format/get.js' ); var setHeaders = require( './props/headers/set.js' ); var getHeaders = require( './props/headers/get.js' ); +var setHeaderAlign = require( './props/header-align/set.js' ); +var getHeaderAlign = require( './props/header-align/get.js' ); var setHeaderSeparator = require( './props/header-separator/set.js' ); var getHeaderSeparator = require( './props/header-separator/get.js' ); var setHorizontalSeparatorMode = require( './props/horizontal-separator-mode/set.js' ); // eslint-disable-line id-length @@ -90,8 +92,8 @@ var setMarginLeft = require( './props/margin-left/set.js' ); var getMarginLeft = require( './props/margin-left/get.js' ); var setMargins = require( './props/margins/set.js' ); var getMargins = require( './props/margins/get.js' ); -var setMaxCellWidth = require( './props/max-cell-width/set.js' ); -var getMaxCellWidth = require( './props/max-cell-width/get.js' ); +var setMaxColumnWidth = require( './props/max-column-width/set.js' ); +var getMaxColumnWidth = require( './props/max-column-width/get.js' ); var setMaxWidth = require( './props/max-width/set.js' ); var getMaxWidth = require( './props/max-width/get.js' ); var setPaddingLeft = require( './props/padding-left/set.js' ); @@ -123,12 +125,13 @@ var PRIVATE_PROPS = [ '_columnSeparator', '_data', '_format', + '_headerAlign', '_headers', '_headerSeparator', '_horizontalSeparatorMode', '_joints', '_margins', - '_maxCellWidth', + '_maxColumnWidth', '_maxWidth', '_numColumns', '_paddingLeft', @@ -151,6 +154,7 @@ var OPTIONS_PROPS = [ 'cornerTopLeft', 'cornerTopRight', 'format', + 'headerAlign', 'headers', 'headerSeparator', 'horizontalSeparatorMode', @@ -165,7 +169,7 @@ var OPTIONS_PROPS = [ 'marginRight', 'marginTop', 'margins', - 'maxCellWidth', + 'maxColumnWidth', 'maxWidth', 'paddingLeft', 'paddingRight', @@ -236,7 +240,7 @@ function initializePrivateProperties( table, defaults ) { // eslint-disable-line * @param {NonNegativeInteger} [options.marginBottom=0] - margin at the bottom of the table in units of blank lines * @param {NonNegativeInteger} [options.marginLeft=0] - margin to the left of the table in units of whitespace * @param {NonNegativeIntegerArray} [options.margins=[0, 0, 0, 0]] - table margins -* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.maxCellWidth] - maximum cell width(s) +* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.maxColumnWidth] - maximum cell width(s) * @param {NonNegativeInteger} [options.maxWidth] - maximum table width * @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.paddingLeft=1] - cell left padding in units of whitespace * @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.paddingRight=1] - cell right padding in units of whitespace @@ -361,7 +365,7 @@ inherit( UnicodeTable, EventEmitter ); * * table.align = 'left'; * -* var align = table.align; +* var v = table.align; * // returns 'left' * * @example @@ -369,7 +373,7 @@ inherit( UnicodeTable, EventEmitter ); * * table.align = [ 'left', 'right', 'center' ]; * -* var align = table.align; +* var v = table.align; * // returns [ 'left', 'right', 'center' ] */ setReadWriteAccessor( UnicodeTable.prototype, 'align', getAlign, setAlign ); @@ -392,7 +396,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'align', getAlign, setAlign ); * * table.autoRender = true; * -* var mode = table.autoRender; +* var v = table.autoRender; * // returns true */ setReadWriteAccessor( UnicodeTable.prototype, 'autoRender', getAutoRender, setAutoRender ); @@ -411,7 +415,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'autoRender', getAutoRender, setAu * * table.borderTop = '='; * -* var border = table.borderTop; +* var v = table.borderTop; * // returns '=' */ setReadWriteAccessor( UnicodeTable.prototype, 'borderTop', getBorderTop, setBorderTop ); @@ -430,7 +434,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borderTop', getBorderTop, setBord * * table.borderRight = '|'; * -* var border = table.borderRight; +* var v = table.borderRight; * // returns '|' */ setReadWriteAccessor( UnicodeTable.prototype, 'borderRight', getBorderRight, setBorderRight ); @@ -449,7 +453,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borderRight', getBorderRight, set * * table.borderBottom = '='; * -* var border = table.borderBottom; +* var v = table.borderBottom; * // returns '=' */ setReadWriteAccessor( UnicodeTable.prototype, 'borderBottom', getBorderBottom, setBorderBottom ); @@ -468,7 +472,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borderBottom', getBorderBottom, s * * table.borderLeft = '|'; * -* var border = table.borderLeft; +* var v = table.borderLeft; * // returns '|' */ setReadWriteAccessor( UnicodeTable.prototype, 'borderLeft', getBorderLeft, setBorderLeft ); @@ -487,7 +491,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borderLeft', getBorderLeft, setBo * * table.borders = [ '=', '!', '=', '!' ]; * -* var borders = table.borders; +* var v = table.borders; * // returns [ '=', '!', '=', '!' ] */ setReadWriteAccessor( UnicodeTable.prototype, 'borders', getBorders, setBorders ); @@ -505,6 +509,9 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borders', getBorders, setBorders * var table = new UnicodeTable(); * * table.bufferSize = 20; +* +* var v = table.bufferSize; +* // returns 20 */ setReadWriteAccessor( UnicodeTable.prototype, 'bufferSize', getBufferSize, setBufferSize ); @@ -522,7 +529,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'bufferSize', getBufferSize, setBu * * table.cornerTopLeft = '*'; * -* var corner = table.cornerTopLeft; +* var v = table.cornerTopLeft; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopLeft', getCornerTopLeft, setCornerTopLeft ); @@ -541,7 +548,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopLeft', getCornerTopLeft, * * table.cornerTopRight = '*'; * -* var corner = table.cornerTopRight; +* var v = table.cornerTopRight; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopRight', getCornerTopRight, setCornerTopRight ); @@ -560,7 +567,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopRight', getCornerTopRigh * * table.cornerBottomRight = '*'; * -* var corner = table.cornerBottomRight; +* var v = table.cornerBottomRight; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomRight', getCornerBottomRight, setCornerBottomRight ); @@ -579,7 +586,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomRight', getCornerBott * * table.cornerBottomLeft = '*'; * -* var corner = table.cornerBottomLeft; +* var v = table.cornerBottomLeft; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomLeft', getCornerBottomLeft, setCornerBottomLeft ); @@ -598,7 +605,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomLeft', getCornerBotto * * table.corners = [ '*', '*', '*', '*' ]; * -* var corners = table.corners; +* var v = table.corners; * // returns [ '*', '*', '*', '*' ] */ setReadWriteAccessor( UnicodeTable.prototype, 'corners', getCorners, setCorners ); @@ -617,7 +624,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'corners', getCorners, setCorners * * table.columnSeparator = '$='; * -* var separator = table.columnSeparator; +* var v = table.columnSeparator; * // returns '$=' */ setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSeparator, setColumnSeparator ); @@ -639,7 +646,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSepara * * table.data = [ [ 'a', 'b' ], [ 1, 2 ] ]; * -* var data = ndarray2array( table.data ); +* var v = ndarray2array( table.data ); * // returns [ [ 'a', 'b' ], [ 1, 2 ] ] */ setReadWriteAccessor( UnicodeTable.prototype, 'data', getData, setData ); @@ -658,11 +665,38 @@ setReadWriteAccessor( UnicodeTable.prototype, 'data', getData, setData ); * * table.format = '%d'; * -* var fmt = table.format; +* var v = table.format; * // returns '%d' */ setReadWriteAccessor( UnicodeTable.prototype, 'format', getFormat, setFormat ); +/** +* Alignment(s) of data within in each table header cell. +* +* @name headerAlign +* @memberof UnicodeTable.prototype +* @type {(Array|string)} +* @throws {TypeError} must be a supported alignment string or an array of alignment strings +* @default 'right' +* +* @example +* var table = new UnicodeTable(); +* +* table.headerAlign = 'left'; +* +* var v = table.headerAlign; +* // returns 'left' +* +* @example +* var table = new UnicodeTable(); +* +* table.headerAlign = [ 'left', 'right', 'center' ]; +* +* var v = table.headerAlign; +* // returns [ 'left', 'right', 'center' ] +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'headerAlign', getHeaderAlign, setHeaderAlign ); + /** * Table headers. * @@ -677,7 +711,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'format', getFormat, setFormat ); * * table.headers = [ 'name', 'age' ]; * -* var headers = table.headers; +* var v = table.headers; * // returns [ 'name', 'age' ] */ setReadWriteAccessor( UnicodeTable.prototype, 'headers', getHeaders, setHeaders ); @@ -696,7 +730,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'headers', getHeaders, setHeaders * * table.headerSeparator = '$='; * -* var separator = table.headerSeparator; +* var v = table.headerSeparator; * // returns '$=' */ setReadWriteAccessor( UnicodeTable.prototype, 'headerSeparator', getHeaderSeparator, setHeaderSeparator ); @@ -715,7 +749,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'headerSeparator', getHeaderSepara * * table.horizontalSeparatorMode = 'repeat'; * -* var mode = table.horizontalSeparatorMode; +* var v = table.horizontalSeparatorMode; * // returns 'repeat' */ setReadWriteAccessor( UnicodeTable.prototype, 'horizontalSeparatorMode', getHorizontalSeparatorMode, setHorizontalSeparatorMode ); @@ -734,7 +768,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'horizontalSeparatorMode', getHori * * table.jointMiddle = '*'; * -* var joint = table.jointMiddle; +* var v = table.jointMiddle; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'jointMiddle', getJointMiddle, setJointMiddle ); @@ -753,7 +787,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointMiddle', getJointMiddle, set * * table.jointTop = '*'; * -* var joint = table.jointTop; +* var v = table.jointTop; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'jointTop', getJointTop, setJointTop ); @@ -772,7 +806,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointTop', getJointTop, setJointT * * table.jointRight = '*'; * -* var joint = table.jointRight; +* var v = table.jointRight; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'jointRight', getJointRight, setJointRight ); @@ -791,7 +825,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointRight', getJointRight, setJo * * table.jointBottom = '*'; * -* var joint = table.jointBottom; +* var v = table.jointBottom; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'jointBottom', getJointBottom, setJointBottom ); @@ -810,7 +844,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointBottom', getJointBottom, set * * table.jointLeft = '*'; * -* var joint = table.jointLeft; +* var v = table.jointLeft; * // returns '*' */ setReadWriteAccessor( UnicodeTable.prototype, 'jointLeft', getJointLeft, setJointLeft ); @@ -829,7 +863,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointLeft', getJointLeft, setJoin * * table.joints = [ '*', '*', '*', '*', '*' ]; * -* var joints = table.joints; +* var v = table.joints; * // returns [ '*', '*', '*', '*', '*' ] */ setReadWriteAccessor( UnicodeTable.prototype, 'joints', getJoints, setJoints ); @@ -848,7 +882,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'joints', getJoints, setJoints ); * * table.marginTop = 2; * -* var margin = table.marginTop; +* var v = table.marginTop; * // returns 2 */ setReadWriteAccessor( UnicodeTable.prototype, 'marginTop', getMarginTop, setMarginTop ); @@ -867,7 +901,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginTop', getMarginTop, setMarg * * table.marginRight = 2; * -* var margin = table.marginRight; +* var v = table.marginRight; * // returns 2 */ setReadWriteAccessor( UnicodeTable.prototype, 'marginRight', getMarginRight, setMarginRight ); @@ -886,7 +920,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginRight', getMarginRight, set * * table.marginBottom = 2; * -* var margin = table.marginBottom; +* var v = table.marginBottom; * // returns 2 */ setReadWriteAccessor( UnicodeTable.prototype, 'marginBottom', getMarginBottom, setMarginBottom ); @@ -905,7 +939,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginBottom', getMarginBottom, s * * table.marginLeft = 2; * -* var margin = table.marginLeft; +* var v = table.marginLeft; * // returns 2 */ setReadWriteAccessor( UnicodeTable.prototype, 'marginLeft', getMarginLeft, setMarginLeft ); @@ -924,15 +958,15 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginLeft', getMarginLeft, setMa * * table.margins = [ 2, 2, 2, 2 ]; * -* var margins = table.margins; +* var v = table.margins; * // returns [ 2, 2, 2, 2 ] */ setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins ); /** -* Maximum cell width(s) in units of grapheme clusters (i.e., visual characters). +* Maximum column width(s) in units of grapheme clusters (i.e., visual characters). * -* @name maxCellWidth +* @name maxColumnWidth * @memberof UnicodeTable.prototype * @type {(Array|NonNegativeInteger|null)} * @throws {TypeError} must be a nonnegative integer, an array of nonnegative integers, or null @@ -941,20 +975,20 @@ setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins * @example * var table = new UnicodeTable(); * -* table.maxCellWidth = 10; +* table.maxColumnWidth = 10; * -* var width = table.maxCellWidth; +* var v = table.maxColumnWidth; * // returns 10 * * @example * var table = new UnicodeTable(); * -* table.maxCellWidth = [ 10, 8 ]; +* table.maxColumnWidth = [ 10, 8 ]; * -* var widths = table.maxCellWidth; +* var v = table.maxColumnWidth; * // returns [ 10, 8 ] */ -setReadWriteAccessor( UnicodeTable.prototype, 'maxCellWidth', getMaxCellWidth, setMaxCellWidth ); +setReadWriteAccessor( UnicodeTable.prototype, 'maxColumnWidth', getMaxColumnWidth, setMaxColumnWidth ); /** * Maximum table width in units of grapheme clusters (i.e., visual characters). @@ -970,7 +1004,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'maxCellWidth', getMaxCellWidth, s * * table.maxWidth = 50; * -* var width = table.maxWidth; +* var v = table.maxWidth; * // returns 50 */ setReadWriteAccessor( UnicodeTable.prototype, 'maxWidth', getMaxWidth, setMaxWidth ); @@ -989,7 +1023,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'maxWidth', getMaxWidth, setMaxWid * * table.paddingLeft = 3; * -* var padding = table.paddingLeft; +* var v = table.paddingLeft; * // returns 3 * * @example @@ -997,7 +1031,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'maxWidth', getMaxWidth, setMaxWid * * table.paddingLeft = [ 3, 2 ]; * -* var paddings = table.paddingLeft; +* var v = table.paddingLeft; * // returns [ 3, 2 ] */ setReadWriteAccessor( UnicodeTable.prototype, 'paddingLeft', getPaddingLeft, setPaddingLeft ); @@ -1016,7 +1050,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'paddingLeft', getPaddingLeft, set * * table.paddingRight = 3; * -* var padding = table.paddingRight; +* var v = table.paddingRight; * // returns 3 * * @example @@ -1024,7 +1058,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'paddingLeft', getPaddingLeft, set * * table.paddingRight = [ 3, 2 ]; * -* var paddings = table.paddingRight; +* var v = table.paddingRight; * // returns [ 3, 2 ] */ setReadWriteAccessor( UnicodeTable.prototype, 'paddingRight', getPaddingRight, setPaddingRight ); @@ -1043,7 +1077,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'paddingRight', getPaddingRight, s * * table.rowSeparator = '$='; * -* var separator = table.rowSeparator; +* var v = table.rowSeparator; * // returns '$=' */ setReadWriteAccessor( UnicodeTable.prototype, 'rowSeparator', getRowSeparator, setRowSeparator ); @@ -1062,7 +1096,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'rowSeparator', getRowSeparator, s * * table.verticalSeparatorMode = 'repeat'; * -* var mode = table.verticalSeparatorMode; +* var v = table.verticalSeparatorMode; * // returns 'repeat' */ setReadWriteAccessor( UnicodeTable.prototype, 'verticalSeparatorMode', getVerticalSeparatorMode, setVerticalSeparatorMode ); @@ -1131,7 +1165,7 @@ setReadOnly( UnicodeTable.prototype, 'push', push ); * 'headers': [ 'A', 'B' ] * }); * -* var str = table.render(); +* var v = table.render(); * // returns '...' */ setReadOnly( UnicodeTable.prototype, 'render', render ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/get.js new file mode 100644 index 000000000000..91db26f5665d --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/get.js @@ -0,0 +1,44 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MAIN // + +/** +* Returns the alignment(s) of data within table header cells. +* +* @private +* @returns {(Array|string|null)} cell alignment(s) +*/ +function get() { + if ( this._headerAlign === null ) { + return this.align; + } + if ( this._headerAlign.length > 1 ) { + return this._headerAlign.slice(); + } + return this._headerAlign[ 0 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js new file mode 100644 index 000000000000..af0b0f238904 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js @@ -0,0 +1,103 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var contains = require( '@stdlib/array/base/assert/contains' ).factory; +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isNull = require( '@stdlib/assert/is-null' ); +var isCollection = require( '@stdlib/assert/is-collection' ); +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); +var format = require( '@stdlib/string/format' ); + + +// VARIABLES // + +var isAlignment = contains( [ 'right', 'center', 'left' ] ); + + +// MAIN // + +/** +* Sets the alignment(s) of data within table header cells. +* +* @private +* @param {(Array|string|null)} value - cell alignment(s) +* @throws {TypeError} must be a supported alignment or an array of alignments +* @throws {RangeError} must provide the correct number of columns +*/ +function set( value ) { + var tmp; + var i; + if ( isNull( value ) ) { + if ( value !== this._headerAlign ) { + this._headerAlign = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + if ( isString( value ) ) { + if ( !isAlignment( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a supported alignment. Value: `%s`.', 'headerAlign', value ) ); + } + value = [ value ]; + if ( !isEqualArray( value, this._align ) ) { + this._align = value; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + if ( !isCollection( value ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string or an array of strings. Value: `%s`.', 'align', value ) ); + } + tmp = []; + for ( i = 0; i < value.length; i++ ) { + if ( !isAlignment( value[ i ] ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of supported alignments. Value: `["%s"]`.', 'align', copy( value ) ).join( '", "' ) ); + } + // Explicitly copy to a new array to avoid external mutation: + tmp.push( value[ i ] ); + } + if ( this._numColumns ) { + if ( tmp.length !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'align', this._numColumns, tmp.join( '", "' ) ) ); + } + } else { + this._numColumns = tmp.length; + } + if ( !isEqualArray( tmp, this._align ) ) { + this._align = tmp; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/get.js similarity index 80% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/get.js index 7c874f925da3..5147327c3bcd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/get.js @@ -23,16 +23,16 @@ // MAIN // /** -* Returns the maximum cell width(s) for each table column. +* Returns the maximum column width(s) for each table column. * * @private -* @returns {(NonNegativeIntegerArray|NonNegativeInteger)} maximum cell width(s) +* @returns {(NonNegativeIntegerArray|NonNegativeInteger)} maximum column width(s) */ function get() { - if ( this._maxCellWidth.length > 1 ) { - return this._maxCellWidth.slice(); + if ( this._maxColumnWidth.length > 1 ) { + return this._maxColumnWidth.slice(); } - return this._maxCellWidth[ 0 ]; + return this._maxColumnWidth[ 0 ]; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js similarity index 84% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js index dfbc675f1303..afa3ce999d4a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-cell-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js @@ -34,10 +34,10 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the maximum cell width(s) for each table column. +* Sets the maximum column width(s) for each table column. * * @private -* @param {(Collection|NonNegativeInteger|null)} value - maximum cell width(s) +* @param {(Collection|NonNegativeInteger|null)} value - maximum column width(s) * @throws {TypeError} must be a nonnegative integer, an array of nonnegative integers, or null * @throws {RangeError} must provide the correct number of columns */ @@ -53,10 +53,10 @@ function set( value ) { } else if ( isNonNegativeInteger( value ) ) { out = [ value ]; } else { - throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', 'maxCellWidth', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', 'maxColumnWidth', value ) ); } - if ( !isEqualArray( out, this._maxCellWidth ) ) { - this._maxCellWidth = out; + if ( !isEqualArray( out, this._maxColumnWidth ) ) { + this._maxColumnWidth = out; if ( !this._quiet ) { this.emit( 'change' ); } @@ -66,7 +66,7 @@ function set( value ) { len = value.length; if ( this._numColumns ) { if ( len !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'maxCellWidth', this._numColumns, copy( value ).join( '", "' ) ) ); + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'maxColumnWidth', this._numColumns, copy( value ).join( '", "' ) ) ); } } else { this._numColumns = len; @@ -82,10 +82,10 @@ function set( value ) { out.push( v ); continue; } - throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `["%s"]`.', 'maxCellWidth', copy( value ).join( '", "' ) ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `["%s"]`.', 'maxColumnWidth', copy( value ).join( '", "' ) ) ); } - if ( !isEqualArray( out, this._maxCellWidth ) ) { - this._maxCellWidth = out; + if ( !isEqualArray( out, this._maxColumnWidth ) ) { + this._maxColumnWidth = out; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 4f37a8fcd0f3..9539c708db54 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -137,7 +137,7 @@ function wrappedColumnIndices( ctx ) { w = columnWidth( ctx.columnWidths[ i ], mw ); if ( w > ctx.maxWidth ) { // The column cannot be accommodated according to the current table configuration, as the column widths exceeds the maximum allowed table width... - return new Error( format( 'invalid operation. The resolved column width for column %d exceeds the maximum allowed table width. Consider either increasing `maxWidth` or decreasing `maxCellWidth`. Maximum width: %d. Maximum cell width: %d. Column width: %d.', ctx.maxWidth, mw, ctx.columnWidths[ i ] ) ); + return new Error( format( 'invalid operation. The resolved column width for column %d exceeds the maximum allowed table width. Consider either increasing `maxWidth` or decreasing `maxColumnWidth`. Maximum width: %d. Maximum cell width: %d. Column width: %d.', ctx.maxWidth, mw, ctx.columnWidths[ i ] ) ); } width += w; @@ -376,6 +376,7 @@ function render() { var end; var out; var idx; + var tmp; var i; var j; @@ -395,7 +396,7 @@ function render() { idx = wrappedColumnIndices({ 'maxWidth': this._maxWidth, 'columnWidths': colWidths, - 'maxWidths': this._maxCellWidth, + 'maxWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], 'borderL': this._borders[ 3 ].ngraphemes, @@ -409,7 +410,7 @@ function render() { // Define a "line" context for rendering non-data content: lctx = { 'columnWidths': colWidths, - 'maxWidths': this._maxCellWidth, + 'maxWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], 'borderL': this._borders[ 3 ].ngraphemes, @@ -424,7 +425,7 @@ function render() { // Define a "row" context for rendering column data: rctx = { 'columnWidths': colWidths, - 'maxWidths': this._maxCellWidth, + 'maxWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], 'paddingL': this._paddingLeft, @@ -460,9 +461,12 @@ function render() { } // Render headers: if ( this._headers ) { + tmp = rctx.alignments; + rctx.alignments = this._headerAlign || this._align; line = renderRow( 0, start, end, headers, rctx, vidx ); out.push( line ); vidx += 1; + rctx.alignments = tmp; } // Render header separator: if ( this._headers && this._headerSeparator.ngraphemes !== 0 ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js index 3226b8eec5b6..bd34ab6fad03 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.main.js @@ -92,7 +92,7 @@ tape( 'the constructor does not require the `new` keyword (data and options)', f 'joints': [ '*', '*', '*', '*', '*' ], 'marginX': 2, 'marginY': 4, - 'maxCellWidth': 10, + 'maxColumnWidth': 10, 'maxOutputWidth': 60, 'rowSeparator': '_-', 'verticalSeparatorMode': 'resume' @@ -125,7 +125,7 @@ tape( 'the constructor does not require the `new` keyword (data, headers and opt 'joints': [ '*', '*', '*', '*', '*' ], 'marginX': 2, 'marginY': 4, - 'maxCellWidth': 10, + 'maxColumnWidth': 10, 'maxOutputWidth': 60, 'rowSeparator': '_-', 'verticalSeparatorMode': 'resume' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_column_width.js similarity index 61% rename from lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js rename to lib/node_modules/@stdlib/plot/table/unicode/test/test.max_column_width.js index e29a1ed015b7..3ca7b72a553a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_cell_width.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.max_column_width.js @@ -34,7 +34,7 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'an instance throws an error if provided an invalid `maxCellWidth` value', function test( t ) { +tape( 'an instance throws an error if provided an invalid `maxColumnWidth` value', function test( t ) { var values; var i; @@ -58,7 +58,7 @@ tape( 'an instance throws an error if provided an invalid `maxCellWidth` value', function badValue( value ) { return function badValue() { var table = ctor(); - table.maxCellWidth = value; + table.maxColumnWidth = value; }; } }); @@ -68,61 +68,61 @@ tape( 'an instance supports setting and getting the property value', function te var arr; table = ctor( null, { - 'maxCellWidth': 2 + 'maxColumnWidth': 2 }); - t.strictEqual( table.maxCellWidth, 2, 'returns expected value' ); + t.strictEqual( table.maxColumnWidth, 2, 'returns expected value' ); - table.maxCellWidth = 3; - t.strictEqual( table.maxCellWidth, 3, 'returns expected value' ); + table.maxColumnWidth = 3; + t.strictEqual( table.maxColumnWidth, 3, 'returns expected value' ); - table.maxCellWidth = null; - t.strictEqual( table.maxCellWidth, FLOAT64_MAX, 'returns expected value' ); + table.maxColumnWidth = null; + t.strictEqual( table.maxColumnWidth, FLOAT64_MAX, 'returns expected value' ); arr = [ 0, 5 ]; - table.maxCellWidth = arr; - t.notEqual( table.maxCellWidth, arr, 'returns a new reference' ); - t.deepEqual( table.maxCellWidth, arr, 'returns expected value' ); + table.maxColumnWidth = arr; + t.notEqual( table.maxColumnWidth, arr, 'returns a new reference' ); + t.deepEqual( table.maxColumnWidth, arr, 'returns expected value' ); arr = [ null, 5 ]; - table.maxCellWidth = arr; - t.notEqual( table.maxCellWidth, arr, 'returns a new reference' ); - t.deepEqual( table.maxCellWidth, [ FLOAT64_MAX, 5 ], 'returns expected value' ); + table.maxColumnWidth = arr; + t.notEqual( table.maxColumnWidth, arr, 'returns a new reference' ); + t.deepEqual( table.maxColumnWidth, [ FLOAT64_MAX, 5 ], 'returns expected value' ); t.end(); }); -tape( 'an instance throws an error if provided a `maxCellWidth` array with incorrect number of columns', function test( t ) { +tape( 'an instance throws an error if provided a `maxColumnWidth` array with incorrect number of columns', function test( t ) { t.throws( badValue, RangeError, 'throws an error' ); t.end(); function badValue() { var table = ctor( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] ); // 3 columns - table.maxCellWidth = [ 1, 2 ]; // 2 columns + table.maxColumnWidth = [ 1, 2 ]; // 2 columns } }); -tape( 'settings the `maxCellWidth` property to an array sets number of columns', function test( t ) { +tape( 'settings the `maxColumnWidth` property to an array sets number of columns', function test( t ) { t.throws( badValue, RangeError, 'throws an error' ); t.end(); function badValue() { var table = ctor( null, { - 'maxCellWidth': [ 1, 2, 3 ] // 3 columns + 'maxColumnWidth': [ 1, 2, 3 ] // 3 columns }); table.data = [ [ 1, 2 ], [ 4, 5 ] ]; // 2 columns } }); -tape( 'setting the `maxCellWidth` property to a new value triggers a `change` event', function test( t ) { +tape( 'setting the `maxColumnWidth` property to a new value triggers a `change` event', function test( t ) { var table; table = ctor( null, { - 'maxCellWidth': 2 + 'maxColumnWidth': 2 }); table.render = noop; table.on( 'change', onChange ); - table.maxCellWidth = [ 1, 2 ]; + table.maxColumnWidth = [ 1, 2 ]; function onChange() { t.ok( true, 'triggers event' ); @@ -130,16 +130,16 @@ tape( 'setting the `maxCellWidth` property to a new value triggers a `change` ev } }); -tape( 'setting the `maxCellWidth` property to its current value does not trigger a `change` event', function test( t ) { +tape( 'setting the `maxColumnWidth` property to its current value does not trigger a `change` event', function test( t ) { var table; table = ctor( null, { - 'maxCellWidth': [ 2, 3 ] + 'maxColumnWidth': [ 2, 3 ] }); table.render = noop; table.on( 'change', onChange ); - table.maxCellWidth = [ 2, 3 ]; + table.maxColumnWidth = [ 2, 3 ]; t.ok( true, 'does not trigger event' ); t.end(); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js index 376a44402bfd..ed18a9cb8f72 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/test/test.render.js @@ -263,7 +263,7 @@ tape( 'the function supports rendering a table with truncated data', function te table.data = [ [ 45, 33, 'hello' ], [ 32.54, true, null ] ]; table.headers = [ 'col1', 'col2', 'col3' ]; - table.maxCellWidth = 6; + table.maxColumnWidth = 6; expected = [ '┌──────┬──────┬──────┐', '│ col1 │ col2 │ col3 │', @@ -275,7 +275,7 @@ tape( 'the function supports rendering a table with truncated data', function te str = table.render(); t.strictEqual( str, expected, 'returns rendered table' ); - table.maxCellWidth = [ 6, 3, 5 ]; + table.maxColumnWidth = [ 6, 3, 5 ]; expected = [ '┌──────┬───┬─────┐', '│ col1 │ . │ ... │', From 38bbb32fd1062f8c6b7d8a12c086caf83944be20 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 13 Feb 2025 22:30:23 -0800 Subject: [PATCH 18/34] feat: add support for specifying fixed column width(s) --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 39 +++++- .../plot/table/unicode/benchmark/benchmark.js | 57 ++++++++ .../@stdlib/plot/table/unicode/docs/repl.txt | 15 +- .../plot/table/unicode/examples/index.js | 1 + .../plot/table/unicode/lib/column_widths.js | 83 +++++++++++ .../plot/table/unicode/lib/defaults.js | 17 ++- .../@stdlib/plot/table/unicode/lib/main.js | 74 +++++++--- .../unicode/lib/props/column-width/get.js | 49 +++++++ .../unicode/lib/props/column-width/set.js | 91 ++++++++++++ .../unicode/lib/props/max-column-width/set.js | 6 +- .../@stdlib/plot/table/unicode/lib/render.js | 130 ++++++++---------- 11 files changed, 451 insertions(+), 111 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/get.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 5cee05caa000..fbcdc722e1f6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -69,6 +69,8 @@ The constructor accepts the following `options`: - **columnSeparator**: column separator character(s). Default: `'│'`. +- **columnWidth**: column width(s) in units of grapheme clusters (i.e., visual characters). When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a `maxColumnWidth` option which is less than the specified width. Default: `null`. + - **cornerTopLeft**: top-left table corner grapheme cluster (i.e., visual character). Default: `'┌'`. - **cornerTopRight**: top-right table corner grapheme cluster (i.e., visual character). Default: `'┌'`. @@ -123,7 +125,7 @@ The constructor accepts the following `options`: - **margins**: table margins in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying margins individually. Default: `[ 0, 0, 0, 0 ]`. -- **maxColumnWidth**: maximum cell width(s) in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. +- **maxColumnWidth**: maximum cell width(s) in units of grapheme clusters (i.e., visual characters). If less than a column's specified width, this option overrides the `columnWidth` option. Default: `+infinity`. - **maxWidth**: maximum table width in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. @@ -327,6 +329,34 @@ var v = table.columnSeparator; // returns '|' ``` + + +#### UnicodeTable.prototype.columnWidth + +Column width in units of grapheme clusters (i.e., visual characters). + +```javascript +var table = new UnicodeTable(); + +// Set: +table.columnWidth = 10; + +// Get: +var v = table.columnWidth; +// returns 10 + +// Set: +table.columnWidth = [ 10, 15 ]; + +// Get: +v = table.columnWidth; +// returns [ 10, 15 ] +``` + +When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a [`maxColumnWidth`](#prop-max-column-width) which is less than the specified width. + +To specify a column width for each column, provide an array of widths. + #### UnicodeTable.prototype.cornerTopLeft @@ -735,11 +765,11 @@ var v = table.margins; // returns [ 2, 2, 2, 2 ] ``` - + #### UnicodeTable.prototype.maxColumnWidth -Maximum cell width in units of grapheme clusters (i.e., visual characters). If cell data is longer than the maximum cell width, the rendered cell data is truncated. To specify the maximum cell width for each column of cells, provide an array of maximum cell widths. +Maximum column width in units of grapheme clusters (i.e., visual characters). If column data is longer than the maximum column width, the rendered column data is truncated. To specify the maximum column width for each column, provide an array of maximum widths. ```javascript var table = new UnicodeTable(); @@ -756,8 +786,11 @@ table.maxColumnWidth = [ 10, 15 ]; // Get: v = table.maxColumnWidth; +// returns [ 10, 15 ] ``` +If set to a value which is less than a column's specified width, the maximum column width takes precedence over [`columnWidth`](#prop-column-width). + #### UnicodeTable.prototype.maxWidth diff --git a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js index 0bb69fb67f86..fea52d4b6355 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/benchmark/benchmark.js @@ -125,6 +125,7 @@ bench( pkg+'::instantiation,data,options', function benchmark( b ) { 'borderLeft': '7890', 'borders': [ '1', '23', '456', '7890' ], 'bufferSize': 10, + 'columnWidth': null, 'columnSeparator': 'None', 'cornerTopLeft': '*', 'cornerTopRight': '*', @@ -437,6 +438,62 @@ bench( pkg+'::set,get:columnSeparator', function benchmark( b ) { b.end(); }); +bench( pkg+'::set,get:columnWidth:value=number', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + 10, + 20, + 30, + 40 + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.columnWidth = values[ i % values.length ]; + if ( !isNumber( v.columnWidth ) ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( !isNumber( v.columnWidth ) ) { + b.fail( 'should return a number' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + +bench( pkg+'::set,get:columnWidth:value=array', function benchmark( b ) { + var values; + var v; + var i; + + values = [ + [ 1, 2, 3 ], + [ 4, 5, 6 ], + [ 7, null, 9 ], + [ null, null, null ] + ]; + v = new UnicodeTable(); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v.columnWidth = values[ i % values.length ]; + if ( !isArray( v.columnWidth ) ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( !isArray( v.columnWidth ) ) { + b.fail( 'should return an array' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); + bench( pkg+'::set,get:cornerTopLeft', function benchmark( b ) { var values; var v; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index 65e84ca7ea25..a856708c6509 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -47,6 +47,13 @@ options.columnSeparator: string (optional) Column separator character(s). Default: '│'. + options.columnWidth: Array|integer|null (optional) + Column width(s) in units of grapheme clusters (i.e., visual + characters). When `null`, column widths are determined according to cell + content. When set to a specific width, a column is rendered with the + specified width, unless overridden by a `maxColumnWidth` option which is + less than the specified width. Default: null. + options.cornerTopLeft: string (optional) Top-left table corner grapheme cluster (i.e., visual character). Default: '┌'. @@ -135,9 +142,10 @@ Table margins in the order [top, right, bottom, left]. Default: [ 0, 0, 0, 0 ]. - options.maxColumnWidth: Array|integer|null (optional) + options.maxColumnWidth: Array|integer|null (optional) Maximum column width(s) in units of grapheme clusters (i.e., visual - characters). Default: +infinity. + characters). If less than a column's specified width, this option + overrides the `columnWidth` option. Default: +infinity. options.maxWidth: integer|null (optional) Maximum table width in units of grapheme clusters (i.e., visual @@ -194,6 +202,9 @@ table.columnSeparator Column separator character(s). + table.columnWidth + Column width(s). + table.cornerTopLeft Top-left table corner grapheme cluster (i.e., visual character). diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js index 567e9e5db632..cc915f0ff984 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/index.js @@ -36,6 +36,7 @@ var table = new UnicodeTable( data, { 'rowSeparator': '-', 'columnSeparator': '#$%', 'maxWidth': 200, + 'columnWidth': 15, 'marginLeft': 5, 'marginRight': 5, 'align': 'right', diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js new file mode 100644 index 000000000000..dafa06a5e53f --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js @@ -0,0 +1,83 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 zeros = require( '@stdlib/array/base/zeros' ); + + +// MAIN // + +/** +* Resolves individual column widths based on table data and specified paddings. +* +* @private +* @param {NonNegativeInteger} nrows - number of table rows +* @param {NonNegativeInteger} ncols - number of table columns +* @param {ndarray} data - table data +* @param {(ndarray|null)} headers - table headers +* @param {NonNegativeIntegerArray} leftPadding - left padding +* @param {NonNegativeIntegerArray} rightPadding - right padding +* @returns {NonNegativeIntegerArray} column widths +*/ +function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) { // eslint-disable-line max-len + var lpad; + var rpad; + var out; + var len; + var M; + var N; + var v; + var i; + var j; + + M = leftPadding.length; + N = rightPadding.length; + + out = zeros( ncols ); + if ( headers ) { + for ( j = 0; j < ncols; j++ ) { + lpad = leftPadding[ j%M ]; + rpad = rightPadding[ j%N ]; + v = headers.get( 0, j ); + len = lpad + v.ngraphemes + rpad; + if ( len > out[ j ] ) { + out[ j ] = len; + } + } + } + for ( i = 0; i < nrows; i++ ) { + for ( j = 0; j < ncols; j++ ) { + lpad = leftPadding[ j%M ]; + rpad = rightPadding[ j%N ]; + v = data.get( i, j ); + len = lpad + v.ngraphemes + rpad; + if ( len > out[ j ] ) { + out[ j ] = len; + } + } + } + return out; +} + + +// EXPORTS // + +module.exports = columnWidths; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index 03a530791751..20d6000abc83 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -71,6 +71,16 @@ function defaults() { // Buffer size: out.bufferSize = FLOAT64_MAX; + // Column separator: + out.columnSeparator = { + 'value': '|', + 'graphemes': [ '|' ], + 'ngraphemes': 1 + }; + + // Column widths: + out.columnWidth = null; // by default, automatically size based on content + // Corner grapheme clusters: out.corners = [ { @@ -99,13 +109,6 @@ function defaults() { } ]; - // Column separator: - out.columnSeparator = { - 'value': '|', - 'graphemes': [ '|' ], - 'ngraphemes': 1 - }; - // Cell format string: out.format = [ '%s' ]; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 4fb5f8ffe2a3..31d340496b3d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -58,6 +58,8 @@ var setCorners = require( './props/corners/set.js' ); var getCorners = require( './props/corners/get.js' ); var setColumnSeparator = require( './props/column-separator/set.js' ); var getColumnSeparator = require( './props/column-separator/get.js' ); +var setColumnWidth = require( './props/column-width/set.js' ); +var getColumnWidth = require( './props/column-width/get.js' ); var setData = require( './props/data/set.js' ); var getData = require( './props/data/get.js' ); var setFormat = require( './props/format/set.js' ); @@ -123,6 +125,7 @@ var PRIVATE_PROPS = [ '_bufferSize', '_corners', '_columnSeparator', + '_columnWidth', '_data', '_format', '_headerAlign', @@ -148,6 +151,7 @@ var OPTIONS_PROPS = [ 'borders', 'bufferSize', 'columnSeparator', + 'columnWidth', 'cornerBottomLeft', 'cornerBottomRight', 'corners', @@ -220,6 +224,7 @@ function initializePrivateProperties( table, defaults ) { // eslint-disable-line * @param {Collection} [options.borders=[ '─', '│', '─', '│' ]] - table border characters * @param {(PositiveInteger|null)} [options.bufferSize] - size of data buffer * @param {string} [options.columnSeparator='│'] - column separator character(s) +* @param {(Collection|NonNegativeInteger|null)} [options.columnWidth] - column width(s) * @param {string} [options.cornerTopLeft='┌'] - top-left table corner grapheme cluster (i.e., visual character) * @param {string} [options.cornerTopRight='┐'] - top-right table corner grapheme cluster (i.e., visual character) * @param {string} [options.cornerBottomRight='┘''] - bottom-right table corner grapheme cluster (i.e., visual character) @@ -240,7 +245,7 @@ function initializePrivateProperties( table, defaults ) { // eslint-disable-line * @param {NonNegativeInteger} [options.marginBottom=0] - margin at the bottom of the table in units of blank lines * @param {NonNegativeInteger} [options.marginLeft=0] - margin to the left of the table in units of whitespace * @param {NonNegativeIntegerArray} [options.margins=[0, 0, 0, 0]] - table margins -* @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.maxColumnWidth] - maximum cell width(s) +* @param {(Collection|NonNegativeInteger|null)} [options.maxColumnWidth] - maximum column width(s) * @param {NonNegativeInteger} [options.maxWidth] - maximum table width * @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.paddingLeft=1] - cell left padding in units of whitespace * @param {(NonNegativeIntegerArray|NonNegativeInteger)} [options.paddingRight=1] - cell right padding in units of whitespace @@ -515,6 +520,52 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borders', getBorders, setBorders */ setReadWriteAccessor( UnicodeTable.prototype, 'bufferSize', getBufferSize, setBufferSize ); +/** +* Column separator character(s). +* +* @name columnSeparator +* @memberof UnicodeTable.prototype +* @type {string} +* @throws {TypeError} must be a string +* @default '│' +* +* @example +* var table = new UnicodeTable(); +* +* table.columnSeparator = '$='; +* +* var v = table.columnSeparator; +* // returns '$=' +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSeparator, setColumnSeparator ); + +/** +* Column width(s) in units of grapheme clusters (i.e., visual characters). +* +* @name columnWidth +* @memberof UnicodeTable.prototype +* @type {(Array|NonNegativeInteger|null)} +* @throws {TypeError} must be null, a nonnegative integer, an array of nonnegative integers and/or nulls +* @default null +* +* @example +* var table = new UnicodeTable(); +* +* table.columnWidth = 10; +* +* var v = table.columnWidth; +* // returns 10 +* +* @example +* var table = new UnicodeTable(); +* +* table.columnWidth = [ 10, 8 ]; +* +* var v = table.columnWidth; +* // returns [ 10, 8 ] +*/ +setReadWriteAccessor( UnicodeTable.prototype, 'columnWidth', getColumnWidth, setColumnWidth ); + /** * Top-left table corner grapheme cluster (i.e., visual character). * @@ -610,25 +661,6 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomLeft', getCornerBotto */ setReadWriteAccessor( UnicodeTable.prototype, 'corners', getCorners, setCorners ); -/** -* Column separator character(s). -* -* @name columnSeparator -* @memberof UnicodeTable.prototype -* @type {string} -* @throws {TypeError} must be a string -* @default '│' -* -* @example -* var table = new UnicodeTable(); -* -* table.columnSeparator = '$='; -* -* var v = table.columnSeparator; -* // returns '$=' -*/ -setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSeparator, setColumnSeparator ); - /** * Table data. * @@ -969,7 +1001,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins * @name maxColumnWidth * @memberof UnicodeTable.prototype * @type {(Array|NonNegativeInteger|null)} -* @throws {TypeError} must be a nonnegative integer, an array of nonnegative integers, or null +* @throws {TypeError} must be null, a nonnegative integer, an array of nonnegative integers and/or nulls * @default +infinity * * @example diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/get.js new file mode 100644 index 000000000000..d3660ceea726 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/get.js @@ -0,0 +1,49 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNull = require( '@stdlib/assert/is-null' ); + + +// MAIN // + +/** +* Returns the column width(s) for each table column. +* +* @private +* @returns {(Array|NonNegativeInteger|null)} column width(s) +*/ +function get() { + if ( isNull( this._columnWidth ) ) { + return this._columnWidth; + } + if ( this._columnWidth.length > 1 ) { + return this._columnWidth.slice(); + } + return this._columnWidth[ 0 ]; +} + + +// EXPORTS // + +module.exports = get; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js new file mode 100644 index 000000000000..8064c2016377 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js @@ -0,0 +1,91 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-invalid-this */ + +'use strict'; + +// MODULES // + +var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive; +var isCollection = require( '@stdlib/assert/is-collection' ); +var isNull = require( '@stdlib/assert/is-null' ); +var isEqualArray = require( '@stdlib/assert/is-equal-array' ); +var copy = require( '@stdlib/array/base/copy' ); +var format = require( '@stdlib/string/format' ); + + +// MAIN // + +/** +* Sets the column width(s) for each table column. +* +* @private +* @param {(Collection|NonNegativeInteger|null)} value - column width(s) +* @throws {TypeError} must be null, a nonnegative integer, an array of nonnegative integers and/or nulls +* @throws {RangeError} must provide the correct number of columns +*/ +function set( value ) { + var out; + var len; + var v; + var i; + + if ( !isCollection( value ) ) { + if ( isNull( value ) || isNonNegativeInteger( value ) ) { + out = [ value ]; + } else { + throw new TypeError( format( 'invalid assignment. `%s` must be either null, a nonnegative integer, or an array of nonnegative integers and/or nulls. Value: `%s`.', 'columnWidth', value ) ); + } + if ( !isEqualArray( out, this._columnWidth ) ) { + this._columnWidth = out; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } + return; + } + len = value.length; + if ( this._numColumns ) { + if ( len !== this._numColumns ) { + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'columnWidth', this._numColumns, copy( value ).join( '", "' ) ) ); + } + } else { + this._numColumns = len; + } + out = []; + for ( i = 0; i < len; i++ ) { + v = value[ i ]; + if ( isNull( v ) || isNonNegativeInteger( v ) ) { + out.push( v ); + continue; + } + throw new TypeError( format( 'invalid assignment. `%s` must be either null, a nonnegative integer, or an array of nonnegative integers and/or nulls. Value: `["%s"]`.', 'columnWidth', copy( value ).join( '", "' ) ) ); + } + if ( !isEqualArray( out, this._columnWidth ) ) { + this._columnWidth = out; + if ( !this._quiet ) { + this.emit( 'change' ); + } + } +} + + +// EXPORTS // + +module.exports = set; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js index afa3ce999d4a..0b88cd56b6fb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js @@ -38,7 +38,7 @@ var format = require( '@stdlib/string/format' ); * * @private * @param {(Collection|NonNegativeInteger|null)} value - maximum column width(s) -* @throws {TypeError} must be a nonnegative integer, an array of nonnegative integers, or null +* @throws {TypeError} must be null, a nonnegative integer, an array of nonnegative integers and/or nulls * @throws {RangeError} must provide the correct number of columns */ function set( value ) { @@ -53,7 +53,7 @@ function set( value ) { } else if ( isNonNegativeInteger( value ) ) { out = [ value ]; } else { - throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `%s`.', 'maxColumnWidth', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be either null, a nonnegative integer, or an array of nonnegative integers and/or nulls. Value: `%s`.', 'maxColumnWidth', value ) ); } if ( !isEqualArray( out, this._maxColumnWidth ) ) { this._maxColumnWidth = out; @@ -82,7 +82,7 @@ function set( value ) { out.push( v ); continue; } - throw new TypeError( format( 'invalid assignment. `%s` must be a nonnegative integer or an array of nonnegative integers. Value: `["%s"]`.', 'maxColumnWidth', copy( value ).join( '", "' ) ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be either null, a nonnegative integer, or an array of nonnegative integers and/or nulls. Value: `["%s"]`.', 'maxColumnWidth', copy( value ).join( '", "' ) ) ); } if ( !isEqualArray( out, this._maxColumnWidth ) ) { this._maxColumnWidth = out; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 9539c708db54..980b328be700 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -26,66 +26,15 @@ var numelDimension = require( '@stdlib/ndarray/base/numel-dimension' ); var floor = require( '@stdlib/math/base/special/floor' ); var ceil = require( '@stdlib/math/base/special/ceil' ); var min = require( '@stdlib/math/base/special/fast/min' ); -var zeros = require( '@stdlib/array/base/zeros' ); +var max = require( '@stdlib/math/base/special/fast/max' ); var repeat = require( '@stdlib/string/repeat' ); var format = require( '@stdlib/string/format' ); var array2matrix = require( './array2matrix.js' ); +var columnWidths = require( './column_widths.js' ); // FUNCTIONS // -/** -* Resolves individual column widths based on table data and specified paddings. -* -* @private -* @param {NonNegativeInteger} nrows - number of table rows -* @param {NonNegativeInteger} ncols - number of table columns -* @param {ndarray} data - table data -* @param {(ndarray|null)} headers - table headers -* @param {NonNegativeIntegerArray} leftPadding - left padding -* @param {NonNegativeIntegerArray} rightPadding - right padding -* @returns {NonNegativeIntegerArray} column widths -*/ -function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) { // eslint-disable-line max-len - var lpad; - var rpad; - var out; - var len; - var M; - var N; - var v; - var i; - var j; - - M = leftPadding.length; - N = rightPadding.length; - - out = zeros( ncols ); - if ( headers ) { - for ( j = 0; j < ncols; j++ ) { - lpad = leftPadding[ j%M ]; - rpad = rightPadding[ j%N ]; - v = headers.get( 0, j ); - len = lpad + v.ngraphemes + rpad; - if ( len > out[ j ] ) { - out[ j ] = len; - } - } - } - for ( i = 0; i < nrows; i++ ) { - for ( j = 0; j < ncols; j++ ) { - lpad = leftPadding[ j%M ]; - rpad = rightPadding[ j%N ]; - v = data.get( i, j ); - len = lpad + v.ngraphemes + rpad; - if ( len > out[ j ] ) { - out[ j ] = len; - } - } - } - return out; -} - /** * Computes a column width. * @@ -104,8 +53,9 @@ function columnWidth( ngraphemes, maxWidth ) { * @private * @param {Object} ctx - context object * @param {NonNegativeInteger} ctx.maxWidth - maximum table width (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.columnWidths - column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.maxWidths - maximum column widths (in units of grapheme clusters) +* @param {Array} ctx.fixedWidths - fixed column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of grapheme clusters) * @param {NonNegativeInteger} ctx.marginL - left table margin * @param {NonNegativeInteger} ctx.marginR - right table margin * @param {NonNegativeInteger} ctx.borderL - left border length (in units of grapheme clusters) @@ -119,10 +69,11 @@ function wrappedColumnIndices( ctx ) { var ncols; var len; var mw; + var fw; var w; var i; - ncols = ctx.columnWidths.length; + ncols = ctx.computedWidths.length; // Initialize an array of indices at which to wrap table rows: indices = [ 0 ]; @@ -133,11 +84,16 @@ function wrappedColumnIndices( ctx ) { // Resolve the column breakpoints... width = 0; for ( i = 0; i < ncols; i++ ) { - mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; - w = columnWidth( ctx.columnWidths[ i ], mw ); + mw = ctx.maxColumnWidths[ i%ctx.maxColumnWidths.length ]; + fw = ctx.fixedWidths[ i%ctx.fixedWidths.length ]; + if ( fw === null ) { + w = columnWidth( ctx.computedWidths[ i ], mw ); + } else { + w = min( fw, mw ); + } if ( w > ctx.maxWidth ) { // The column cannot be accommodated according to the current table configuration, as the column widths exceeds the maximum allowed table width... - return new Error( format( 'invalid operation. The resolved column width for column %d exceeds the maximum allowed table width. Consider either increasing `maxWidth` or decreasing `maxColumnWidth`. Maximum width: %d. Maximum cell width: %d. Column width: %d.', ctx.maxWidth, mw, ctx.columnWidths[ i ] ) ); + return new Error( format( 'invalid operation. The resolved column width for column %d exceeds the maximum allowed table width. Consider either increasing `maxWidth` or decreasing `maxColumnWidth`. Maximum width: %d. Maximum cell width: %d. Column width: %d.', ctx.maxWidth, mw, ctx.computedWidths[ i ] ) ); } width += w; @@ -166,6 +122,9 @@ function wrappedColumnIndices( ctx ) { * @returns {string} output string */ function renderWhitespace( len ) { + if ( len <= 0 ) { + return ''; + } return repeat( ' ', len ); } @@ -193,8 +152,9 @@ function renderVerticalMargin( out, margin ) { * @param {NonNegativeInteger} end - ending column index (exclusive) * @param {Object} ch - line characters * @param {Object} ctx - context object -* @param {NonNegativeIntegerArray} ctx.columnWidths - column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.maxWidths - maximum column widths (in units of grapheme clusters) +* @param {Array} ctx.fixedWidths - fixed column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of grapheme clusters) * @param {NonNegativeInteger} ctx.marginL - left table margin * @param {NonNegativeInteger} ctx.marginR - right table margin * @param {NonNegativeInteger} ctx.borderL - left border length (in units of grapheme clusters) @@ -210,6 +170,7 @@ function renderLine( start, end, ch, ctx ) { var hidx; var out; var mw; + var fw; var w; var i; var j; @@ -239,8 +200,13 @@ function renderLine( start, end, ch, ctx ) { } } // Render as many of the line characters as can visually fit across a column... - mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; - w = columnWidth( ctx.columnWidths[ i ], mw ); + mw = ctx.maxColumnWidths[ i%ctx.maxColumnWidths.length ]; + fw = ctx.fixedWidths[ i%ctx.fixedWidths.length ]; + if ( fw === null ) { + w = columnWidth( ctx.computedWidths[ i ], mw ); + } else { + w = min( fw, mw ); + } for ( j = 0; j < w; j++ ) { out += ch[ hidx%ch.length ]; hidx += 1; @@ -265,8 +231,9 @@ function renderLine( start, end, ch, ctx ) { * @param {NonNegativeInteger} end - ending column index (exclusive) * @param {ndarray} data - table data * @param {Object} ctx - context object -* @param {NonNegativeInteger} ctx.columnWidths - column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.maxWidths - maximum column widths (in units of grapheme clusters) +* @param {Array} ctx.fixedWidths - fixed column widths (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.computedWidths - column widths (in units of grapheme clusters) +* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of grapheme clusters) * @param {NonNegativeInteger} ctx.marginL - left table margin * @param {NonNegativeInteger} ctx.marginR - right table margin * @param {NonNegativeIntegerArray} ctx.paddingL - left cell padding @@ -284,6 +251,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { var out; var len; var mw; + var fw; var w; var d; var v; @@ -313,8 +281,13 @@ function renderRow( row, start, end, data, ctx, vidx ) { len = lpad + v.ngraphemes + rpad; // number of grapheme clusters // Determine whether we need to truncate rendered data: - mw = ctx.maxWidths[ i%ctx.maxWidths.length ]; - w = ctx.columnWidths[ i ]; + mw = ctx.maxColumnWidths[ i%ctx.maxColumnWidths.length ]; + fw = ctx.fixedWidths[ i%ctx.fixedWidths.length ]; + w = ctx.computedWidths[ i ]; + if ( fw !== null ) { + mw = min( fw, mw ); + w = max( fw, w ); + } if ( w > mw ) { // Truncate rendered data: w = mw; @@ -364,7 +337,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { * @returns {string} rendered table */ function render() { - var colWidths; + var computedWidths; + var fixedWidths; var headers; var start; var nrows; @@ -390,13 +364,17 @@ function render() { headers = ( this._headers ) ? array2matrix( this._headers, [ 1, this._headers.length ] ) : null; // eslint-disable-line max-len // Resolve the column widths needed to fit column data: - colWidths = columnWidths( nrows, ncols, this._data, headers, this._paddingLeft, this._paddingRight ); // eslint-disable-line max-len + computedWidths = columnWidths( nrows, ncols, this._data, headers, this._paddingLeft, this._paddingRight ); // eslint-disable-line max-len + + // Resolve fixed-width column widths: + fixedWidths = this._columnWidth || [ null ]; // Resolve indices at which to wrap the table rows: idx = wrappedColumnIndices({ 'maxWidth': this._maxWidth, - 'columnWidths': colWidths, - 'maxWidths': this._maxColumnWidth, + 'fixedWidths': fixedWidths, + 'computedWidths': computedWidths, + 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], 'borderL': this._borders[ 3 ].ngraphemes, @@ -409,8 +387,9 @@ function render() { // Define a "line" context for rendering non-data content: lctx = { - 'columnWidths': colWidths, - 'maxWidths': this._maxColumnWidth, + 'fixedWidths': fixedWidths, + 'computedWidths': computedWidths, + 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], 'borderL': this._borders[ 3 ].ngraphemes, @@ -424,8 +403,9 @@ function render() { // Define a "row" context for rendering column data: rctx = { - 'columnWidths': colWidths, - 'maxWidths': this._maxColumnWidth, + 'fixedWidths': fixedWidths, + 'computedWidths': computedWidths, + 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], 'paddingL': this._paddingLeft, From d2d519c46efc5c09d799f72f753131eaf53f0fb3 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Fri, 14 Feb 2025 01:47:59 -0800 Subject: [PATCH 19/34] refactor: compute columns rather than number of graphemes due to terminal rendering limitations --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/plot/table/unicode/README.md | 112 +++++++++++------- .../@stdlib/plot/table/unicode/docs/repl.txt | 106 ++++++++--------- .../plot/table/unicode/lib/column_widths.js | 4 +- .../plot/table/unicode/lib/defaults.js | 36 +++--- .../@stdlib/plot/table/unicode/lib/main.js | 77 ++++++------ .../plot/table/unicode/lib/normalize.js | 7 +- .../plot/table/unicode/lib/props/align/set.js | 2 +- .../unicode/lib/props/border-bottom/get.js | 4 +- .../unicode/lib/props/border-bottom/set.js | 20 ++-- .../unicode/lib/props/border-left/get.js | 4 +- .../unicode/lib/props/border-left/set.js | 20 ++-- .../unicode/lib/props/border-right/get.js | 4 +- .../unicode/lib/props/border-right/set.js | 20 ++-- .../table/unicode/lib/props/border-top/get.js | 4 +- .../table/unicode/lib/props/border-top/set.js | 18 +-- .../table/unicode/lib/props/borders/set.js | 25 ++-- .../unicode/lib/props/column-separator/set.js | 7 +- .../unicode/lib/props/column-width/set.js | 4 +- .../lib/props/corner-bottom-left/get.js | 4 +- .../lib/props/corner-bottom-left/set.js | 21 ++-- .../lib/props/corner-bottom-right/get.js | 4 +- .../lib/props/corner-bottom-right/set.js | 21 ++-- .../unicode/lib/props/corner-top-left/get.js | 4 +- .../unicode/lib/props/corner-top-left/set.js | 21 ++-- .../unicode/lib/props/corner-top-right/get.js | 4 +- .../unicode/lib/props/corner-top-right/set.js | 21 ++-- .../table/unicode/lib/props/corners/get.js | 4 +- .../table/unicode/lib/props/corners/set.js | 21 ++-- .../unicode/lib/props/header-align/set.js | 2 +- .../unicode/lib/props/header-separator/set.js | 7 +- .../table/unicode/lib/props/headers/set.js | 9 +- .../unicode/lib/props/joint-bottom/get.js | 4 +- .../unicode/lib/props/joint-bottom/set.js | 21 ++-- .../table/unicode/lib/props/joint-left/get.js | 4 +- .../table/unicode/lib/props/joint-left/set.js | 21 ++-- .../unicode/lib/props/joint-middle/get.js | 4 +- .../unicode/lib/props/joint-middle/set.js | 21 ++-- .../unicode/lib/props/joint-right/get.js | 4 +- .../unicode/lib/props/joint-right/set.js | 21 ++-- .../table/unicode/lib/props/joint-top/get.js | 4 +- .../table/unicode/lib/props/joint-top/set.js | 21 ++-- .../table/unicode/lib/props/joints/set.js | 19 +-- .../unicode/lib/props/max-column-width/set.js | 2 +- .../table/unicode/lib/props/max-width/get.js | 2 +- .../unicode/lib/props/padding-left/set.js | 2 +- .../unicode/lib/props/padding-right/get.js | 2 +- .../unicode/lib/props/padding-right/set.js | 2 +- .../unicode/lib/props/row-separator/set.js | 7 +- .../@stdlib/plot/table/unicode/lib/render.js | 84 ++++++------- .../plot/table/unicode/lib/wcswidth.js | 37 ++++++ 50 files changed, 491 insertions(+), 408 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index fbcdc722e1f6..85f188e3066e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -55,13 +55,13 @@ The constructor accepts the following `options`: - **autoRender**: boolean indicating whether to automatically re-render a table on a `change` event. Default: `false`. -- **borderTop**: top table border character(s). Default: `'-'`. +- **borderTop**: top table border character. Default: `'-'`. -- **borderRight**: right table border character(s). Default: `'|'`. +- **borderRight**: right table border character. Default: `'|'`. -- **borderBottom**: bottom table border character(s). Default: `'-'`. +- **borderBottom**: bottom table border character. Default: `'-'`. -- **borderLeft**: left table border character(s). Default: `'|'`. +- **borderLeft**: left table border character. Default: `'|'`. - **borders**: table border characters in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying borders individually. Default: `[ '─', '│', '─', '│' ]`. @@ -69,17 +69,17 @@ The constructor accepts the following `options`: - **columnSeparator**: column separator character(s). Default: `'│'`. -- **columnWidth**: column width(s) in units of grapheme clusters (i.e., visual characters). When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a `maxColumnWidth` option which is less than the specified width. Default: `null`. +- **columnWidth**: table column width(s) in units of character columns. When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a `maxColumnWidth` option which is less than the specified width. Default: `null`. -- **cornerTopLeft**: top-left table corner grapheme cluster (i.e., visual character). Default: `'┌'`. +- **cornerTopLeft**: top-left table corner character. Default: `'┌'`. -- **cornerTopRight**: top-right table corner grapheme cluster (i.e., visual character). Default: `'┌'`. +- **cornerTopRight**: top-right table corner character. Default: `'┌'`. -- **cornerBottomRight**: bottom-right table corner grapheme cluster (i.e., visual character). Default: `'┘'`. +- **cornerBottomRight**: bottom-right table corner character. Default: `'┘'`. -- **cornerBottomLeft**: bottom-left table corner grapheme cluster (i.e., visual character). Default: `'└'`. +- **cornerBottomLeft**: bottom-left table corner character. Default: `'└'`. -- **corners**: table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. This is a shorthand option instead of specifying corner character sequences individually. Default: `[ '┌', '┐', '┘', '└' ]`. +- **corners**: table corner characters in the order `[top-left, top-right, bottom-right, bottom-left]`. This is a shorthand option instead of specifying corner character sequences individually. Default: `[ '┌', '┐', '┘', '└' ]`. - **format**: cell [format][@stdlib/string/format] string(s). Default: `'%s'`. @@ -103,17 +103,17 @@ The constructor accepts the following `options`: Default: `'resume'`. -- **jointMiddle**: joint grapheme cluster (i.e., visual character) connecting table cells within the middle of the table. Default: `'┼'`. +- **jointMiddle**: joint character connecting table cells within the middle of the table. Default: `'┼'`. -- **jointTop**: joint grapheme cluster (i.e., visual character) connecting table cells along the top of the table. Default: `'┬'`. +- **jointTop**: joint character connecting table cells along the top of the table. Default: `'┬'`. -- **jointRight**: joint grapheme cluster (i.e., visual character) connecting table cells along the right of the table. Default: `'┤'`. +- **jointRight**: joint character connecting table cells along the right of the table. Default: `'┤'`. -- **jointBottom**: joint grapheme cluster (i.e., visual character) connecting table cells along the bottom of the table. Default: `'┴'`. +- **jointBottom**: joint character connecting table cells along the bottom of the table. Default: `'┴'`. -- **jointLeft**: joint grapheme cluster (i.e., visual character) connecting table cells along the left of the table. Default: `'├'`. +- **jointLeft**: joint character connecting table cells along the left of the table. Default: `'├'`. -- **joints**: joint grapheme clusters (i.e., visual characters) connecting table cells in the order `[middle, top, right, bottom, left]`. This is a shorthand option instead of specifying join character sequences individually. Default: `[ '┼', '┬', '┤', '┴', '├' ]`. +- **joints**: joint characters connecting table cells in the order `[middle, top, right, bottom, left]`. This is a shorthand option instead of specifying join character sequences individually. Default: `[ '┼', '┬', '┤', '┴', '├' ]`. - **marginTop**: margin at the top of the table in units of blank lines. Default: `0`. @@ -125,9 +125,9 @@ The constructor accepts the following `options`: - **margins**: table margins in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying margins individually. Default: `[ 0, 0, 0, 0 ]`. -- **maxColumnWidth**: maximum cell width(s) in units of grapheme clusters (i.e., visual characters). If less than a column's specified width, this option overrides the `columnWidth` option. Default: `+infinity`. +- **maxColumnWidth**: maximum table cell width(s) in units of character columns. If less than a column's specified width, this option overrides the `columnWidth` option. Default: `+infinity`. -- **maxWidth**: maximum table width in units of grapheme clusters (i.e., visual characters). Default: `+infinity`. +- **maxWidth**: maximum table width in units of character columns. Default: `+infinity`. - **paddingLeft**: cell left padding in units of whitespace characters. Default: `1`. @@ -183,7 +183,7 @@ To specify the alignment for each column of table cells, set to an array of alig #### UnicodeTable.prototype.autoRender -Rendering mode. If `true`, an instance automatically re-renders a table on each `'change'` event; otherwise, rendering must be triggered manually. +Rendering mode. ```javascript var table = new UnicodeTable(); @@ -196,11 +196,13 @@ var v = table.autoRender; // returns false ``` +If `true`, an instance automatically re-renders a table on each `'change'` event; otherwise, rendering must be triggered manually. + #### UnicodeTable.prototype.borderTop -Top table border character(s). +Top table border character. ```javascript var table = new UnicodeTable(); @@ -217,7 +219,7 @@ var v = table.borderTop; #### UnicodeTable.prototype.borderRight -Right table border character(s). +Right table border character. ```javascript var table = new UnicodeTable(); @@ -234,7 +236,7 @@ var v = table.borderRight; #### UnicodeTable.prototype.borderBottom -Bottom table border character(s). +Bottom table border character. ```javascript var table = new UnicodeTable(); @@ -251,7 +253,7 @@ var v = table.borderBottom; #### UnicodeTable.prototype.borderLeft -Left table border character(s). +Left table border character. ```javascript var table = new UnicodeTable(); @@ -285,7 +287,7 @@ var v = table.borders; #### UnicodeTable.prototype.bufferSize -Data buffer size. If set, this specifies the maximum number of rows which can be rendered. Once an internal data buffer is full, each new row results in the oldest row being removed. +Data buffer size. ```javascript var ndarray2array = require( '@stdlib/ndarray/to-array' ); @@ -310,13 +312,15 @@ data = ndarray2array( table.data ); // returns [ [ 3, 4 ], [ 5, 6 ], [ 7, 8 ] ] ``` +If set, this specifies the maximum number of table rows which can be rendered. Once an internal data buffer is full, each new table row results in the oldest table row being removed. + Setting a data buffer size is useful when rendering data streams. #### UnicodeTable.prototype.columnSeparator -Column separator character(s). If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. +Table column separator character(s). ```javascript var table = new UnicodeTable(); @@ -329,11 +333,13 @@ var v = table.columnSeparator; // returns '|' ``` +If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. + #### UnicodeTable.prototype.columnWidth -Column width in units of grapheme clusters (i.e., visual characters). +Table column width in units of character columns. ```javascript var table = new UnicodeTable(); @@ -353,15 +359,17 @@ v = table.columnWidth; // returns [ 10, 15 ] ``` -When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a [`maxColumnWidth`](#prop-max-column-width) which is less than the specified width. +When `null`, table column widths are determined according to cell content. When set to a specific width, a table column is rendered with the specified width, unless overridden by a [`maxColumnWidth`](#prop-max-column-width) which is less than the specified width. -To specify a column width for each column, provide an array of widths. +If table column data is longer than a specified column width, the rendered column data is truncated. + +To specify a table column width for each column, provide an array of widths. #### UnicodeTable.prototype.cornerTopLeft -Top-left table corner grapheme cluster (i.e., visual character). +Top-left table corner character. ```javascript var table = new UnicodeTable(); @@ -378,7 +386,7 @@ var v = table.cornerTopLeft; #### UnicodeTable.prototype.cornerTopRight -Top-right table corner grapheme cluster (i.e., visual character). +Top-right table corner character. ```javascript var table = new UnicodeTable(); @@ -395,7 +403,7 @@ var v = table.cornerTopRight; #### UnicodeTable.prototype.cornerBottomRight -Bottom-right table corner grapheme cluster (i.e., visual character). +Bottom-right table corner character. ```javascript var table = new UnicodeTable(); @@ -412,7 +420,7 @@ var v = table.cornerBottomRight; #### UnicodeTable.prototype.cornerBottomLeft -Bottom-left table corner grapheme cluster (i.e., visual character). +Bottom-left table corner character. ```javascript var table = new UnicodeTable(); @@ -429,7 +437,7 @@ var v = table.cornerBottomLeft; #### UnicodeTable.prototype.corners -Table corner grapheme clusters (i.e., visual characters) in the order `[ 'top-left', 'top-right', 'bottom-right', 'bottom-left' ]`. +Table corner characters in the order `[ 'top-left', 'top-right', 'bottom-right', 'bottom-left' ]`. ```javascript var table = new UnicodeTable(); @@ -542,7 +550,7 @@ var v = table.headers; #### UnicodeTable.prototype.headerSeparator -Header separator character(s). If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. +Header separator character(s). ```javascript var table = new UnicodeTable(); @@ -555,6 +563,8 @@ var v = table.headerSeparator; // returns '-' ``` +If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. + #### UnicodeTable.prototype.horizontalSeparatorMode @@ -582,7 +592,7 @@ The following modes are supported: #### UnicodeTable.prototype.jointMiddle -Joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +Joint character connecting cells within the middle of the table. ```javascript var table = new UnicodeTable(); @@ -599,7 +609,7 @@ var v = table.jointMiddle; #### UnicodeTable.prototype.jointTop -Joint grapheme cluster (i.e., visual character) connecting cells along the top of the table. +Joint character connecting cells along the top of the table. ```javascript var table = new UnicodeTable(); @@ -616,7 +626,7 @@ var v = table.jointTop; #### UnicodeTable.prototype.jointRight -Joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +Joint character connecting cells along the right side of the table. ```javascript var table = new UnicodeTable(); @@ -633,7 +643,7 @@ var v = table.jointRight; #### UnicodeTable.prototype.jointBottom -Joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table. +Joint character connecting cells along the bottom of the table. ```javascript var table = new UnicodeTable(); @@ -650,7 +660,7 @@ var v = table.jointBottom; #### UnicodeTable.prototype.jointLeft -Joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +Joint character connecting cells along the left side of the table. ```javascript var table = new UnicodeTable(); @@ -667,7 +677,7 @@ var v = table.jointLeft; #### UnicodeTable.prototype.joints -Joint grapheme clusters (i.e., visual characters) in the order `[ 'middle', 'top', 'right', 'bottom', 'left' ]`. +Joint characters in the order `[ 'middle', 'top', 'right', 'bottom', 'left' ]`. ```javascript var table = new UnicodeTable(); @@ -769,7 +779,7 @@ var v = table.margins; #### UnicodeTable.prototype.maxColumnWidth -Maximum column width in units of grapheme clusters (i.e., visual characters). If column data is longer than the maximum column width, the rendered column data is truncated. To specify the maximum column width for each column, provide an array of maximum widths. +Maximum table column width in units of character columns. ```javascript var table = new UnicodeTable(); @@ -789,13 +799,15 @@ v = table.maxColumnWidth; // returns [ 10, 15 ] ``` -If set to a value which is less than a column's specified width, the maximum column width takes precedence over [`columnWidth`](#prop-column-width). +If table column data is longer than the maximum column width, the rendered column data is truncated. To specify the maximum column width for each table column, provide an array of maximum widths. + +If set to a value which is less than a column's specified width, the maximum table column width takes precedence over [`columnWidth`](#prop-column-width). #### UnicodeTable.prototype.maxWidth -Maximum table width in units of grapheme clusters (i.e., visual characters). If the generated table is longer than the maximum table width, a generated table is split into multiple tables. +Maximum table width in units of character columns. ```javascript var table = new UnicodeTable(); @@ -808,11 +820,13 @@ var v = table.maxWidth; // returns 200 ``` +If the generated table is longer than the maximum table width, a generated table is split into multiple tables. + #### UnicodeTable.prototype.paddingLeft -Cell left padding(s) in units of whitespace. To specify the padding of each column of table cells, provide an array of paddings. +Cell left padding(s) in units of whitespace. ```javascript var table = new UnicodeTable(); @@ -832,11 +846,13 @@ v = table.paddingLeft; // returns [ 3, 4 ] ``` +To specify the padding of each column of table cells, provide an array of paddings. + #### UnicodeTable.prototype.paddingRight -Cell right padding(s) in units of whitespace. To specify the padding of each column of table cells, provide an array of paddings. +Cell right padding(s) in units of whitespace. ```javascript var table = new UnicodeTable(); @@ -856,11 +872,13 @@ v = table.paddingRight; // returns [ 3, 4 ] ``` +To specify the padding of each column of table cells, provide an array of paddings. + #### UnicodeTable.prototype.rowSeparator -Row separator character(s). If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. +Row separator character(s). ```javascript var table = new UnicodeTable(); @@ -873,6 +891,8 @@ var v = table.rowSeparator; // returns '-' ``` +If provided a string with multiple grapheme clusters, each grapheme cluster is rendered sequentially. No separator is rendered if provided an empty string. + #### UnicodeTable.prototype.verticalSeparatorMode diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index a856708c6509..2d162861091c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -24,16 +24,16 @@ event. Default: false. options.borderTop: string (optional) - Top table border character(s). Default: '-'. + Top table border character. Default: '-'. options.borderRight: string (optional) - Right table border character(s). Default: '|'. + Right table border character. Default: '|'. options.borderBottom: string (optional) - Bottom table border character(s). Default: '-'. + Bottom table border character. Default: '-'. options.borderLeft: string (optional) - Left table border character(s). Default: '|'. + Left table border character. Default: '|'. options.borders: Array (optional) Table border characters in the order [top, right, bottom, left]. @@ -48,32 +48,27 @@ Column separator character(s). Default: '│'. options.columnWidth: Array|integer|null (optional) - Column width(s) in units of grapheme clusters (i.e., visual - characters). When `null`, column widths are determined according to cell - content. When set to a specific width, a column is rendered with the - specified width, unless overridden by a `maxColumnWidth` option which is - less than the specified width. Default: null. + Table column width(s) in units of character columns. When `null`, column + widths are determined according to cell content. When set to a specific + width, a column is rendered with the specified width, unless overridden + by a `maxColumnWidth` option which is less than the specified width. + Default: null. options.cornerTopLeft: string (optional) - Top-left table corner grapheme cluster (i.e., visual character). - Default: '┌'. + Top-left table corner character. Default: '┌'. options.cornerTopRight: string (optional) - Top-right table corner grapheme cluster (i.e., visual character). - Default: '┐'. + Top-right table corner character. Default: '┐'. options.cornerBottomRight: string (optional) - Bottom-right table corner grapheme cluster (i.e., visual character). - Default: '┘'. + Bottom-right table corner character. Default: '┘'. options.cornerBottomLeft: string (optional) - Bottom-left table corner grapheme cluster (i.e., visual character). - Default: '└'. + Bottom-left table corner character. Default: '└'. options.corners: Array (optional) - Table corner grapheme clusters (i.e., visual characters) in the order - [top-left, top-right, bottom-right, bottom-left]. Default: [ '┌', '┐', - '┘', '└' ]. + Table corner characters in the order [top-left, top-right, bottom-right, + bottom-left]. Default: [ '┌', '┐', '┘', '└' ]. options.format: Array|string (optional) Cell format string(s). Default: '%s'. @@ -103,28 +98,28 @@ Default: 'resume'. options.jointMiddle: string (optional) - Joint grapheme cluster (i.e., visual character) connecting cells within - the middle of the table. Default: '┼'. + Joint character connecting cells within the middle of the table. + Default: '┼'. options.jointTop: string (optional) - Joint grapheme cluster (i.e., visual character) connecting cells along - the top of the table. Default: '┬'. + Joint character connecting cells along the top of the table. Default: + '┬'. options.jointRight: string (optional) - Joint grapheme cluster (i.e., visual character) connecting cells along - the right side of the table. Default: '┤'. + Joint character connecting cells along the right side of the table. + Default: '┤'. options.jointBottom: string (optional) - Joint grapheme cluster (i.e., visual character) connecting cells along - the bottom of the table. Default: '┴'. + Joint character connecting cells along the bottom of the table. Default: + '┴'. options.jointLeft: string (optional) - Joint grapheme cluster (i.e., visual character) connecting cells along - the left side of the table. Default: '├'. + Joint character connecting cells along the left side of the table. + Default: '├'. options.joints: Array (optional) - Joint grapheme cluster (i.e., visual characters) in the order [middle, - top, right, bottom, left]. Default: [ '┼', '┬', '┤', '┴', '├' ]. + Joint characters in the order [middle, top, right, bottom, left]. + Default: [ '┼', '┬', '┤', '┴', '├' ]. options.marginTop: integer (optional) Margin at the top of the table in units of blank lines. Default: 0. @@ -143,13 +138,12 @@ [ 0, 0, 0, 0 ]. options.maxColumnWidth: Array|integer|null (optional) - Maximum column width(s) in units of grapheme clusters (i.e., visual - characters). If less than a column's specified width, this option - overrides the `columnWidth` option. Default: +infinity. + Maximum table column width(s) in units of character columns. If less + than a column's specified width, this option overrides the `columnWidth` + option. Default: +infinity. options.maxWidth: integer|null (optional) - Maximum table width in units of grapheme clusters (i.e., visual - characters). Default: +infinity. + Maximum table width in units of character columns. Default: +infinity. options.paddingLeft: Array|integer (optional) Cell left padding(s) in units of whitespace characters. Default: 1. @@ -182,16 +176,16 @@ 'change' event; otherwise, rendering must be triggered manually. table.borderTop - Top table border character(s). + Top table border character. table.borderRight - Right table border character(s). + Right table border character. table.borderBottom - Bottom table border character(s). + Bottom table border character. table.borderLeft - Left table border character(s). + Left table border character. table.borders Table border characters in the order [top, right, bottom, left]. @@ -206,20 +200,20 @@ Column width(s). table.cornerTopLeft - Top-left table corner grapheme cluster (i.e., visual character). + Top-left table corner character. table.cornerTopRight - Top-right table corner grapheme cluster (i.e., visual character). + Top-right table corner character. table.cornerBottomRight - Bottom-right table corner grapheme cluster (i.e., visual character). + Bottom-right table corner character. table.cornerBottomLeft - Bottom-left table corner grapheme cluster (i.e., visual character). + Bottom-left table corner character. table.corners - Corner grapheme clusters (i.e., visual characters) in the order - [top-left, top-right, bottom-right, bottom-left]. + Corner characters in the order [top-left, top-right, bottom-right, + bottom-left]. table.data Table data. @@ -243,28 +237,22 @@ Horizontal line separator mode. table.jointMiddle - Joint grapheme cluster (i.e., visual character) connecting cells within - the middle of the table. + Joint character connecting cells within the middle of the table. table.jointTop - Joint grapheme cluster (i.e., visual character) connecting cells along - the top of the table. + Joint character connecting cells along the top of the table. table.jointRight - Joint grapheme cluster (i.e., visual character) connecting cells along - the right side of the table. + Joint character connecting cells along the right side of the table. table.jointBottom - Joint grapheme cluster (i.e., visual character) connecting cells along - the bottom of the table. + Joint character connecting cells along the bottom of the table. table.jointLeft - Joint grapheme cluster (i.e., visual character) connecting cells along - the left side of the table. + Joint character connecting cells along the left side of the table. table.joints - Joint grapheme clusters (i.e., visual characters) in the order [middle, - top, right, bottom, left]. + Joint characters in the order [middle, top, right, bottom, left]. table.marginTop Top table margin. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js index dafa06a5e53f..fe99a2375b51 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js @@ -57,7 +57,7 @@ function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) lpad = leftPadding[ j%M ]; rpad = rightPadding[ j%N ]; v = headers.get( 0, j ); - len = lpad + v.ngraphemes + rpad; + len = lpad + v.columns + rpad; if ( len > out[ j ] ) { out[ j ] = len; } @@ -68,7 +68,7 @@ function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) lpad = leftPadding[ j%M ]; rpad = rightPadding[ j%N ]; v = data.get( i, j ); - len = lpad + v.ngraphemes + rpad; + len = lpad + v.columns + rpad; if ( len > out[ j ] ) { out[ j ] = len; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index 20d6000abc83..d3859df7cf24 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -46,25 +46,25 @@ function defaults() { 'value': '-', 'graphemes': [ '-' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '|', 'graphemes': [ '|' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '-', 'graphemes': [ '-' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '|', 'graphemes': [ '|' ], - 'ngraphemes': 1 + 'columns': 1 } ]; @@ -75,37 +75,37 @@ function defaults() { out.columnSeparator = { 'value': '|', 'graphemes': [ '|' ], - 'ngraphemes': 1 + 'columns': 1 }; // Column widths: out.columnWidth = null; // by default, automatically size based on content - // Corner grapheme clusters: + // Corner characters: out.corners = [ { 'value': '┌', 'graphemes': [ '┌' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '┐', 'graphemes': [ '┐' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '┘', 'graphemes': [ '┘' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '└', 'graphemes': [ '└' ], - 'ngraphemes': 1 + 'columns': 1 } ]; @@ -122,43 +122,43 @@ function defaults() { out.headerSeparator = { 'value': '-', 'graphemes': [ '-' ], - 'ngraphemes': 1 + 'columns': 1 }; // Horizontal line separator mode: out.horizontalSeparatorMode = 'resume'; - // Joint grapheme clusters: + // Joint characters: out.joints = [ { 'value': '┼', 'graphemes': [ '┼' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '┬', 'graphemes': [ '┬' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '┤', 'graphemes': [ '┤' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '┴', 'graphemes': [ '┴' ], - 'ngraphemes': 1 + 'columns': 1 }, { 'value': '├', 'graphemes': [ '├' ], - 'ngraphemes': 1 + 'columns': 1 } ]; @@ -179,7 +179,7 @@ function defaults() { out.rowSeparator = { 'value': '', 'graphemes': [], - 'ngraphemes': 0 + 'columns': 0 }; // Vertical line separator mode: diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 31d340496b3d..92942ed2f38a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -217,29 +217,29 @@ function initializePrivateProperties( table, defaults ) { // eslint-disable-line * @param {Options} [options] - table options * @param {(Collection|string)} [options.align='right'] - cell alignment(s) * @param {boolean} [options.autoRender=false] - boolean indicating whether to re-render on each `change` event -* @param {string} [options.borderTop='-'] - top table border character(s) -* @param {string} [options.borderRight='|'] - right table border character(s) -* @param {string} [options.borderBottom='-'] - bottom table border character(s) -* @param {string} [options.borderLeft='|'] - left table border character(s) +* @param {string} [options.borderTop='-'] - top table border character +* @param {string} [options.borderRight='|'] - right table border character +* @param {string} [options.borderBottom='-'] - bottom table border character +* @param {string} [options.borderLeft='|'] - left table border character * @param {Collection} [options.borders=[ '─', '│', '─', '│' ]] - table border characters * @param {(PositiveInteger|null)} [options.bufferSize] - size of data buffer * @param {string} [options.columnSeparator='│'] - column separator character(s) * @param {(Collection|NonNegativeInteger|null)} [options.columnWidth] - column width(s) -* @param {string} [options.cornerTopLeft='┌'] - top-left table corner grapheme cluster (i.e., visual character) -* @param {string} [options.cornerTopRight='┐'] - top-right table corner grapheme cluster (i.e., visual character) -* @param {string} [options.cornerBottomRight='┘''] - bottom-right table corner grapheme cluster (i.e., visual character) -* @param {string} [options.cornerBottomLeft='└'] - bottom-left table corner grapheme cluster (i.e., visual character) -* @param {Collection} [options.corners=[ '┌', '┐', '┘', '└' ]] - table corner grapheme clusters (i.e., visual characters) +* @param {string} [options.cornerTopLeft='┌'] - top-left table corner character +* @param {string} [options.cornerTopRight='┐'] - top-right table corner character +* @param {string} [options.cornerBottomRight='┘''] - bottom-right table corner character +* @param {string} [options.cornerBottomLeft='└'] - bottom-left table corner character +* @param {Collection} [options.corners=[ '┌', '┐', '┘', '└' ]] - table corner characters * @param {(string|StringArray)} [options.format='%s'] - cell format string(s) * @param {Collection} [options.headers] - table headers * @param {string} [options.headerSeparator='─'] - header separator character(s) * @param {string} [options.horizontalSeparatorMode='resume'] - horizontal line separator mode -* @param {string} [options.jointMiddle='┼'] - joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table -* @param {string} [options.jointTop='┬'] - joint grapheme cluster (i.e., visual character) connecting cells along the top of the table -* @param {string} [options.jointRight='┤'] - joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table -* @param {string} [options.jointBottom='┴'] - joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table -* @param {string} [options.jointLeft='├'] - joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table -* @param {Collection} [options.joints=[ '┼', '┬', '┤', '┴', '├' ]] - joint grapheme clusters (i.e., visual characters) +* @param {string} [options.jointMiddle='┼'] - joint character connecting cells within the middle of the table +* @param {string} [options.jointTop='┬'] - joint character connecting cells along the top of the table +* @param {string} [options.jointRight='┤'] - joint character connecting cells along the right side of the table +* @param {string} [options.jointBottom='┴'] - joint character connecting cells along the bottom of the table +* @param {string} [options.jointLeft='├'] - joint character connecting cells along the left side of the table +* @param {Collection} [options.joints=[ '┼', '┬', '┤', '┴', '├' ]] - joint characters * @param {NonNegativeInteger} [options.marginTop=0] - margin at the top of the table in units of blank lines * @param {NonNegativeInteger} [options.marginRight=0] - margin to the right of the table in units of whitespace * @param {NonNegativeInteger} [options.marginBottom=0] - margin at the bottom of the table in units of blank lines @@ -363,6 +363,7 @@ inherit( UnicodeTable, EventEmitter ); * @memberof UnicodeTable.prototype * @type {(Array|string)} * @throws {TypeError} must be a supported alignment string or an array of alignment strings +* @throws {RangeError} must provide the correct number of table columns * @default 'right' * * @example @@ -407,7 +408,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'align', getAlign, setAlign ); setReadWriteAccessor( UnicodeTable.prototype, 'autoRender', getAutoRender, setAutoRender ); /** -* Top table border character(s). +* Top table border character. * * @name borderTop * @memberof UnicodeTable.prototype @@ -426,7 +427,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'autoRender', getAutoRender, setAu setReadWriteAccessor( UnicodeTable.prototype, 'borderTop', getBorderTop, setBorderTop ); /** -* Right table border character(s). +* Right table border character. * * @name borderRight * @memberof UnicodeTable.prototype @@ -445,7 +446,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borderTop', getBorderTop, setBord setReadWriteAccessor( UnicodeTable.prototype, 'borderRight', getBorderRight, setBorderRight ); /** -* Bottom table border character(s). +* Bottom table border character. * * @name borderBottom * @memberof UnicodeTable.prototype @@ -464,7 +465,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borderRight', getBorderRight, set setReadWriteAccessor( UnicodeTable.prototype, 'borderBottom', getBorderBottom, setBorderBottom ); /** -* Left table border character(s). +* Left table border character. * * @name borderLeft * @memberof UnicodeTable.prototype @@ -508,7 +509,6 @@ setReadWriteAccessor( UnicodeTable.prototype, 'borders', getBorders, setBorders * @memberof UnicodeTable.prototype * @type {(PositiveInteger|null)} * @throws {TypeError} must be a positive integer or null -* @throws {RangeError} must be greater than or equal to the number of rows * * @example * var table = new UnicodeTable(); @@ -540,7 +540,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'bufferSize', getBufferSize, setBu setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSeparator, setColumnSeparator ); /** -* Column width(s) in units of grapheme clusters (i.e., visual characters). +* Column width(s) in units of character columns. * * @name columnWidth * @memberof UnicodeTable.prototype @@ -567,7 +567,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSepara setReadWriteAccessor( UnicodeTable.prototype, 'columnWidth', getColumnWidth, setColumnWidth ); /** -* Top-left table corner grapheme cluster (i.e., visual character). +* Top-left table corner character. * * @name cornerTopLeft * @memberof UnicodeTable.prototype @@ -586,7 +586,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'columnWidth', getColumnWidth, set setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopLeft', getCornerTopLeft, setCornerTopLeft ); /** -* Top-right table corner grapheme cluster (i.e., visual character). +* Top-right table corner character. * * @name cornerTopRight * @memberof UnicodeTable.prototype @@ -605,7 +605,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopLeft', getCornerTopLeft, setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopRight', getCornerTopRight, setCornerTopRight ); /** -* Bottom-right table corner grapheme cluster (i.e., visual character). +* Bottom-right table corner character. * * @name cornerBottomRight * @memberof UnicodeTable.prototype @@ -624,7 +624,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerTopRight', getCornerTopRigh setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomRight', getCornerBottomRight, setCornerBottomRight ); /** -* Bottom-left table corner grapheme cluster (i.e., visual character). +* Bottom-left table corner character. * * @name cornerBottomLeft * @memberof UnicodeTable.prototype @@ -643,12 +643,12 @@ setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomRight', getCornerBott setReadWriteAccessor( UnicodeTable.prototype, 'cornerBottomLeft', getCornerBottomLeft, setCornerBottomLeft ); /** -* Table corner grapheme clusters (i.e., visual characters) in the order of `[top-left, top-right, bottom-right, bottom-left]`. +* Table corner characters in the order of `[top-left, top-right, bottom-right, bottom-left]`. * * @name corners * @memberof UnicodeTable.prototype * @type {Array} -* @throws {TypeError} must be an array of four grapheme clusters +* @throws {TypeError} must be an array of four strings * @default [ "┌", "┐", "┘", "└" ] * * @example @@ -690,6 +690,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'data', getData, setData ); * @memberof UnicodeTable.prototype * @type {(string|StringArray)} * @throws {TypeError} must be a string or an array of strings +* @throws {RangeError} must provide the correct number of table columns * @default '%s' * * @example @@ -709,6 +710,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'format', getFormat, setFormat ); * @memberof UnicodeTable.prototype * @type {(Array|string)} * @throws {TypeError} must be a supported alignment string or an array of alignment strings +* @throws {RangeError} must provide the correct number of table columns * @default 'right' * * @example @@ -736,7 +738,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'headerAlign', getHeaderAlign, set * @memberof UnicodeTable.prototype * @type {Collection} * @throws {TypeError} must be an array-like object -* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} must provide the correct number of table columns * * @example * var table = new UnicodeTable(); @@ -787,7 +789,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'headerSeparator', getHeaderSepara setReadWriteAccessor( UnicodeTable.prototype, 'horizontalSeparatorMode', getHorizontalSeparatorMode, setHorizontalSeparatorMode ); /** -* Joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +* Joint character connecting cells within the middle of the table. * * @name jointMiddle * @memberof UnicodeTable.prototype @@ -806,7 +808,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'horizontalSeparatorMode', getHori setReadWriteAccessor( UnicodeTable.prototype, 'jointMiddle', getJointMiddle, setJointMiddle ); /** -* Joint grapheme cluster (i.e., visual character) connecting cells at the top of the table. +* Joint character connecting cells at the top of the table. * * @name jointTop * @memberof UnicodeTable.prototype @@ -825,7 +827,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointMiddle', getJointMiddle, set setReadWriteAccessor( UnicodeTable.prototype, 'jointTop', getJointTop, setJointTop ); /** -* Joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +* Joint character connecting cells along the right side of the table. * * @name jointRight * @memberof UnicodeTable.prototype @@ -844,7 +846,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointTop', getJointTop, setJointT setReadWriteAccessor( UnicodeTable.prototype, 'jointRight', getJointRight, setJointRight ); /** -* Joint grapheme cluster (i.e., visual character) connecting cells at the bottom of the table. +* Joint character connecting cells at the bottom of the table. * * @name jointBottom * @memberof UnicodeTable.prototype @@ -863,7 +865,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointRight', getJointRight, setJo setReadWriteAccessor( UnicodeTable.prototype, 'jointBottom', getJointBottom, setJointBottom ); /** -* Joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +* Joint character connecting cells along the left side of the table. * * @name jointLeft * @memberof UnicodeTable.prototype @@ -882,12 +884,12 @@ setReadWriteAccessor( UnicodeTable.prototype, 'jointBottom', getJointBottom, set setReadWriteAccessor( UnicodeTable.prototype, 'jointLeft', getJointLeft, setJointLeft ); /** -* Joint grapheme clusters (i.e., visual characters) in the order of `[middle, top, right, bottom, left]`. +* Joint characters in the order of `[middle, top, right, bottom, left]`. * * @name joints * @memberof UnicodeTable.prototype * @type {Array} -* @throws {TypeError} must be an array of five grapheme clusters +* @throws {TypeError} must be an array of five strings * @default [ "┼", "┬", "┤", "┴", "├" ] * * @example @@ -983,6 +985,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginLeft', getMarginLeft, setMa * @memberof UnicodeTable.prototype * @type {NonNegativeIntegerArray} * @throws {TypeError} must be an array of nonnegative integers +* @throws {RangeError} must provide the correct number of table columns * @default [ 0, 0, 0, 0 ] * * @example @@ -996,7 +999,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginLeft', getMarginLeft, setMa setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins ); /** -* Maximum column width(s) in units of grapheme clusters (i.e., visual characters). +* Maximum column width(s) in units of character columns. * * @name maxColumnWidth * @memberof UnicodeTable.prototype @@ -1023,7 +1026,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins setReadWriteAccessor( UnicodeTable.prototype, 'maxColumnWidth', getMaxColumnWidth, setMaxColumnWidth ); /** -* Maximum table width in units of grapheme clusters (i.e., visual characters). +* Maximum table width in units of character columns. * * @name maxWidth * @memberof UnicodeTable.prototype diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index 135f69d26a4e..2af0c605c5c5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -23,6 +23,7 @@ var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var accessors = require( '@stdlib/array/base/accessors' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // @@ -41,7 +42,6 @@ function normalize( buffer, shape, fmts ) { var get; var set; var raw; - var ch; var v; var i; var j; @@ -56,12 +56,11 @@ function normalize( buffer, shape, fmts ) { for ( j = 0; j < shape[ 1 ]; j++ ) { raw = get( buffer, k ); v = format( fmts[ j%fmts.length ], raw ); - ch = splitGraphemeClusters( v ); set( buffer, k, { 'raw': raw, 'value': v, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( v ), + 'columns': wcswidth( v ) }); k += 1; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js index 331e99624f02..3085aa188805 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/align/set.js @@ -43,7 +43,7 @@ var isAlignment = contains( [ 'right', 'center', 'left' ] ); * @private * @param {(Array|string)} value - cell alignment(s) * @throws {TypeError} must be a supported alignment or an array of alignments -* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} must provide the correct number of table columns */ function set( value ) { var tmp; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js index c58a9d052c1d..22be478f7e66 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the table bottom border character(s). +* Returns the table bottom border character. * * @private -* @returns {string} border character(s) +* @returns {string} border character */ function get() { return this._borders[ 2 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index d8abd61a0996..f9df31e87b5e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -25,28 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the table bottom border character(s). +* Sets the table bottom border character. * * @private -* @param {string} value - border character(s) -* @throws {TypeError} must be a string +* @param {string} value - border character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderBottom', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderBottom', value ) ); + } + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderBottom', value ) ); } if ( value !== this._borders[ 2 ].value ) { - ch = splitGraphemeClusters( value ); this._borders[ 2 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js index be3d6698b140..ceacf6567ebd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the table left border character(s). +* Returns the table left border character. * * @private -* @returns {string} border character(s) +* @returns {string} border character */ function get() { return this._borders[ 3 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index f59281ecacf0..7ff197db40ba 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -25,28 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the table left border character(s). +* Sets the table left border character. * * @private -* @param {string} value - border character(s) -* @throws {TypeError} must be a string +* @param {string} value - border character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); + } + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); } if ( value !== this._borders[ 3 ].value ) { - ch = splitGraphemeClusters( value ); this._borders[ 3 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js index 3a54aff7e65c..0e936d2a1d6a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the table right border character(s). +* Returns the table right border character. * * @private -* @returns {string} border character(s) +* @returns {string} border character */ function get() { return this._borders[ 1 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index 99abcca8229f..f3a6b3468795 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -25,28 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the table right border character(s). +* Sets the table right border character. * * @private -* @param {string} value - border character(s) -* @throws {TypeError} must be a string +* @param {string} value - border character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderRight', value ) ); + } + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderRight', value ) ); } if ( value !== this._borders[ 1 ].value ) { - ch = splitGraphemeClusters( value ); this._borders[ 1 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js index 51040187f4c5..16208ead9d49 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the table top border character(s). +* Returns the table top border character. * * @private -* @returns {string} border character(s) +* @returns {string} border character */ function get() { return this._borders[ 0 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index dca1d8d189f8..9c41ef30ca48 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -25,28 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the table top border character(s). +* Sets the table top border character. * * @private -* @param {string} value - border character(s) +* @param {string} value - border character * @throws {TypeError} must be a string */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderTop', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderTop', value ) ); + } + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderTop', value ) ); } if ( value !== this._borders[ 0 ].value ) { - ch = splitGraphemeClusters( value ); this._borders[ 0 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index 54977b99e77c..11d47d142732 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -22,11 +22,13 @@ // MODULES // -var isStringArray = require( '@stdlib/assert/is-string-array' ).primitives; +var isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var isCollection = require( '@stdlib/assert/is-collection' ); var copy = require( '@stdlib/array/base/copy' ); var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // VARIABLES // @@ -57,13 +59,15 @@ function predicate( v1, v2 ) { * @private * @param {Collection} values - border characters * @throws {TypeError} must be an array of strings +* @throws {TypeError} each array element must be a single character * @throws {RangeError} must provide four strings */ function set( values ) { var data; - var ch; + var w; + var v; var i; - if ( !isStringArray( values ) ) { + if ( !isCollection( values ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings. Value: `%s`.', 'borders', values ) ); } if ( values.length !== NUM_BORDERS ) { @@ -71,11 +75,18 @@ function set( values ) { } data = []; for ( i = 0; i < NUM_BORDERS; i++ ) { - ch = splitGraphemeClusters( values[ i ] ); + v = values[ i ]; + if ( !isString( v ) ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); + } + w = wcswidth( v ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); + } data.push({ - 'value': values[ i ], - 'graphemes': ch, - 'ngraphemes': ch.length + 'value': v, + 'graphemes': splitGraphemeClusters( v ), + 'columns': w }); } if ( !everyBy2( data, this._borders, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 771897333114..5170daa60de6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -25,6 +25,7 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // @@ -37,16 +38,14 @@ var format = require( '@stdlib/string/format' ); * @throws {TypeError} must be a string */ function set( value ) { - var ch; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', value ) ); } if ( value !== this._columnSeparator.value ) { - ch = splitGraphemeClusters( value ); this._columnSeparator = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': wcswidth( value ) }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js index 8064c2016377..6a4d1c168598 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js @@ -33,12 +33,12 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the column width(s) for each table column. +* Sets the column width(s) for each table column in units of character columns. * * @private * @param {(Collection|NonNegativeInteger|null)} value - column width(s) * @throws {TypeError} must be null, a nonnegative integer, an array of nonnegative integers and/or nulls -* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} must provide the correct number of table columns */ function set( value ) { var out; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js index 7e259f29e281..465667144c22 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the bottom-left table corner grapheme cluster (i.e., visual character). +* Returns the bottom-left table corner character. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._corners[ 3 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 227c1721ea4d..865c166609fa 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the bottom-left table corner grapheme cluster (i.e., visual character). +* Sets the bottom-left table corner character. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomLeft', value ) ); } - ch = splitGraphemeClusters( value ); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomLeft', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomLeft', value ) ); } if ( value !== this._corners[ 3 ].value ) { this._corners[ 3 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js index f5b80542be91..a2a7fc099e7a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the bottom-right table corner grapheme cluster (i.e., visual character). +* Returns the bottom-right table corner character. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._corners[ 2 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 0cc68d96f6d3..ffe4b2b042cd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the bottom-right table corner grapheme cluster (i.e., visual character). +* Sets the bottom-right table corner character. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomRight', value ) ); } - ch = splitGraphemeClusters( value ); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerBottomRight', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomRight', value ) ); } if ( value !== this._corners[ 2 ].value ) { this._corners[ 2 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js index cb074bd55b83..134333efe244 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the top-left table corner grapheme cluster (i.e., visual character). +* Returns the top-left table corner character. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._corners[ 0 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index baf3ead07f83..5dac6bff0f2d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the top-left table corner grapheme cluster (i.e., visual character). +* Sets the top-left table corner character. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopLeft', value ) ); } - ch = splitGraphemeClusters( value ); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopLeft', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopLeft', value ) ); } if ( value !== this._corners[ 0 ].value ) { this._corners[ 0 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js index 1e06d2534890..696d0b12b064 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the top-right table corner grapheme cluster (i.e., visual character). +* Returns the top-right table corner character. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._corners[ 1 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index a64f16b32e85..2c39542733eb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the top-right table corner grapheme cluster (i.e., visual character). +* Sets the top-right table corner character. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopRight', value ) ); } - ch = splitGraphemeClusters( value ); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'cornerTopRight', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopRight', value ) ); } if ( value !== this._corners[ 1 ].value ) { this._corners[ 1 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js index 92508e499359..0fbf6c389bf9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/get.js @@ -28,10 +28,10 @@ var pluck = require( '@stdlib/utils/pluck' ); // TODO: replace with array/base u // MAIN // /** -* Returns the table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. +* Returns the table corner characters in the order `[top-left, top-right, bottom-right, bottom-left]`. * * @private -* @returns {Array} corners +* @returns {Array} list of characters */ function get() { return pluck( this._corners, 'value' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index 964449dd7592..df015363c2ca 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -28,6 +28,7 @@ var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var copy = require( '@stdlib/array/base/copy' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // VARIABLES // @@ -53,17 +54,17 @@ function predicate( v1, v2 ) { // MAIN // /** -* Sets the table corner grapheme clusters (i.e., visual characters) in the order `[top-left, top-right, bottom-right, bottom-left]`. +* Sets the table corner characters in the order `[top-left, top-right, bottom-right, bottom-left]`. * * @private -* @param {Array} values - corners +* @param {Array} values - list of characters * @throws {TypeError} must be an array of strings -* @throws {TypeError} each array element must be a single grapheme cluster +* @throws {TypeError} each array element must be a single character * @throws {RangeError} must provide four strings */ function set( values ) { var data; - var ch; + var w; var v; var i; @@ -77,16 +78,16 @@ function set( values ) { for ( i = 0; i < NUM_CORNERS; i++ ) { v = values[ i ]; if ( !isString( v ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } - ch = splitGraphemeClusters( v ); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); + w = wcswidth( v ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } data.push({ 'value': v, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( v ), + 'columns': w }); } if ( !everyBy2( data, this._corners, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js index af0b0f238904..19cd5409c2eb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-align/set.js @@ -44,7 +44,7 @@ var isAlignment = contains( [ 'right', 'center', 'left' ] ); * @private * @param {(Array|string|null)} value - cell alignment(s) * @throws {TypeError} must be a supported alignment or an array of alignments -* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} must provide the correct number of table columns */ function set( value ) { var tmp; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index dc74092a6b07..a03d97c9b782 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -25,6 +25,7 @@ var isString = require( '@stdlib/assert/is-string' ); var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // @@ -37,16 +38,14 @@ var format = require( '@stdlib/string/format' ); * @throws {TypeError} must be a string */ function set( value ) { - var ch; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', value ) ); } if ( value !== this._headerSeparator.value ) { - ch = splitGraphemeClusters( value ); this._headerSeparator = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': wcswidth( value ) }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index 3ca6e1452e15..04540d5217bd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -27,6 +27,7 @@ var copy = require( '@stdlib/array/base/copy' ); var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // FUNCTIONS // @@ -52,12 +53,11 @@ function predicate( v1, v2 ) { * @private * @param {Collection} values - table headers * @throws {TypeError} must be a collection -* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} must provide the correct number of table columns */ function set( values ) { var data; var len; - var ch; var v; var i; if ( !isCollection( values ) ) { @@ -74,11 +74,10 @@ function set( values ) { data = []; for ( i = 0; i < len; i++ ) { v = String( values[ i ] ); - ch = splitGraphemeClusters( v ); data.push({ 'value': v, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( v ), + 'columns': wcswidth( v ) }); } if ( this._headers === null || !everyBy2( data, this._headers, predicate ) ) { // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js index 62fefcc27639..13ee47f23d89 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table. +* Returns the joint character connecting cells along the bottom of the table. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._joints[ 3 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index f73b10284edd..4e6be74a4db6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the bottom of the table. +* Sets the joint character connecting cells along the bottom of the table. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointBottom', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); } - ch = splitGraphemeClusters( value); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointBottom', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); } if ( value !== this._joints[ 3 ].value ) { this._joints[ 3 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js index 8e39e4c93703..1c695cbf8bcf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +* Returns the joint character connecting cells along the left side of the table. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._joints[ 4 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index 383651fe3d47..523cbfd3a3c1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the left side of the table. +* Sets the joint character connecting cells along the left side of the table. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointLeft', value ) ); } - ch = splitGraphemeClusters( value); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointLeft', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointLeft', value ) ); } if ( value !== this._joints[ 4 ].value ) { this._joints[ 4 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js index 2530b2e2bf34..c8925b223add 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +* Returns the joint character connecting cells within the middle of the table. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._joints[ 0 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index 4cfb0b50974a..6693b22a30f8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the joint grapheme cluster (i.e., visual character) connecting cells within the middle of the table. +* Sets the joint character connecting cells within the middle of the table. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointMiddle', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointMiddle', value ) ); } - ch = splitGraphemeClusters( value); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointMiddle', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointMiddle', value ) ); } if ( value !== this._joints[ 0 ].value ) { this._joints[ 0 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js index 10c3de867fed..d803c50d44da 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +* Returns the joint character connecting cells along the right side of the table. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._joints[ 2 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index 2f63d91dbbeb..aeeb6f349df1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the right side of the table. +* Sets the joint character connecting cells along the right side of the table. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointRight', value ) ); } - ch = splitGraphemeClusters( value); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointRight', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointRight', value ) ); } if ( value !== this._joints[ 2 ].value ) { this._joints[ 2 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js index 5801f28f4fb7..35f51dcf6fa1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/get.js @@ -23,10 +23,10 @@ // MAIN // /** -* Returns the joint grapheme cluster (i.e., visual character) connecting cells along the top of the table. +* Returns the joint character connecting cells along the top of the table. * * @private -* @returns {string} grapheme cluster +* @returns {string} character */ function get() { return this._joints[ 1 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index 73f2bab6e732..ef1780d3b7ca 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -25,31 +25,32 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // /** -* Sets the joint grapheme cluster (i.e., visual character) connecting cells along the top of the table. +* Sets the joint character connecting cells along the top of the table. * * @private -* @param {string} value - grapheme cluster -* @throws {TypeError} must be a string containing a single grapheme cluster +* @param {string} value - character +* @throws {TypeError} must be a string containing a single character */ function set( value ) { - var ch; + var w; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointTop', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointTop', value ) ); } - ch = splitGraphemeClusters( value); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string containing a single grapheme cluster. Value: `%s`.', 'jointTop', value ) ); + w = wcswidth( value ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointTop', value ) ); } if ( value !== this._joints[ 1 ].value ) { this._joints[ 1 ] = { 'value': value, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( value ), + 'columns': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 56b74a4bf8eb..f0829fa941b0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -28,6 +28,7 @@ var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var copy = require( '@stdlib/array/base/copy' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // VARIABLES // @@ -53,17 +54,17 @@ function predicate( v1, v2 ) { // MAIN // /** -* Sets the joint grapheme clusters (i.e., visual characters) in the order `[middle, top, right, bottom, left ]`. +* Sets the joint characters in the order `[middle, top, right, bottom, left ]`. * * @private * @param {Array} values - joint characters * @throws {TypeError} must be an array of strings -* @throws {TypeError} each array element must be a single grapheme cluster +* @throws {TypeError} each array element must be a single character * @throws {RangeError} must provide five strings */ function set( values ) { var data; - var ch; + var w; var v; var i; @@ -77,16 +78,16 @@ function set( values ) { for ( i = 0; i < NUM_JOINTS; i++ ) { v = values[ i ]; if ( !isString( v ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } - ch = splitGraphemeClusters( v ); - if ( ch.length !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a single grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); + w = wcswidth( v ); + if ( w !== 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } data.push({ 'value': v, - 'graphemes': ch, - 'ngraphemes': 1 + 'graphemes': splitGraphemeClusters( v ), + 'columns': w }); } if ( !everyBy2( data, this._joints, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js index 0b88cd56b6fb..0373e4488501 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-column-width/set.js @@ -39,7 +39,7 @@ var format = require( '@stdlib/string/format' ); * @private * @param {(Collection|NonNegativeInteger|null)} value - maximum column width(s) * @throws {TypeError} must be null, a nonnegative integer, an array of nonnegative integers and/or nulls -* @throws {RangeError} must provide the correct number of columns +* @throws {RangeError} must provide the correct number of table columns */ function set( value ) { var out; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js index 18d9347136b8..29c89bb0dcd0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js @@ -23,7 +23,7 @@ // MAIN // /** -* Returns the maximum table width in units of grapheme clusters (i.e., visual characters). +* Returns the maximum table width in units of character columns. * * @private * @returns {NonNegativeInteger} maximum width diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js index 12c32b2f3825..be6dfdf09bee 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-left/set.js @@ -32,7 +32,7 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table cell left padding(s) in units of whitespace. +* Sets the table cell left padding(s) in units of whitespace characters. * * @private * @param {(Array|NonNegativeInteger)} value - cell left padding(s) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js index 009f65e9a89d..b3b0467803f5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/get.js @@ -23,7 +23,7 @@ // MAIN // /** -* Returns the cell right padding(s) in units of whitespace. +* Returns the cell right padding(s) in units of whitespace characters. * * @private * @returns {(NonNegativeIntegerArray|NonNegativeInteger)} cell right padding(s) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js index 213dd244227e..c03f6a97a6d6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/padding-right/set.js @@ -32,7 +32,7 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the table cell right padding(s) in units of whitespace. +* Sets the table cell right padding(s) in units of whitespace characters. * * @private * @param {(Array|NonNegativeInteger)} value - cell right padding(s) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index ee52a34540c4..7b056a3d3bb4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -25,6 +25,7 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); +var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth // MAIN // @@ -37,16 +38,14 @@ var format = require( '@stdlib/string/format' ); * @throws {TypeError} must be a string */ function set( value ) { - var ch; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', value ) ); } if ( value !== this._rowSeparator.value ) { - ch = splitGraphemeClusters( value ); this._rowSeparator = { 'value': value, - 'graphemes': ch, - 'ngraphemes': ch.length + 'graphemes': splitGraphemeClusters( value ), + 'columns': wcswidth( value ) }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 980b328be700..5f3a6c29ce38 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -39,12 +39,12 @@ var columnWidths = require( './column_widths.js' ); * Computes a column width. * * @private -* @param {NonNegativeInteger} ngraphemes - number of grapheme clusters -* @param {NonNegativeInteger} maxWidth - maximum column width (in units of grapheme clusters) -* @returns {NonNegativeInteger} width (in units of grapheme clusters) +* @param {NonNegativeInteger} len - number of character columns +* @param {NonNegativeInteger} maxWidth - maximum column width (in units of character columns) +* @returns {NonNegativeInteger} width (in units of character columns) */ -function columnWidth( ngraphemes, maxWidth ) { - return min( ngraphemes, maxWidth ); +function columnWidth( len, maxWidth ) { + return min( len, maxWidth ); } /** @@ -52,14 +52,14 @@ function columnWidth( ngraphemes, maxWidth ) { * * @private * @param {Object} ctx - context object -* @param {NonNegativeInteger} ctx.maxWidth - maximum table width (in units of grapheme clusters) -* @param {Array} ctx.fixedWidths - fixed column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.maxWidth - maximum table width (in units of character columns) +* @param {Array} ctx.fixedWidths - fixed column widths (in units of character columns) +* @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of character columns) +* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of character columns) * @param {NonNegativeInteger} ctx.marginL - left table margin * @param {NonNegativeInteger} ctx.marginR - right table margin -* @param {NonNegativeInteger} ctx.borderL - left border length (in units of grapheme clusters) -* @param {NonNegativeInteger} ctx.borderR - right border length (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.borderL - left border length (in units of character columns) +* @param {NonNegativeInteger} ctx.borderR - right border length (in units of character columns) * @param {Object} ctx.columnSeparator - column separator * @returns {(NonNegativeIntegerArray|Error)} list of column indices or an error */ @@ -105,7 +105,7 @@ function wrappedColumnIndices( ctx ) { } // For all columns apart from the last (which has a border, not a column separator), include the width of the column separator... if ( i < ncols-1 ) { - width += ctx.columnSeparator.ngraphemes; + width += ctx.columnSeparator.columns; } } // Include a final "index" to serve as the index upper bound: @@ -148,17 +148,17 @@ function renderVerticalMargin( out, margin ) { * Renders a table line. * * @private -* @param {NonNegativeInteger} start - starting column index (inclusive) -* @param {NonNegativeInteger} end - ending column index (exclusive) -* @param {Object} ch - line characters +* @param {NonNegativeInteger} start - starting table column index (inclusive) +* @param {NonNegativeInteger} end - ending table column index (exclusive) +* @param {StringArray} ch - line characters * @param {Object} ctx - context object -* @param {Array} ctx.fixedWidths - fixed column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of grapheme clusters) +* @param {Array} ctx.fixedWidths - fixed column widths (in units of character columns) +* @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of character columns) +* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of character columns) * @param {NonNegativeInteger} ctx.marginL - left table margin * @param {NonNegativeInteger} ctx.marginR - right table margin -* @param {NonNegativeInteger} ctx.borderL - left border length (in units of grapheme clusters) -* @param {NonNegativeInteger} ctx.borderR - right border length (in units of grapheme clusters) +* @param {NonNegativeInteger} ctx.borderL - left border length (in units of character columns) +* @param {NonNegativeInteger} ctx.borderR - right border length (in units of character columns) * @param {string} ctx.jointL - left joint * @param {string} ctx.jointM - middle joint * @param {string} ctx.jointR - right joint @@ -191,7 +191,7 @@ function renderLine( start, end, ch, ctx ) { // Render a table line... for ( i = start; i < end; i++ ) { // If columns are separated by a column separator, render the middle joint... - if ( i > start && ctx.columnSeparator.ngraphemes > 0 ) { + if ( i > start && ctx.columnSeparator.columns > 0 ) { out += ctx.jointM; if ( ctx.mode === 'interpolate' ) { hidx += 1; @@ -231,9 +231,9 @@ function renderLine( start, end, ch, ctx ) { * @param {NonNegativeInteger} end - ending column index (exclusive) * @param {ndarray} data - table data * @param {Object} ctx - context object -* @param {Array} ctx.fixedWidths - fixed column widths (in units of grapheme clusters) -* @param {NonNegativeInteger} ctx.computedWidths - column widths (in units of grapheme clusters) -* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of grapheme clusters) +* @param {Array} ctx.fixedWidths - fixed column widths (in units of character columns) +* @param {NonNegativeInteger} ctx.computedWidths - column widths (in units of character columns) +* @param {NonNegativeIntegerArray} ctx.maxColumnWidths - maximum column widths (in units of character columns) * @param {NonNegativeInteger} ctx.marginL - left table margin * @param {NonNegativeInteger} ctx.marginR - right table margin * @param {NonNegativeIntegerArray} ctx.paddingL - left cell padding @@ -250,6 +250,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { var rpad; var out; var len; + var tmp; var mw; var fw; var w; @@ -261,13 +262,13 @@ function renderRow( row, start, end, data, ctx, vidx ) { out = renderWhitespace( ctx.marginL ); // Render left border: - if ( ctx.borderL.ngraphemes > 0 ) { - out += ctx.borderL.graphemes[ vidx%ctx.borderL.ngraphemes ]; + if ( ctx.borderL.columns > 0 ) { + out += ctx.borderL.graphemes[ vidx%ctx.borderL.graphemes.length ]; } for ( i = start; i < end; i++ ) { // Render column separator: - if ( i > start && ctx.columnSeparator.ngraphemes > 0 ) { - out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.ngraphemes ]; // eslint-disable-line max-len + if ( i > start && ctx.columnSeparator.columns > 0 ) { + out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.graphemes.length ]; // eslint-disable-line max-len } // Resolve cell paddings: lpad = ctx.paddingL[ i%ctx.paddingL.length ]; @@ -278,7 +279,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { // Resolve cell data: v = data.get( row, i ); - len = lpad + v.ngraphemes + rpad; // number of grapheme clusters + len = lpad + v.columns + rpad; // number of character columns // Determine whether we need to truncate rendered data: mw = ctx.maxColumnWidths[ i%ctx.maxColumnWidths.length ]; @@ -291,7 +292,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { if ( w > mw ) { // Truncate rendered data: w = mw; - d = v.graphemes.slice( 0, mw-lpad-rpad ).join( '' ); + tmp = v.graphemes.slice( 0, mw-lpad-rpad ); // FIXME: be emoji aware and don't cut off graphemes mid-grapheme + d = tmp.join( '' ); } else { d = v.value; } @@ -317,8 +319,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { out += renderWhitespace( rpad ); } // Render right border: - if ( ctx.borderR.ngraphemes > 0 ) { - out += ctx.borderR.graphemes[ vidx%ctx.borderR.ngraphemes ]; + if ( ctx.borderR.columns > 0 ) { + out += ctx.borderR.graphemes[ vidx%ctx.borderR.graphemes.length ]; } // Render right margin: out += renderWhitespace( ctx.marginR ); @@ -333,7 +335,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { * Renders a table. * * @private -* @throws {Error} output must be able to accommodate every column individually +* @throws {Error} output must be able to accommodate every table column individually * @returns {string} rendered table */ function render() { @@ -377,8 +379,8 @@ function render() { 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], - 'borderL': this._borders[ 3 ].ngraphemes, - 'borderR': this._borders[ 1 ].ngraphemes, + 'borderL': this._borders[ 3 ].columns, + 'borderR': this._borders[ 1 ].columns, 'columnSeparator': this._columnSeparator }); if ( idx instanceof Error ) { @@ -392,8 +394,8 @@ function render() { 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], - 'borderL': this._borders[ 3 ].ngraphemes, - 'borderR': this._borders[ 1 ].ngraphemes, + 'borderL': this._borders[ 3 ].columns, + 'borderR': this._borders[ 1 ].columns, 'jointL': '', 'jointM': '', 'jointR': '', @@ -429,7 +431,7 @@ function render() { vidx = 0; // Render top border: - if ( this._borders[ 0 ].ngraphemes > 0 ) { + if ( this._borders[ 0 ].columns > 0 ) { lctx.jointL = this._corners[ 0 ].value; lctx.jointM = this._joints[ 1 ].value; lctx.jointR = this._corners[ 1 ].value; @@ -449,7 +451,7 @@ function render() { rctx.alignments = tmp; } // Render header separator: - if ( this._headers && this._headerSeparator.ngraphemes !== 0 ) { + if ( this._headers && this._headerSeparator.columns !== 0 ) { lctx.jointL = this._joints[ 4 ].value; lctx.jointM = this._joints[ 0 ].value; lctx.jointR = this._joints[ 2 ].value; @@ -470,7 +472,7 @@ function render() { vidx += 1; // Render row separator: - if ( this._rowSeparator.ngraphemes > 0 && i < nrows-1 ) { + if ( this._rowSeparator.columns > 0 && i < nrows-1 ) { lctx.jointL = this._joints[ 4 ].value; lctx.jointM = this._joints[ 0 ].value; lctx.jointR = this._joints[ 2 ].value; @@ -485,7 +487,7 @@ function render() { } } // Render bottom border: - if ( this._borders[ 2 ].ngraphemes > 0 ) { + if ( this._borders[ 2 ].columns > 0 ) { lctx.jointL = this._corners[ 3 ].value; lctx.jointM = this._joints[ 3 ].value; lctx.jointR = this._corners[ 2 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js new file mode 100644 index 000000000000..5eaaf4212680 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js @@ -0,0 +1,37 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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'; + +// MAIN // + +/** +* Returns the width of a Unicode string when rendered to a terminal. +* +* @private +* @param {string} str - input string +* @returns {NonNegativeInteger} number of columns +*/ +function wcswidth( str ) { + return str.length; // FIXME: implement wcswidth! +} + + +// EXPORTS // + +module.exports = wcswidth; From de57031e4b9dab8a5105c239e4656eed2c139cdc Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 19:20:44 -0800 Subject: [PATCH 20/34] refactor: rename internal properties and add initial ANSI escape support --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../table/unicode/examples/ansi_styling.js | 2 +- .../plot/table/unicode/lib/ansi_regexp.js | 34 ++++ .../plot/table/unicode/lib/column_widths.js | 4 +- .../plot/table/unicode/lib/defaults.js | 32 ++-- .../plot/table/unicode/lib/normalize.js | 159 +++++++++++++++++- .../unicode/lib/props/border-bottom/set.js | 2 +- .../unicode/lib/props/border-left/set.js | 2 +- .../unicode/lib/props/border-right/set.js | 2 +- .../table/unicode/lib/props/border-top/set.js | 2 +- .../table/unicode/lib/props/borders/set.js | 2 +- .../unicode/lib/props/column-separator/set.js | 2 +- .../lib/props/corner-bottom-left/set.js | 2 +- .../lib/props/corner-bottom-right/set.js | 2 +- .../unicode/lib/props/corner-top-left/set.js | 2 +- .../unicode/lib/props/corner-top-right/set.js | 2 +- .../table/unicode/lib/props/corners/set.js | 2 +- .../unicode/lib/props/header-separator/set.js | 2 +- .../table/unicode/lib/props/headers/set.js | 20 +-- .../unicode/lib/props/joint-bottom/set.js | 2 +- .../table/unicode/lib/props/joint-left/set.js | 2 +- .../unicode/lib/props/joint-middle/set.js | 2 +- .../unicode/lib/props/joint-right/set.js | 2 +- .../table/unicode/lib/props/joint-top/set.js | 2 +- .../table/unicode/lib/props/joints/set.js | 2 +- .../unicode/lib/props/row-separator/set.js | 2 +- .../plot/table/unicode/lib/remove_ansi.js | 43 +++++ .../@stdlib/plot/table/unicode/lib/render.js | 34 ++-- .../plot/table/unicode/lib/wcswidth.js | 7 +- 28 files changed, 300 insertions(+), 73 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/ansi_regexp.js create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/remove_ansi.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js index 9234387c1a9f..b6900f8c24d4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -26,7 +26,7 @@ var data = [ '\u001b[31mbeep\u001b[0m', // red '\u001b[1mboop\u001b[0m', // bold '\u001b[44mfoo\u001b[0m', // blue_bg - '\u001b[4m\u001b[47mbar\u001b[0m\u001b[0m' // underline, white_bg + '\u001b[4;47mbar\u001b[0m' // underline, white_bg ] ]; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/ansi_regexp.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/ansi_regexp.js new file mode 100644 index 000000000000..cdbfd22378c9 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/ansi_regexp.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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'; + +// MAIN // + +/** +* Regular expression to match ANSI escape sequences. +* +* @private +* @type {RegExp} +*/ +var RE = /([\u001B\u009B][[\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\d\/#&.:=?%@~_]+)*|[a-zA-Z\d]+(?:;[-a-zA-Z\d\/#&.:=?%@~_]*)*)?(?:\u0007|\u001B\u005C|\u009C))|(?:(?:\d{1,4}(?:;\d{0,4})*)?[\dA-PR-TZcf-nq-uy=><~])))/g; // eslint-disable-line no-control-regex, no-useless-escape + + +// EXPORTS // + +module.exports = RE; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js index fe99a2375b51..94e913471159 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/column_widths.js @@ -57,7 +57,7 @@ function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) lpad = leftPadding[ j%M ]; rpad = rightPadding[ j%N ]; v = headers.get( 0, j ); - len = lpad + v.columns + rpad; + len = lpad + v.width + rpad; if ( len > out[ j ] ) { out[ j ] = len; } @@ -68,7 +68,7 @@ function columnWidths( nrows, ncols, data, headers, leftPadding, rightPadding ) lpad = leftPadding[ j%M ]; rpad = rightPadding[ j%N ]; v = data.get( i, j ); - len = lpad + v.columns + rpad; + len = lpad + v.width + rpad; if ( len > out[ j ] ) { out[ j ] = len; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index d3859df7cf24..98927b0b1fd3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -46,25 +46,25 @@ function defaults() { 'value': '-', 'graphemes': [ '-' ], - 'columns': 1 + 'width': 1 }, { 'value': '|', 'graphemes': [ '|' ], - 'columns': 1 + 'width': 1 }, { 'value': '-', 'graphemes': [ '-' ], - 'columns': 1 + 'width': 1 }, { 'value': '|', 'graphemes': [ '|' ], - 'columns': 1 + 'width': 1 } ]; @@ -75,7 +75,7 @@ function defaults() { out.columnSeparator = { 'value': '|', 'graphemes': [ '|' ], - 'columns': 1 + 'width': 1 }; // Column widths: @@ -87,25 +87,25 @@ function defaults() { 'value': '┌', 'graphemes': [ '┌' ], - 'columns': 1 + 'width': 1 }, { 'value': '┐', 'graphemes': [ '┐' ], - 'columns': 1 + 'width': 1 }, { 'value': '┘', 'graphemes': [ '┘' ], - 'columns': 1 + 'width': 1 }, { 'value': '└', 'graphemes': [ '└' ], - 'columns': 1 + 'width': 1 } ]; @@ -122,7 +122,7 @@ function defaults() { out.headerSeparator = { 'value': '-', 'graphemes': [ '-' ], - 'columns': 1 + 'width': 1 }; // Horizontal line separator mode: @@ -134,31 +134,31 @@ function defaults() { 'value': '┼', 'graphemes': [ '┼' ], - 'columns': 1 + 'width': 1 }, { 'value': '┬', 'graphemes': [ '┬' ], - 'columns': 1 + 'width': 1 }, { 'value': '┤', 'graphemes': [ '┤' ], - 'columns': 1 + 'width': 1 }, { 'value': '┴', 'graphemes': [ '┴' ], - 'columns': 1 + 'width': 1 }, { 'value': '├', 'graphemes': [ '├' ], - 'columns': 1 + 'width': 1 } ]; @@ -179,7 +179,7 @@ function defaults() { out.rowSeparator = { 'value': '', 'graphemes': [], - 'columns': 0 + 'width': 0 }; // Vertical line separator mode: diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index 2af0c605c5c5..ac27774ea2f2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -24,6 +24,140 @@ var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var accessors = require( '@stdlib/array/base/accessors' ); var format = require( '@stdlib/string/format' ); var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth +var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequences + + +// FUNCTIONS // + +/** +* Removes empty strings from a list of strings. +* +* @private +* @param {StringArray} arr - array of strings +* @returns {StringArray} mutated input array +* +* @example +* var arr = [ '', 'a', 'b', '', 'c', '' ]; +* +* var out = compress( arr ); +* // returns [ 'a', 'b', 'c' ] +* +* @example +* var arr = [ '', '' ]; +* +* var out = compress( arr ); +* // returns [] +*/ +function compress( arr ) { // TODO: consider make this an array/base utility (e.g., remove falsy values; array/base/remove-falsy?) + var i; + var j; + + j = 0; + for ( i = 0; i < arr.length; i++ ) { + if ( arr[ i ] ) { + arr[ j ] = arr[ i ]; + j += 1; + } + } + arr.length = j; + return arr; +} + +/** +* Returns a mask indicating whether an element is an ANSI escape sequence. +* +* @private +* @param {StringArray} arr - array of strings +* @returns {NonNegativeIntegerArray} mask array +*/ +function ansiMask( arr ) { + var out; + var i; + + out = []; + for ( i = 0; i < arr.length; i++ ) { + out.push( ( RE_ANSI.test( arr[ i ] ) ) ? 1 : 0 ); + } + return out; +} + +/** +* Splits each string into individual grapheme clusters according to a provided mask array. +* +* @private +* @param {StringArray} arr - input array +* @param {NonNegativeIntegerArray} msk - mask array +* @returns {Array} output arrays +*/ +function splitGraphemes( arr, msk ) { + var tmp; + var oa; + var om; + var i; + var j; + + oa = []; + om = []; + for ( i = 0; i < arr.length; i++ ) { + // Check whether the string is "masked"... + if ( msk[ i ] === 1 ) { + // Copy over without splitting into grapheme clusters... + oa.push( arr[ i ] ); + om.push( msk[ i ] ); + continue; + } + tmp = splitGraphemeClusters( arr[ i ] ); + for ( j = 0; j < tmp.length; j++ ) { + oa.push( tmp[ j ] ); + om.push( msk[ i ] ); + } + } + return [ oa, om ]; +} + +/** +* Computes column widths for a list of strings according to a provided mask array. +* +* @private +* @param {StringArray} arr - input array +* @param {NonNegativeIntegerArray} msk - mask array +* @returns {NonNegativeIntegerArray} list of column widths +*/ +function computeWidths( arr, msk ) { // TODO: eventually make this into a separate string utility package + var out; + var i; + + out = []; + for ( i = 0; i < arr.length; i++ ) { + if ( msk[ i ] ) { + out.push( 0 ); + } else { + out.push( wcswidth( arr[ i ] ) ); + } + } + return out; +} + +/** +* Computes the sum of an array according to a provided mask array. +* +* @private +* @param {NonNegativeIntegerArray} arr - input array +* @param {NonNegativeIntegerArray} msk - mask array +* @returns {NonNegativeInteger} sum +*/ +function sum( arr, msk ) { // TODO: replace with blas/ext/base/* msk sum package + var s; + var i; + + s = 0; + for ( i = 0; i < arr.length; i++ ) { + if ( msk[ i ] === 0 ) { + s += arr[ i ]; + } + } + return s; +} // MAIN // @@ -42,6 +176,9 @@ function normalize( buffer, shape, fmts ) { var get; var set; var raw; + var msk; + var tmp; + var w; var v; var i; var j; @@ -55,12 +192,30 @@ function normalize( buffer, shape, fmts ) { for ( i = 0; i < shape[ 0 ]; i++ ) { for ( j = 0; j < shape[ 1 ]; j++ ) { raw = get( buffer, k ); + + // Generate a formatted string: v = format( fmts[ j%fmts.length ], raw ); + + // Split the formatted string according to whether a substring is an ANSI escape sequence: + tmp = compress( v.split( RE_ANSI ) ); + + // Create a mask array which flags whether a substring is an ANSI escape sequence: + msk = ansiMask( tmp ); + + // Expand each non-ANSI escape sequence into individual grapheme clusters: + tmp = splitGraphemes( tmp, msk ); + + // For each grapheme cluster, compute the number of columns that a symbol is expected to occupy when rendered to a terminal: + w = computeWidths( tmp[ 0 ], tmp[ 1 ] ); + + // Replace the element in the data buffer: set( buffer, k, { 'raw': raw, 'value': v, - 'graphemes': splitGraphemeClusters( v ), - 'columns': wcswidth( v ) + 'graphemes': tmp[ 0 ], + 'mask': tmp[ 1 ], + 'columnWidths': w, + 'width': sum( w, tmp[ 1 ] ) }); k += 1; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index f9df31e87b5e..7554a4e544a4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -50,7 +50,7 @@ function set( value ) { this._borders[ 2 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index 7ff197db40ba..8d15d202eeeb 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -50,7 +50,7 @@ function set( value ) { this._borders[ 3 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index f3a6b3468795..cb61ea087f6d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -50,7 +50,7 @@ function set( value ) { this._borders[ 1 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index 9c41ef30ca48..ccf4ba42bee9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -50,7 +50,7 @@ function set( value ) { this._borders[ 0 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index 11d47d142732..b225d7efa9fd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -86,7 +86,7 @@ function set( values ) { data.push({ 'value': v, 'graphemes': splitGraphemeClusters( v ), - 'columns': w + 'width': w }); } if ( !everyBy2( data, this._borders, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 5170daa60de6..29ff88c5a5c0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -45,7 +45,7 @@ function set( value ) { this._columnSeparator = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': wcswidth( value ) + 'width': wcswidth( value ) }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 865c166609fa..363139973016 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -50,7 +50,7 @@ function set( value ) { this._corners[ 3 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index ffe4b2b042cd..eabeb509719f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -50,7 +50,7 @@ function set( value ) { this._corners[ 2 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index 5dac6bff0f2d..f08ae4e7e8a4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -50,7 +50,7 @@ function set( value ) { this._corners[ 0 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index 2c39542733eb..6472da27dced 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -50,7 +50,7 @@ function set( value ) { this._corners[ 1 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index df015363c2ca..c770e24fb41a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -87,7 +87,7 @@ function set( values ) { data.push({ 'value': v, 'graphemes': splitGraphemeClusters( v ), - 'columns': w + 'width': w }); } if ( !everyBy2( data, this._corners, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index a03d97c9b782..87e9b39e0544 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -45,7 +45,7 @@ function set( value ) { this._headerSeparator = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': wcswidth( value ) + 'width': wcswidth( value ) }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index 04540d5217bd..34dd894c8ee9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -24,10 +24,9 @@ var isCollection = require( '@stdlib/assert/is-collection' ); var copy = require( '@stdlib/array/base/copy' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalize = require( './../../normalize.js' ); // FUNCTIONS // @@ -58,28 +57,19 @@ function predicate( v1, v2 ) { function set( values ) { var data; var len; - var v; - var i; if ( !isCollection( values ) ) { throw new TypeError( format( 'invalid argument. `%s` must be an array-like object. Value: `%s`.', 'headers', values ) ); } - len = values.length; + data = copy( values ); + len = data.length; if ( this._numColumns ) { if ( len !== this._numColumns ) { - throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'headers', this._numColumns, copy( values ).join( '", "' ) ) ); + throw new RangeError( format( 'invalid assignment. `%s` must have a length of %d in order to match the number of table columns. Value: `["%s"]`.', 'headers', this._numColumns, data.join( '", "' ) ) ); } } else { this._numColumns = len; } - data = []; - for ( i = 0; i < len; i++ ) { - v = String( values[ i ] ); - data.push({ - 'value': v, - 'graphemes': splitGraphemeClusters( v ), - 'columns': wcswidth( v ) - }); - } + data = normalize( data, [ 1, len ], [ '%s' ] ); if ( this._headers === null || !everyBy2( data, this._headers, predicate ) ) { // eslint-disable-line max-len this._headers = data; if ( !this._quiet ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 4e6be74a4db6..8210c708f754 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -50,7 +50,7 @@ function set( value ) { this._joints[ 3 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index 523cbfd3a3c1..f37d5ec703cf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -50,7 +50,7 @@ function set( value ) { this._joints[ 4 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index 6693b22a30f8..3043f20759f2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -50,7 +50,7 @@ function set( value ) { this._joints[ 0 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index aeeb6f349df1..be1aec7a2868 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -50,7 +50,7 @@ function set( value ) { this._joints[ 2 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index ef1780d3b7ca..c28e0a126ef4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -50,7 +50,7 @@ function set( value ) { this._joints[ 1 ] = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': w + 'width': w }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index f0829fa941b0..e8a215769681 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -87,7 +87,7 @@ function set( values ) { data.push({ 'value': v, 'graphemes': splitGraphemeClusters( v ), - 'columns': w + 'width': w }); } if ( !everyBy2( data, this._joints, predicate ) ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index 7b056a3d3bb4..44a7cc0d670c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -45,7 +45,7 @@ function set( value ) { this._rowSeparator = { 'value': value, 'graphemes': splitGraphemeClusters( value ), - 'columns': wcswidth( value ) + 'width': wcswidth( value ) }; if ( !this._quiet ) { this.emit( 'change' ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/remove_ansi.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/remove_ansi.js new file mode 100644 index 000000000000..1f7574f6ce0b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/remove_ansi.js @@ -0,0 +1,43 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 replace = require( '@stdlib/string/base/replace' ); +var RE_ANSI = require( './ansi_regexp.js' ); + + +// MAIN // + +/** +* Removes ANSI escape sequences from a string. +* +* @private +* @param {string} str - input string +* @returns {string} output string +*/ +function removeANSI( str ) { + return replace( str, RE_ANSI, '' ); +} + + +// EXPORTS // + +module.exports = removeANSI; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 5f3a6c29ce38..f9b653115c95 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -105,7 +105,7 @@ function wrappedColumnIndices( ctx ) { } // For all columns apart from the last (which has a border, not a column separator), include the width of the column separator... if ( i < ncols-1 ) { - width += ctx.columnSeparator.columns; + width += ctx.columnSeparator.width; } } // Include a final "index" to serve as the index upper bound: @@ -191,7 +191,7 @@ function renderLine( start, end, ch, ctx ) { // Render a table line... for ( i = start; i < end; i++ ) { // If columns are separated by a column separator, render the middle joint... - if ( i > start && ctx.columnSeparator.columns > 0 ) { + if ( i > start && ctx.columnSeparator.width > 0 ) { out += ctx.jointM; if ( ctx.mode === 'interpolate' ) { hidx += 1; @@ -208,7 +208,7 @@ function renderLine( start, end, ch, ctx ) { w = min( fw, mw ); } for ( j = 0; j < w; j++ ) { - out += ch[ hidx%ch.length ]; + out += ch[ hidx%ch.length ]; // WARNING: this assumes that each line character occupies a single column! hidx += 1; } } @@ -262,12 +262,12 @@ function renderRow( row, start, end, data, ctx, vidx ) { out = renderWhitespace( ctx.marginL ); // Render left border: - if ( ctx.borderL.columns > 0 ) { + if ( ctx.borderL.width > 0 ) { out += ctx.borderL.graphemes[ vidx%ctx.borderL.graphemes.length ]; } for ( i = start; i < end; i++ ) { // Render column separator: - if ( i > start && ctx.columnSeparator.columns > 0 ) { + if ( i > start && ctx.columnSeparator.width > 0 ) { out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.graphemes.length ]; // eslint-disable-line max-len } // Resolve cell paddings: @@ -279,7 +279,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { // Resolve cell data: v = data.get( row, i ); - len = lpad + v.columns + rpad; // number of character columns + len = lpad + v.width + rpad; // number of character columns // Determine whether we need to truncate rendered data: mw = ctx.maxColumnWidths[ i%ctx.maxColumnWidths.length ]; @@ -319,7 +319,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { out += renderWhitespace( rpad ); } // Render right border: - if ( ctx.borderR.columns > 0 ) { + if ( ctx.borderR.width > 0 ) { out += ctx.borderR.graphemes[ vidx%ctx.borderR.graphemes.length ]; } // Render right margin: @@ -363,7 +363,7 @@ function render() { ncols = numelDimension( this._data, 1 ); // Convert the list of headers to a two-dimensional ndarray: - headers = ( this._headers ) ? array2matrix( this._headers, [ 1, this._headers.length ] ) : null; // eslint-disable-line max-len + headers = ( this._headers ) ? array2matrix( this._headers, [ 1, ncols ] ) : null; // eslint-disable-line max-len // Resolve the column widths needed to fit column data: computedWidths = columnWidths( nrows, ncols, this._data, headers, this._paddingLeft, this._paddingRight ); // eslint-disable-line max-len @@ -371,7 +371,7 @@ function render() { // Resolve fixed-width column widths: fixedWidths = this._columnWidth || [ null ]; - // Resolve indices at which to wrap the table rows: + // Resolve the indices of columns at which to wrap table rows: idx = wrappedColumnIndices({ 'maxWidth': this._maxWidth, 'fixedWidths': fixedWidths, @@ -379,8 +379,8 @@ function render() { 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], - 'borderL': this._borders[ 3 ].columns, - 'borderR': this._borders[ 1 ].columns, + 'borderL': this._borders[ 3 ].width, + 'borderR': this._borders[ 1 ].width, 'columnSeparator': this._columnSeparator }); if ( idx instanceof Error ) { @@ -394,8 +394,8 @@ function render() { 'maxColumnWidths': this._maxColumnWidth, 'marginL': this._margins[ 3 ], 'marginR': this._margins[ 1 ], - 'borderL': this._borders[ 3 ].columns, - 'borderR': this._borders[ 1 ].columns, + 'borderL': this._borders[ 3 ].width, + 'borderR': this._borders[ 1 ].width, 'jointL': '', 'jointM': '', 'jointR': '', @@ -431,7 +431,7 @@ function render() { vidx = 0; // Render top border: - if ( this._borders[ 0 ].columns > 0 ) { + if ( this._borders[ 0 ].width > 0 ) { lctx.jointL = this._corners[ 0 ].value; lctx.jointM = this._joints[ 1 ].value; lctx.jointR = this._corners[ 1 ].value; @@ -451,7 +451,7 @@ function render() { rctx.alignments = tmp; } // Render header separator: - if ( this._headers && this._headerSeparator.columns !== 0 ) { + if ( this._headers && this._headerSeparator.width !== 0 ) { lctx.jointL = this._joints[ 4 ].value; lctx.jointM = this._joints[ 0 ].value; lctx.jointR = this._joints[ 2 ].value; @@ -472,7 +472,7 @@ function render() { vidx += 1; // Render row separator: - if ( this._rowSeparator.columns > 0 && i < nrows-1 ) { + if ( this._rowSeparator.width > 0 && i < nrows-1 ) { lctx.jointL = this._joints[ 4 ].value; lctx.jointM = this._joints[ 0 ].value; lctx.jointR = this._joints[ 2 ].value; @@ -487,7 +487,7 @@ function render() { } } // Render bottom border: - if ( this._borders[ 2 ].columns > 0 ) { + if ( this._borders[ 2 ].width > 0 ) { lctx.jointL = this._corners[ 3 ].value; lctx.jointM = this._joints[ 3 ].value; lctx.jointR = this._corners[ 2 ].value; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js index 5eaaf4212680..46998e14e985 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/wcswidth.js @@ -18,6 +18,11 @@ 'use strict'; +// MODULES // + +var removeANSI = require( './remove_ansi.js' ); + + // MAIN // /** @@ -28,7 +33,7 @@ * @returns {NonNegativeInteger} number of columns */ function wcswidth( str ) { - return str.length; // FIXME: implement wcswidth! + return removeANSI( str ).length; // FIXME: implement wcswidth! } From a2510d52d30e648ffa6a1d90d630d1fefef4871c Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 19:42:52 -0800 Subject: [PATCH 21/34] fix: add specialized logic for joining strings --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../table/unicode/examples/ansi_styling.js | 3 +- .../@stdlib/plot/table/unicode/lib/render.js | 47 ++++++++++++++++++- 2 files changed, 47 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js index b6900f8c24d4..c020a6982e25 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -40,7 +40,8 @@ var table = new UnicodeTable( data, { 'columnSeparator': '|', 'marginLeft': 5, 'marginRight': 5, - 'align': 'right' + 'align': 'right', + 'maxColumnWidth': 10 }); // Render the table: diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index f9b653115c95..03878315f018 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -114,6 +114,49 @@ function wrappedColumnIndices( ctx ) { return indices; } +/** +* Joins a sequence of grapheme clusters according to an ANSI escape sequence mask array. +* +* @private +* @param {StringArray} arr - input array +* @param {NonNegativeIntegerArray} widths - grapheme cluster column widths +* @param {NonNegativeIntegerArray} msk - mask array +* @param {NonNegativeInteger} max - maximum output width +* @returns {Array} output string and column width +*/ +function join( arr, widths, msk, max ) { + var width; + var out; + var w; + var i; + + out = ''; + width = 0; + for ( i = 0; i < arr.length; i++ ) { + // Check whether the current element is an ANSI escape sequence... + if ( msk[ i ] === 1 ) { + // As ANSI escape sequences do not contribute to the visual width, we can just append to the output string without incrementing the output width... + out += arr[ i ]; + continue; + } + // Avoid rendering an incomplete grapheme cluster and ensure that we do not exceed the maximum output width... + w = widths[ i ]; + if ( width+w > max ) { + break; + } + // The grapheme cluster can be completely rendered and is safe to include in the output string: + out += arr[ i ]; + width += w; + } + // Append any remaining ANSI escape sequences in order to ensure that all matching resets are included in the output string... + for ( ; i < arr.length; i++ ) { + if ( msk[ i ] === 1 ) { + out += arr[ i ]; + } + } + return [ out, width ]; +} + /** * Renders a specified number of whitespace characters. * @@ -292,8 +335,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { if ( w > mw ) { // Truncate rendered data: w = mw; - tmp = v.graphemes.slice( 0, mw-lpad-rpad ); // FIXME: be emoji aware and don't cut off graphemes mid-grapheme - d = tmp.join( '' ); + tmp = join( v.graphemes, v.columnWidths, v.mask, mw-lpad-rpad ); + d = tmp[ 0 ]; } else { d = v.value; } From 2d0eb3749d7b55699ac83afe349f4c94fdd72ca7 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 19:47:54 -0800 Subject: [PATCH 22/34] docs: update comment --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index ac27774ea2f2..f1b6d3358e9c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -24,7 +24,7 @@ var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var accessors = require( '@stdlib/array/base/accessors' ); var format = require( '@stdlib/string/format' ); var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth -var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequences +var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequence // FUNCTIONS // From 2dc3f6f31dbc36b4952f263cc45efec70c4581df Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 20:01:23 -0800 Subject: [PATCH 23/34] refactor: move normalization of cell data to separate module --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../table/unicode/examples/ansi_styling.js | 4 +- .../plot/table/unicode/lib/normalize.js | 162 +------------- .../plot/table/unicode/lib/normalize_datum.js | 199 ++++++++++++++++++ 3 files changed, 207 insertions(+), 158 deletions(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js index c020a6982e25..46e32ca6ca38 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -36,8 +36,8 @@ var headers = [ 'A', 'B', 'C', 'D' ]; // Create a table: var table = new UnicodeTable( data, { 'headers': headers, - 'rowSeparator': '-', - 'columnSeparator': '|', + 'rowSeparator': '\u001b[31m-\u001b[0m', + 'columnSeparator': '\u001b[31m|\u001b[0m', 'marginLeft': 5, 'marginRight': 5, 'align': 'right', diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index f1b6d3358e9c..eed89ddd4a05 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -20,144 +20,9 @@ // MODULES // -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var accessors = require( '@stdlib/array/base/accessors' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth -var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequence - - -// FUNCTIONS // - -/** -* Removes empty strings from a list of strings. -* -* @private -* @param {StringArray} arr - array of strings -* @returns {StringArray} mutated input array -* -* @example -* var arr = [ '', 'a', 'b', '', 'c', '' ]; -* -* var out = compress( arr ); -* // returns [ 'a', 'b', 'c' ] -* -* @example -* var arr = [ '', '' ]; -* -* var out = compress( arr ); -* // returns [] -*/ -function compress( arr ) { // TODO: consider make this an array/base utility (e.g., remove falsy values; array/base/remove-falsy?) - var i; - var j; - - j = 0; - for ( i = 0; i < arr.length; i++ ) { - if ( arr[ i ] ) { - arr[ j ] = arr[ i ]; - j += 1; - } - } - arr.length = j; - return arr; -} - -/** -* Returns a mask indicating whether an element is an ANSI escape sequence. -* -* @private -* @param {StringArray} arr - array of strings -* @returns {NonNegativeIntegerArray} mask array -*/ -function ansiMask( arr ) { - var out; - var i; - - out = []; - for ( i = 0; i < arr.length; i++ ) { - out.push( ( RE_ANSI.test( arr[ i ] ) ) ? 1 : 0 ); - } - return out; -} - -/** -* Splits each string into individual grapheme clusters according to a provided mask array. -* -* @private -* @param {StringArray} arr - input array -* @param {NonNegativeIntegerArray} msk - mask array -* @returns {Array} output arrays -*/ -function splitGraphemes( arr, msk ) { - var tmp; - var oa; - var om; - var i; - var j; - - oa = []; - om = []; - for ( i = 0; i < arr.length; i++ ) { - // Check whether the string is "masked"... - if ( msk[ i ] === 1 ) { - // Copy over without splitting into grapheme clusters... - oa.push( arr[ i ] ); - om.push( msk[ i ] ); - continue; - } - tmp = splitGraphemeClusters( arr[ i ] ); - for ( j = 0; j < tmp.length; j++ ) { - oa.push( tmp[ j ] ); - om.push( msk[ i ] ); - } - } - return [ oa, om ]; -} - -/** -* Computes column widths for a list of strings according to a provided mask array. -* -* @private -* @param {StringArray} arr - input array -* @param {NonNegativeIntegerArray} msk - mask array -* @returns {NonNegativeIntegerArray} list of column widths -*/ -function computeWidths( arr, msk ) { // TODO: eventually make this into a separate string utility package - var out; - var i; - - out = []; - for ( i = 0; i < arr.length; i++ ) { - if ( msk[ i ] ) { - out.push( 0 ); - } else { - out.push( wcswidth( arr[ i ] ) ); - } - } - return out; -} - -/** -* Computes the sum of an array according to a provided mask array. -* -* @private -* @param {NonNegativeIntegerArray} arr - input array -* @param {NonNegativeIntegerArray} msk - mask array -* @returns {NonNegativeInteger} sum -*/ -function sum( arr, msk ) { // TODO: replace with blas/ext/base/* msk sum package - var s; - var i; - - s = 0; - for ( i = 0; i < arr.length; i++ ) { - if ( msk[ i ] === 0 ) { - s += arr[ i ]; - } - } - return s; -} +var normalizeDatum = require( './normalize_datum.js' ); // MAIN // @@ -176,9 +41,7 @@ function normalize( buffer, shape, fmts ) { var get; var set; var raw; - var msk; var tmp; - var w; var v; var i; var j; @@ -196,27 +59,14 @@ function normalize( buffer, shape, fmts ) { // Generate a formatted string: v = format( fmts[ j%fmts.length ], raw ); - // Split the formatted string according to whether a substring is an ANSI escape sequence: - tmp = compress( v.split( RE_ANSI ) ); - - // Create a mask array which flags whether a substring is an ANSI escape sequence: - msk = ansiMask( tmp ); - - // Expand each non-ANSI escape sequence into individual grapheme clusters: - tmp = splitGraphemes( tmp, msk ); + // Normalize the string to a data object: + tmp = normalizeDatum( v ); - // For each grapheme cluster, compute the number of columns that a symbol is expected to occupy when rendered to a terminal: - w = computeWidths( tmp[ 0 ], tmp[ 1 ] ); + // Cache the original datum: + tmp.raw = raw; // Replace the element in the data buffer: - set( buffer, k, { - 'raw': raw, - 'value': v, - 'graphemes': tmp[ 0 ], - 'mask': tmp[ 1 ], - 'columnWidths': w, - 'width': sum( w, tmp[ 1 ] ) - }); + set( buffer, k, tmp ); k += 1; } } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js new file mode 100644 index 000000000000..81e007a0ccde --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js @@ -0,0 +1,199 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth +var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequence + + +// FUNCTIONS // + +/** +* Removes empty strings from a list of strings. +* +* @private +* @param {StringArray} arr - array of strings +* @returns {StringArray} mutated input array +* +* @example +* var arr = [ '', 'a', 'b', '', 'c', '' ]; +* +* var out = compress( arr ); +* // returns [ 'a', 'b', 'c' ] +* +* @example +* var arr = [ '', '' ]; +* +* var out = compress( arr ); +* // returns [] +*/ +function compress( arr ) { // TODO: consider make this an array/base utility (e.g., remove falsy values; array/base/remove-falsy?) + var i; + var j; + + j = 0; + for ( i = 0; i < arr.length; i++ ) { + if ( arr[ i ] ) { + arr[ j ] = arr[ i ]; + j += 1; + } + } + arr.length = j; + return arr; +} + +/** +* Returns a mask indicating whether an element is an ANSI escape sequence. +* +* @private +* @param {StringArray} arr - array of strings +* @returns {NonNegativeIntegerArray} mask array +*/ +function ansiMask( arr ) { + var out; + var i; + + out = []; + for ( i = 0; i < arr.length; i++ ) { + out.push( ( RE_ANSI.test( arr[ i ] ) ) ? 1 : 0 ); + } + return out; +} + +/** +* Splits each string into individual grapheme clusters according to a provided mask array. +* +* @private +* @param {StringArray} arr - input array +* @param {NonNegativeIntegerArray} msk - mask array +* @returns {Array} output arrays +*/ +function splitGraphemes( arr, msk ) { + var tmp; + var oa; + var om; + var i; + var j; + + oa = []; + om = []; + for ( i = 0; i < arr.length; i++ ) { + // Check whether the string is "masked"... + if ( msk[ i ] === 1 ) { + // Copy over without splitting into grapheme clusters... + oa.push( arr[ i ] ); + om.push( msk[ i ] ); + continue; + } + tmp = splitGraphemeClusters( arr[ i ] ); + for ( j = 0; j < tmp.length; j++ ) { + oa.push( tmp[ j ] ); + om.push( msk[ i ] ); + } + } + return [ oa, om ]; +} + +/** +* Computes column widths for a list of strings according to a provided mask array. +* +* @private +* @param {StringArray} arr - input array +* @param {NonNegativeIntegerArray} msk - mask array +* @returns {NonNegativeIntegerArray} list of column widths +*/ +function computeWidths( arr, msk ) { // TODO: eventually make this into a separate string utility package + var out; + var i; + + out = []; + for ( i = 0; i < arr.length; i++ ) { + if ( msk[ i ] ) { + out.push( 0 ); + } else { + out.push( wcswidth( arr[ i ] ) ); + } + } + return out; +} + +/** +* Computes the sum of an array according to a provided mask array. +* +* @private +* @param {NonNegativeIntegerArray} arr - input array +* @param {NonNegativeIntegerArray} msk - mask array +* @returns {NonNegativeInteger} sum +*/ +function sum( arr, msk ) { // TODO: replace with blas/ext/base/* msk sum package + var s; + var i; + + s = 0; + for ( i = 0; i < arr.length; i++ ) { + if ( msk[ i ] === 0 ) { + s += arr[ i ]; + } + } + return s; +} + + +// MAIN // + +/** +* Normalizes data belonging to a single table cell. +* +* @private +* @param {string} value - input string +* @returns {Object} normalized results +*/ +function normalize( value ) { + var tmp; + var msk; + var w; + + // Split the formatted string according to whether a substring is an ANSI escape sequence: + tmp = compress( value.split( RE_ANSI ) ); + + // Create a mask array which flags whether a substring is an ANSI escape sequence: + msk = ansiMask( tmp ); + + // Expand each non-ANSI escape sequence into individual grapheme clusters: + tmp = splitGraphemes( tmp, msk ); + + // For each grapheme cluster, compute the number of columns that a symbol is expected to occupy when rendered to a terminal: + w = computeWidths( tmp[ 0 ], tmp[ 1 ] ); + + return { + 'value': value, + 'graphemes': tmp[ 0 ], + 'mask': tmp[ 1 ], + 'columnWidths': w, + 'width': sum( w, tmp[ 1 ] ) + }; +} + + +// EXPORTS // + +module.exports = normalize; From 2c1654ae923c1878b62a6d00492c8191af42ee9a Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 21:14:12 -0800 Subject: [PATCH 24/34] refactor: support ANSI escape sequences in table characters --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../table/unicode/examples/ansi_styling.js | 22 +++- .../plot/table/unicode/lib/defaults.js | 110 +++--------------- .../@stdlib/plot/table/unicode/lib/main.js | 4 + .../plot/table/unicode/lib/normalize.js | 4 +- ...normalize_datum.js => normalize_string.js} | 2 + .../unicode/lib/props/border-bottom/set.js | 15 +-- .../unicode/lib/props/border-left/set.js | 15 +-- .../unicode/lib/props/border-right/set.js | 15 +-- .../table/unicode/lib/props/border-top/set.js | 15 +-- .../table/unicode/lib/props/borders/set.js | 14 +-- .../unicode/lib/props/column-separator/set.js | 9 +- .../lib/props/corner-bottom-left/set.js | 15 +-- .../lib/props/corner-bottom-right/set.js | 15 +-- .../unicode/lib/props/corner-top-left/set.js | 15 +-- .../unicode/lib/props/corner-top-right/set.js | 15 +-- .../table/unicode/lib/props/corners/set.js | 14 +-- .../unicode/lib/props/header-separator/set.js | 9 +- .../unicode/lib/props/joint-bottom/set.js | 15 +-- .../table/unicode/lib/props/joint-left/set.js | 15 +-- .../unicode/lib/props/joint-middle/set.js | 15 +-- .../unicode/lib/props/joint-right/set.js | 15 +-- .../table/unicode/lib/props/joint-top/set.js | 15 +-- .../table/unicode/lib/props/joints/set.js | 14 +-- .../unicode/lib/props/row-separator/set.js | 9 +- .../@stdlib/plot/table/unicode/lib/render.js | 86 ++++++++------ 25 files changed, 180 insertions(+), 312 deletions(-) rename lib/node_modules/@stdlib/plot/table/unicode/lib/{normalize_datum.js => normalize_string.js} (97%) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js index 46e32ca6ca38..254b7df3e618 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -18,8 +18,20 @@ 'use strict'; +var isArray = require( '@stdlib/assert/is-array' ); var UnicodeTable = require( './../lib' ); +function styleGreen( value ) { + var i; + if ( isArray( value ) ) { + for ( i = 0; i < value.length; i++ ) { + value[ i ] = '\u001b[32m' + value[ i ] + '\u001b[0m'; + } + return value; + } + return '\u001b[32m' + value + '\u001b[0m'; +} + // Define a data set containing emoji: var data = [ [ @@ -36,14 +48,20 @@ var headers = [ 'A', 'B', 'C', 'D' ]; // Create a table: var table = new UnicodeTable( data, { 'headers': headers, - 'rowSeparator': '\u001b[31m-\u001b[0m', - 'columnSeparator': '\u001b[31m|\u001b[0m', 'marginLeft': 5, 'marginRight': 5, 'align': 'right', 'maxColumnWidth': 10 }); +table.rowSeparator = styleGreen( table.rowSeparator ); +table.columnSeparator = styleGreen( table.columnSeparator ); +table.headerSeparator = styleGreen( table.headerSeparator ); + +table.borders = styleGreen( table.borders ); +table.corners = styleGreen( table.corners ); +table.joints = styleGreen( table.joints ); + // Render the table: var str = table.render(); console.log( str ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index 98927b0b1fd3..bf9b05acb4f6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -21,6 +21,7 @@ // MODULES // var FLOAT64_MAX = require( '@stdlib/constants/float64/max' ); +var normalizeString = require( './normalize_string.js' ); // MAIN // @@ -42,71 +43,27 @@ function defaults() { // Border characters: out.borders = [ - { - - 'value': '-', - 'graphemes': [ '-' ], - 'width': 1 - }, - { - - 'value': '|', - 'graphemes': [ '|' ], - 'width': 1 - }, - { - - 'value': '-', - 'graphemes': [ '-' ], - 'width': 1 - }, - { - - 'value': '|', - 'graphemes': [ '|' ], - 'width': 1 - } + normalizeString( '-' ), + normalizeString( '|' ), + normalizeString( '-' ), + normalizeString( '|' ) ]; // Buffer size: out.bufferSize = FLOAT64_MAX; // Column separator: - out.columnSeparator = { - 'value': '|', - 'graphemes': [ '|' ], - 'width': 1 - }; + out.columnSeparator = normalizeString( '|' ); // Column widths: out.columnWidth = null; // by default, automatically size based on content // Corner characters: out.corners = [ - { - - 'value': '┌', - 'graphemes': [ '┌' ], - 'width': 1 - }, - { - - 'value': '┐', - 'graphemes': [ '┐' ], - 'width': 1 - }, - { - - 'value': '┘', - 'graphemes': [ '┘' ], - 'width': 1 - }, - { - - 'value': '└', - 'graphemes': [ '└' ], - 'width': 1 - } + normalizeString( '┌' ), + normalizeString( '┐' ), + normalizeString( '┘' ), + normalizeString( '└' ) ]; // Cell format string: @@ -119,47 +76,18 @@ function defaults() { out.headers = null; // Header separator: - out.headerSeparator = { - 'value': '-', - 'graphemes': [ '-' ], - 'width': 1 - }; + out.headerSeparator = normalizeString( '-' ); // Horizontal line separator mode: out.horizontalSeparatorMode = 'resume'; // Joint characters: out.joints = [ - { - - 'value': '┼', - 'graphemes': [ '┼' ], - 'width': 1 - }, - { - - 'value': '┬', - 'graphemes': [ '┬' ], - 'width': 1 - }, - { - - 'value': '┤', - 'graphemes': [ '┤' ], - 'width': 1 - }, - { - - 'value': '┴', - 'graphemes': [ '┴' ], - 'width': 1 - }, - { - - 'value': '├', - 'graphemes': [ '├' ], - 'width': 1 - } + normalizeString( '┼' ), + normalizeString( '┬' ), + normalizeString( '┤' ), + normalizeString( '┴' ), + normalizeString( '├' ) ]; // Table margins: @@ -176,11 +104,7 @@ function defaults() { out.paddingRight = [ 1 ]; // Row separator: - out.rowSeparator = { - 'value': '', - 'graphemes': [], - 'width': 0 - }; + out.rowSeparator = normalizeString( '' ); // Vertical line separator mode: out.verticalSeparatorMode = 'resume'; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 92942ed2f38a..921a9398268d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -148,7 +148,11 @@ var PRIVATE_PROPS = [ var OPTIONS_PROPS = [ 'align', 'autoRender', + 'borderBottom', + 'borderLeft', + 'borderRight', 'borders', + 'borderTop', 'bufferSize', 'columnSeparator', 'columnWidth', diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index eed89ddd4a05..4fb53ed71d08 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -22,7 +22,7 @@ var accessors = require( '@stdlib/array/base/accessors' ); var format = require( '@stdlib/string/format' ); -var normalizeDatum = require( './normalize_datum.js' ); +var normalizeString = require( './normalize_string.js' ); // MAIN // @@ -60,7 +60,7 @@ function normalize( buffer, shape, fmts ) { v = format( fmts[ j%fmts.length ], raw ); // Normalize the string to a data object: - tmp = normalizeDatum( v ); + tmp = normalizeString( v ); // Cache the original datum: tmp.raw = raw; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js similarity index 97% rename from lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js rename to lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js index 81e007a0ccde..68c426590e5b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_datum.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js @@ -21,6 +21,7 @@ // MODULES // var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var gsum = require( '@stdlib/blas/ext/base/gsum' ); var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequence @@ -187,6 +188,7 @@ function normalize( value ) { return { 'value': value, 'graphemes': tmp[ 0 ], + 'ngraphemes': tmp[ 0 ].length - gsum( tmp[ 1 ].length, tmp[ 1 ], 1 ), 'mask': tmp[ 1 ], 'columnWidths': w, 'width': sum( w, tmp[ 1 ] ) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index 7554a4e544a4..ceb6b0653daf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderBottom', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderBottom', value ) ); } if ( value !== this._borders[ 2 ].value ) { - this._borders[ 2 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._borders[ 2 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index 8d15d202eeeb..1edc7093793b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); } if ( value !== this._borders[ 3 ].value ) { - this._borders[ 3 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._borders[ 3 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index cb61ea087f6d..26decf0c7541 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderRight', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderRight', value ) ); } if ( value !== this._borders[ 1 ].value ) { - this._borders[ 1 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._borders[ 1 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index ccf4ba42bee9..4b4caf43c61d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderTop', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderTop', value ) ); } if ( value !== this._borders[ 0 ].value ) { - this._borders[ 0 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._borders[ 0 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index b225d7efa9fd..5231cf0b30c9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -25,10 +25,9 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var isCollection = require( '@stdlib/assert/is-collection' ); var copy = require( '@stdlib/array/base/copy' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // VARIABLES // @@ -64,7 +63,6 @@ function predicate( v1, v2 ) { */ function set( values ) { var data; - var w; var v; var i; if ( !isCollection( values ) ) { @@ -79,15 +77,11 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); } - w = wcswidth( v ); - if ( w !== 1 ) { + v = normalizeString( v ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); } - data.push({ - 'value': v, - 'graphemes': splitGraphemeClusters( v ), - 'width': w - }); + data.push( v ); } if ( !everyBy2( data, this._borders, predicate ) ) { this._borders = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index 29ff88c5a5c0..ad2a2e2824d4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -42,11 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', value ) ); } if ( value !== this._columnSeparator.value ) { - this._columnSeparator = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': wcswidth( value ) - }; + this._columnSeparator = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 363139973016..6369cb0a6bc9 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomLeft', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomLeft', value ) ); } if ( value !== this._corners[ 3 ].value ) { - this._corners[ 3 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._corners[ 3 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index eabeb509719f..4fa3ad4e093c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomRight', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomRight', value ) ); } if ( value !== this._corners[ 2 ].value ) { - this._corners[ 2 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._corners[ 2 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index f08ae4e7e8a4..f98d1c4f5ef1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopLeft', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopLeft', value ) ); } if ( value !== this._corners[ 0 ].value ) { - this._corners[ 0 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._corners[ 0 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index 6472da27dced..ec37d9278454 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopRight', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopRight', value ) ); } if ( value !== this._corners[ 1 ].value ) { - this._corners[ 1 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._corners[ 1 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index c770e24fb41a..f7dac4a8d4b0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -24,11 +24,10 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var isCollection = require( '@stdlib/assert/is-collection' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var copy = require( '@stdlib/array/base/copy' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // VARIABLES // @@ -64,7 +63,6 @@ function predicate( v1, v2 ) { */ function set( values ) { var data; - var w; var v; var i; @@ -80,15 +78,11 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } - w = wcswidth( v ); - if ( w !== 1 ) { + v = normalizeString( v ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } - data.push({ - 'value': v, - 'graphemes': splitGraphemeClusters( v ), - 'width': w - }); + data.push( v ); } if ( !everyBy2( data, this._corners, predicate ) ) { this._corners = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index 87e9b39e0544..332c887f3a48 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -42,11 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', value ) ); } if ( value !== this._headerSeparator.value ) { - this._headerSeparator = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': wcswidth( value ) - }; + this._headerSeparator = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 8210c708f754..7835dc84ffb2 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); } if ( value !== this._joints[ 3 ].value ) { - this._joints[ 3 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value), - 'width': w - }; + this._joints[ 3 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index f37d5ec703cf..5c33336b1909 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointLeft', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointLeft', value ) ); } if ( value !== this._joints[ 4 ].value ) { - this._joints[ 4 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._joints[ 4 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index 3043f20759f2..6396fb091caf 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointMiddle', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointMiddle', value ) ); } if ( value !== this._joints[ 0 ].value ) { - this._joints[ 0 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._joints[ 0 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index be1aec7a2868..5f995db11330 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointRight', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointRight', value ) ); } if ( value !== this._joints[ 2 ].value ) { - this._joints[ 2 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._joints[ 2 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index c28e0a126ef4..5d43d4af538e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -38,20 +37,16 @@ var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/ba * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var w; + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointTop', value ) ); } - w = wcswidth( value ); - if ( w !== 1 ) { + v = normalizeString( value ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointTop', value ) ); } if ( value !== this._joints[ 1 ].value ) { - this._joints[ 1 ] = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': w - }; + this._joints[ 1 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index e8a215769681..98d214e60083 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -24,11 +24,10 @@ var isString = require( '@stdlib/assert/is-string' ).isPrimitive; var isCollection = require( '@stdlib/assert/is-collection' ); -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var copy = require( '@stdlib/array/base/copy' ); var format = require( '@stdlib/string/format' ); var everyBy2 = require( './../../every_by2.js' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // VARIABLES // @@ -64,7 +63,6 @@ function predicate( v1, v2 ) { */ function set( values ) { var data; - var w; var v; var i; @@ -80,15 +78,11 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } - w = wcswidth( v ); - if ( w !== 1 ) { + v = normalizeString( v ); + if ( v.width !== 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } - data.push({ - 'value': v, - 'graphemes': splitGraphemeClusters( v ), - 'width': w - }); + data.push( v ); } if ( !everyBy2( data, this._joints, predicate ) ) { this._joints = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index 44a7cc0d670c..fbf1852ce404 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -23,9 +23,8 @@ // MODULES // var isString = require( '@stdlib/assert/is-string' ).isPrimitive; -var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); var format = require( '@stdlib/string/format' ); -var wcswidth = require( './../../wcswidth.js' ); // TODO: replace with string/base/wcswidth +var normalizeString = require( './../../normalize_string.js' ); // MAIN // @@ -42,11 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', value ) ); } if ( value !== this._rowSeparator.value ) { - this._rowSeparator = { - 'value': value, - 'graphemes': splitGraphemeClusters( value ), - 'width': wcswidth( value ) - }; + this._rowSeparator = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 03878315f018..8090357c877d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -121,17 +121,20 @@ function wrappedColumnIndices( ctx ) { * @param {StringArray} arr - input array * @param {NonNegativeIntegerArray} widths - grapheme cluster column widths * @param {NonNegativeIntegerArray} msk - mask array -* @param {NonNegativeInteger} max - maximum output width +* @param {NonNegativeInteger} skip - number of grapheme clusters to skip before starting to join subsequent grapheme clusters +* @param {NonNegativeInteger} max - maximum output width (inclusive) * @returns {Array} output string and column width */ -function join( arr, widths, msk, max ) { +function join( arr, widths, msk, skip, max ) { var width; var out; + var cnt; var w; var i; out = ''; width = 0; + cnt = 0; for ( i = 0; i < arr.length; i++ ) { // Check whether the current element is an ANSI escape sequence... if ( msk[ i ] === 1 ) { @@ -144,6 +147,11 @@ function join( arr, widths, msk, max ) { if ( width+w > max ) { break; } + // Avoid rendering any grapheme clusters which should be skipped... + if ( cnt < skip ) { + cnt += 1; + continue; + } // The grapheme cluster can be completely rendered and is safe to include in the output string: out += arr[ i ]; width += w; @@ -193,7 +201,7 @@ function renderVerticalMargin( out, margin ) { * @private * @param {NonNegativeInteger} start - starting table column index (inclusive) * @param {NonNegativeInteger} end - ending table column index (exclusive) -* @param {StringArray} ch - line characters +* @param {ObjectArray} ch - line characters * @param {Object} ctx - context object * @param {Array} ctx.fixedWidths - fixed column widths (in units of character columns) * @param {NonNegativeIntegerArray} ctx.computedWidths - column widths (in units of character columns) @@ -202,9 +210,9 @@ function renderVerticalMargin( out, margin ) { * @param {NonNegativeInteger} ctx.marginR - right table margin * @param {NonNegativeInteger} ctx.borderL - left border length (in units of character columns) * @param {NonNegativeInteger} ctx.borderR - right border length (in units of character columns) -* @param {string} ctx.jointL - left joint -* @param {string} ctx.jointM - middle joint -* @param {string} ctx.jointR - right joint +* @param {Object} ctx.jointL - left joint +* @param {Object} ctx.jointM - middle joint +* @param {Object} ctx.jointR - right joint * @param {Object} ctx.columnSeparator - column separator * @param {string} ctx.mode - horizontal separator mode * @returns {string} rendered line @@ -212,6 +220,7 @@ function renderVerticalMargin( out, margin ) { function renderLine( start, end, ch, ctx ) { var hidx; var out; + var tmp; var mw; var fw; var w; @@ -226,7 +235,8 @@ function renderLine( start, end, ch, ctx ) { // Render left joint: if ( ctx.borderL > 0 ) { - out += ctx.jointL; + tmp = join( ctx.jointL.graphemes, ctx.jointL.columnWidths, ctx.jointL.mask, 0, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; if ( ctx.mode === 'interpolate' ) { hidx += 1; } @@ -235,7 +245,8 @@ function renderLine( start, end, ch, ctx ) { for ( i = start; i < end; i++ ) { // If columns are separated by a column separator, render the middle joint... if ( i > start && ctx.columnSeparator.width > 0 ) { - out += ctx.jointM; + tmp = join( ctx.jointM.graphemes, ctx.jointM.columnWidths, ctx.jointM.mask, 0, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; if ( ctx.mode === 'interpolate' ) { hidx += 1; } else if ( ctx.mode === 'repeat' ) { @@ -251,13 +262,15 @@ function renderLine( start, end, ch, ctx ) { w = min( fw, mw ); } for ( j = 0; j < w; j++ ) { - out += ch[ hidx%ch.length ]; // WARNING: this assumes that each line character occupies a single column! + tmp = join( ch.graphemes, ch.columnWidths, ch.mask, hidx%ch.ngraphemes, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; hidx += 1; } } // Render right joint: if ( ctx.borderR > 0 ) { - out += ctx.jointR; + tmp = join( ctx.jointR.graphemes, ctx.jointR.columnWidths, ctx.jointR.mask, 0, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; } // Render right margin: out += renderWhitespace( ctx.marginR ); @@ -298,6 +311,7 @@ function renderRow( row, start, end, data, ctx, vidx ) { var fw; var w; var d; + var n; var v; var i; @@ -306,12 +320,14 @@ function renderRow( row, start, end, data, ctx, vidx ) { // Render left border: if ( ctx.borderL.width > 0 ) { - out += ctx.borderL.graphemes[ vidx%ctx.borderL.graphemes.length ]; + tmp = join( ctx.borderL.graphemes, ctx.borderL.columnWidths, ctx.borderL.mask, vidx%ctx.borderL.ngraphemes, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; } for ( i = start; i < end; i++ ) { // Render column separator: if ( i > start && ctx.columnSeparator.width > 0 ) { - out += ctx.columnSeparator.graphemes[ vidx%ctx.columnSeparator.graphemes.length ]; // eslint-disable-line max-len + tmp = join( ctx.columnSeparator.graphemes, ctx.columnSeparator.columnWidths, ctx.columnSeparator.mask, vidx%ctx.columnSeparator.ngraphemes, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; } // Resolve cell paddings: lpad = ctx.paddingL[ i%ctx.paddingL.length ]; @@ -334,8 +350,9 @@ function renderRow( row, start, end, data, ctx, vidx ) { } if ( w > mw ) { // Truncate rendered data: - w = mw; - tmp = join( v.graphemes, v.columnWidths, v.mask, mw-lpad-rpad ); + n = mw - lpad - rpad; + tmp = join( v.graphemes, v.columnWidths, v.mask, 0, n ); + w = mw + ( n - tmp[ 1 ] ); // adjusted by a fudge factor to allow additional whitespace padding to be rendered if we were unable to render a string having the full desired width d = tmp[ 0 ]; } else { d = v.value; @@ -363,7 +380,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { } // Render right border: if ( ctx.borderR.width > 0 ) { - out += ctx.borderR.graphemes[ vidx%ctx.borderR.graphemes.length ]; + tmp = join( ctx.borderR.graphemes, ctx.borderR.columnWidths, ctx.borderR.mask, vidx%ctx.borderR.ngraphemes, 1 ); // eslint-disable-line max-len + out += tmp[ 0 ]; } // Render right margin: out += renderWhitespace( ctx.marginR ); @@ -439,9 +457,9 @@ function render() { 'marginR': this._margins[ 1 ], 'borderL': this._borders[ 3 ].width, 'borderR': this._borders[ 1 ].width, - 'jointL': '', - 'jointM': '', - 'jointR': '', + 'jointL': null, + 'jointM': null, + 'jointR': null, 'columnSeparator': this._columnSeparator, 'mode': this._horizontalSeparatorMode }; @@ -475,10 +493,10 @@ function render() { // Render top border: if ( this._borders[ 0 ].width > 0 ) { - lctx.jointL = this._corners[ 0 ].value; - lctx.jointM = this._joints[ 1 ].value; - lctx.jointR = this._corners[ 1 ].value; - line = renderLine( start, end, this._borders[ 0 ].graphemes, lctx ); + lctx.jointL = this._corners[ 0 ]; + lctx.jointM = this._joints[ 1 ]; + lctx.jointR = this._corners[ 1 ]; + line = renderLine( start, end, this._borders[ 0 ], lctx ); out.push( line ); if ( this._verticalSeparatorMode === 'interpolate' ) { vidx += 1; @@ -495,10 +513,10 @@ function render() { } // Render header separator: if ( this._headers && this._headerSeparator.width !== 0 ) { - lctx.jointL = this._joints[ 4 ].value; - lctx.jointM = this._joints[ 0 ].value; - lctx.jointR = this._joints[ 2 ].value; - line = renderLine( start, end, this._headerSeparator.graphemes, lctx ); // eslint-disable-line max-len + lctx.jointL = this._joints[ 4 ]; + lctx.jointM = this._joints[ 0 ]; + lctx.jointR = this._joints[ 2 ]; + line = renderLine( start, end, this._headerSeparator, lctx ); out.push( line ); if ( this._verticalSeparatorMode === 'interpolate' ) { vidx += 1; @@ -516,10 +534,10 @@ function render() { // Render row separator: if ( this._rowSeparator.width > 0 && i < nrows-1 ) { - lctx.jointL = this._joints[ 4 ].value; - lctx.jointM = this._joints[ 0 ].value; - lctx.jointR = this._joints[ 2 ].value; - line = renderLine( start, end, this._rowSeparator.graphemes, lctx ); // eslint-disable-line max-len + lctx.jointL = this._joints[ 4 ]; + lctx.jointM = this._joints[ 0 ]; + lctx.jointR = this._joints[ 2 ]; + line = renderLine( start, end, this._rowSeparator, lctx ); out.push( line ); if ( this._verticalSeparatorMode === 'interpolate' ) { vidx += 1; @@ -531,10 +549,10 @@ function render() { } // Render bottom border: if ( this._borders[ 2 ].width > 0 ) { - lctx.jointL = this._corners[ 3 ].value; - lctx.jointM = this._joints[ 3 ].value; - lctx.jointR = this._corners[ 2 ].value; - line = renderLine( start, end, this._borders[ 2 ].graphemes, lctx ); + lctx.jointL = this._corners[ 3 ]; + lctx.jointM = this._joints[ 3 ]; + lctx.jointR = this._corners[ 2 ]; + line = renderLine( start, end, this._borders[ 2 ], lctx ); out.push( line ); } } From e13e98ed7e68fc2850d8343cdac5ebd90ec00215 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 21:29:54 -0800 Subject: [PATCH 25/34] docs: add example demonstrating value-dependent styling --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../table/unicode/examples/ansi_styling.js | 2 +- .../unicode/examples/ansi_styling_values.js | 75 +++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js index 254b7df3e618..f69dea88806b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -32,7 +32,7 @@ function styleGreen( value ) { return '\u001b[32m' + value + '\u001b[0m'; } -// Define a data set containing emoji: +// Define a data set: var data = [ [ '\u001b[31mbeep\u001b[0m', // red diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js new file mode 100644 index 000000000000..24b55954baaa --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js @@ -0,0 +1,75 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-restricted-syntax, max-len */ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var filled2dBy = require( '@stdlib/array/base/filled2d-by' ); +var map2d = require( '@stdlib/array/base/map2d' ); +var UnicodeTable = require( './../lib' ); + +function styleRed( value ) { + return '\u001b[31m' + value + '\u001b[0m'; +} + +function styleGreen( value ) { + return '\u001b[32m' + value + '\u001b[0m'; +} + +function Value( value ) { + this._value = value; + return this; +} + +Value.prototype.toString = function toString() { + if ( this._value > 0 ) { + return styleGreen( this._value.toString() ); + } + if ( this._value < 0 ) { + return styleRed( this._value.toString() ); + } + return this._value.toString(); +}; + +function toValue( value ) { + return new Value( value ); +} + +// Define a data set: +var shape = [ 5, 4 ]; +var data = map2d( filled2dBy( shape, discreteUniform( -3, 3 ) ), shape, toValue ); + +// Define column headers: +var headers = [ 'A', 'B', 'C', 'D' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right', + 'maxColumnWidth': 10 +}); + +// Render the table: +var str = table.render(); +console.log( str ); +// => '...' From dcdab1eb40041fcaa5ea84c5916d5ba119383646 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Sun, 16 Feb 2025 21:29:54 -0800 Subject: [PATCH 26/34] docs: add example demonstrating value-dependent styling --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../table/unicode/examples/ansi_styling.js | 2 +- .../unicode/examples/ansi_styling_values.js | 75 +++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js index 254b7df3e618..f69dea88806b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling.js @@ -32,7 +32,7 @@ function styleGreen( value ) { return '\u001b[32m' + value + '\u001b[0m'; } -// Define a data set containing emoji: +// Define a data set: var data = [ [ '\u001b[31mbeep\u001b[0m', // red diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js new file mode 100644 index 000000000000..24b55954baaa --- /dev/null +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/ansi_styling_values.js @@ -0,0 +1,75 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable no-restricted-syntax, max-len */ + +'use strict'; + +var discreteUniform = require( '@stdlib/random/base/discrete-uniform' ).factory; +var filled2dBy = require( '@stdlib/array/base/filled2d-by' ); +var map2d = require( '@stdlib/array/base/map2d' ); +var UnicodeTable = require( './../lib' ); + +function styleRed( value ) { + return '\u001b[31m' + value + '\u001b[0m'; +} + +function styleGreen( value ) { + return '\u001b[32m' + value + '\u001b[0m'; +} + +function Value( value ) { + this._value = value; + return this; +} + +Value.prototype.toString = function toString() { + if ( this._value > 0 ) { + return styleGreen( this._value.toString() ); + } + if ( this._value < 0 ) { + return styleRed( this._value.toString() ); + } + return this._value.toString(); +}; + +function toValue( value ) { + return new Value( value ); +} + +// Define a data set: +var shape = [ 5, 4 ]; +var data = map2d( filled2dBy( shape, discreteUniform( -3, 3 ) ), shape, toValue ); + +// Define column headers: +var headers = [ 'A', 'B', 'C', 'D' ]; + +// Create a table: +var table = new UnicodeTable( data, { + 'headers': headers, + 'rowSeparator': '-', + 'marginLeft': 5, + 'marginRight': 5, + 'align': 'right', + 'maxColumnWidth': 10 +}); + +// Render the table: +var str = table.render(); +console.log( str ); +// => '...' From 558b87e7f92e10b3f8dd3bc5d9bd6392a9bc8e1b Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Tue, 18 Feb 2025 01:24:51 -0800 Subject: [PATCH 27/34] refactor: remove character length restriction This commit allows, e.g., specifying emoji for borders which, despite poor support in terminals, may be appropriate when rendering tables in other contexts. --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../plot/table/unicode/lib/props/border-bottom/set.js | 11 +++-------- .../plot/table/unicode/lib/props/border-left/set.js | 9 ++------- .../plot/table/unicode/lib/props/border-right/set.js | 11 +++-------- .../plot/table/unicode/lib/props/border-top/set.js | 9 ++------- .../plot/table/unicode/lib/props/borders/set.js | 7 +------ .../table/unicode/lib/props/corner-bottom-left/set.js | 11 +++-------- .../unicode/lib/props/corner-bottom-right/set.js | 11 +++-------- .../table/unicode/lib/props/corner-top-left/set.js | 11 +++-------- .../table/unicode/lib/props/corner-top-right/set.js | 11 +++-------- .../plot/table/unicode/lib/props/corners/set.js | 7 +------ .../plot/table/unicode/lib/props/joint-bottom/set.js | 7 +------ .../plot/table/unicode/lib/props/joint-left/set.js | 11 +++-------- .../plot/table/unicode/lib/props/joint-middle/set.js | 11 +++-------- .../plot/table/unicode/lib/props/joint-right/set.js | 11 +++-------- .../plot/table/unicode/lib/props/joint-top/set.js | 11 +++-------- .../plot/table/unicode/lib/props/joints/set.js | 7 +------ 16 files changed, 38 insertions(+), 118 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index ceb6b0653daf..ff5af123a6b5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - border character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderBottom', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderBottom', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderBottom', value ) ); } if ( value !== this._borders[ 2 ].value ) { - this._borders[ 2 ] = v; + this._borders[ 2 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index 1edc7093793b..ce7dadb5e3c1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - border character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); - } if ( value !== this._borders[ 3 ].value ) { - this._borders[ 3 ] = v; + this._borders[ 3 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index 26decf0c7541..caee084566dd 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - border character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderRight', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderRight', value ) ); } if ( value !== this._borders[ 1 ].value ) { - this._borders[ 1 ] = v; + this._borders[ 1 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index 4b4caf43c61d..4796f985ad7c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -37,16 +37,11 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderTop', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderTop', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderTop', value ) ); } if ( value !== this._borders[ 0 ].value ) { - this._borders[ 0 ] = v; + this._borders[ 0 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index 5231cf0b30c9..06e89463380f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -58,7 +58,6 @@ function predicate( v1, v2 ) { * @private * @param {Collection} values - border characters * @throws {TypeError} must be an array of strings -* @throws {TypeError} each array element must be a single character * @throws {RangeError} must provide four strings */ function set( values ) { @@ -77,11 +76,7 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); } - v = normalizeString( v ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); - } - data.push( v ); + data.push( normalizeString( v ) ); } if ( !everyBy2( data, this._borders, predicate ) ) { this._borders = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 6369cb0a6bc9..6213bb77be15 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomLeft', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerBottomLeft', value ) ); } if ( value !== this._corners[ 3 ].value ) { - this._corners[ 3 ] = v; + this._corners[ 3 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 4fa3ad4e093c..12c8dfadf791 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomRight', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerBottomRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerBottomRight', value ) ); } if ( value !== this._corners[ 2 ].value ) { - this._corners[ 2 ] = v; + this._corners[ 2 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index f98d1c4f5ef1..75d458226f67 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopLeft', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerTopLeft', value ) ); } if ( value !== this._corners[ 0 ].value ) { - this._corners[ 0 ] = v; + this._corners[ 0 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index ec37d9278454..cbfcb235cce5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopRight', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'cornerTopRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerTopRight', value ) ); } if ( value !== this._corners[ 1 ].value ) { - this._corners[ 1 ] = v; + this._corners[ 1 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index f7dac4a8d4b0..0d5dfdfb7431 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -58,7 +58,6 @@ function predicate( v1, v2 ) { * @private * @param {Array} values - list of characters * @throws {TypeError} must be an array of strings -* @throws {TypeError} each array element must be a single character * @throws {RangeError} must provide four strings */ function set( values ) { @@ -78,11 +77,7 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } - v = normalizeString( v ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); - } - data.push( v ); + data.push( normalizeString( v ) ); } if ( !everyBy2( data, this._corners, predicate ) ) { this._corners = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 7835dc84ffb2..41087c27cb98 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -37,16 +37,11 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string containing a single character */ function set( value ) { - var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); - } if ( value !== this._joints[ 3 ].value ) { - this._joints[ 3 ] = v; + this._joints[ 3 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index 5c33336b1909..b1f7ab0a94ea 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointLeft', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointLeft', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointLeft', value ) ); } if ( value !== this._joints[ 4 ].value ) { - this._joints[ 4 ] = v; + this._joints[ 4 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index 6396fb091caf..21258be35f2e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointMiddle', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointMiddle', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointMiddle', value ) ); } if ( value !== this._joints[ 0 ].value ) { - this._joints[ 0 ] = v; + this._joints[ 0 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index 5f995db11330..d47792fbd19b 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointRight', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointRight', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointRight', value ) ); } if ( value !== this._joints[ 2 ].value ) { - this._joints[ 2 ] = v; + this._joints[ 2 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index 5d43d4af538e..1f3f1af7143c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -34,19 +34,14 @@ var normalizeString = require( './../../normalize_string.js' ); * * @private * @param {string} value - character -* @throws {TypeError} must be a string containing a single character +* @throws {TypeError} must be a string */ function set( value ) { - var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointTop', value ) ); - } - v = normalizeString( value ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointTop', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointTop', value ) ); } if ( value !== this._joints[ 1 ].value ) { - this._joints[ 1 ] = v; + this._joints[ 1 ] = normalizeString( value ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 98d214e60083..8e98678caee5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -58,7 +58,6 @@ function predicate( v1, v2 ) { * @private * @param {Array} values - joint characters * @throws {TypeError} must be an array of strings -* @throws {TypeError} each array element must be a single character * @throws {RangeError} must provide five strings */ function set( values ) { @@ -78,11 +77,7 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } - v = normalizeString( v ); - if ( v.width !== 1 ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); - } - data.push( v ); + data.push( normalizeString( v ) ); } if ( !everyBy2( data, this._joints, predicate ) ) { this._joints = data; From 0b7b7ffc5720db9e306240038486e89502bc0bb5 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Tue, 18 Feb 2025 01:28:18 -0800 Subject: [PATCH 28/34] docs: add note --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- lib/node_modules/@stdlib/plot/table/unicode/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index 85f188e3066e..d547cebdf42f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -1044,6 +1044,7 @@ function onRender( str ) { ## Notes - Once a table instance has resolved the number of table columns (e.g., by setting table headers, binding table data, specifying column paddings, or specifying column alignments), the number of table columns is fixed. In order to remove or add table columns, create a new table instance with the desired configuration. +- When rendering a Unicode table to terminals, be advised that emojis can cause alignment issues due to variability in how many terminal columns an emoji occupies. This is particularly true for emoji using skin tones. From 1138b9ce171d2de5fa9abc440d00738dbcf29c93 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Tue, 18 Feb 2025 23:29:37 -0800 Subject: [PATCH 29/34] refactor: restrict corners and joints to one grapheme cluster --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../table/unicode/lib/props/corner-bottom-left/set.js | 7 ++++++- .../table/unicode/lib/props/corner-bottom-right/set.js | 7 ++++++- .../table/unicode/lib/props/corner-top-left/set.js | 7 ++++++- .../table/unicode/lib/props/corner-top-right/set.js | 7 ++++++- .../plot/table/unicode/lib/props/corners/set.js | 10 +++++++--- .../plot/table/unicode/lib/props/joint-bottom/set.js | 9 +++++++-- .../plot/table/unicode/lib/props/joint-left/set.js | 7 ++++++- .../plot/table/unicode/lib/props/joint-middle/set.js | 7 ++++++- .../plot/table/unicode/lib/props/joint-right/set.js | 7 ++++++- .../plot/table/unicode/lib/props/joint-top/set.js | 7 ++++++- .../@stdlib/plot/table/unicode/lib/props/joints/set.js | 8 ++++++-- 11 files changed, 68 insertions(+), 15 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 6213bb77be15..09843f652d85 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerBottomLeft', value ) ); } if ( value !== this._corners[ 3 ].value ) { - this._corners[ 3 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerBottomLeft', value ) ); + } + this._corners[ 3 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 12c8dfadf791..660991b210e8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerBottomRight', value ) ); } if ( value !== this._corners[ 2 ].value ) { - this._corners[ 2 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerBottomRight', value ) ); + } + this._corners[ 2 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index 75d458226f67..25d86e7f5f1d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerTopLeft', value ) ); } if ( value !== this._corners[ 0 ].value ) { - this._corners[ 0 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerTopLeft', value ) ); + } + this._corners[ 0 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index cbfcb235cce5..dfff018c11af 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerTopRight', value ) ); } if ( value !== this._corners[ 1 ].value ) { - this._corners[ 1 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerTopRight', value ) ); + } + this._corners[ 1 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index 0d5dfdfb7431..c3dfff55beb8 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -74,10 +74,14 @@ function set( values ) { data = []; for ( i = 0; i < NUM_CORNERS; i++ ) { v = values[ i ]; - if ( !isString( v ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); + if ( !isString( v ) || v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } - data.push( normalizeString( v ) ); + v = normalizeString( v ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); + } + data.push( v ); } if ( !everyBy2( data, this._corners, predicate ) ) { this._corners = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 41087c27cb98..7da90da0fd12 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string containing a single character */ function set( value ) { + var v; if ( !isString( value ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'jointBottom', value ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointBottom', value ) ); } if ( value !== this._joints[ 3 ].value ) { - this._joints[ 3 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointBottom', value ) ); + } + this._joints[ 3 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index b1f7ab0a94ea..81e2afb95ce6 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointLeft', value ) ); } if ( value !== this._joints[ 4 ].value ) { - this._joints[ 4 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointLeft', value ) ); + } + this._joints[ 4 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index 21258be35f2e..c4fcd7e0e2ba 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointMiddle', value ) ); } if ( value !== this._joints[ 0 ].value ) { - this._joints[ 0 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointMiddle', value ) ); + } + this._joints[ 0 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index d47792fbd19b..079cea51ad01 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointRight', value ) ); } if ( value !== this._joints[ 2 ].value ) { - this._joints[ 2 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointRight', value ) ); + } + this._joints[ 2 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index 1f3f1af7143c..b2c2a86e21ac 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -37,11 +37,16 @@ var normalizeString = require( './../../normalize_string.js' ); * @throws {TypeError} must be a string */ function set( value ) { + var v; if ( !isString( value ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointTop', value ) ); } if ( value !== this._joints[ 1 ].value ) { - this._joints[ 1 ] = normalizeString( value ); + v = normalizeString( value ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointTop', value ) ); + } + this._joints[ 1 ] = v; if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index 8e98678caee5..ce29abbd54b3 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -75,9 +75,13 @@ function set( values ) { for ( i = 0; i < NUM_JOINTS; i++ ) { v = values[ i ]; if ( !isString( v ) ) { - throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } - data.push( normalizeString( v ) ); + v = normalizeString( v ); + if ( v.ngraphemes > 1 ) { + throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); + } + data.push( v ); } if ( !everyBy2( data, this._joints, predicate ) ) { this._joints = data; From 26caefaef8700b25247a1b0cc6336bf067cf32d7 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 19 Feb 2025 01:23:51 -0800 Subject: [PATCH 30/34] fix: support grapheme clusters for joints, corners, and borders --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../plot/table/unicode/examples/emoji.js | 1 + .../@stdlib/plot/table/unicode/lib/render.js | 49 ++++++++++++++++--- 2 files changed, 43 insertions(+), 7 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js index 347334fec6fe..0dc5a777392e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js @@ -35,6 +35,7 @@ var table = new UnicodeTable( data, { 'rowSeparator': '-', 'columnSeparator': '|', 'cellWidth': 10, + 'cornerTopLeft': '😀', 'marginLeft': 5, 'marginRight': 5, 'align': 'right' diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js index 8090357c877d..15b1d298759f 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/render.js @@ -35,6 +35,32 @@ var columnWidths = require( './column_widths.js' ); // FUNCTIONS // +/** +* Returns the width of a specified grapheme cluster according to a mask array. +* +* @private +* @param {NonNegativeIntegerArray} widths - column widths +* @param {NonNegativeIntegerArray} mask - mask array +* @param {NonNegativeInteger} idx - index of grapheme cluster (unmasked) +* @returns {NonNegativeInteger} column width +*/ +function graphemeWidth( widths, mask, idx ) { + var cnt; + var i; + + cnt = -1; + for ( i = 0; i < widths.length; i++ ) { + if ( mask[ i ] === 1 ) { + continue; + } + cnt += 1; + if ( cnt === idx ) { + break; + } + } + return widths[ i ]; +} + /** * Computes a column width. * @@ -226,6 +252,7 @@ function renderLine( start, end, ch, ctx ) { var w; var i; var j; + var k; // Initialize an index variable for determining how to handle horizontal separators: hidx = 0; @@ -235,7 +262,8 @@ function renderLine( start, end, ch, ctx ) { // Render left joint: if ( ctx.borderL > 0 ) { - tmp = join( ctx.jointL.graphemes, ctx.jointL.columnWidths, ctx.jointL.mask, 0, 1 ); // eslint-disable-line max-len + k = 0; + tmp = join( ctx.jointL.graphemes, ctx.jointL.columnWidths, ctx.jointL.mask, k, graphemeWidth( ctx.jointL.columnWidths, ctx.jointL.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; if ( ctx.mode === 'interpolate' ) { hidx += 1; @@ -245,7 +273,8 @@ function renderLine( start, end, ch, ctx ) { for ( i = start; i < end; i++ ) { // If columns are separated by a column separator, render the middle joint... if ( i > start && ctx.columnSeparator.width > 0 ) { - tmp = join( ctx.jointM.graphemes, ctx.jointM.columnWidths, ctx.jointM.mask, 0, 1 ); // eslint-disable-line max-len + k = 0; + tmp = join( ctx.jointM.graphemes, ctx.jointM.columnWidths, ctx.jointM.mask, k, graphemeWidth( ctx.jointM.columnWidths, ctx.jointM.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; if ( ctx.mode === 'interpolate' ) { hidx += 1; @@ -262,14 +291,16 @@ function renderLine( start, end, ch, ctx ) { w = min( fw, mw ); } for ( j = 0; j < w; j++ ) { - tmp = join( ch.graphemes, ch.columnWidths, ch.mask, hidx%ch.ngraphemes, 1 ); // eslint-disable-line max-len + k = hidx % ch.ngraphemes; + tmp = join( ch.graphemes, ch.columnWidths, ch.mask, k, graphemeWidth( ch.columnWidths, ch.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; hidx += 1; } } // Render right joint: if ( ctx.borderR > 0 ) { - tmp = join( ctx.jointR.graphemes, ctx.jointR.columnWidths, ctx.jointR.mask, 0, 1 ); // eslint-disable-line max-len + k = 0; + tmp = join( ctx.jointR.graphemes, ctx.jointR.columnWidths, ctx.jointR.mask, k, graphemeWidth( ctx.jointR.columnWidths, ctx.jointR.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; } // Render right margin: @@ -314,19 +345,22 @@ function renderRow( row, start, end, data, ctx, vidx ) { var n; var v; var i; + var k; // Render left margin: out = renderWhitespace( ctx.marginL ); // Render left border: if ( ctx.borderL.width > 0 ) { - tmp = join( ctx.borderL.graphemes, ctx.borderL.columnWidths, ctx.borderL.mask, vidx%ctx.borderL.ngraphemes, 1 ); // eslint-disable-line max-len + k = vidx % ctx.borderL.ngraphemes; + tmp = join( ctx.borderL.graphemes, ctx.borderL.columnWidths, ctx.borderL.mask, k, graphemeWidth( ctx.borderL.columnWidths, ctx.borderL.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; } for ( i = start; i < end; i++ ) { // Render column separator: if ( i > start && ctx.columnSeparator.width > 0 ) { - tmp = join( ctx.columnSeparator.graphemes, ctx.columnSeparator.columnWidths, ctx.columnSeparator.mask, vidx%ctx.columnSeparator.ngraphemes, 1 ); // eslint-disable-line max-len + k = vidx % ctx.columnSeparator.ngraphemes; + tmp = join( ctx.columnSeparator.graphemes, ctx.columnSeparator.columnWidths, ctx.columnSeparator.mask, k, graphemeWidth( ctx.columnSeparator.columnWidths, ctx.columnSeparator.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; } // Resolve cell paddings: @@ -380,7 +414,8 @@ function renderRow( row, start, end, data, ctx, vidx ) { } // Render right border: if ( ctx.borderR.width > 0 ) { - tmp = join( ctx.borderR.graphemes, ctx.borderR.columnWidths, ctx.borderR.mask, vidx%ctx.borderR.ngraphemes, 1 ); // eslint-disable-line max-len + k = vidx % ctx.borderR.ngraphemes; + tmp = join( ctx.borderR.graphemes, ctx.borderR.columnWidths, ctx.borderR.mask, k, graphemeWidth( ctx.borderR.columnWidths, ctx.borderR.mask, k ) ); // eslint-disable-line max-len out += tmp[ 0 ]; } // Render right margin: From cbbe6ec73e6be80474c1ea12fe83df48aa387d7a Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 19 Feb 2025 01:32:37 -0800 Subject: [PATCH 31/34] docs: update example --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../@stdlib/plot/table/unicode/examples/emoji.js | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js b/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js index 0dc5a777392e..0fe9457f0dad 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/examples/emoji.js @@ -32,10 +32,13 @@ var headers = [ '1️⃣', '2️⃣', '3️⃣', '4️⃣', '5️⃣' ]; // Create a table: var table = new UnicodeTable( data, { 'headers': headers, - 'rowSeparator': '-', - 'columnSeparator': '|', + 'corners': [ '🤣', '🤣', '🤣', '🤣' ], + 'joints': [ '🐥', '🐥', '🐥', '🐥', '🐥' ], + 'borders': [ '🦋', '🦋', '🦋', '🦋' ], + 'headerSeparator': '👑', + 'rowSeparator': '🐞', + 'columnSeparator': '✨', 'cellWidth': 10, - 'cornerTopLeft': '😀', 'marginLeft': 5, 'marginRight': 5, 'align': 'right' From ae6a4cd8feb5c46394152506694dabe37252f135 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 19 Feb 2025 02:37:14 -0800 Subject: [PATCH 32/34] refactor: add internal width "units" property --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/README.md | 12 +++---- .../@stdlib/plot/table/unicode/docs/repl.txt | 17 +++++---- .../plot/table/unicode/lib/defaults.js | 35 ++++++++++--------- .../@stdlib/plot/table/unicode/lib/main.js | 9 ++--- .../plot/table/unicode/lib/normalize.js | 5 +-- .../table/unicode/lib/normalize_string.js | 20 ++++++++--- .../unicode/lib/props/border-bottom/set.js | 2 +- .../unicode/lib/props/border-left/set.js | 2 +- .../unicode/lib/props/border-right/set.js | 2 +- .../table/unicode/lib/props/border-top/set.js | 2 +- .../table/unicode/lib/props/borders/set.js | 2 +- .../unicode/lib/props/column-separator/set.js | 2 +- .../unicode/lib/props/column-width/set.js | 2 +- .../lib/props/corner-bottom-left/set.js | 2 +- .../lib/props/corner-bottom-right/set.js | 2 +- .../unicode/lib/props/corner-top-left/set.js | 2 +- .../unicode/lib/props/corner-top-right/set.js | 2 +- .../table/unicode/lib/props/corners/set.js | 2 +- .../plot/table/unicode/lib/props/data/set.js | 2 +- .../unicode/lib/props/header-separator/set.js | 2 +- .../table/unicode/lib/props/headers/set.js | 2 +- .../unicode/lib/props/joint-bottom/set.js | 2 +- .../table/unicode/lib/props/joint-left/set.js | 2 +- .../unicode/lib/props/joint-middle/set.js | 2 +- .../unicode/lib/props/joint-right/set.js | 2 +- .../table/unicode/lib/props/joint-top/set.js | 2 +- .../table/unicode/lib/props/joints/set.js | 2 +- .../table/unicode/lib/props/max-width/get.js | 2 +- .../unicode/lib/props/row-separator/set.js | 2 +- .../@stdlib/plot/table/unicode/lib/push.js | 2 +- .../@stdlib/plot/table/unicode/lib/set.js | 2 +- 31 files changed, 81 insertions(+), 67 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/README.md b/lib/node_modules/@stdlib/plot/table/unicode/README.md index d547cebdf42f..4edd1d82c108 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/README.md +++ b/lib/node_modules/@stdlib/plot/table/unicode/README.md @@ -69,7 +69,7 @@ The constructor accepts the following `options`: - **columnSeparator**: column separator character(s). Default: `'│'`. -- **columnWidth**: table column width(s) in units of character columns. When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a `maxColumnWidth` option which is less than the specified width. Default: `null`. +- **columnWidth**: table column width(s). When `null`, column widths are determined according to cell content. When set to a specific width, a column is rendered with the specified width, unless overridden by a `maxColumnWidth` option which is less than the specified width. Default: `null`. - **cornerTopLeft**: top-left table corner character. Default: `'┌'`. @@ -125,9 +125,9 @@ The constructor accepts the following `options`: - **margins**: table margins in the order `[top, right, bottom, left]`. This is a shorthand option instead of specifying margins individually. Default: `[ 0, 0, 0, 0 ]`. -- **maxColumnWidth**: maximum table cell width(s) in units of character columns. If less than a column's specified width, this option overrides the `columnWidth` option. Default: `+infinity`. +- **maxColumnWidth**: maximum table cell width(s). If less than a column's specified width, this option overrides the `columnWidth` option. Default: `+infinity`. -- **maxWidth**: maximum table width in units of character columns. Default: `+infinity`. +- **maxWidth**: maximum table width. Default: `+infinity`. - **paddingLeft**: cell left padding in units of whitespace characters. Default: `1`. @@ -339,7 +339,7 @@ If provided a string with multiple grapheme clusters, each grapheme cluster is r #### UnicodeTable.prototype.columnWidth -Table column width in units of character columns. +Table column width. ```javascript var table = new UnicodeTable(); @@ -779,7 +779,7 @@ var v = table.margins; #### UnicodeTable.prototype.maxColumnWidth -Maximum table column width in units of character columns. +Maximum table column width. ```javascript var table = new UnicodeTable(); @@ -807,7 +807,7 @@ If set to a value which is less than a column's specified width, the maximum tab #### UnicodeTable.prototype.maxWidth -Maximum table width in units of character columns. +Maximum table width. ```javascript var table = new UnicodeTable(); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt index 2d162861091c..3d21d410caf0 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt +++ b/lib/node_modules/@stdlib/plot/table/unicode/docs/repl.txt @@ -48,11 +48,11 @@ Column separator character(s). Default: '│'. options.columnWidth: Array|integer|null (optional) - Table column width(s) in units of character columns. When `null`, column - widths are determined according to cell content. When set to a specific - width, a column is rendered with the specified width, unless overridden - by a `maxColumnWidth` option which is less than the specified width. - Default: null. + Table column width(s). When `null`, column widths are determined + according to cell content. When set to a specific width, a column is + rendered with the specified width, unless overridden by a + `maxColumnWidth` option which is less than the specified width. Default: + null. options.cornerTopLeft: string (optional) Top-left table corner character. Default: '┌'. @@ -138,12 +138,11 @@ [ 0, 0, 0, 0 ]. options.maxColumnWidth: Array|integer|null (optional) - Maximum table column width(s) in units of character columns. If less - than a column's specified width, this option overrides the `columnWidth` - option. Default: +infinity. + Maximum table column width(s). If less than a column's specified width, + this option overrides the `columnWidth` option. Default: +infinity. options.maxWidth: integer|null (optional) - Maximum table width in units of character columns. Default: +infinity. + Maximum table width. Default: +infinity. options.paddingLeft: Array|integer (optional) Cell left padding(s) in units of whitespace characters. Default: 1. diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index bf9b05acb4f6..d7aa331688ac 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -43,27 +43,27 @@ function defaults() { // Border characters: out.borders = [ - normalizeString( '-' ), - normalizeString( '|' ), - normalizeString( '-' ), - normalizeString( '|' ) + normalizeString( '-', '' ), + normalizeString( '|', '' ), + normalizeString( '-', '' ), + normalizeString( '|', '' ) ]; // Buffer size: out.bufferSize = FLOAT64_MAX; // Column separator: - out.columnSeparator = normalizeString( '|' ); + out.columnSeparator = normalizeString( '|', '' ); // Column widths: out.columnWidth = null; // by default, automatically size based on content // Corner characters: out.corners = [ - normalizeString( '┌' ), - normalizeString( '┐' ), - normalizeString( '┘' ), - normalizeString( '└' ) + normalizeString( '┌', '' ), + normalizeString( '┐', '' ), + normalizeString( '┘', '' ), + normalizeString( '└', '' ) ]; // Cell format string: @@ -76,18 +76,18 @@ function defaults() { out.headers = null; // Header separator: - out.headerSeparator = normalizeString( '-' ); + out.headerSeparator = normalizeString( '-', '' ); // Horizontal line separator mode: out.horizontalSeparatorMode = 'resume'; // Joint characters: out.joints = [ - normalizeString( '┼' ), - normalizeString( '┬' ), - normalizeString( '┤' ), - normalizeString( '┴' ), - normalizeString( '├' ) + normalizeString( '┼', '' ), + normalizeString( '┬', '' ), + normalizeString( '┤', '' ), + normalizeString( '┴', '' ), + normalizeString( '├', '' ) ]; // Table margins: @@ -104,11 +104,14 @@ function defaults() { out.paddingRight = [ 1 ]; // Row separator: - out.rowSeparator = normalizeString( '' ); + out.rowSeparator = normalizeString( '', '' ); // Vertical line separator mode: out.verticalSeparatorMode = 'resume'; + // Width "units": + out.widthUnits = 'columns'; + return out; } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js index 921a9398268d..8295f8aa7336 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/main.js @@ -141,7 +141,8 @@ var PRIVATE_PROPS = [ '_paddingRight', '_quiet', '_rowSeparator', - '_verticalSeparatorMode' + '_verticalSeparatorMode', + '_widthUnits' ]; // List of options properties (note: keep in alphabetical order): @@ -544,7 +545,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'bufferSize', getBufferSize, setBu setReadWriteAccessor( UnicodeTable.prototype, 'columnSeparator', getColumnSeparator, setColumnSeparator ); /** -* Column width(s) in units of character columns. +* Column width(s). * * @name columnWidth * @memberof UnicodeTable.prototype @@ -1003,7 +1004,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'marginLeft', getMarginLeft, setMa setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins ); /** -* Maximum column width(s) in units of character columns. +* Maximum column width(s). * * @name maxColumnWidth * @memberof UnicodeTable.prototype @@ -1030,7 +1031,7 @@ setReadWriteAccessor( UnicodeTable.prototype, 'margins', getMargins, setMargins setReadWriteAccessor( UnicodeTable.prototype, 'maxColumnWidth', getMaxColumnWidth, setMaxColumnWidth ); /** -* Maximum table width in units of character columns. +* Maximum table width. * * @name maxWidth * @memberof UnicodeTable.prototype diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js index 4fb53ed71d08..71ff8d6f8517 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize.js @@ -34,9 +34,10 @@ var normalizeString = require( './normalize_string.js' ); * @param {Collection} buffer - linear data buffer * @param {NonNegativeIntegerArray} shape - table data shape * @param {StringArray} fmts - format strings +* @param {string} units - width units * @returns {Collection} modified data buffer */ -function normalize( buffer, shape, fmts ) { +function normalize( buffer, shape, fmts, units ) { var obj; var get; var set; @@ -60,7 +61,7 @@ function normalize( buffer, shape, fmts ) { v = format( fmts[ j%fmts.length ], raw ); // Normalize the string to a data object: - tmp = normalizeString( v ); + tmp = normalizeString( v, units ); // Cache the original datum: tmp.raw = raw; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js index 68c426590e5b..657952954845 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/normalize_string.js @@ -21,6 +21,7 @@ // MODULES // var splitGraphemeClusters = require( '@stdlib/string/split-grapheme-clusters' ); +var constantFunction = require( '@stdlib/utils/constant-function' ); var gsum = require( '@stdlib/blas/ext/base/gsum' ); var wcswidth = require( './wcswidth.js' ); // TODO: replace with string/base/wcswidth var RE_ANSI = require( './ansi_regexp.js' ); // TODO: replace with regexp/ansi-escape-sequence @@ -120,18 +121,26 @@ function splitGraphemes( arr, msk ) { * @private * @param {StringArray} arr - input array * @param {NonNegativeIntegerArray} msk - mask array +* @param {string} units - width units * @returns {NonNegativeIntegerArray} list of column widths */ -function computeWidths( arr, msk ) { // TODO: eventually make this into a separate string utility package +function computeWidths( arr, msk, units ) { // TODO: eventually make this into a separate string utility package var out; + var f; var i; + if ( units === 'graphemes' ) { + f = constantFunction( 1 ); + } else { // units === 'columns' + f = wcswidth; + } + out = []; for ( i = 0; i < arr.length; i++ ) { if ( msk[ i ] ) { out.push( 0 ); } else { - out.push( wcswidth( arr[ i ] ) ); + out.push( f( arr[ i ] ) ); } } return out; @@ -166,9 +175,10 @@ function sum( arr, msk ) { // TODO: replace with blas/ext/base/* msk sum package * * @private * @param {string} value - input string +* @param {string} units - width units * @returns {Object} normalized results */ -function normalize( value ) { +function normalize( value, units ) { var tmp; var msk; var w; @@ -182,8 +192,8 @@ function normalize( value ) { // Expand each non-ANSI escape sequence into individual grapheme clusters: tmp = splitGraphemes( tmp, msk ); - // For each grapheme cluster, compute the number of columns that a symbol is expected to occupy when rendered to a terminal: - w = computeWidths( tmp[ 0 ], tmp[ 1 ] ); + // For each grapheme cluster, compute the expected width: + w = computeWidths( tmp[ 0 ], tmp[ 1 ], units ); return { 'value': value, diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js index ff5af123a6b5..56b67cb0b89a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-bottom/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderBottom', value ) ); } if ( value !== this._borders[ 2 ].value ) { - this._borders[ 2 ] = normalizeString( value ); + this._borders[ 2 ] = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js index ce7dadb5e3c1..a93c137fba63 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-left/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string which contains one and only one character. Value: `%s`.', 'borderLeft', value ) ); } if ( value !== this._borders[ 3 ].value ) { - this._borders[ 3 ] = normalizeString( value ); + this._borders[ 3 ] = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js index caee084566dd..a7a6d910564e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-right/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderRight', value ) ); } if ( value !== this._borders[ 1 ].value ) { - this._borders[ 1 ] = normalizeString( value ); + this._borders[ 1 ] = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js index 4796f985ad7c..a34f01b3193a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/border-top/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'borderTop', value ) ); } if ( value !== this._borders[ 0 ].value ) { - this._borders[ 0 ] = normalizeString( value ); + this._borders[ 0 ] = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js index 06e89463380f..018fbeac8400 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/borders/set.js @@ -76,7 +76,7 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one character. Value: `["%s"]`.', 'borders', copy( values ).join( '", "' ) ) ); } - data.push( normalizeString( v ) ); + data.push( normalizeString( v, this._widthUnits ) ); } if ( !everyBy2( data, this._borders, predicate ) ) { this._borders = data; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js index ad2a2e2824d4..1e0c69a64b1c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-separator/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'columnSeparator', value ) ); } if ( value !== this._columnSeparator.value ) { - this._columnSeparator = normalizeString( value ); + this._columnSeparator = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js index 6a4d1c168598..9cc7a422c464 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/column-width/set.js @@ -33,7 +33,7 @@ var format = require( '@stdlib/string/format' ); // MAIN // /** -* Sets the column width(s) for each table column in units of character columns. +* Sets the column width(s) for each table column. * * @private * @param {(Collection|NonNegativeInteger|null)} value - column width(s) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js index 09843f652d85..3df9d0e081f1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-left/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerBottomLeft', value ) ); } if ( value !== this._corners[ 3 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerBottomLeft', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js index 660991b210e8..29b48389f53e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-bottom-right/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerBottomRight', value ) ); } if ( value !== this._corners[ 2 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerBottomRight', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js index 25d86e7f5f1d..ad3048461951 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-left/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerTopLeft', value ) ); } if ( value !== this._corners[ 0 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerTopLeft', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js index dfff018c11af..bad05789de63 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corner-top-right/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'cornerTopRight', value ) ); } if ( value !== this._corners[ 1 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'cornerTopRight', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js index c3dfff55beb8..c8e42756a98e 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/corners/set.js @@ -77,7 +77,7 @@ function set( values ) { if ( !isString( v ) || v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } - v = normalizeString( v ); + v = normalizeString( v, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'corners', copy( values ).join( '", "' ) ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js index f8361cf2ea3b..4c70740da881 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/data/set.js @@ -111,7 +111,7 @@ function set( data ) { this._numColumns = sh[ 1 ]; } // Normalize the underlying table data buffer: - normalizeData( getData( out ), sh, this._format ); + normalizeData( getData( out ), sh, this._format, this._widthUnits ); // Anytime a user sets table data, assume that the data has changed (note: performing a deep equality check is likely too expensive and not worth the effort) and thus, if not in "quiet" mode, always emit a 'change' event... this._data = out; diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js index 332c887f3a48..85888a7ac429 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/header-separator/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'headerSeparator', value ) ); } if ( value !== this._headerSeparator.value ) { - this._headerSeparator = normalizeString( value ); + this._headerSeparator = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js index 34dd894c8ee9..b0fc63038543 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/headers/set.js @@ -69,7 +69,7 @@ function set( values ) { } else { this._numColumns = len; } - data = normalize( data, [ 1, len ], [ '%s' ] ); + data = normalize( data, [ 1, len ], [ '%s' ], this._widthUnits ); if ( this._headers === null || !everyBy2( data, this._headers, predicate ) ) { // eslint-disable-line max-len this._headers = data; if ( !this._quiet ) { diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js index 7da90da0fd12..23eaf18cb61d 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-bottom/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointBottom', value ) ); } if ( value !== this._joints[ 3 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointBottom', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js index 81e2afb95ce6..4388e410b966 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-left/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointLeft', value ) ); } if ( value !== this._joints[ 4 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointLeft', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js index c4fcd7e0e2ba..3af8f8a97c54 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-middle/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointMiddle', value ) ); } if ( value !== this._joints[ 0 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointMiddle', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js index 079cea51ad01..5bf78ede8ef5 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-right/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointRight', value ) ); } if ( value !== this._joints[ 2 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointRight', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js index b2c2a86e21ac..aba7986a064a 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joint-top/set.js @@ -42,7 +42,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'jointTop', value ) ); } if ( value !== this._joints[ 1 ].value ) { - v = normalizeString( value ); + v = normalizeString( value, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string containing one and only one grapheme cluster. Value: `%s`.', 'jointTop', value ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js index ce29abbd54b3..7f1a17f55dd4 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/joints/set.js @@ -77,7 +77,7 @@ function set( values ) { if ( !isString( v ) ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } - v = normalizeString( v ); + v = normalizeString( v, this._widthUnits ); if ( v.ngraphemes > 1 ) { throw new TypeError( format( 'invalid assignment. `%s` must be an array of strings in which each array element is a string containing one and only one grapheme cluster. Value: `["%s"]`.', 'joints', copy( values ).join( '", "' ) ) ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js index 29c89bb0dcd0..d8fe66e3c786 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/max-width/get.js @@ -23,7 +23,7 @@ // MAIN // /** -* Returns the maximum table width in units of character columns. +* Returns the maximum table width. * * @private * @returns {NonNegativeInteger} maximum width diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js index fbf1852ce404..a417b0040c38 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/props/row-separator/set.js @@ -41,7 +41,7 @@ function set( value ) { throw new TypeError( format( 'invalid assignment. `%s` must be a string. Value: `%s`.', 'rowSeparator', value ) ); } if ( value !== this._rowSeparator.value ) { - this._rowSeparator = normalizeString( value ); + this._rowSeparator = normalizeString( value, this._widthUnits ); if ( !this._quiet ) { this.emit( 'change' ); } diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js index bea743417aab..f1eaa3641416 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/push.js @@ -162,7 +162,7 @@ function push( data ) { arr = out; } // Normalize the incoming table data: - normalizeData( getData( arr ), ash, this._format ); + normalizeData( getData( arr ), ash, this._format, this._widthUnits ); // Get the current number of table rows and columns: csh = getShape( view ); diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js index be88f3d1a123..47965a9f2eb7 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/set.js @@ -63,7 +63,7 @@ function set( i, j, value ) { } // Assume that, if a user is setting a new value, that means the data is different... (note: this provides an escape hatch for the same instance of a mutable class to be provided and have that instance trigger a 'change' event when its internal data/state has changed without the **reference** to that class instance having changed; meaning, two values may strictly compare as equal, but are allowed to render differently due to internal state changes) fmt = this._format[ j%this._format.length ]; - v = normalizeData( [ value ], [ 1, 1 ], [ fmt ] ); + v = normalizeData( [ value ], [ 1, 1 ], [ fmt ], this._widthUnits ); this._data.set( i, j, v[ 0 ] ); if ( !this._quiet ) { this.emit( 'change' ); From e378881e1b414982e2e58f76d08fd74e793c82a1 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 19 Feb 2025 02:40:21 -0800 Subject: [PATCH 33/34] docs: add comments --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../@stdlib/plot/table/unicode/lib/defaults.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index d7aa331688ac..1bb7c112d92c 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -36,7 +36,7 @@ function defaults() { var out = {}; // Cell alignment: - out.align = [ 'right' ]; + out.align = [ 'right' ]; // 'left' || 'right' || 'center' // Boolean indicating whether to automatically re-render on a `change` event: out.autoRender = false; @@ -79,7 +79,7 @@ function defaults() { out.headerSeparator = normalizeString( '-', '' ); // Horizontal line separator mode: - out.horizontalSeparatorMode = 'resume'; + out.horizontalSeparatorMode = 'resume'; // 'interpolate' || 'repeat' || 'resume' // Joint characters: out.joints = [ @@ -107,10 +107,10 @@ function defaults() { out.rowSeparator = normalizeString( '', '' ); // Vertical line separator mode: - out.verticalSeparatorMode = 'resume'; + out.verticalSeparatorMode = 'resume'; // 'interpolate' || 'repeat' || 'resume' // Width "units": - out.widthUnits = 'columns'; + out.widthUnits = 'columns'; // 'graphemes' || 'columns' return out; } From 03b81574aeda12a9fbade621e47810bb3d7d08ca Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Wed, 19 Feb 2025 03:04:40 -0800 Subject: [PATCH 34/34] refactor: ensure normalization uses consistent units --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na --- --- .../plot/table/unicode/lib/defaults.js | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js index 1bb7c112d92c..9c6eaecf5ba1 100644 --- a/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js +++ b/lib/node_modules/@stdlib/plot/table/unicode/lib/defaults.js @@ -35,6 +35,9 @@ var normalizeString = require( './normalize_string.js' ); function defaults() { var out = {}; + // Width "units": + out.widthUnits = 'columns'; // 'graphemes' || 'columns' + // Cell alignment: out.align = [ 'right' ]; // 'left' || 'right' || 'center' @@ -43,27 +46,27 @@ function defaults() { // Border characters: out.borders = [ - normalizeString( '-', '' ), - normalizeString( '|', '' ), - normalizeString( '-', '' ), - normalizeString( '|', '' ) + normalizeString( '-', out.widthUnits ), + normalizeString( '|', out.widthUnits ), + normalizeString( '-', out.widthUnits ), + normalizeString( '|', out.widthUnits ) ]; // Buffer size: out.bufferSize = FLOAT64_MAX; // Column separator: - out.columnSeparator = normalizeString( '|', '' ); + out.columnSeparator = normalizeString( '|', out.widthUnits ); // Column widths: out.columnWidth = null; // by default, automatically size based on content // Corner characters: out.corners = [ - normalizeString( '┌', '' ), - normalizeString( '┐', '' ), - normalizeString( '┘', '' ), - normalizeString( '└', '' ) + normalizeString( '┌', out.widthUnits ), + normalizeString( '┐', out.widthUnits ), + normalizeString( '┘', out.widthUnits ), + normalizeString( '└', out.widthUnits ) ]; // Cell format string: @@ -76,18 +79,18 @@ function defaults() { out.headers = null; // Header separator: - out.headerSeparator = normalizeString( '-', '' ); + out.headerSeparator = normalizeString( '-', out.widthUnits ); // Horizontal line separator mode: out.horizontalSeparatorMode = 'resume'; // 'interpolate' || 'repeat' || 'resume' // Joint characters: out.joints = [ - normalizeString( '┼', '' ), - normalizeString( '┬', '' ), - normalizeString( '┤', '' ), - normalizeString( '┴', '' ), - normalizeString( '├', '' ) + normalizeString( '┼', out.widthUnits ), + normalizeString( '┬', out.widthUnits ), + normalizeString( '┤', out.widthUnits ), + normalizeString( '┴', out.widthUnits ), + normalizeString( '├', out.widthUnits ) ]; // Table margins: @@ -104,14 +107,11 @@ function defaults() { out.paddingRight = [ 1 ]; // Row separator: - out.rowSeparator = normalizeString( '', '' ); + out.rowSeparator = normalizeString( '', out.widthUnits ); // Vertical line separator mode: out.verticalSeparatorMode = 'resume'; // 'interpolate' || 'repeat' || 'resume' - // Width "units": - out.widthUnits = 'columns'; // 'graphemes' || 'columns' - return out; }