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

package/is-square-number/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@stdlib/assert/is-square-number",
+  "version": "0.0.0",
+  "description": "Test if a value is a square 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": {},
+  "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",
+    "stdassert",
+    "assertion",
+    "assert",
+    "utilities",
+    "utility",
+    "utils",
+    "util",
+    "number",
+    "numeric",
+    "square",
+    "is",
+    "issquare",
+    "type",
+    "check",
+    "valid",
+    "validate",
+    "test",
+    "primitive",
+    "object"
+  ]
+}

package/is-square-triangular-number/README.md

@@ -0,0 +1,222 @@
+<!--
+
+@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.
+
+-->
+
+# isSquareTriangularNumber
+
+> Test if a value is a [square triangular number][square-triangular-number].
+
+<section class="intro">
+
+A **square triangular number** is an integer value which is both a [square number][@stdlib/assert/is-square-number] and a [triangular number][@stdlib/assert/is-triangular-number].
+
+[Triangular numbers][@stdlib/assert/is-triangular-number] can be computed using the following formula
+
+<!-- <equation class="equation" label="eq:triangular_number" align="center" raw="T_n = \frac{n(n+1)}{2}" alt="Triangular number formula."> -->
+
+<div class="equation" align="center" data-raw-text="T_n = \frac{n(n+1)}{2}" data-equation="eq:triangular_number">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b295a09a80f4fd0cc84682dcda0fe3e354394c0c/lib/node_modules/@stdlib/assert/is-square-triangular-number/docs/img/equation_triangular_number.svg" alt="Triangular number formula.">
+    <br>
+</div> -->
+
+<!-- </equation> -->
+
+for `n >= 0`.
+
+By analogy with the square root of `x`, one can define the positive triangular root of `x` such that `T_n = x`
+
+<!-- <equation class="equation" label="eq:triangular_root" align="center" raw="n = \frac{\sqrt{8x+1} - 1}{2}" alt="Triangular root formula."> -->
+
+<!-- <div class="equation" align="center" data-raw-text="n = \frac{\sqrt{8x+1} - 1}{2}" data-equation="eq:triangular_root">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b295a09a80f4fd0cc84682dcda0fe3e354394c0c/lib/node_modules/@stdlib/assert/is-square-triangular-number/docs/img/equation_triangular_root.svg" alt="Triangular root formula.">
+    <br>
+</div>
+
+<!-- </equation> -->
+
+Accordingly, an integer `x` is a [triangular number][@stdlib/assert/is-triangular-number] **if and only** if `8x+1` is a [square number][@stdlib/assert/is-square-number].
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var isSquareTriangularNumber = require( '@stdlib/assert/is-square-triangular-number' );
+```
+
+#### isSquareTriangularNumber( value )
+
+Tests if a `value` is a [square triangular number][square-triangular-number].
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+
+var bool = isSquareTriangularNumber( 36.0 );
+// returns true
+
+bool = isSquareTriangularNumber( new Number( 36.0 ) );
+// returns true
+
+bool = isSquareTriangularNumber( 3.14 );
+// returns false
+
+bool = isSquareTriangularNumber( -5.0 );
+// returns false
+
+bool = isSquareTriangularNumber( NaN );
+// returns false
+
+bool = isSquareTriangularNumber( null );
+// returns false
+```
+
+#### isSquareTriangularNumber.isPrimitive( value )
+
+Tests if a `value` is a primitive [square triangular number][square-triangular-number].
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+
+var bool = isSquareTriangularNumber.isPrimitive( 36.0 );
+// returns true
+
+bool = isSquareTriangularNumber.isPrimitive( new Number( 36.0 ) );
+// returns false
+```
+
+#### isSquareTriangularNumber.isObject( value )
+
+Tests if a `value` is a `Number` object having a value which is a [square triangular number][square-triangular-number].
+
+<!-- eslint-disable no-new-wrappers -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+
+var bool = isSquareTriangularNumber.isObject( 36.0 );
+// returns false
+
+bool = isSquareTriangularNumber.isObject( new Number( 36.0 ) );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   Return values are not reliable for numbers greater than `1125899906842624`.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable no-new-wrappers -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var Number = require( '@stdlib/number/ctor' );
+var isSquareTriangularNumber = require( '@stdlib/assert/is-square-triangular-number' );
+
+var bool = isSquareTriangularNumber( 36.0 );
+// returns true
+
+bool = isSquareTriangularNumber( new Number( 36.0 ) );
+// returns true
+
+bool = isSquareTriangularNumber( 0.0 );
+// returns true
+
+bool = isSquareTriangularNumber( 1.0 );
+// returns true
+
+bool = isSquareTriangularNumber( 3.14 );
+// returns false
+
+bool = isSquareTriangularNumber( -5.0 );
+// returns false
+
+bool = isSquareTriangularNumber( NaN );
+// returns false
+
+bool = isSquareTriangularNumber( '0.5' );
+// returns false
+
+bool = isSquareTriangularNumber( 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-integer`][@stdlib/assert/is-integer]</span><span class="delimiter">: </span><span class="description">test if a value is a number having an integer 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>
+-   <span class="package-name">[`@stdlib/assert/is-square-number`][@stdlib/assert/is-square-number]</span><span class="delimiter">: </span><span class="description">test if a value is a square number.</span>
+-   <span class="package-name">[`@stdlib/assert/is-triangular-number`][@stdlib/assert/is-triangular-number]</span><span class="delimiter">: </span><span class="description">test if a value is a triangular 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">
+
+[square-triangular-number]: https://en.wikipedia.org/wiki/Square_triangular_number
+
+<!-- <related-links> -->
+
+[@stdlib/assert/is-integer]: https://github.com/stdlib-js/assert/tree/main/is-integer
+
+[@stdlib/assert/is-number]: https://github.com/stdlib-js/assert/tree/main/is-number
+
+[@stdlib/assert/is-square-number]: https://github.com/stdlib-js/assert/tree/main/is-square-number
+
+[@stdlib/assert/is-triangular-number]: https://github.com/stdlib-js/assert/tree/main/is-triangular-number
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

