@ohos-ports/stdlib-assert 0.0.0-stage → 0.4.1-beta.0

package/is-nonnegative-finite/README.md

@@ -0,0 +1,173 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# isNonNegativeFinite
+
+> Test if a value is a number having a nonnegative finite value.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' );
+```
+
+#### isNonNegativeFinite( value )
+
+Tests if a value is a number having a nonnegative finite value.
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+
+var bool = isNonNegativeFinite( 5.0 );
+// returns true
+
+bool = isNonNegativeFinite( new Number( 5.0 ) );
+// returns true
+
+bool = isNonNegativeFinite( 3.14 );
+// returns true
+
+bool = isNonNegativeFinite( -5.0 );
+// returns false
+
+bool = isNonNegativeFinite( null );
+// returns false
+
+bool = isNonNegativeFinite( 1.0/0.0 );
+// returns false
+```
+
+#### isNonNegativeFinite.isPrimitive( value )
+
+Tests if a value is a primitive number having a nonnegative finite value.
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+
+var bool = isNonNegativeFinite.isPrimitive( 3.0 );
+// returns true
+
+bool = isNonNegativeFinite.isPrimitive( new Number( 3.0 ) );
+// returns false
+```
+
+#### isNonNegativeFinite.isObject( value )
+
+Tests if a value is a `Number` object having a nonnegative finite value.
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+
+var bool = isNonNegativeFinite.isObject( 3.0 );
+// returns false
+
+bool = isNonNegativeFinite.isObject( new Number( 3.0 ) );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable no-new-wrappers -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' );
+
+var bool = isNonNegativeFinite( 5.0 );
+// returns true
+
+bool = isNonNegativeFinite( new Number( 5.0 ) );
+// returns true
+
+bool = isNonNegativeFinite( new Number( 1.0/0.0 ) );
+// returns false
+
+bool = isNonNegativeFinite( 1.0/0.0 );
+// returns false
+
+bool = isNonNegativeFinite( 0.0 );
+// returns true
+
+bool = isNonNegativeFinite( 3.14 );
+// returns true
+
+bool = isNonNegativeFinite( -5.0 );
+// returns false
+
+bool = isNonNegativeFinite( '5' );
+// returns false
+
+bool = isNonNegativeFinite( null );
+// returns false
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/is-finite`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span>
+-   <span class="package-name">[`@stdlib/assert/is-nonnegative-number`][@stdlib/assert/is-nonnegative-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number having a nonnegative value.</span>
+-   <span class="package-name">[`@stdlib/assert/is-number`][@stdlib/assert/is-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+<!-- <related-links> -->
+
+[@stdlib/assert/is-finite]: https://github.com/stdlib-js/assert/tree/main/is-finite
+
+[@stdlib/assert/is-nonnegative-number]: https://github.com/stdlib-js/assert/tree/main/is-nonnegative-number
+
+[@stdlib/assert/is-number]: https://github.com/stdlib-js/assert/tree/main/is-number
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

package/is-nonnegative-finite/docs/repl.txt

@@ -0,0 +1,77 @@
+
+{{alias}}( value )
+    Tests if a value is a nonnegative finite number.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether value is a nonnegative finite number.
+
+    Examples
+    --------
+    > var bool = {{alias}}( 5.0 )
+    true
+    > bool = {{alias}}( new {{alias:@stdlib/number/ctor}}( 5.0 ) )
+    true
+    > bool = {{alias}}( 3.14 )
+    true
+    > bool = {{alias}}( -5.0 )
+    false
+    > bool = {{alias}}( null )
+    false
+    > bool = {{alias}}( {{alias:@stdlib/constants/float64/pinf}} )
+    false
+
+
+{{alias}}.isPrimitive( value )
+    Tests if a value is a number primitive having a nonnegative finite value.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether value is a number primitive having a
+        nonnegative finite value.
+
+    Examples
+    --------
+    > var bool = {{alias}}.isPrimitive( 3.0 )
+    true
+    > bool = {{alias}}.isPrimitive( new {{alias:@stdlib/number/ctor}}( 3.0 ) )
+    false
+
+
+{{alias}}.isObject( value )
+    Tests if a value is a number object having a nonnegative finite value.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether value is a number object having a 
+        nonnegative finite value.
+
+    Examples
+    --------
+    > var bool = {{alias}}.isObject( 3.0 )
+    false
+    > bool = {{alias}}.isObject( new {{alias:@stdlib/number/ctor}}( 3.0 ) )
+    true
+
+
+    See Also
+    --------
+

package/is-nonnegative-finite/docs/types/index.d.ts

@@ -0,0 +1,141 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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
+
+/**
+* Interface defining `isNonNegativeFinite` with methods for testing for primitives and objects, respectively.
+*/
+interface IsNonNegativeFinite {
+	/**
+	* Tests if a value is a nonnegative finite number.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is a nonnegative finite number
+	*
+	* @example
+	* var bool = isNonNegativeFinite( 5.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = isNonNegativeFinite( new Number( 5.0 ) );
+	* // returns true
+	*
+	* @example
+	* var bool = isNonNegativeFinite( 3.14 );
+	* // returns true
+	*
+	* @example
+	* var bool = isNonNegativeFinite( 1.0/0.0 );
+	* // returns false
+	*
+	* @example
+	* var bool = isNonNegativeFinite( -5.0 );
+	* // returns false
+	*
+	* @example
+	* var bool = isNonNegativeFinite( null );
+	* // returns false
+	*/
+	( value: any ): boolean;
+
+	/**
+	* Tests if a value is a number primitive having a nonnegative finite value.
+	*
+	* @param value - value to test
+	* @returns boolean indicating if a value is a number primitive having a nonnegative finite value
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isPrimitive( 3.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isPrimitive( new Number( 3.0 ) );
+	* // returns false
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isPrimitive( new Number( -5.0 ) );
+	* // returns false
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isPrimitive( 1.0/0.0 );
+	* // returns false
+	*/
+	isPrimitive( value: any ): boolean;
+
+	/**
+	* Tests if a value is a number object having a nonnegative finite value.
+	*
+	* @param value - value to test
+	* @returns boolean indicating if a value is a number object having a nonnegative finite number value
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isObject( 3.0 );
+	* // returns false
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isObject( new Number( 3.0 ) );
+	* // returns true
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isObject( new Number( -5.0 ) );
+	* // returns false
+	*
+	* @example
+	* var bool = isNonNegativeFinite.isObject( 1.0/0.0 );
+	* // returns false
+	*/
+	isObject( value: any ): boolean;
+}
+
+/**
+* Tests if a value is a nonnegative finite number.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is a nonnegative finite number
+*
+* @example
+* var bool = isNonNegativeFinite( 5.0 );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( new Number( 5.0 ) );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( 3.14 );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( 1.0/0.0 );
+* // returns false
+*
+* @example
+* var bool = isNonNegativeFinite( -5.0 );
+* // returns false
+*
+* @example
+* var bool = isNonNegativeFinite( null );
+* // returns false
+*/
+declare var isNonNegativeFinite: IsNonNegativeFinite;
+
+
+// EXPORTS //
+
+export = isNonNegativeFinite;

package/is-nonnegative-finite/docs/types/test.ts

@@ -0,0 +1,60 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isNonNegativeFinite = require( './index' );
+
+
+// TESTS //
+
+// The function returns a boolean...
+{
+	isNonNegativeFinite( 1.2 ); // $ExpectType boolean
+	isNonNegativeFinite( -1.2 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	isNonNegativeFinite(); // $ExpectError
+	isNonNegativeFinite( 2, 123 ); // $ExpectError
+}
+
+// Attached to main export is an `isPrimitive` method which returns a boolean...
+{
+	// eslint-disable-next-line no-new-wrappers
+	isNonNegativeFinite.isPrimitive( new Number( 2 ) ); // $ExpectType boolean
+	isNonNegativeFinite.isPrimitive( 2 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the `isPrimitive` method is provided an unsupported number of arguments...
+{
+	isNonNegativeFinite.isPrimitive(); // $ExpectError
+	isNonNegativeFinite.isPrimitive( 2, 123 ); // $ExpectError
+}
+
+// Attached to main export is an `isObject` method which returns a boolean...
+{
+	// eslint-disable-next-line no-new-wrappers
+	isNonNegativeFinite.isObject( new Number( 2 ) ); // $ExpectType boolean
+	isNonNegativeFinite.isObject( 2 ); // $ExpectType boolean
+}
+
+// The compiler throws an error if the `isObject` method is provided an unsupported number of arguments...
+{
+	isNonNegativeFinite.isObject(); // $ExpectError
+	isNonNegativeFinite.isObject( 2, 123 ); // $ExpectError
+}

package/is-nonnegative-finite/lib/index.js

@@ -0,0 +1,85 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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';
+
+/**
+* Test if a value is a nonnegative finite number.
+*
+* @module @stdlib/assert/is-nonnegative-finite
+*
+* @example
+* var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' );
+*
+* var bool = isNonNegativeFinite( 5.0 );
+* // returns true
+*
+* bool = isNonNegativeFinite( new Number( 5.0 ) );
+* // returns true
+*
+* bool = isNonNegativeFinite( 3.14 );
+* // returns true
+*
+* var bool = isNonNegativeFinite( 1.0/0.0 );
+* // returns false
+*
+* bool = isNonNegativeFinite( -5.0 );
+* // returns false
+*
+* bool = isNonNegativeFinite( null );
+* // returns false
+*
+* @example
+* var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' ).isPrimitive;
+*
+* var bool = isNonNegativeFinite( 3.0 );
+* // returns true
+*
+* bool = isNonNegativeFinite( new Number( 3.0 ) );
+* // returns false
+*
+* @example
+* var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' ).isObject;
+*
+* var bool = isNonNegativeFinite( 3.0 );
+* // returns false
+*
+* var bool = isNonNegativeFinite( 1.0/0.0 );
+* // returns false
+*
+* bool = isNonNegativeFinite( new Number( 3.0 ) );
+* // returns true
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@ohos-ports/stdlib-utils/define-nonenumerable-read-only-property' );
+var main = require( './main.js' );
+var isPrimitive = require( './primitive.js' );
+var isObject = require( './object.js' );
+
+
+// MAIN //
+
+setReadOnly( main, 'isPrimitive', isPrimitive );
+setReadOnly( main, 'isObject', isObject );
+
+
+// EXPORTS //
+
+module.exports = main;

package/is-nonnegative-finite/lib/main.js

@@ -0,0 +1,66 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isPrimitive = require( './primitive.js' );
+var isObject = require( './object.js' );
+
+
+// MAIN //
+
+/**
+* Tests if a value is a nonnegative finite number.
+*
+* @param {*} value - value to test
+* @returns {boolean} boolean indicating whether value is a nonnegative finite number
+*
+* @example
+* var bool = isNonNegativeFinite( 5.0 );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( new Number( 5.0 ) );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( 3.14 );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( 1.0/0.0 );
+* // returns false
+*
+* @example
+* var bool = isNonNegativeFinite( -5.0 );
+* // returns false
+*
+* @example
+* var bool = isNonNegativeFinite( null );
+* // returns false
+*/
+function isNonNegativeFinite( value ) {
+	return ( isPrimitive( value ) || isObject( value ) );
+}
+
+
+// EXPORTS //
+
+module.exports = isNonNegativeFinite;

package/is-nonnegative-finite/lib/object.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isNonNegativeNumber = require( './../../is-nonnegative-number' ).isObject;
+var PINF = require( '@ohos-ports/stdlib-constants/float64/pinf' );
+
+
+// MAIN //
+
+/**
+* Tests if a value is a finite number object having a nonnegative value.
+*
+* @param {*} value - value to test
+* @returns {boolean} boolean indicating if a value is a number object having a nonnegative finite number value
+*
+* @example
+* var bool = isNonNegativeFinite( 3.0 );
+* // returns false
+*
+* @example
+* var bool = isNonNegativeFinite( new Number( 3.0 ) );
+* // returns true
+*
+* @example
+* var bool = isNonNegativeFinite( new Number( -5.0 ) );
+* // returns false
+*
+* @example
+* var bool = isNonNegativeFinite( 1.0/0.0 );
+* // returns false
+*/
+function isNonNegativeFinite( value ) {
+	return (
+		isNonNegativeNumber( value ) &&
+		value.valueOf() < PINF
+	);
+}
+
+
+// EXPORTS //
+
+module.exports = isNonNegativeFinite;