154 lines
2.8 KiB
Markdown
154 lines
2.8 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2020 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.
|
|
|
|
-->
|
|
|
|
# isSquareNumber
|
|
|
|
> Test if a value is a square number.
|
|
|
|
<section class="intro">
|
|
|
|
A **square number** is defined as an integer value which is the square of an integer.
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var isSquareNumber = require( '@stdlib/assert/is-square-number' );
|
|
```
|
|
|
|
#### isSquareNumber( value )
|
|
|
|
Tests if a `value` is a square number.
|
|
|
|
<!-- eslint-disable no-new-wrappers -->
|
|
|
|
```javascript
|
|
var Number = require( '@stdlib/number/ctor' );
|
|
|
|
var bool = isSquareNumber( 4.0 );
|
|
// returns true
|
|
|
|
bool = isSquareNumber( new Number( 4.0 ) );
|
|
// returns true
|
|
|
|
bool = isSquareNumber( 3.14 );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( -5.0 );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( NaN );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( null );
|
|
// returns false
|
|
```
|
|
|
|
#### isSquareNumber.isPrimitive( value )
|
|
|
|
Tests if a `value` is a primitive square number.
|
|
|
|
<!-- eslint-disable no-new-wrappers -->
|
|
|
|
```javascript
|
|
var Number = require( '@stdlib/number/ctor' );
|
|
|
|
var bool = isSquareNumber.isPrimitive( 4.0 );
|
|
// returns true
|
|
|
|
bool = isSquareNumber.isPrimitive( new Number( 4.0 ) );
|
|
// returns false
|
|
```
|
|
|
|
#### isSquareNumber.isObject( value )
|
|
|
|
Tests if a `value` is a `Number` object having a value which is a square number.
|
|
|
|
<!-- eslint-disable no-new-wrappers -->
|
|
|
|
```javascript
|
|
var Number = require( '@stdlib/number/ctor' );
|
|
|
|
var bool = isSquareNumber.isObject( 4.0 );
|
|
// returns false
|
|
|
|
bool = isSquareNumber.isObject( new Number( 4.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 isSquareNumber = require( '@stdlib/assert/is-square-number' );
|
|
|
|
var bool = isSquareNumber( 4.0 );
|
|
// returns true
|
|
|
|
bool = isSquareNumber( new Number( 4.0 ) );
|
|
// returns true
|
|
|
|
bool = isSquareNumber( 0.0 );
|
|
// returns true
|
|
|
|
bool = isSquareNumber( 1.0 );
|
|
// returns true
|
|
|
|
bool = isSquareNumber( 3.14 );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( -5.0 );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( NaN );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( '0.5' );
|
|
// returns false
|
|
|
|
bool = isSquareNumber( null );
|
|
// returns false
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<section class="links">
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|