@stdlib/random-array-invgamma 0.1.0

package/lib/main.js

@@ -0,0 +1,58 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 factory = require( './factory.js' );
+
+
+// MAIN //
+
+/**
+* Returns an array containing pseudorandom numbers drawn from an inverse gamma distribution with parameters `alpha` (shape parameter) and `beta` (scale parameter).
+*
+* @name invgamma
+* @type {Function}
+* @param {NonNegativeInteger} len - array length
+* @param {PositiveNumber} alpha - shape parameter
+* @param {PositiveNumber} beta - scale parameter
+* @param {Options} [options] - options
+* @param {string} [options.dtype="float64"] - output array data type
+* @throws {TypeError} first argument must be a nonnegative integer
+* @throws {TypeError} options argument must be an object
+* @throws {TypeError} must provide valid options
+* @returns {(Array|TypedArray)} output array
+*
+* @example
+* var arr = invgamma( 10, 2.0, 5.0 );
+* // returns <Float64Array>
+*
+* @example
+* var arr = invgamma( 10, 2.0, 5.0, {
+*     'dtype': 'generic'
+* });
+* // returns [...]
+*/
+var invgamma = factory();
+
+
+// EXPORTS //
+
+module.exports = invgamma;

package/lib/validate.js

@@ -0,0 +1,72 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );
+var isObject = require( '@stdlib/assert-is-plain-object' );
+var hasOwnProp = require( '@stdlib/assert-has-own-property' );
+var format = require( '@stdlib/string-format' );
+
+
+// VARIABLES //
+
+var DTYPES = dtypes();
+DTYPES.push( 'generic' );
+
+
+// MAIN //
+
+/**
+* Validates function options.
+*
+* @private
+* @param {Object} opts - destination object
+* @param {Options} options - function options
+* @param {string} [options.dtype] - output array data type
+* @returns {(Error|null)} null or an error object
+*
+* @example
+* var opts = {};
+* var options = {
+*     'dtype': 'float64'
+* };
+* var err = validate( opts, options );
+* if ( err ) {
+*     throw err;
+* }
+*/
+function validate( opts, options ) {
+	if ( !isObject( options ) ) {
+		return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
+	}
+	if ( hasOwnProp( options, 'dtype' ) ) {
+		opts.dtype = options.dtype;
+		if ( DTYPES.indexOf( opts.dtype ) < 0 ) {
+			return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) );
+		}
+	}
+	return null;
+}
+
+
+// EXPORTS //
+
+module.exports = validate;

package/package.json

@@ -0,0 +1,115 @@
+{
+  "name": "@stdlib/random-array-invgamma",
+  "version": "0.1.0",
+  "description": "Create an array containing pseudorandom numbers drawn from an inverse gamma distribution.",
+  "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/random-array-invgamma.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {
+    "@stdlib/array-base-filled-by": "^0.1.0",
+    "@stdlib/array-typed-real-float-ctors": "^0.1.0",
+    "@stdlib/array-typed-real-float-dtypes": "^0.1.0",
+    "@stdlib/assert-has-own-property": "^0.1.0",
+    "@stdlib/assert-is-nonnegative-integer": "^0.1.0",
+    "@stdlib/assert-is-plain-object": "^0.1.0",
+    "@stdlib/random-base-invgamma": "^0.1.0",
+    "@stdlib/strided-base-binary": "^0.1.0",
+    "@stdlib/strided-base-nullary": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-constant-function": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.0",
+    "@stdlib/utils-noop": "^0.1.0",
+    "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
+  },
+  "devDependencies": {
+    "@stdlib/array-float32": "^0.1.0",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/array-uint32": "^0.1.0",
+    "@stdlib/assert-is-uint32array": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/console-log-each": "^0.1.0",
+    "@stdlib/constants-uint32-max": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-nanf": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.1.0",
+    "@stdlib/random-base-minstd": "^0.1.0",
+    "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
+    "istanbul": "^0.4.1",
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
+  },
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "os": [
+    "aix",
+    "darwin",
+    "freebsd",
+    "linux",
+    "macos",
+    "openbsd",
+    "sunos",
+    "win32",
+    "windows"
+  ],
+  "keywords": [
+    "stdlib",
+    "stdmath",
+    "mathematics",
+    "math",
+    "statistics",
+    "stats",
+    "prng",
+    "rng",
+    "pseudorandom",
+    "random",
+    "rand",
+    "inverse",
+    "gamma",
+    "inverse-gamma",
+    "continuous",
+    "generator",
+    "seed",
+    "seedable",
+    "array",
+    "vector"
+  ],
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
+  }
+}