@ohos-ports/stdlib-simulate 0.4.1-beta.0

package/iter/sine-wave/docs/repl.txt

@@ -0,0 +1,51 @@
+
+{{alias}}( [options] )
+    Returns an iterator which generates a sine wave.
+
+    If an environment supports Symbol.iterator, the returned iterator is
+    iterable.
+
+    Parameters
+    ----------
+    options: Object (optional)
+        Function options.
+
+    options.period: integer (optional)
+        Period (i.e., the number of iterations before a sine wave repeats).
+        Default: 10.
+
+    options.amplitude: number (optional)
+        Peak amplitude. Default: 1.0.
+
+    options.offset: integer (optional)
+        Phase offset (in units of iterations; zero-based). A negative offset
+        translates the waveform to the left. A positive offset translates a
+        waveform to the right. Default: 0.
+
+    options.iter: integer (optional)
+        Number of iterations. Default: 1e308.
+
+    Returns
+    -------
+    iterator: Object
+        Iterator.
+
+    iterator.next(): Function
+        Returns an iterator protocol-compliant object containing the next
+        iterated value (if one exists) and a boolean flag indicating whether the
+        iterator is finished.
+
+    iterator.return( [value] ): Function
+        Finishes an iterator and returns a provided value.
+
+    Examples
+    --------
+    > var it = {{alias}}();
+    > var v = it.next().value
+    <number>
+    > v = it.next().value
+    <number>
+
+    See Also
+    --------
+

package/iter/sine-wave/docs/types/index.d.ts

@@ -0,0 +1,96 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The 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
+
+/// <reference types="@stdlib/types"/>
+
+import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter';
+
+// Define a union type representing both iterable and non-iterable iterators:
+type Iterator = Iter | IterableIterator;
+
+interface Options {
+	/**
+	* Period (i.e., the number of iterations before a sine wave repeats).
+	*/
+	period?: number;
+
+	/**
+	* Peak amplitude.
+	*/
+	amplitude?: number;
+
+	/**
+	* Phase offset (in units of iterations; zero-based).
+	*
+	* ## Notes
+	*
+	* -   A negative offset translates a waveform to the left.
+	* -   A positive offset translates a waveform to the right.
+	*/
+	offset?: number;
+
+	/**
+	* Number of iterations.
+	*/
+	iter?: number;
+}
+
+/**
+* Returns an iterator which generates a sine wave.
+*
+* ## Notes
+*
+* -   If an environment supports `Symbol.iterator`, the returned iterator is iterable.
+*
+* @param options - function options
+* @param options.period - number of iterations before a sine wave repeats (default: 10)
+* @param options.amplitude - peak amplitude (default: 1.0)
+* @param options.offset - phase offset (in units of iterations; default: 0)
+* @param options.iter - number of iterations (default: 1e308)
+* @throws `period` option must be a positive integer
+* @throws `amplitude` must be a nonnegative number
+* @throws `offset` option must be an integer
+* @throws `iter` option must be a nonnegative integer
+* @returns iterator
+*
+* @example
+* var opts = {
+*     'period': 4
+* };
+*
+* var iter = iterSineWave( opts );
+*
+* var v = iter.next().value;
+* // returns 0.0
+*
+* v = iter.next().value;
+* // returns 1.0
+*
+* v = iter.next().value;
+* // returns 0.0
+*
+* // ...
+*/
+declare function iterSineWave( options?: Options ): Iterator;
+
+
+// EXPORTS //
+
+export = iterSineWave;

package/iter/sine-wave/docs/types/test.ts

