Skip to content

Commit 4a787f1

Browse files
Amansingh0807Amansingh0807
committed
feat: add constants/float16/sqrt-three
1 parent 4304bee commit 4a787f1

File tree

8 files changed

+355
-0
lines changed

8 files changed

+355
-0
lines changed

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/README.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# FLOAT16_SQRT3
22+
23+
> [Square root][@stdlib/math/base/special/sqrt] of `3` as a half-precision floating-point number.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var FLOAT16_SQRT3 = require( '@stdlib/constants/float16/sqrt-three' );
31+
```
32+
33+
#### FLOAT16_SQRT3
34+
35+
[Square root][@stdlib/math/base/special/sqrt] of `3` as a half-precision floating-point number.
36+
37+
```javascript
38+
var bool = ( FLOAT16_SQRT3 === 1.732421875 );
39+
// returns true
40+
```
41+
42+
</section>
43+
44+
<!-- /.usage -->
45+
46+
<section class="examples">
47+
48+
## Examples
49+
50+
<!-- TODO: better example -->
51+
52+
<!-- eslint no-undef: "error" -->
53+
54+
```javascript
55+
var FLOAT16_SQRT3 = require( '@stdlib/constants/float16/sqrt-three' );
56+
57+
console.log( FLOAT16_SQRT3 );
58+
// => 1.732421875
59+
```
60+
61+
</section>
62+
63+
<!-- /.examples -->
64+
65+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
66+
67+
<section class="related">
68+
69+
* * *
70+
71+
## See Also
72+
73+
- <span class="package-name">[`@stdlib/constants/float16/sqrt-eps`][@stdlib/constants/float16/sqrt-eps]</span><span class="delimiter">: </span><span class="description">square root of half-precision floating-point epsilon.</span>
74+
- <span class="package-name">[`@stdlib/constants/float32/sqrt-three`][@stdlib/constants/float32/sqrt-three]</span><span class="delimiter">: </span><span class="description">square root of `3` as a single-precision floating-point number.</span>
75+
- <span class="package-name">[`@stdlib/constants/float64/sqrt-three`][@stdlib/constants/float64/sqrt-three]</span><span class="delimiter">: </span><span class="description">square root of 3.</span>
76+
77+
</section>
78+
79+
<!-- /.related -->
80+
81+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
82+
83+
<section class="links">
84+
85+
[@stdlib/math/base/special/sqrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sqrt
86+
87+
<!-- <related-links> -->
88+
89+
[@stdlib/constants/float16/sqrt-eps]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float16/sqrt-eps
90+
91+
[@stdlib/constants/float32/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/sqrt-three
92+
93+
[@stdlib/constants/float64/sqrt-three]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/sqrt-three
94+
95+
<!-- </related-links> -->
96+
97+
</section>
98+
99+
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/repl.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
{{alias}}
3+
Square root of `3` as a half-precision floating-point number.
4+
5+
Examples
6+
--------
7+
> {{alias}}
8+
1.732421875
9+
10+
See Also
11+
--------
12+

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/index.d.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Square root of `3` as a half-precision floating-point number.
23+
*
24+
* @example
25+
* var val = FLOAT16_SQRT3;
26+
* // returns 1.732421875
27+
*/
28+
declare const FLOAT16_SQRT3: number;
29+
30+
31+
// EXPORTS //
32+
33+
export = FLOAT16_SQRT3;

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/docs/types/test.ts‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import FLOAT16_SQRT3 = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The export is a number...
25+
{
26+
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
27+
FLOAT16_SQRT3; // $ExpectType number
28+
}

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/examples/index.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
var FLOAT16_SQRT3 = require( './../lib' );
22+
23+
console.log( FLOAT16_SQRT3 );
24+
// => 1.732421875

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/lib/index.js‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
/**
22+
* Square root of `3` as a half-precision floating-point number.
23+
*
24+
* @module @stdlib/constants/float16/sqrt-three
25+
* @type {number}
26+
*
27+
* @example
28+
* var FLOAT16_SQRT3 = require( '@stdlib/constants/float16/sqrt-three' );
29+
* // returns 1.732421875
30+
*/
31+
32+
33+
// MAIN //
34+
35+
/**
36+
* Square root of `3` as a half-precision floating-point number.
37+
*
38+
* ```tex
39+
* \sqrt{3}
40+
* ```
41+
*
42+
* @constant
43+
* @type {number}
44+
* @default 1.732421875
45+
*/
46+
var FLOAT16_SQRT3 = 1.732421875;
47+
48+
49+
// EXPORTS //
50+
51+
module.exports = FLOAT16_SQRT3;

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/package.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"name": "@stdlib/constants/float16/sqrt-three",
3+
"version": "0.0.0",
4+
"description": "Square root of 3 as a half-precision floating-point number.",
5+
"license": "Apache-2.0",
6+
"author": {
7+
"name": "The Stdlib Authors",
8+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
9+
},
10+
"contributors": [
11+
{
12+
"name": "The Stdlib Authors",
13+
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
14+
}
15+
],
16+
"main": "./lib",
17+
"directories": {
18+
"doc": "./docs",
19+
"example": "./examples",
20+
"lib": "./lib",
21+
"test": "./test"
22+
},
23+
"types": "./docs/types",
24+
"scripts": {},
25+
"homepage": "https://github.com/stdlib-js/stdlib",
26+
"repository": {
27+
"type": "git",
28+
"url": "git://github.com/stdlib-js/stdlib.git"
29+
},
30+
"bugs": {
31+
"url": "https://github.com/stdlib-js/stdlib/issues"
32+
},
33+
"dependencies": {},
34+
"devDependencies": {},
35+
"engines": {
36+
"node": ">=0.10.0",
37+
"npm": ">2.7.0"
38+
},
39+
"os": [
40+
"aix",
41+
"darwin",
42+
"freebsd",
43+
"linux",
44+
"macos",
45+
"openbsd",
46+
"sunos",
47+
"win32",
48+
"windows"
49+
],
50+
"keywords": [
51+
"stdlib",
52+
"stdmath",
53+
"constant",
54+
"const",
55+
"mathematics",
56+
"math",
57+
"sqrt",
58+
"square",
59+
"root",
60+
"three",
61+
"sqrt3",
62+
"ieee754",
63+
"half",
64+
"half-precision",
65+
"floating-point",
66+
"float16",
67+
"16bit",
68+
"16-bit"
69+
]
70+
}

‎lib/node_modules/@stdlib/constants/float16/sqrt-three/test/test.js‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var tape = require( 'tape' );
24+
var FLOAT16_SQRT3 = require( './../lib' );
25+
26+
27+
// TESTS //
28+
29+
tape( 'main export is a number', function test( t ) {
30+
t.ok( true, __filename );
31+
t.strictEqual( typeof FLOAT16_SQRT3, 'number', 'main export is a number' );
32+
t.end();
33+
});
34+
35+
tape( 'the exported value is a half-precision floating-point number equal to the square root of 3', function test( t ) {
36+
t.strictEqual( FLOAT16_SQRT3, 1.732421875, 'returns expected value' );
37+
t.end();
38+
});

0 commit comments

Comments
 (0)