package/is-square-triangular-number/docs/img/equation_triangular_number.svg

@@ -0,0 +1,32 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="15.112ex" height="5.676ex" style="vertical-align: -1.838ex;" viewBox="0 -1652.5 6506.6 2443.8" role="img" focusable="false" xmlns="http://www.w3.org/2000/svg" aria-labelledby="MathJax-SVG-1-Title">
+<title id="MathJax-SVG-1-Title">upper T Subscript n Baseline equals StartFraction n left-parenthesis n plus 1 right-parenthesis Over 2 EndFraction</title>
+<defs aria-hidden="true">
+<path stroke-width="1" id="E1-MJMATHI-54" d="M40 437Q21 437 21 445Q21 450 37 501T71 602L88 651Q93 669 101 677H569H659Q691 677 697 676T704 667Q704 661 687 553T668 444Q668 437 649 437Q640 437 637 437T631 442L629 445Q629 451 635 490T641 551Q641 586 628 604T573 629Q568 630 515 631Q469 631 457 630T439 622Q438 621 368 343T298 60Q298 48 386 46Q418 46 427 45T436 36Q436 31 433 22Q429 4 424 1L422 0Q419 0 415 0Q410 0 363 1T228 2Q99 2 64 0H49Q43 6 43 9T45 27Q49 40 55 46H83H94Q174 46 189 55Q190 56 191 56Q196 59 201 76T241 233Q258 301 269 344Q339 619 339 625Q339 630 310 630H279Q212 630 191 624Q146 614 121 583T67 467Q60 445 57 441T43 437H40Z"></path>
+<path stroke-width="1" id="E1-MJMATHI-6E" d="M21 287Q22 293 24 303T36 341T56 388T89 425T135 442Q171 442 195 424T225 390T231 369Q231 367 232 367L243 378Q304 442 382 442Q436 442 469 415T503 336T465 179T427 52Q427 26 444 26Q450 26 453 27Q482 32 505 65T540 145Q542 153 560 153Q580 153 580 145Q580 144 576 130Q568 101 554 73T508 17T439 -10Q392 -10 371 17T350 73Q350 92 386 193T423 345Q423 404 379 404H374Q288 404 229 303L222 291L189 157Q156 26 151 16Q138 -11 108 -11Q95 -11 87 -5T76 7T74 17Q74 30 112 180T152 343Q153 348 153 366Q153 405 129 405Q91 405 66 305Q60 285 60 284Q58 278 41 278H27Q21 284 21 287Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-3D" d="M56 347Q56 360 70 367H707Q722 359 722 347Q722 336 708 328L390 327H72Q56 332 56 347ZM56 153Q56 168 72 173H708Q722 163 722 153Q722 140 707 133H70Q56 140 56 153Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-28" d="M94 250Q94 319 104 381T127 488T164 576T202 643T244 695T277 729T302 750H315H319Q333 750 333 741Q333 738 316 720T275 667T226 581T184 443T167 250T184 58T225 -81T274 -167T316 -220T333 -241Q333 -250 318 -250H315H302L274 -226Q180 -141 137 -14T94 250Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-2B" d="M56 237T56 250T70 270H369V420L370 570Q380 583 389 583Q402 583 409 568V270H707Q722 262 722 250T707 230H409V-68Q401 -82 391 -82H389H387Q375 -82 369 -68V230H70Q56 237 56 250Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-31" d="M213 578L200 573Q186 568 160 563T102 556H83V602H102Q149 604 189 617T245 641T273 663Q275 666 285 666Q294 666 302 660V361L303 61Q310 54 315 52T339 48T401 46H427V0H416Q395 3 257 3Q121 3 100 0H88V46H114Q136 46 152 46T177 47T193 50T201 52T207 57T213 61V578Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-29" d="M60 749L64 750Q69 750 74 750H86L114 726Q208 641 251 514T294 250Q294 182 284 119T261 12T224 -76T186 -143T145 -194T113 -227T90 -246Q87 -249 86 -250H74Q66 -250 63 -250T58 -247T55 -238Q56 -237 66 -225Q221 -64 221 250T66 725Q56 737 55 738Q55 746 60 749Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-32" d="M109 429Q82 429 66 447T50 491Q50 562 103 614T235 666Q326 666 387 610T449 465Q449 422 429 383T381 315T301 241Q265 210 201 149L142 93L218 92Q375 92 385 97Q392 99 409 186V189H449V186Q448 183 436 95T421 3V0H50V19V31Q50 38 56 46T86 81Q115 113 136 137Q145 147 170 174T204 211T233 244T261 278T284 308T305 340T320 369T333 401T340 431T343 464Q343 527 309 573T212 619Q179 619 154 602T119 569T109 550Q109 549 114 549Q132 549 151 535T170 489Q170 464 154 447T109 429Z"></path>
+</defs>
+<g stroke="currentColor" fill="currentColor" stroke-width="0" transform="matrix(1 0 0 -1 0 0)" aria-hidden="true">
+ <use xlink:href="#E1-MJMATHI-54" x="0" y="0"></use>
+ <use transform="scale(0.707)" xlink:href="#E1-MJMATHI-6E" x="826" y="-213"></use>
+ <use xlink:href="#E1-MJMAIN-3D" x="1386" y="0"></use>
+<g transform="translate(2165,0)">
+<g transform="translate(397,0)">
+<rect stroke="none" width="3823" height="60" x="0" y="220"></rect>
+<g transform="translate(60,770)">
+ <use xlink:href="#E1-MJMATHI-6E" x="0" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-28" x="600" y="0"></use>
+ <use xlink:href="#E1-MJMATHI-6E" x="990" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-2B" x="1812" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-31" x="2813" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-29" x="3313" y="0"></use>
+</g>
+ <use xlink:href="#E1-MJMAIN-32" x="1661" y="-687"></use>
+</g>
+</g>
+</g>
+</svg>

