@stdlib/math-iter-sequences-continued-fraction 0.0.1

package/lib/validate.js

@@ -0,0 +1,89 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2022 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;
+var isFinite = require( '@stdlib/assert-is-finite' ).isPrimitive; // eslint-disable-line stdlib/no-redeclare
+
+
+// VARIABLES //
+
+var returns = [
+	'terms',
+	'convergents',
+	'*'
+];
+
+
+// MAIN //
+
+/**
+* Validates function options.
+*
+* @private
+* @param {Object} opts - destination object
+* @param {Options} options - function options
+* @param {NonNegativeInteger} [options.iter] - maximum number of iterations
+* @param {PositiveNumber} [options.tol] - tolerance at which to terminate further evaluation of the continued fraction
+* @param {string} [options.returns] - specifies the type of result to return (must be one of `'terms'`, `'convergents'`, or `'*'`)
+* @returns {(Error|null)} null or an error object
+*
+* @example
+* var opts = {};
+* var options = {
+*     'iter': 50
+* };
+* var err = validate( opts, options );
+* if ( err ) {
+*     throw err;
+* }
+*/
+function validate( opts, options ) {
+	if ( !isPlainObject( options ) ) {
+		return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
+	}
+	if ( hasOwnProp( options, 'iter' ) ) {
+		opts.iter = options.iter;
+		if ( !isNonNegativeInteger( options.iter ) ) {
+			return new TypeError( 'invalid option. `iter` option must be a nonnegative integer. Option: `' + options.iter + '`.' );
+		}
+	}
+	if ( hasOwnProp( options, 'tol' ) ) {
+		opts.tol = options.tol;
+		if ( !isFinite( options.tol ) || options.tol <= 0.0 ) {
+			return new TypeError( 'invalid option. `tol` option must be a positive finite number. Option: `' + options.tol + '`.' );
+		}
+	}
+	if ( hasOwnProp( options, 'returns' ) ) {
+		opts.returns = options.returns;
+		if ( returns.indexOf( options.returns ) === -1 ) {
+			return new TypeError( 'invalid option. `returns` option must be one of the following: '+returns.join( ', ' )+'. Option: `' + options.returns + '`.' );
+		}
+	}
+	return null;
+}
+
+
+// EXPORTS //
+
+module.exports = validate;

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@stdlib/math-iter-sequences-continued-fraction",
+  "version": "0.0.1",
+  "description": "Create an iterator which generates a list of all continued fraction terms which can be obtained given the precision of a provided number.",
+  "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": {
+    "test": "make test",
+    "test-cov": "make test-cov",
+    "examples": "make examples",
+    "benchmark": "make benchmark"
+  },
+  "homepage": "https://stdlib.io",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/math-iter-sequences-continued-fraction.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/assert-has-own-property": "^0.0.x",
+    "@stdlib/assert-is-finite": "^0.0.x",
+    "@stdlib/assert-is-nonnegative-integer": "^0.0.x",
+    "@stdlib/assert-is-plain-object": "^0.0.x",
+    "@stdlib/constants-float64-eps": "^0.0.x",
+    "@stdlib/math-base-special-abs": "^0.0.x",
+    "@stdlib/math-base-special-floor": "^0.0.x",
+    "@stdlib/symbol-iterator": "^0.0.x",
+    "@stdlib/types": "^0.0.x",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x",
+    "@stdlib/utils-fifo": "^0.0.x"
+  },
+  "devDependencies": {
+    "@stdlib/assert-is-array": "^0.0.x",
+    "@stdlib/assert-is-iterator-like": "^0.0.x",
+    "@stdlib/bench": "^0.0.x",
+    "@stdlib/constants-float64-pi": "^0.0.x",
+    "@stdlib/math-base-assert-is-nan": "^0.0.x",
+    "proxyquire": "^2.0.0",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "istanbul": "^0.4.1",
+    "tap-spec": "5.x.x"
+  },
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdmath",
+    "mathematics",
+    "math",
+    "continued",
+    "fraction",
+    "sequence",
+    "iterator",
+    "iterate",
+    "iteration",
+    "iter"
+  ],
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/athan"
+  }
+}