diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/README.md b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/README.md new file mode 100644 index 000000000000..fe58365d5dde --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/README.md @@ -0,0 +1,117 @@ + + +# markInterpolationMethods + +> List of supported Vega mark interpolation methods. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var markInterpolationMethods = require( '@stdlib/plot/vega/mark/interpolation-methods' ); +``` + +#### markInterpolationMethods() + +Returns a list of mark interpolation methods. + +```javascript +var out = markInterpolationMethods(); +// returns [ 'basis', 'cardinal', 'catmull-rom', 'linear', 'monotone', 'natural', 'step', 'step-after', 'step-before' ] +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```javascript +var contains = require( '@stdlib/array/base/assert/contains' ).factory; +var markInterpolationMethods = require( '@stdlib/plot/vega/mark/interpolation-methods' ); + +var isMarkInterpolationMethod = contains( markInterpolationMethods() ); + +var bool = isMarkInterpolationMethod( 'linear' ); +// returns true + +bool = isMarkInterpolationMethod( 'step' ); +// returns true + +bool = isMarkInterpolationMethod( 'beep' ); +// returns false + +bool = isMarkInterpolationMethod( 'boop' ); +// returns false +``` + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/benchmark/benchmark.js b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/benchmark/benchmark.js new file mode 100644 index 000000000000..94d06c9211c3 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/benchmark/benchmark.js @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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 isStringArray = require( '@stdlib/assert/is-string-array' ).primitives; +var pkg = require( './../package.json' ).name; +var markInterpolationMethods = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var out; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = markInterpolationMethods(); + if ( out.length < 2 ) { + b.fail( 'should return an array' ); + } + } + b.toc(); + if ( !isStringArray( out ) ) { + b.fail( 'should return an array of strings' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/repl.txt b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/repl.txt new file mode 100644 index 000000000000..df45013176d1 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/repl.txt @@ -0,0 +1,17 @@ + +{{alias}}() + Returns a list of mark interpolation methods. + + Returns + ------- + out: Array + List of mark interpolation methods. + + Examples + -------- + > var out = {{alias}}() + [ 'basis', 'cardinal', 'catmull-rom', ... ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/types/index.d.ts b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/types/index.d.ts new file mode 100644 index 000000000000..a34d5497a8ca --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/types/index.d.ts @@ -0,0 +1,35 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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. +*/ + +// TypeScript Version: 4.1 + +/** +* Returns a list of mark interpolation methods. +* +* @returns list of mark interpolation methods +* +* @example +* var list = markInterpolationMethods(); +* // returns [ 'basis', 'cardinal', 'catmull-rom', 'linear', 'monotone', 'natural', 'step', 'step-after', 'step-before' ] +*/ +declare function markInterpolationMethods(): Array; + + +// EXPORTS // + +export = markInterpolationMethods; diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/types/test.ts b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/types/test.ts new file mode 100644 index 000000000000..eaafe505dbc8 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/docs/types/test.ts @@ -0,0 +1,32 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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. +*/ + +import markInterpolationMethods = require( './index' ); + + +// TESTS // + +// The function returns an array of strings... +{ + markInterpolationMethods(); // $ExpectType string[] +} + +// The compiler throws an error if the function is provided any arguments... +{ + markInterpolationMethods( 9 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/examples/index.js b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/examples/index.js new file mode 100644 index 000000000000..e11e3b86cc6b --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/examples/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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 contains = require( '@stdlib/array/base/assert/contains' ).factory; +var markInterpolationMethods = require( './../lib' ); + +var isMarkInterpolationMethod = contains( markInterpolationMethods() ); + +var bool = isMarkInterpolationMethod( 'linear' ); +console.log( bool ); +// => true + +bool = isMarkInterpolationMethod( 'step' ); +console.log( bool ); +// => true + +bool = isMarkInterpolationMethod( 'beep' ); +console.log( bool ); +// => false + +bool = isMarkInterpolationMethod( 'boop' ); +console.log( bool ); +// => false diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/data.json b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/data.json new file mode 100644 index 000000000000..02358fc43e93 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/data.json @@ -0,0 +1,11 @@ +[ + "basis", + "cardinal", + "catmull-rom", + "linear", + "monotone", + "natural", + "step", + "step-after", + "step-before" +] diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/index.js b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/index.js new file mode 100644 index 000000000000..223df9a26876 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/index.js @@ -0,0 +1,40 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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'; + +/** +* Return a list of mark interpolation methods. +* +* @module @stdlib/plot/vega/mark/interpolation-methods +* +* @example +* var markInterpolationMethods = require( '@stdlib/plot/vega/mark/interpolation-methods' ); +* +* var out = markInterpolationMethods(); +* // returns [ 'basis', 'cardinal', 'catmull-rom', 'linear', 'monotone', 'natural', 'step', 'step-after', 'step-before' ] +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/main.js b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/main.js new file mode 100644 index 000000000000..5ef32d880b13 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/lib/main.js @@ -0,0 +1,44 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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 DATA = require( './data.json' ); + + +// MAIN // + +/** +* Returns a list of mark interpolation methods. +* +* @returns {StringArray} list of mark interpolation methods +* +* @example +* var out = interpolationMethods(); +* // returns [ 'basis', 'cardinal', 'catmull-rom', 'linear', 'monotone', 'natural', 'step', 'step-after', 'step-before' ] +*/ +function interpolationMethods() { + return DATA.slice(); +} + + +// EXPORTS // + +module.exports = interpolationMethods; diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/package.json b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/package.json new file mode 100644 index 000000000000..c532b22ebbce --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/package.json @@ -0,0 +1,64 @@ +{ + "name": "@stdlib/plot/vega/mark/interpolation-methods", + "version": "0.0.0", + "description": "List of supported Vega mark interpolation methods.", + "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" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "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", + "vega", + "mark", + "interpolation", + "interpolate", + "utilities", + "utility", + "utils", + "util" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/test/test.js b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/test/test.js new file mode 100644 index 000000000000..cd924af14600 --- /dev/null +++ b/lib/node_modules/@stdlib/plot/vega/mark/interpolation-methods/test/test.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2026 The 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 markInterpolationMethods = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof markInterpolationMethods, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns a list of mark interpolation methods', function test( t ) { + var expected; + var actual; + + expected = [ + 'basis', + 'cardinal', + 'catmull-rom', + 'linear', + 'monotone', + 'natural', + 'step', + 'step-after', + 'step-before' + ]; + actual = markInterpolationMethods(); + + t.deepEqual( actual, expected, 'returns expected value' ); + t.end(); +});