package/is-square-triangular-number/docs/img/equation_triangular_root.svg

@@ -0,0 +1,36 @@
+<svg xmlns:xlink="http://www.w3.org/1999/xlink" width="17.763ex" height="5.843ex" style="vertical-align: -1.838ex;" viewBox="0 -1724.2 7647.9 2515.6" role="img" focusable="false" xmlns="http://www.w3.org/2000/svg" aria-labelledby="MathJax-SVG-1-Title">
+<title id="MathJax-SVG-1-Title">n equals StartFraction StartRoot 8 x plus 1 EndRoot minus 1 Over 2 EndFraction</title>
+<defs aria-hidden="true">
+<path stroke-width="1" id="E1-MJMATHI-6E" d="M21 287Q22 293 24 303T36 341T56 388T89 425T135 442Q171 442 195 424T225 390T231 369Q231 367 232 367L243 378Q304 442 382 442Q436 442 469 415T503 336T465 179T427 52Q427 26 444 26Q450 26 453 27Q482 32 505 65T540 145Q542 153 560 153Q580 153 580 145Q580 144 576 130Q568 101 554 73T508 17T439 -10Q392 -10 371 17T350 73Q350 92 386 193T423 345Q423 404 379 404H374Q288 404 229 303L222 291L189 157Q156 26 151 16Q138 -11 108 -11Q95 -11 87 -5T76 7T74 17Q74 30 112 180T152 343Q153 348 153 366Q153 405 129 405Q91 405 66 305Q60 285 60 284Q58 278 41 278H27Q21 284 21 287Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-3D" d="M56 347Q56 360 70 367H707Q722 359 722 347Q722 336 708 328L390 327H72Q56 332 56 347ZM56 153Q56 168 72 173H708Q722 163 722 153Q722 140 707 133H70Q56 140 56 153Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-38" d="M70 417T70 494T124 618T248 666Q319 666 374 624T429 515Q429 485 418 459T392 417T361 389T335 371T324 363L338 354Q352 344 366 334T382 323Q457 264 457 174Q457 95 399 37T249 -22Q159 -22 101 29T43 155Q43 263 172 335L154 348Q133 361 127 368Q70 417 70 494ZM286 386L292 390Q298 394 301 396T311 403T323 413T334 425T345 438T355 454T364 471T369 491T371 513Q371 556 342 586T275 624Q268 625 242 625Q201 625 165 599T128 534Q128 511 141 492T167 463T217 431Q224 426 228 424L286 386ZM250 21Q308 21 350 55T392 137Q392 154 387 169T375 194T353 216T330 234T301 253T274 270Q260 279 244 289T218 306L210 311Q204 311 181 294T133 239T107 157Q107 98 150 60T250 21Z"></path>
+<path stroke-width="1" id="E1-MJMATHI-78" d="M52 289Q59 331 106 386T222 442Q257 442 286 424T329 379Q371 442 430 442Q467 442 494 420T522 361Q522 332 508 314T481 292T458 288Q439 288 427 299T415 328Q415 374 465 391Q454 404 425 404Q412 404 406 402Q368 386 350 336Q290 115 290 78Q290 50 306 38T341 26Q378 26 414 59T463 140Q466 150 469 151T485 153H489Q504 153 504 145Q504 144 502 134Q486 77 440 33T333 -11Q263 -11 227 52Q186 -10 133 -10H127Q78 -10 57 16T35 71Q35 103 54 123T99 143Q142 143 142 101Q142 81 130 66T107 46T94 41L91 40Q91 39 97 36T113 29T132 26Q168 26 194 71Q203 87 217 139T245 247T261 313Q266 340 266 352Q266 380 251 392T217 404Q177 404 142 372T93 290Q91 281 88 280T72 278H58Q52 284 52 289Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-2B" d="M56 237T56 250T70 270H369V420L370 570Q380 583 389 583Q402 583 409 568V270H707Q722 262 722 250T707 230H409V-68Q401 -82 391 -82H389H387Q375 -82 369 -68V230H70Q56 237 56 250Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-31" d="M213 578L200 573Q186 568 160 563T102 556H83V602H102Q149 604 189 617T245 641T273 663Q275 666 285 666Q294 666 302 660V361L303 61Q310 54 315 52T339 48T401 46H427V0H416Q395 3 257 3Q121 3 100 0H88V46H114Q136 46 152 46T177 47T193 50T201 52T207 57T213 61V578Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-221A" d="M95 178Q89 178 81 186T72 200T103 230T169 280T207 309Q209 311 212 311H213Q219 311 227 294T281 177Q300 134 312 108L397 -77Q398 -77 501 136T707 565T814 786Q820 800 834 800Q841 800 846 794T853 782V776L620 293L385 -193Q381 -200 366 -200Q357 -200 354 -197Q352 -195 256 15L160 225L144 214Q129 202 113 190T95 178Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-2212" d="M84 237T84 250T98 270H679Q694 262 694 250T679 230H98Q84 237 84 250Z"></path>
+<path stroke-width="1" id="E1-MJMAIN-32" d="M109 429Q82 429 66 447T50 491Q50 562 103 614T235 666Q326 666 387 610T449 465Q449 422 429 383T381 315T301 241Q265 210 201 149L142 93L218 92Q375 92 385 97Q392 99 409 186V189H449V186Q448 183 436 95T421 3V0H50V19V31Q50 38 56 46T86 81Q115 113 136 137Q145 147 170 174T204 211T233 244T261 278T284 308T305 340T320 369T333 401T340 431T343 464Q343 527 309 573T212 619Q179 619 154 602T119 569T109 550Q109 549 114 549Q132 549 151 535T170 489Q170 464 154 447T109 429Z"></path>
+</defs>
+<g stroke="currentColor" fill="currentColor" stroke-width="0" transform="matrix(1 0 0 -1 0 0)" aria-hidden="true">
+ <use xlink:href="#E1-MJMATHI-6E" x="0" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-3D" x="878" y="0"></use>
+<g transform="translate(1656,0)">
+<g transform="translate(397,0)">
+<rect stroke="none" width="5473" height="60" x="0" y="220"></rect>
+<g transform="translate(60,722)">
+ <use xlink:href="#E1-MJMAIN-221A" x="0" y="-2"></use>
+<rect stroke="none" width="2796" height="60" x="833" y="739"></rect>
+<g transform="translate(833,0)">
+ <use xlink:href="#E1-MJMAIN-38" x="0" y="0"></use>
+ <use xlink:href="#E1-MJMATHI-78" x="500" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-2B" x="1295" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-31" x="2295" y="0"></use>
+</g>
+ <use xlink:href="#E1-MJMAIN-2212" x="3852" y="0"></use>
+ <use xlink:href="#E1-MJMAIN-31" x="4852" y="0"></use>
+</g>
+ <use xlink:href="#E1-MJMAIN-32" x="2486" y="-687"></use>
+</g>
+</g>
+</g>
+</svg>

