diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/README.md b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/README.md new file mode 100644 index 000000000000..cc5250f6d045 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/README.md @@ -0,0 +1,121 @@ + + +# enum2str + +> Return the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var enum2str = require( '@stdlib/blas/base/matrix-triangle-enum2str' ); +``` + +#### enum2str( value ) + +Returns the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant. + +```javascript +var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); + +var v = str2enum( 'upper' ); +// returns + +var s = enum2str( v ); +// returns 'upper' +``` + +If unable to resolve a matrix triangle string, the function returns `null`. + +```javascript +var v = enum2str( -999999999 ); +// returns null +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + +```javascript +var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +var enum2str = require( '@stdlib/blas/base/matrix-triangle-enum2str' ); + +var str = enum2str( str2enum( 'upper' ) ); +// returns 'upper' + +str = enum2str( str2enum( 'lower' ) ); +// returns 'lower' +``` + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/benchmark/benchmark.js new file mode 100644 index 000000000000..9b78f64697b3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/benchmark/benchmark.js @@ -0,0 +1,55 @@ +/** +* @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 isString = require( '@stdlib/assert/is-string' ).isPrimitive; +var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +var pkg = require( './../package.json' ).name; +var enum2str = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var values; + var out; + var i; + + values = [ + str2enum( 'upper' ), + str2enum( 'lower' ) + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = enum2str( values[ i%values.length ] ); + if ( typeof out !== 'string' ) { + b.fail( 'should return a string' ); + } + } + b.toc(); + if ( !isString( out ) ) { + b.fail( 'should return a string' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/repl.txt new file mode 100644 index 000000000000..c21f6594c985 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/repl.txt @@ -0,0 +1,22 @@ + +{{alias}}( value ) + Returns the BLAS matrix triangle string associated with a BLAS matrix + triangle enumeration constant. + + Parameters + ---------- + value: integer + Matrix triangle enumeration constant. + + Returns + ------- + out: string|null + Matrix triangle string. + + Examples + -------- + > var out = {{alias}}( {{alias:@stdlib/blas/base/matrix-triangle-str2enum}}( 'upper' ) ) + 'upper' + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/types/index.d.ts new file mode 100644 index 000000000000..0efab6852a36 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/types/index.d.ts @@ -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. +*/ + +// TypeScript Version: 4.1 + +/** +* Returns the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant. +* +* @param value - enumeration constant +* @returns matrix triangle string +* +* @example +* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +* +* var v = str2enum( 'upper' ); +* // returns +* +* var s = enum2str( v ); +* // returns 'upper' +*/ +declare function enum2str( value: number ): string | null; + + +// EXPORTS // + +export = enum2str; diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/types/test.ts new file mode 100644 index 000000000000..65833e5930c3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/docs/types/test.ts @@ -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. +*/ + +import enum2str = require( './index' ); + + +// TESTS // + +// The function returns a string or null... +{ + enum2str( 0 ); // $ExpectType string | null +} + +// The compiler throws an error if not provided a number... +{ + enum2str( '10' ); // $ExpectError + enum2str( true ); // $ExpectError + enum2str( false ); // $ExpectError + enum2str( null ); // $ExpectError + enum2str( undefined ); // $ExpectError + enum2str( [] ); // $ExpectError + enum2str( {} ); // $ExpectError + enum2str( ( x: number ): number => x ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/examples/index.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/examples/index.js new file mode 100644 index 000000000000..9e49329541c1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/examples/index.js @@ -0,0 +1,30 @@ +/** +* @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 str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +var enum2str = require( './../lib' ); + +var str = enum2str( str2enum( 'upper' ) ); +console.log( str ); +// => 'upper' + +str = enum2str( str2enum( 'lower' ) ); +console.log( str ); +// => 'lower' diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/lib/index.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/lib/index.js new file mode 100644 index 000000000000..78b5063114e1 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/lib/index.js @@ -0,0 +1,44 @@ +/** +* @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'; + +/** +* Return the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant. +* +* @module @stdlib/blas/base/matrix-triangle-enum2str +* +* @example +* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +* var enum2str = require( '@stdlib/blas/base/matrix-triangle-enum2str' ); +* +* var v = str2enum( 'upper' ); +* // returns +* +* var s = enum2str( v ); +* // returns 'upper' +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/lib/main.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/lib/main.js new file mode 100644 index 000000000000..15e05e7eaad2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/lib/main.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 objectInverse = require( '@stdlib/utils/object-inverse' ); +var enumeration = require( '@stdlib/blas/base/matrix-triangles' ).enum; + + +// VARIABLES // + +var hash = objectInverse( enumeration(), { + 'duplicates': false +}); + + +// MAIN // + +/** +* Returns the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant. +* +* @param {integer} value - enumeration constant +* @returns {(string|null)} matrix triangle string or null +* +* @example +* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +* +* var v = str2enum( 'upper' ); +* // returns +* +* var s = enum2str( v ); +* // returns 'upper' +*/ +function enum2str( value ) { + var v = hash[ value ]; + return ( typeof v === 'string' ) ? v : null; // note: we include this guard to prevent walking the prototype chain +} + + +// EXPORTS // + +module.exports = enum2str; diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/package.json b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/package.json new file mode 100644 index 000000000000..e55cba29fd0b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/blas/base/matrix-triangle-enum2str", + "version": "0.0.0", + "description": "Return the BLAS matrix triangle string associated with a BLAS matrix triangle enumeration constant.", + "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", + "stdtypes", + "types", + "blas", + "triangle", + "triangular", + "matrix", + "multidimensional", + "ndarray", + "array", + "utilities", + "utility", + "utils", + "util" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/test/test.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/test/test.js new file mode 100644 index 000000000000..da6b9a4c47ef --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-enum2str/test/test.js @@ -0,0 +1,65 @@ +/** +* @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 str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +var enum2str = require( './../lib' ); + + +// VARIABLES // + +var VALUES = [ + 'lower', + 'upper' +]; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof enum2str, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the string associated with a BLAS matrix triangle enumeration constant', function test( t ) { + var i; + for ( i = 0; i < VALUES.length; i++ ) { + t.strictEqual( enum2str( str2enum( VALUES[ i ] ) ), VALUES[ i ], 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns `null` if unable to resolve a string', function test( t ) { + var values; + var i; + + values = [ + -9999999, + -999999999, + -99999999999 + ]; + for ( i = 0; i < values.length; i++ ) { + t.strictEqual( enum2str( values[ i ] ), null, 'returns expected value' ); + } + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/README.md b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/README.md new file mode 100644 index 000000000000..f42e6368df65 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/README.md @@ -0,0 +1,119 @@ + + +# str2enum + +> Return the enumeration constant associated with a BLAS matrix triangle. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +``` + +#### str2enum( operation ) + +Return the enumeration constant associated with a BLAS matrix triangle. + +```javascript +var v = str2enum( 'upper' ); +// returns +``` + +If unable to resolve an enumeration constant, the function returns `null`. + +```javascript +var v = str2enum( 'beep' ); +// returns null +``` + +
+ + + + + +
+ +## Notes + +- Downstream consumers of this function should **not** rely on specific integer values (e.g., `UPPER == 0`). Instead, the function should be used in an opaque manner. + +
+ + + + + +
+ +## Examples + + + +```javascript +var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); + +var v = str2enum( 'upper' ); +// returns + +v = str2enum( 'lower' ); +// returns +``` + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/benchmark/benchmark.js new file mode 100644 index 000000000000..e2200bbcd3cc --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/benchmark/benchmark.js @@ -0,0 +1,54 @@ +/** +* @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 isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive; +var pkg = require( './../package.json' ).name; +var str2enum = require( './../lib' ); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var values; + var out; + var i; + + values = [ + 'upper', + 'lower' + ]; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + out = str2enum( values[ i%values.length ] ); + if ( typeof out !== 'number' ) { + b.fail( 'should return a number' ); + } + } + b.toc(); + if ( !isInteger( out ) ) { + b.fail( 'should return an integer' ); + } + b.pass( 'benchmark finished' ); + b.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/repl.txt new file mode 100644 index 000000000000..ce8b19a42910 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/repl.txt @@ -0,0 +1,25 @@ + +{{alias}}( value ) + Returns the enumeration constant associated with a BLAS matrix triangle. + + Downstream consumers of this function should *not* rely on specific integer + values (e.g., `UPPER == 0`). Instead, the function should be used in an + opaque manner. + + Parameters + ---------- + value: string + Matrix triangle string. + + Returns + ------- + out: integer|null + Enumeration constant. + + Examples + -------- + > var out = {{alias}}( 'upper' ) + + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/types/index.d.ts new file mode 100644 index 000000000000..acb58893be17 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/types/index.d.ts @@ -0,0 +1,40 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/** +* Returns the enumeration constant associated with a BLAS matrix triangle. +* +* ## Notes +* +* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `UPPER == 0`). Instead, the function should be used in an opaque manner. +* +* @param value - matrix triangle string +* @returns enumeration constant +* +* @example +* var v = str2enum( 'upper' ); +* // returns +*/ +declare function str2enum( value: string ): number | null; + + +// EXPORTS // + +export = str2enum; diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/types/test.ts new file mode 100644 index 000000000000..f61d5962d701 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/docs/types/test.ts @@ -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. +*/ + +import str2enum = require( './index' ); + + +// TESTS // + +// The function returns a number or null... +{ + str2enum( 'upper' ); // $ExpectType number | null +} + +// The compiler throws an error if not provided a string... +{ + str2enum( 10 ); // $ExpectError + str2enum( true ); // $ExpectError + str2enum( false ); // $ExpectError + str2enum( null ); // $ExpectError + str2enum( undefined ); // $ExpectError + str2enum( [] ); // $ExpectError + str2enum( {} ); // $ExpectError + str2enum( ( x: number ): number => x ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/examples/index.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/examples/index.js new file mode 100644 index 000000000000..7c611888b96f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/examples/index.js @@ -0,0 +1,29 @@ +/** +* @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 str2enum = require( './../lib' ); + +var v = str2enum( 'upper' ); +console.log( v ); +// => + +v = str2enum( 'lower' ); +console.log( v ); +// => diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/lib/index.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/lib/index.js new file mode 100644 index 000000000000..e62510df532b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/lib/index.js @@ -0,0 +1,40 @@ +/** +* @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'; + +/** +* Return the enumeration constant associated with a BLAS matrix triangle. +* +* @module @stdlib/blas/base/matrix-triangle-str2enum +* +* @example +* var str2enum = require( '@stdlib/blas/base/matrix-triangle-str2enum' ); +* +* var v = str2enum( 'upper' ); +* // returns +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/lib/main.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/lib/main.js new file mode 100644 index 000000000000..bd732b4e5aff --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/lib/main.js @@ -0,0 +1,55 @@ +/** +* @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 enumeration = require( '@stdlib/blas/base/matrix-triangles' ).enum; + + +// VARIABLES // + +var ENUM = enumeration(); + + +// MAIN // + +/** +* Returns the enumeration constant associated with a BLAS matrix triangle. +* +* ## Notes +* +* - Downstream consumers of this function should **not** rely on specific integer values (e.g., `UPPER == 0`). Instead, the function should be used in an opaque manner. +* +* @param {string} value - matrix triangle string +* @returns {(integer|null)} integer value or null +* +* @example +* var v = str2enum( 'upper' ); +* // returns +*/ +function str2enum( value ) { + var v = ENUM[ value ]; + return ( typeof v === 'number' ) ? v : null; // note: we include this guard to prevent walking the prototype chain +} + + +// EXPORTS // + +module.exports = str2enum; diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/package.json b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/package.json new file mode 100644 index 000000000000..b8d2495baaed --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/blas/base/matrix-triangle-str2enum", + "version": "0.0.0", + "description": "Return the enumeration constant associated with a BLAS matrix triangle.", + "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", + "stdtypes", + "types", + "blas", + "triangle", + "triangular", + "matrix", + "multidimensional", + "ndarray", + "array", + "utilities", + "utility", + "utils", + "util" + ], + "__stdlib__": {} +} diff --git a/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/test/test.js b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/test/test.js new file mode 100644 index 000000000000..cbc3d3ac3c8e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/matrix-triangle-str2enum/test/test.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 tape = require( 'tape' ); +var enum2str = require( '@stdlib/blas/base/matrix-triangle-enum2str' ); +var str2enum = require( './../lib' ); + + +// VARIABLES // + +var VALUES = [ + 'upper', + 'lower' +]; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof str2enum, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns the enumeration constant associated with a string', function test( t ) { + var i; + for ( i = 0; i < VALUES.length; i++ ) { + t.strictEqual( enum2str( str2enum( VALUES[ i ] ) ), VALUES[ i ], 'returns expected value' ); + } + t.end(); +}); + +tape( 'the function returns `null` if unable to resolve an enumeration constant', function test( t ) { + var values; + var i; + + values = [ + 'beep', + 'boop', + 'foo', + 'bar' + ]; + for ( i = 0; i < values.length; i++ ) { + t.strictEqual( str2enum( values[ i ] ), null, 'returns expected value' ); + } + t.end(); +});