@stdlib/dstructs-compact-adjacency-matrix 0.1.0

package/lib/bit_value.js

@@ -0,0 +1,45 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 value (either `0` or `1`) of a specified bit.
+*
+* @private
+* @param {integer32} value - integer value
+* @param {NonNegativeInteger} i - bit number
+* @returns {NonNegativeInteger} bit value
+*
+* @example
+* var b = bitValue( 4, 2 );
+* // returns 1
+*
+* b = bitValue( 4, 0 );
+* // returns 0
+*/
+function bitValue( value, i ) {
+	return ( value >> i ) & 1;
+}
+
+
+// EXPORTS //
+
+module.exports = bitValue;

package/lib/clear_bit.js

@@ -0,0 +1,43 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 //
+
+/**
+* Clears a bit.
+*
+* @private
+* @param {integer32} value - integer value
+* @param {NonNegativeInteger} i - bit to clear
+* @returns {integer32} updated integer value
+*
+* @example
+* var v = clearBit( 5, 2 );
+* // returns 1
+*/
+function clearBit( value, i ) {
+	value &= ~( 1 << i );
+	return value;
+}
+
+
+// EXPORTS //
+
+module.exports = clearBit;

package/lib/from_adjacency_list_iterator.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Returns an array of iterated values.
+*
+* @private
+* @param {Object} it - iterator
+* @returns {(Array|TypeError)} array or an error
+*/
+function fromIterator( it ) {
+	var out;
+	var v;
+	var z;
+
+	out = [];
+	while ( true ) {
+		v = it.next();
+		z = v.value;
+		if ( z ) {
+			if ( !isCollection( z ) ) {
+				return new TypeError( format( 'invalid argument. An iterator must return an array-like object containing vertices. Value: `%s`.', z ) );
+			}
+			out.push( z );
+		}
+		if ( v.done ) {
+			break;
+		}
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = fromIterator;

package/lib/from_adjacency_list_iterator_map.js

@@ -0,0 +1,67 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Returns an array of iterated values.
+*
+* @private
+* @param {Object} it - iterator
+* @param {Function} clbk - callback to invoke for each iterated value
+* @param {*} thisArg - invocation context
+* @returns {(Array|TypeError)} array or an error
+*/
+function fromIteratorMap( it, clbk, thisArg ) {
+	var out;
+	var v;
+	var z;
+	var i;
+
+	out = [];
+	i = -1;
+	while ( true ) {
+		i += 1;
+		v = it.next();
+		z = v.value;
+		if ( z ) {
+			z = clbk.call( thisArg, z, i );
+			if ( !isCollection( z ) ) {
+				return new TypeError( format( 'invalid argument. Callback must return an array-like object containing vertices. Value: `%s`.', z ) );
+			}
+			out.push( z );
+		}
+		if ( v.done ) {
+			break;
+		}
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = fromIteratorMap;

package/lib/from_edges_iterator.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Returns an array of iterated values.
+*
+* @private
+* @param {Object} it - iterator
+* @returns {(Array|TypeError)} array or an error
+*/
+function fromIterator( it ) {
+	var out;
+	var v;
+	var z;
+
+	out = [];
+	while ( true ) {
+		v = it.next();
+		z = v.value;
+		if ( z ) {
+			if ( !isCollection( z ) ) {
+				return new TypeError( format( 'invalid argument. An iterator must return an array-like object containing vertices. Value: `%s`.', z ) );
+			}
+			out.push( z[ 0 ], z[ 1 ] );
+		}
+		if ( v.done ) {
+			break;
+		}
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = fromIterator;

package/lib/from_edges_iterator_map.js

@@ -0,0 +1,67 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 format = require( '@stdlib/string-format' );
+
+
+// MAIN //
+
+/**
+* Returns an array of iterated values.
+*
+* @private
+* @param {Object} it - iterator
+* @param {Function} clbk - callback to invoke for each iterated value
+* @param {*} thisArg - invocation context
+* @returns {(Array|TypeError)} array or an error
+*/
+function fromIteratorMap( it, clbk, thisArg ) {
+	var out;
+	var v;
+	var z;
+	var i;
+
+	out = [];
+	i = -1;
+	while ( true ) {
+		i += 1;
+		v = it.next();
+		z = v.value;
+		if ( z ) {
+			z = clbk.call( thisArg, z, i );
+			if ( !isCollection( z ) ) {
+				return new TypeError( format( 'invalid argument. Callback must return an array-like object containing vertices. Value: `%s`.', z ) );
+			}
+			out.push( z[ 0 ], z[ 1 ] );
+		}
+		if ( v.done ) {
+			break;
+		}
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = fromIteratorMap;

package/lib/index.js

@@ -0,0 +1,49 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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';
+
+/**
+* Compact adjacency matrix.
+*
+* @module @stdlib/dstructs-compact-adjacency-matrix
+*
+* @example
+* var CompactAdjacencyMatrix = require( '@stdlib/dstructs-compact-adjacency-matrix' );
+*
+* var adj = new CompactAdjacencyMatrix( 4 );
+* // returns <CompactAdjacencyMatrix>
+*
+* // ...
+*
+* adj.addEdge( 0, 1 );
+* adj.addEdge( 0, 2 );
+* adj.addEdge( 1, 2 );
+* adj.addEdge( 2, 3 );
+*
+* // ...
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/lib/is_set.js

@@ -0,0 +1,50 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The 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 Boolean = require( '@stdlib/boolean-ctor' );
+
+
+// MAIN //
+
+/**
+* Checks whether a bit is set.
+*
+* @private
+* @param {integer32} value - integer value
+* @param {NonNegativeInteger} i - bit to check
+* @returns {boolean} boolean indicating whether a bit is set
+*
+* @example
+* var bool = isSet( 4, 2 );
+* // returns true
+*
+* bool = isSet( 4, 0 );
+* // returns false
+*/
+function isSet( value, i ) {
+	return Boolean( ( value >> i ) & 1 );
+}
+
+
+// EXPORTS //
+
+module.exports = isSet;