package/is-square-triangular-number/docs/repl.txt

@@ -0,0 +1,78 @@
+
+{{alias}}( value )
+    Tests if a value is a square triangular number.
+
+    Return values are not reliable for numbers greater than 1125899906842624.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether value is a square triangular number.
+
+    Examples
+    --------
+    > var bool = {{alias}}( 36.0 )
+    true
+    > bool = {{alias}}( new Number( 36.0 ) )
+    true
+    > bool = {{alias}}( 3.14 )
+    false
+    > bool = {{alias}}( -5.0 )
+    false
+    > bool = {{alias}}( null )
+    false
+
+
+{{alias}}.isPrimitive( value )
+    Tests if a value is a number primitive which is a square triangular number.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether value is a number primitive which is a
+        square triangular number.
+
+    Examples
+    --------
+    > var bool = {{alias}}.isPrimitive( 36.0 )
+    true
+    > bool = {{alias}}.isPrimitive( new Number( 36.0 ) )
+    false
+
+
+{{alias}}.isObject( value )
+    Tests if a value is a number object having a value which is a square
+    triangular number.
+
+    Parameters
+    ----------
+    value: any
+        Value to test.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating whether value is a number object having a value which
+        is a square triangular number.
+
+    Examples
+    --------
+    > var bool = {{alias}}.isObject( 36.0 )
+    false
+    > bool = {{alias}}.isObject( new Number( 36.0 ) )
+    true
+
+
+    See Also
+    --------
+