@@ -0,0 +1,78 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The 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 iterSineWave = require( './index' );
+
+
+// TESTS //
+
+// The function returns an iterator...
+{
+	iterSineWave(); // $ExpectType Iterator
+	iterSineWave( {} ); // $ExpectType Iterator
+	iterSineWave( { 'iter': 10 } ); // $ExpectType Iterator
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an options object...
+{
+	iterSineWave( null ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a `period` option which is not a number...
+{
+	iterSineWave( { 'period': '5' } ); // $ExpectError
+	iterSineWave( { 'period': true } ); // $ExpectError
+	iterSineWave( { 'period': false } ); // $ExpectError
+	iterSineWave( { 'period': null } ); // $ExpectError
+	iterSineWave( { 'period': [] } ); // $ExpectError
+	iterSineWave( { 'period': {} } ); // $ExpectError
+	iterSineWave( { 'period': ( x: number ): number => x } ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an `amplitude` option which is not a number...
+{
+	iterSineWave( { 'amplitude': '5' } ); // $ExpectError
+	iterSineWave( { 'amplitude': true } ); // $ExpectError
+	iterSineWave( { 'amplitude': false } ); // $ExpectError
+	iterSineWave( { 'amplitude': null } ); // $ExpectError
+	iterSineWave( { 'amplitude': [] } ); // $ExpectError
+	iterSineWave( { 'amplitude': {} } ); // $ExpectError
+	iterSineWave( { 'amplitude': ( x: number ): number => x } ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an `offset` option which is not a number...
+{
+	iterSineWave( { 'offset': '5' } ); // $ExpectError
+	iterSineWave( { 'offset': true } ); // $ExpectError
+	iterSineWave( { 'offset': false } ); // $ExpectError
+	iterSineWave( { 'offset': null } ); // $ExpectError
+	iterSineWave( { 'offset': [] } ); // $ExpectError
+	iterSineWave( { 'offset': {} } ); // $ExpectError
+	iterSineWave( { 'offset': ( x: number ): number => x } ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an `iter` option which is not a number...
+{
+	iterSineWave( { 'iter': '5' } ); // $ExpectError
+	iterSineWave( { 'iter': true } ); // $ExpectError
+	iterSineWave( { 'iter': false } ); // $ExpectError
+	iterSineWave( { 'iter': null } ); // $ExpectError
+	iterSineWave( { 'iter': [] } ); // $ExpectError
+	iterSineWave( { 'iter': {} } ); // $ExpectError
+	iterSineWave( { 'iter': ( x: number ): number => x } ); // $ExpectError
+}

package/iter/sine-wave/lib/index.js

@@ -0,0 +1,54 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The 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 an iterator which generates a sine wave.
+*
+* @module @stdlib/simulate/iter/sine-wave
+*
+* @example
+* var iterSineWave = require( '@stdlib/simulate/iter/sine-wave' );
+*
+* var opts = {
+*     'period': 4
+* };
+*
+* var iter = iterSineWave( opts );
+*
+* var v = iter.next().value;
+* // returns 0.0
+*
+* v = iter.next().value;
+* // returns 1.0
+*
+* v = iter.next().value;
+* // returns 0.0
+*
+* // ...
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

package/iter/sine-wave/lib/main.js

@@ -0,0 +1,156 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The 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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
+var iteratorSymbol = require( '@stdlib/symbol/iterator' );
+var sinpi = require( '@stdlib/math/base/special/sinpi' );
+var validate = require( './validate.js' );
+
+
+// MAIN //
+
+/**
+* Returns an iterator which generates a sine wave.
+*
+* @param {Options} [options] - function options
+* @param {PositiveInteger} [options.period=10] - number of iterations before a sine wave repeats
+* @param {NonNegativeNumber} [options.amplitude=1.0] - peak amplitude
+* @param {integer} [options.offset=0] - phase offset (in units of iterations; zero-based)
+* @param {NonNegativeInteger} [options.iter=1e308] - number of iterations
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
+* @returns {Iterator} iterator
+*
+* @example
+* var opts = {
+*     'period': 4
+* };
+*
+* var iter = iterSineWave( opts );
+*
+* var v = iter.next().value;
+* // returns 0.0
+*
+* v = iter.next().value;
+* // returns 1.0
+*
+* v = iter.next().value;
+* // returns 0.0
+*
+* // ...
+*/
+function iterSineWave( options ) {
+	var opts;
+	var iter;
+	var FLG;
+	var err;
+	var t;
+	var s;
+	var i;
+
+	opts = {
+		'period': 10,
+		'amplitude': 1.0,
+		'offset': 0,
+		'iter': 1e308
+	};
+	if ( arguments.length ) {
+		err = validate( opts, options );
+		if ( err ) {
+			throw err;
+		}
+	}
+	t = ( opts.period-opts.offset ) % opts.period;
+	if ( t < 0 ) {
+		t += opts.period; // normalize such that t ϵ [0,τ]
+	}
+	t -= 1;
+	s = 2.0 / opts.period;
+	i = 0;
+
+	// Create an iterator protocol-compliant object:
+	iter = {};
+	setReadOnly( iter, 'next', next );
+	setReadOnly( iter, 'return', end );
+
+	// If an environment supports `Symbol.iterator`, make the iterator iterable:
+	if ( iteratorSymbol ) {
+		setReadOnly( iter, iteratorSymbol, factory );
+	}
+	return iter;
+
+	/**
+	* Returns an iterator protocol-compliant object containing the next iterated value.
+	*
+	* @private
+	* @returns {Object} iterator protocol-compliant object
+	*/
+	function next() {
+		i += 1;
+		if ( FLG || i > opts.iter ) {
+			return {
+				'done': true
+			};
+		}
+		t += 1;
+		t %= opts.period;
+		return {
+			'value': opts.amplitude * sinpi( s*t ),
+			'done': false
+		};
+	}
+
+	/**
+	* Finishes an iterator.
+	*
+	* @private
+	* @param {*} [value] - value to return
+	* @returns {Object} iterator protocol-compliant object
+	*/
+	function end( value ) {
+		FLG = true;
+		if ( arguments.length ) {
+			return {
+				'value': value,
+				'done': true
+			};
+		}
+		return {
+			'done': true
+		};
+	}
+
+	/**
+	* Returns a new iterator.
+	*
+	* @private
+	* @returns {Iterator} iterator
+	*/
+	function factory() {
+		return iterSineWave( opts );
+	}
+}
+
+
+// EXPORTS //
+
+module.exports = iterSineWave;

package/iter/sine-wave/lib/validate.js

@@ -0,0 +1,90 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The 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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
+var hasOwnProp = require( '@stdlib/assert/has-own-property' );
+var isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
+var isPositiveInteger = require( '@stdlib/assert/is-positive-integer' ).isPrimitive;
+var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
+var isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number' ).isPrimitive;
+var format = require( '@stdlib/string/format' );
+
+
+// MAIN //
+
+/**
+* Validates function options.
+*
+* @private
+* @param {Object} opts - destination object
+* @param {Options} options - function options
+* @param {PositiveInteger} [options.period] - number of iterations before a sine wave repeats
+* @param {NonNegativeNumber} [options.amplitude] - peak amplitude
+* @param {integer} [options.offset] - phase offset (in units of iterations)
+* @param {NonNegativeInteger} [options.iter] - number of iterations
+* @returns {(Error|null)} null or an error object
+*
+* @example
+* var opts = {};
+* var options = {
+*     'iter': 100
+* };
+* var err = validate( opts, options );
+* if ( err ) {
+*     throw err;
+* }
+*/
+function validate( opts, options ) {
+	if ( !isPlainObject( options ) ) {
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+	}
+	if ( hasOwnProp( options, 'period' ) ) {
+		opts.period = options.period;
+		if ( !isPositiveInteger( options.period ) ) {
+			return new TypeError( format( 'invalid option. `%s` option must be an positive integer. Option: `%s`.', 'period', options.period ) );
+		}
+	}
+	if ( hasOwnProp( options, 'amplitude' ) ) {
+		opts.amplitude = options.amplitude;
+		if ( !isNonNegativeNumber( options.amplitude ) ) {
+			return new TypeError( format( 'invalid option. `%s` option must be a nonnegative number. Option: `%s`.', 'amplitude', options.amplitude ) );
+		}
+	}
+	if ( hasOwnProp( options, 'offset' ) ) {
+		opts.offset = options.offset;
+		if ( !isInteger( options.offset ) ) {
+			return new TypeError( format( 'invalid option. `%s` option must be an integer. Option: `%s`.', 'offset', options.offset ) );
+		}
+	}
+	if ( hasOwnProp( options, 'iter' ) ) {
+		opts.iter = options.iter;
+		if ( !isNonNegativeInteger( options.iter ) ) {
+			return new TypeError( format( 'invalid option. `%s` option must be a nonnegative integer. Option: `%s`.', 'iter', options.iter ) );
+		}
+	}
+	return null;
+}
+
+
+// EXPORTS //
+
+module.exports = validate;

package/iter/sine-wave/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@stdlib/simulate/iter/sine-wave",
+  "version": "0.0.0",
+  "description": "Create an iterator which generates a sine wave.",
+  "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",
+    "simulate",
+    "simulation",
+    "sine",
+    "sin",
+    "cos",
+    "cosine",
+    "sinusoid",
+    "wave",
+    "signal",
+    "processing",
+    "waveform",
+    "periodic",
+    "iterator",
+    "iterate",
+    "iteration",
+    "iter"
+  ]
+}