@stdlib/dstructs-named-typed-tuple 0.1.0

package/lib/ascending.js

@@ -0,0 +1,44 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The 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 //
+
+/**
+* Specifies a sort order for ordering numeric values in ascending order.
+*
+* ## Notes
+*
+* -   If `a < b`, then function returns a number less than `0`, which specifies to sort `a` to an index lower than `b`.
+* -   If `a > b`, then function returns a number greater than `0`, which specifies to sort `a` to an index higher than `b`.
+* -   If `a == b`, then function returns `0`, which specifies that the order of `a` and `b` should remain unchanged (not guaranteed).
+*
+* @private
+* @param {number} a - first value
+* @param {number} b - second value
+* @returns {number} difference between `a` and `b`
+*/
+function ascending( a, b ) {
+	return a - b;
+}
+
+
+// EXPORTS //
+
+module.exports = ascending;

package/lib/contains.js

@@ -0,0 +1,44 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The 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 a boolean indicating if an array contains a provided value.
+*
+* @private
+* @param {Array} arr - array
+* @param {*} v - search value
+* @returns {boolean} boolean indicating if an array contains a search value
+*/
+function contains( arr, v ) {
+	var i;
+	for ( i = 0; i < arr.length; i++ ) {
+		if ( arr[ i ] === v ) {
+			return true;
+		}
+	}
+	return false;
+}
+
+
+// EXPORTS //
+
+module.exports = contains;

package/lib/from_iterator.js

@@ -0,0 +1,48 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The 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 an array of iterated values.
+*
+* @private
+* @param {Object} it - iterator
+* @returns {Array} output array
+*/
+function fromIterator( it ) {
+	var out;
+	var v;
+
+	out = [];
+	while ( true ) {
+		v = it.next();
+		if ( v.done ) {
+			break;
+		}
+		out.push( v.value );
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = fromIterator;

package/lib/from_iterator_map.js

@@ -0,0 +1,54 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The 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 an array of iterated values.
+*
+* @private
+* @param {StringArray} fields - tuple fields
+* @param {Object} it - iterator
+* @param {Function} clbk - callback to invoke for each iterated value
+* @param {*} thisArg - invocation context
+* @returns {Array} output array
+*/
+function fromIteratorMap( fields, it, clbk, thisArg ) {
+	var out;
+	var v;
+	var i;
+
+	out = [];
+	i = -1;
+	while ( true ) {
+		v = it.next();
+		if ( v.done ) {
+			break;
+		}
+		i += 1;
+		out.push( clbk.call( thisArg, v.value, i, fields[ i ] ) );
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = fromIteratorMap;

package/lib/has_distinct_elements.js

@@ -0,0 +1,52 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The 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' );
+
+
+// MAIN //
+
+/**
+* Tests if an array contains distinct elements.
+*
+* @private
+* @param {Array} arr - input array
+* @returns {boolean} boolean indicating if an array contains distinct elements
+*/
+function hasDistinctElements( arr ) {
+	var obj;
+	var i;
+
+	obj = {};
+	for ( i = 0; i < arr.length; i++ ) {
+		if ( hasOwnProp( obj, arr[ i ] ) ) {
+			return false;
+		}
+		obj[ arr[i] ] = true;
+	}
+	return true;
+}
+
+
+// EXPORTS //
+
+module.exports = hasDistinctElements;

package/lib/index.js

@@ -0,0 +1,53 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The 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';
+
+/**
+* Named typed tuple.
+*
+* @module @stdlib/dstructs-named-typed-tuple
+*
+* @example
+* var namedtypedtuple = require( '@stdlib/dstructs-named-typed-tuple' );
+*
+* var point = namedtypedtuple( [ 'x', 'y' ] );
+*
+* var p = point( [ 1.0, -1.0 ] );
+*
+* var x = p[ 0 ];
+* // returns 1.0
+*
+* x = p.x;
+* // returns 1.0
+*
+* var y = p[ 1 ];
+* // returns -1.0
+*
+* y = p.y;
+* // returns -1.0
+*/
+
+// MAIN //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;