package/is-square-triangular-number/docs/types/index.d.ts

@@ -0,0 +1,129 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Interface describing methods for testing for primitives and objects.
+*/
+interface IsSquareTriangularNumber {
+	/**
+	* Tests if a value is a square triangular number.
+	*
+	* @param value - value to test
+	* @returns boolean indicating whether value is a square triangular number
+	*
+	* @example
+	* var bool = isSquareTriangularNumber( 36.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = isSquareTriangularNumber( new Number( 36.0 ) );
+	* // returns true
+	*
+	* @example
+	* var bool = isSquareTriangularNumber( 3.14 );
+	* // returns false
+	*
+	* @example
+	* var bool = isSquareTriangularNumber( -5.0 );
+	* // returns false
+	*
+	* @example
+	* var bool = isSquareTriangularNumber( null );
+	* // returns false
+	*/
+	( value: any ): boolean;
+
+	/**
+	* Tests if a value is a number primitive having a value which is a square triangular number.
+	*
+	* @param value - value to test
+	* @returns boolean indicating if a value is a number primitive having a value which is a square triangular number
+	*
+	* @example
+	* var bool = isSquareTriangularNumber.isPrimitive( 36.0 );
+	* // returns true
+	*
+	* @example
+	* var bool = isSquareTriangularNumber.isPrimitive( new Number( 36.0 ) );
+	* // returns false
+	*/
+	isPrimitive( value: any ): boolean;
+
+	/**
+	* Tests if a value is a number object having a value which is a square triangular number.
+	*
+	* @param value - value to test
+	* @returns boolean indicating if a value is a number object having a value which is a square triangular number
+	*
+	* @example
+	* var bool = isSquareTriangularNumber.isObject( 36.0 );
+	* // returns false
+	*
+	* @example
+	* var bool = isSquareTriangularNumber.isObject( new Number( 36.0 ) );
+	* // returns true
+	*/
+	isObject( value: any ): boolean;
+}
+
+/**
+* Tests if a value is a square triangular number.
+*
+* ## Notes
+*
+* -   Return values are not reliable for numbers greater than `1125899906842624`.
+*
+* @param value - value to test
+* @returns boolean indicating whether value is a square triangular number
+*
+* @example
+* var bool = isSquareTriangularNumber( 36.0 );
+* // returns true
+*
+* @example
+* var bool = isSquareTriangularNumber( new Number( 36.0 ) );
+* // returns true
+*
+* @example
+* var bool = isSquareTriangularNumber( 3.14 );
+* // returns false
+*
+* @example
+* var bool = isSquareTriangularNumber( -5.0 );
+* // returns false
+*
+* @example
+* var bool = isSquareTriangularNumber( null );
+* // returns false
+*
+* @example
+* var bool = isSquareTriangularNumber.isPrimitive( 36.0 );
+* // returns true
+*
+* @example
+* var bool = isSquareTriangularNumber.isObject( new Number( 36.0 ) );
+* // returns true
+*/
+declare var isSquareTriangularNumber: IsSquareTriangularNumber;
+
+
+// EXPORTS //
+
+export = isSquareTriangularNumber;

package/is-square-triangular-number/docs/types/test.ts

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